Re: [PATCH v6 1/5] lib: Update LZ4 compressor module
From: Jonathan Corbet
Date: Tue Jan 31 2017 - 17:28:02 EST
On Fri, 27 Jan 2017 23:02:00 +0100
Sven Schmidt <4sschmid@xxxxxxxxxxxxxxxxxxxxxxxxx> wrote:
I have one quick question...
> + * LZ4_compress_default()
> + * Compresses 'sourceSize' bytes from buffer 'source'
> + * into already allocated 'dest' buffer of size 'maxOutputSize'.
> + * Compression is guaranteed to succeed if
> + * 'maxOutputSize' >= LZ4_compressBound(inputSize).
> + * It also runs faster, so it's a recommended setting.
> + * If the function cannot compress 'source'
> + * into a more limited 'dest' budget,
> + * compression stops *immediately*,
> + * and the function result is zero.
> + * As a consequence, 'dest' content is not valid.
> + *
> + * source : source address of the original data
> + * dest : output buffer address
> + * of the compressed data
> + * inputSize : Max supported value is
> + * LZ4_MAX_INPUT_SIZE
> + * maxOutputSize: full or partial size of buffer 'dest'
> + * (which must be already allocated)
> + * workmem : address of the working memory.
> + * This requires 'workmem' of size LZ4_MEM_COMPRESS.
> + * return : the number of bytes written into buffer 'dest'
> + * (necessarily <= maxOutputSize) or 0 if compression fails
> + */
> +int LZ4_compress_default(const char *source, char *dest, int inputSize,
> + int maxOutputSize, void *wrkmem);
Is there any chance you could format these as kerneldoc comments? You're
not too far from it now, and that would allow the LZ4 interface to be
pulled into the documentation.