kevin/linux
1
Fork 0
Code

xz: fix kernel-doc formatting errors in xz.h

Browse Source 
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>
This commit is contained in:
Lasse Collin 2024-07-21 16:36:20 +03:00 committed by Andrew Morton
parent ff221153aa
commit ad8c67b870
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/linux/xz.h
View File

@ -142,7 +142,7 @@ struct xz_buf {
size_t out_size; size_t out_size;
}; };
/** /*
* struct xz_dec - Opaque type to hold the XZ decoder state * struct xz_dec - Opaque type to hold the XZ decoder state
*/ */
struct xz_dec; struct xz_dec;
@ -240,15 +240,16 @@ XZ_EXTERN void xz_dec_end(struct xz_dec *s);
* marked with XZ_EXTERN. This avoids warnings about static functions that * marked with XZ_EXTERN. This avoids warnings about static functions that
* are never defined. * are never defined.
*/ */
/**
/*
* struct xz_dec_microlzma - Opaque type to hold the MicroLZMA decoder state * struct xz_dec_microlzma - Opaque type to hold the MicroLZMA decoder state
*/ */
struct xz_dec_microlzma; struct xz_dec_microlzma;
/** /**
* xz_dec_microlzma_alloc() - Allocate memory for the MicroLZMA decoder * xz_dec_microlzma_alloc() - Allocate memory for the MicroLZMA decoder
* @mode XZ_SINGLE or XZ_PREALLOC * @mode: XZ_SINGLE or XZ_PREALLOC
* @dict_size LZMA dictionary size. This must be at least 4 KiB and * @dict_size: LZMA dictionary size. This must be at least 4 KiB and
* at most 3 GiB. * at most 3 GiB.
* *
* In contrast to xz_dec_init(), this function only allocates the memory * In contrast to xz_dec_init(), this function only allocates the memory
@ -276,15 +277,15 @@ extern struct xz_dec_microlzma *xz_dec_microlzma_alloc(enum xz_mode mode,
/** /**
* xz_dec_microlzma_reset() - Reset the MicroLZMA decoder state * xz_dec_microlzma_reset() - Reset the MicroLZMA decoder state
* @s Decoder state allocated using xz_dec_microlzma_alloc() * @s: Decoder state allocated using xz_dec_microlzma_alloc()
* @comp_size Compressed size of the input stream * @comp_size: Compressed size of the input stream
* @uncomp_size Uncompressed size of the input stream. A value smaller * @uncomp_size: Uncompressed size of the input stream. A value smaller
* than the real uncompressed size of the input stream can * than the real uncompressed size of the input stream can
* be specified if uncomp_size_is_exact is set to false. * be specified if uncomp_size_is_exact is set to false.
* uncomp_size can never be set to a value larger than the * uncomp_size can never be set to a value larger than the
* expected real uncompressed size because it would eventually * expected real uncompressed size because it would eventually
* result in XZ_DATA_ERROR. * result in XZ_DATA_ERROR.
* @uncomp_size_is_exact This is an int instead of bool to avoid * @uncomp_size_is_exact: This is an int instead of bool to avoid
* requiring stdbool.h. This should normally be set to true. * requiring stdbool.h. This should normally be set to true.
* When this is set to false, error detection is weaker. * When this is set to false, error detection is weaker.
*/ */
@ -294,7 +295,7 @@ extern void xz_dec_microlzma_reset(struct xz_dec_microlzma *s,
/** /**
* xz_dec_microlzma_run() - Run the MicroLZMA decoder * xz_dec_microlzma_run() - Run the MicroLZMA decoder
* @s Decoder state initialized using xz_dec_microlzma_reset() * @s: Decoder state initialized using xz_dec_microlzma_reset()
* @b: Input and output buffers * @b: Input and output buffers
* *
* This works similarly to xz_dec_run() with a few important differences. * This works similarly to xz_dec_run() with a few important differences.