From: Sven Schmidt <4sschmid@informatik.uni-hamburg.de>
To: Jonathan Corbet <corbet@lwn.net>
Cc: akpm@linux-foundation.org, bongkyu.kim@lge.com,
rsalvaterra@gmail.com, sergey.senozhatsky@gmail.com,
gregkh@linuxfoundation.org, linux-kernel@vger.kernel.org,
herbert@gondor.apana.org.au, davem@davemloft.net,
linux-crypto@vger.kernel.org, anton@enomsg.org,
ccross@android.com, keescook@chromium.org, tony.luck@intel.com,
4sschmid@informatik.uni-hamburg.de
Subject: Re: [PATCH v6 1/5] lib: Update LZ4 compressor module
Date: Wed, 1 Feb 2017 21:18:59 +0100 [thread overview]
Message-ID: <20170201201859.GA15641@bierbaron.springfield.local> (raw)
In-Reply-To: <20170131152744.5bd2f3ba@lwn.net>
On Tue, Jan 31, 2017 at 03:27:44PM -0700, Jonathan Corbet wrote:
> On Fri, 27 Jan 2017 23:02:00 +0100
> Sven Schmidt <4sschmid@informatik.uni-hamburg.de> 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.
>
> Thanks,
>
> jon
Hi Jon,
of course, that makes sense. I already checked the documentation and you're right, I'm not that far from it.
Will do the necessary changes.
Thanks,
Sven
next prev parent reply other threads:[~2017-02-01 20:19 UTC|newest]
Thread overview: 84+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <1482259992-16680-1-git-send-email-4sschmid@informatik.uni-hamburg.de>
[not found] ` <1482259992-16680-2-git-send-email-4sschmid@informatik.uni-hamburg.de>
2016-12-22 13:25 ` [PATCH 1/3] crypto: Change lz4 modules to work with new lz4 compressor module version Sergey Senozhatsky
2017-01-07 16:55 ` [PATCH v2 0/4] Update LZ4 compressor module Sven Schmidt
2017-01-07 16:55 ` [PATCH v2 1/4] lib: Update LZ4 compressor module based on LZ4 v1.7.2 Sven Schmidt
2017-01-08 11:22 ` Greg KH
2017-01-10 9:32 ` Sven Schmidt
2017-01-10 9:59 ` Greg KH
2017-01-08 11:25 ` Greg KH
2017-01-08 11:33 ` Rui Salvaterra
2017-01-10 9:21 ` Sven Schmidt
2017-01-10 10:00 ` Greg KH
2017-01-10 10:50 ` Willy Tarreau
2017-01-07 16:55 ` [PATCH v2 2/4] lib/decompress_unlz4: Change module to work with new LZ4 module version Sven Schmidt
2017-01-08 11:23 ` Greg KH
2017-01-07 16:55 ` [PATCH v2 3/4] crypto: Change LZ4 modules " Sven Schmidt
2017-01-07 16:55 ` [PATCH v2 4/4] fs/pstore: fs/squashfs: Change usage of LZ4 to comply " Sven Schmidt
2017-01-07 21:33 ` Kees Cook
2017-01-10 9:45 ` Sven Schmidt
2017-01-21 15:09 ` [PATCH v3 0/4] Update LZ4 compressor module Sven Schmidt
2017-01-21 15:09 ` [PATCH 1/4] lib: " Sven Schmidt
2017-01-21 15:56 ` kbuild test robot
2017-01-21 16:16 ` kbuild test robot
2017-01-21 17:38 ` kbuild test robot
2017-01-22 11:05 ` Greg KH
2017-01-21 15:09 ` [PATCH 2/4] lib/decompress_unlz4: Change module to work with new LZ4 module version Sven Schmidt
2017-01-21 15:09 ` [PATCH 3/4] crypto: Change LZ4 modules " Sven Schmidt
2017-01-21 15:09 ` [PATCH 4/4] fs/pstore: fs/squashfs: Change usage of LZ4 to work with new LZ4 version Sven Schmidt
2017-01-22 19:35 ` [PATCH v4 0/4] Update LZ4 compressor module Sven Schmidt
2017-01-22 19:35 ` [PATCH v4 1/4] lib: " Sven Schmidt
2017-01-24 0:23 ` Andrew Morton
2017-01-24 16:48 ` Sven Schmidt
2017-01-22 19:35 ` [PATCH v4 2/4] lib/decompress_unlz4: Change module to work with new LZ4 module version Sven Schmidt
2017-01-22 19:35 ` [PATCH v4 3/4] crypto: Change LZ4 modules " Sven Schmidt
2017-01-22 19:35 ` [PATCH v4 4/4] fs/pstore: fs/squashfs: Change usage of LZ4 to work with new LZ4 version Sven Schmidt
2017-01-26 7:57 ` [PATCH v5 0/5] Update LZ4 compressor module Sven Schmidt
2017-01-26 7:57 ` [PATCH v5 1/5] lib: " Sven Schmidt
2017-01-26 7:57 ` [PATCH v5 2/5] lib/decompress_unlz4: Change module to work with new LZ4 module version Sven Schmidt
2017-01-26 7:57 ` [PATCH v5 3/5] crypto: Change LZ4 modules " Sven Schmidt
2017-01-26 7:57 ` [PATCH v5 4/5] fs/pstore: fs/squashfs: Change usage of LZ4 to work with new LZ4 version Sven Schmidt
2017-01-26 7:57 ` [PATCH v5 5/5] lib/lz4: Remove back-compat wrappers Sven Schmidt
2017-01-26 9:19 ` [PATCH v5 0/5] Update LZ4 compressor module Eric Biggers
2017-01-26 14:15 ` Sven Schmidt
2017-01-27 22:01 ` [PATCH v6 " Sven Schmidt
2017-01-27 22:02 ` [PATCH v6 1/5] lib: " Sven Schmidt
2017-01-31 22:27 ` Jonathan Corbet
2017-02-01 20:18 ` Sven Schmidt [this message]
2017-01-27 22:02 ` [PATCH v6 2/5] lib/decompress_unlz4: Change module to work with new LZ4 module version Sven Schmidt
2017-01-27 22:02 ` [PATCH v6 3/5] crypto: Change LZ4 modules " Sven Schmidt
2017-01-27 22:02 ` [PATCH v6 4/5] fs/pstore: fs/squashfs: Change usage of LZ4 to work with new LZ4 version Sven Schmidt
2017-01-27 22:02 ` [PATCH v6 5/5] lib/lz4: Remove back-compat wrappers Sven Schmidt
2017-02-05 19:09 ` [PATCH v7 0/5] Update LZ4 compressor module Sven Schmidt
2017-02-05 19:09 ` [PATCH v7 1/5] lib: " Sven Schmidt
2017-02-05 19:09 ` [PATCH v7 2/5] lib/decompress_unlz4: Change module to work with new LZ4 module version Sven Schmidt
2017-02-05 19:09 ` [PATCH v7 3/5] crypto: Change LZ4 modules " Sven Schmidt
2017-02-05 19:09 ` [PATCH v7 4/5] fs/pstore: fs/squashfs: Change usage of LZ4 to work with new LZ4 version Sven Schmidt
2017-02-05 19:09 ` [PATCH v7 5/5] lib/lz4: Remove back-compat wrappers Sven Schmidt
2017-02-08 23:31 ` [PATCH v7 0/5] Update LZ4 compressor module Minchan Kim
2017-02-09 0:24 ` Eric Biggers
2017-02-09 5:24 ` Eric Biggers
2017-02-09 11:05 ` Sven Schmidt
2017-02-09 18:20 ` Eric Biggers
2017-02-10 0:14 ` Minchan Kim
2017-02-09 11:02 ` Sven Schmidt
2017-02-09 18:29 ` Eric Biggers
2017-02-10 3:57 ` David Miller
2017-02-09 10:56 ` Sven Schmidt
2017-02-10 0:13 ` Minchan Kim
2017-02-12 11:16 ` Sven Schmidt
2017-02-12 11:16 ` [PATCH] lz4: fix performance regressions Sven Schmidt
2017-02-12 13:05 ` Willy Tarreau
2017-02-12 15:20 ` Sven Schmidt
2017-02-12 21:41 ` Willy Tarreau
2017-02-13 11:53 ` Sven Schmidt
2017-02-13 13:37 ` Willy Tarreau
2017-02-12 23:38 ` Eric Biggers
2017-02-14 10:33 ` Sven Schmidt
2017-02-13 0:03 ` [PATCH v7 0/5] Update LZ4 compressor module Minchan Kim
2017-02-13 12:08 ` Sven Schmidt
2017-02-15 7:29 ` Minchan Kim
2017-02-15 18:16 ` [PATCH v8 " Sven Schmidt
2017-02-15 18:16 ` [PATCH v8 1/5] lib: " Sven Schmidt
2017-02-15 18:16 ` [PATCH v8 2/5] lib/decompress_unlz4: Change module to work with new LZ4 module version Sven Schmidt
2017-02-15 18:16 ` [PATCH v8 3/5] crypto: Change LZ4 modules " Sven Schmidt
2017-02-15 18:16 ` [PATCH v8 4/5] fs/pstore: fs/squashfs: Change usage of LZ4 to work with new LZ4 version Sven Schmidt
2017-02-15 18:16 ` [PATCH v8 5/5] lib/lz4: Remove back-compat wrappers Sven Schmidt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170201201859.GA15641@bierbaron.springfield.local \
--to=4sschmid@informatik.uni-hamburg.de \
--cc=akpm@linux-foundation.org \
--cc=anton@enomsg.org \
--cc=bongkyu.kim@lge.com \
--cc=ccross@android.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=gregkh@linuxfoundation.org \
--cc=herbert@gondor.apana.org.au \
--cc=keescook@chromium.org \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rsalvaterra@gmail.com \
--cc=sergey.senozhatsky@gmail.com \
--cc=tony.luck@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).