| Message ID | 20240723051647.3053491-1-rdunlap@infradead.org |
|---|---|
| State | Awaiting Upstream |
| Headers | show |
| Series | jbd2: fix kernel-doc for j_transaction_overhead_buffers | expand |
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 > */ >
On Mon, 22 Jul 2024 22:16:47 -0700, 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' > > > [...] Applied, thanks! [1/1] jbd2: fix kernel-doc for j_transaction_overhead_buffers commit: 7e8fb2eda9885ea2d13179a4c0bbf810f900ef25 Best regards,
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 */
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> --- 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(-)