linux-kernel - Re: [PATCH] jbd2: fix kernel-doc for j_transaction_overhead

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240723092201.cr6kxdjrdvmlbfga@quack3>
Date: Tue, 23 Jul 2024 11:22:01 +0200
From: Jan Kara <jack@...e.cz>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Stephen Rothwell <sfr@...b.auug.org.au>,
	Jan Kara <jack@...e.cz>, Theodore Ts'o <tytso@....edu>,
	linux-ext4@...r.kernel.org
Subject: Re: [PATCH] jbd2: fix kernel-doc for j_transaction_overhead_buffers

On Mon 22-07-24 22:16:47, Randy Dunlap wrote:
> Use the correct struct member name in the kernel-doc notation
> to prevent a kernel-doc build warning.
> 
> include/linux/jbd2.h:1303: warning: Function parameter or struct member 'j_transaction_overhead_buffers' not described in 'journal_s'
> include/linux/jbd2.h:1303: warning: Excess struct member 'j_transaction_overhead' description in 'journal_s'
> 
> Fixes: e3a00a23781c ("jbd2: precompute number of transaction descriptor blocks")
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20240710182252.4c281445@canb.auug.org.au/
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>

Yeah, thanks and sorry for breaking the doc here. Feel free to add:

Reviewed-by: Jan Kara <jack@...e.cz>

								Honza

> ---
> Cc: Jan Kara <jack@...e.cz>
> Cc: Theodore Ts'o <tytso@....edu>
> Cc: linux-ext4@...r.kernel.org
> 
>  include/linux/jbd2.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff -- a/include/linux/jbd2.h b/include/linux/jbd2.h
> --- a/include/linux/jbd2.h
> +++ b/include/linux/jbd2.h
> @@ -1086,7 +1086,7 @@ struct journal_s
>  	int			j_revoke_records_per_block;
>  
>  	/**
> -	 * @j_transaction_overhead:
> +	 * @j_transaction_overhead_buffers:
>  	 *
>  	 * Number of blocks each transaction needs for its own bookkeeping
>  	 */
> 
-- 
Jan Kara <jack@...e.com>
SUSE Labs, CR