liblzma: Document that lzma_allocator.free(opaque, NULL) is possible

It feels better to fix the docs than change the code because this
way newly-written applications will be forced to be compatible with
the lzma_allocator behavior of old liblzma versions. It can matter
if someone builds the application against an older liblzma version.

Fixes: https://github.com/tukaani-project/xz/issues/183

diff --git a/src/liblzma/api/lzma/base.h b/src/liblzma/api/lzma/base.h
index 0589cde2058dfbc1fa5ae5f2e67205f3ddc9e62b..00499381426a8490704244a02a59e620ff5c1f9c 100644 (file)
--- a/src/liblzma/api/lzma/base.h
+++ b/src/liblzma/api/lzma/base.h
@@ -450,7 +450,9 @@ typedef struct {
         * \param       opaque  lzma_allocator.opaque (see below)
         * \param       ptr     Pointer returned by lzma_allocator.alloc(),
         *                      or when it is set to NULL, a pointer returned
-        *                      by the standard malloc().
+        *                      by the standard malloc(). In addition, NULL
+        *                      is a possible value. The function should do
+        *                      nothing when ptr == NULL.
         */
        void (LZMA_API_CALL *free)(void *opaque, void *ptr);