tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

xz: improve the MicroLZMA kernel-doc in xz.h

Move the description of the format into a "DOC:" comment. Emphasize that
MicroLZMA functions aren't usually needed.

Link: https://lkml.kernel.org/r/20240721133633.47721-7-lasse.collin@tukaani.org
Signed-off-by: Lasse Collin <lasse.collin@tukaani.org>
Reviewed-by: Sam James <sam@gentoo.org>
Cc: Albert Ou <aou@eecs.berkeley.edu>
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Emil Renner Berthing <emil.renner.berthing@canonical.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Joel Stanley <joel@jms.id.au>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Jubin Zhong <zhongjubin@huawei.com>
Cc: Jules Maselbas <jmaselbas@zdiv.net>
Cc: Krzysztof Kozlowski <krzk@kernel.org>
Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: Palmer Dabbelt <palmer@dabbelt.com>
Cc: Paul Walmsley <paul.walmsley@sifive.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Rui Li <me@lirui.org>
Cc: Simon Glass <sjg@chromium.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Will Deacon <will@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Lasse Collin and committed by
Andrew Morton 0f2c5996 ad8c67b8

+12 -12
+12 -12
include/linux/xz.h
··· 232 232 */ 233 233 XZ_EXTERN void xz_dec_end(struct xz_dec *s); 234 234 235 - /* 236 - * Decompressor for MicroLZMA, an LZMA variant with a very minimal header. 237 - * See xz_dec_microlzma_alloc() below for details. 235 + /** 236 + * DOC: MicroLZMA decompressor 237 + * 238 + * This MicroLZMA header format was created for use in EROFS but may be used 239 + * by others too. **In most cases one needs the XZ APIs above instead.** 240 + * 241 + * The compressed format supported by this decoder is a raw LZMA stream 242 + * whose first byte (always 0x00) has been replaced with bitwise-negation 243 + * of the LZMA properties (lc/lp/pb) byte. For example, if lc/lp/pb is 244 + * 3/0/2, the first byte is 0xA2. This way the first byte can never be 0x00. 245 + * Just like with LZMA2, lc + lp <= 4 must be true. The LZMA end-of-stream 246 + * marker must not be used. The unused values are reserved for future use. 238 247 * 239 248 * These functions aren't used or available in preboot code and thus aren't 240 249 * marked with XZ_EXTERN. This avoids warnings about static functions that ··· 271 262 * On success, xz_dec_microlzma_alloc() returns a pointer to 272 263 * struct xz_dec_microlzma. If memory allocation fails or 273 264 * dict_size is invalid, NULL is returned. 274 - * 275 - * The compressed format supported by this decoder is a raw LZMA stream 276 - * whose first byte (always 0x00) has been replaced with bitwise-negation 277 - * of the LZMA properties (lc/lp/pb) byte. For example, if lc/lp/pb is 278 - * 3/0/2, the first byte is 0xA2. This way the first byte can never be 0x00. 279 - * Just like with LZMA2, lc + lp <= 4 must be true. The LZMA end-of-stream 280 - * marker must not be used. The unused values are reserved for future use. 281 - * This MicroLZMA header format was created for use in EROFS but may be used 282 - * by others too. 283 265 */ 284 266 extern struct xz_dec_microlzma *xz_dec_microlzma_alloc(enum xz_mode mode, 285 267 uint32_t dict_size);