2024-04-08 08:39:48

by Yang Li

Subject: [PATCH -next 1/3 v2] powerpc: boot: Fix kernel-doc param for partial_decompress

Fix the kernel-doc annotation for the 'skip' parameter in the
partial_decompress() function by adding a missing underscore and colon.

Signed-off-by: Yang Li <[email protected]>
---
arch/powerpc/boot/decompress.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/powerpc/boot/decompress.c b/arch/powerpc/boot/decompress.c
index 977eb15a6d17..6835cb53f034 100644
--- a/arch/powerpc/boot/decompress.c
+++ b/arch/powerpc/boot/decompress.c
@@ -101,7 +101,7 @@ static void print_err(char *s)
* @input_size: length of the input buffer
* @outbuf: output buffer
* @output_size: length of the output buffer
- * @skip number of output bytes to ignore
+ * @_skip: number of output bytes to ignore
*
* This function takes compressed data from inbuf, decompresses and write it to
* outbuf. Once output_size bytes are written to the output buffer, or the
--
2.20.1.7.g153144c

2024-04-08 15:20:44

by Randy Dunlap

Subject: Re: [PATCH -next 1/3 v2] powerpc: boot: Fix kernel-doc param for partial_decompress

On 4/8/24 1:39 AM, Yang Li wrote:
> Fix the kernel-doc annotation for the 'skip' parameter in the
> partial_decompress() function by adding a missing underscore and colon.
>
> Signed-off-by: Yang Li <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> arch/powerpc/boot/decompress.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/powerpc/boot/decompress.c b/arch/powerpc/boot/decompress.c
> index 977eb15a6d17..6835cb53f034 100644
> --- a/arch/powerpc/boot/decompress.c
> +++ b/arch/powerpc/boot/decompress.c
> @@ -101,7 +101,7 @@ static void print_err(char *s)
> * @input_size: length of the input buffer
> * @outbuf: output buffer
> * @output_size: length of the output buffer
> - * @skip number of output bytes to ignore
> + * @_skip: number of output bytes to ignore
> *
> * This function takes compressed data from inbuf, decompresses and write it to
> * outbuf. Once output_size bytes are written to the output buffer, or the

--
#Randy