diff options
author | Andrew Bartlett <abartlet@samba.org> | 2023-03-28 15:10:39 +1300 |
---|---|---|
committer | Andrew Bartlett <abartlet@samba.org> | 2023-03-31 01:48:30 +0000 |
commit | e37f20fb36a1bda3e121dba5d8042efeb84ed7e3 (patch) | |
tree | 9c8cd283c45a0d0ae67fe5c95f5f37e8a39153af /lib/compression | |
parent | 0ab5552c8c32e7d7196b5a33eaa5533ccac53d0e (diff) | |
download | samba-e37f20fb36a1bda3e121dba5d8042efeb84ed7e3.tar.gz |
lib/compression: Fix documentation of lzxpress_huffman_compress()
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>
Diffstat (limited to 'lib/compression')
-rw-r--r-- | lib/compression/lzxpress_huffman.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/compression/lzxpress_huffman.c b/lib/compression/lzxpress_huffman.c index 6d383e4f8ca..ee0fa2c83e6 100644 --- a/lib/compression/lzxpress_huffman.c +++ b/lib/compression/lzxpress_huffman.c @@ -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. * |