]> git.ipfire.org Git - thirdparty/samba.git/commitdiff
lib/compression: Fix documentation of lzxpress_huffman_compress()
authorAndrew Bartlett <abartlet@samba.org>
Tue, 28 Mar 2023 02:10:39 +0000 (15:10 +1300)
committerAndrew Bartlett <abartlet@samba.org>
Fri, 31 Mar 2023 01:48:30 +0000 (01:48 +0000)
The "inconvenience function" takes one type, and converts it to another
but the documentation was not updated.

Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
lib/compression/lzxpress_huffman.c

index 6d383e4f8cab1e5af383226c42c2372732b3b803..ee0fa2c83e6325dc44b9aea7b63a36b0a3919f4b 100644 (file)
@@ -1294,11 +1294,11 @@ ssize_t lzxpress_huffman_compress_talloc(TALLOC_CTX *mem_ctx,
  * lzxpress_huffman_compress_talloc().
  *
  * To use this, you need to have allocated (but not initialised) a `struct
- * lzxhuff_compressor_context`, and an output buffer. If the buffer is not big
+ * lzxhuff_compressor_mem`, and an output buffer. If the buffer is not big
  * enough (per `output_size`), you'll get a negative return value, otherwise
  * the number of bytes actually consumed, which will always be at least 260.
  *
- * The `struct lzxhuff_compressor_context` is reusable -- it is basically a
+ * The `struct lzxhuff_compressor_mem` is reusable -- it is basically a
  * collection of uninitialised memory buffers. The total size is less than
  * 150k, so stack allocation is plausible.
  *