From: Jan Kara <jack@suse.cz>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org,
Stephen Rothwell <sfr@canb.auug.org.au>, Jan Kara <jack@suse.cz>,
Theodore Ts'o <tytso@mit.edu>,
linux-ext4@vger.kernel.org
Subject: Re: [PATCH] jbd2: fix kernel-doc for j_transaction_overhead_buffers
Date: Tue, 23 Jul 2024 11:22:01 +0200 [thread overview]
Message-ID: <20240723092201.cr6kxdjrdvmlbfga@quack3> (raw)
In-Reply-To: <20240723051647.3053491-1-rdunlap@infradead.org>
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@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20240710182252.4c281445@canb.auug.org.au/
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Yeah, thanks and sorry for breaking the doc here. Feel free to add:
Reviewed-by: Jan Kara <jack@suse.cz>
Honza
> ---
> Cc: Jan Kara <jack@suse.cz>
> Cc: Theodore Ts'o <tytso@mit.edu>
> Cc: linux-ext4@vger.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@suse.com>
SUSE Labs, CR
next prev parent reply other threads:[~2024-07-23 9:22 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-23 5:16 [PATCH] jbd2: fix kernel-doc for j_transaction_overhead_buffers Randy Dunlap
2024-07-23 9:22 ` Jan Kara [this message]
2024-08-27 12:47 ` Theodore Ts'o
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240723092201.cr6kxdjrdvmlbfga@quack3 \
--to=jack@suse.cz \
--cc=linux-ext4@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=sfr@canb.auug.org.au \
--cc=tytso@mit.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox