From e37f20fb36a1bda3e121dba5d8042efeb84ed7e3 Mon Sep 17 00:00:00 2001 From: Andrew Bartlett Date: Tue, 28 Mar 2023 15:10:39 +1300 Subject: 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 Reviewed-by: Douglas Bagnall --- lib/compression/lzxpress_huffman.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'lib/compression') 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. * -- cgit v1.2.1