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: fix kernel-doc formatting errors in xz.h

The opaque structs xz_dec and xz_dec_microlzma are declared in xz.h but
their definitions are in xz_dec_lzma2.c without kernel-doc comments. Use
regular comments for these structs in xz.h to avoid errors when building
the docs.

Add a few missing colons.

Link: https://lkml.kernel.org/r/20240721133633.47721-6-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 ad8c67b8 ff221153

+10 -9
+10 -9
include/linux/xz.h
··· 142 142 size_t out_size; 143 143 }; 144 144 145 - /** 145 + /* 146 146 * struct xz_dec - Opaque type to hold the XZ decoder state 147 147 */ 148 148 struct xz_dec; ··· 240 240 * marked with XZ_EXTERN. This avoids warnings about static functions that 241 241 * are never defined. 242 242 */ 243 - /** 243 + 244 + /* 244 245 * struct xz_dec_microlzma - Opaque type to hold the MicroLZMA decoder state 245 246 */ 246 247 struct xz_dec_microlzma; 247 248 248 249 /** 249 250 * xz_dec_microlzma_alloc() - Allocate memory for the MicroLZMA decoder 250 - * @mode XZ_SINGLE or XZ_PREALLOC 251 - * @dict_size LZMA dictionary size. This must be at least 4 KiB and 251 + * @mode: XZ_SINGLE or XZ_PREALLOC 252 + * @dict_size: LZMA dictionary size. This must be at least 4 KiB and 252 253 * at most 3 GiB. 253 254 * 254 255 * In contrast to xz_dec_init(), this function only allocates the memory ··· 277 276 278 277 /** 279 278 * xz_dec_microlzma_reset() - Reset the MicroLZMA decoder state 280 - * @s Decoder state allocated using xz_dec_microlzma_alloc() 281 - * @comp_size Compressed size of the input stream 282 - * @uncomp_size Uncompressed size of the input stream. A value smaller 279 + * @s: Decoder state allocated using xz_dec_microlzma_alloc() 280 + * @comp_size: Compressed size of the input stream 281 + * @uncomp_size: Uncompressed size of the input stream. A value smaller 283 282 * than the real uncompressed size of the input stream can 284 283 * be specified if uncomp_size_is_exact is set to false. 285 284 * uncomp_size can never be set to a value larger than the 286 285 * expected real uncompressed size because it would eventually 287 286 * result in XZ_DATA_ERROR. 288 - * @uncomp_size_is_exact This is an int instead of bool to avoid 287 + * @uncomp_size_is_exact: This is an int instead of bool to avoid 289 288 * requiring stdbool.h. This should normally be set to true. 290 289 * When this is set to false, error detection is weaker. 291 290 */ ··· 295 294 296 295 /** 297 296 * xz_dec_microlzma_run() - Run the MicroLZMA decoder 298 - * @s Decoder state initialized using xz_dec_microlzma_reset() 297 + * @s: Decoder state initialized using xz_dec_microlzma_reset() 299 298 * @b: Input and output buffers 300 299 * 301 300 * This works similarly to xz_dec_run() with a few important differences.