* [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions
@ 2017-06-26 4:50 sayli karnik
2017-07-17 9:12 ` Jan Kara
0 siblings, 1 reply; 2+ messages in thread
From: sayli karnik @ 2017-06-26 4:50 UTC (permalink / raw)
To: linux-ext4, Theodore Ts'o, Jan Kara, linux-kernel
Add function parameters in kernel-doc comments to fix warnings in the
Sphinx build:
transaction.c:511: warning: No description found for parameter 'type'
transaction.c:511: warning: No description found for parameter 'line_no'
Signed-off-by: sayli karnik <karniksayli1995@gmail.com>
---
fs/jbd2/transaction.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/fs/jbd2/transaction.c b/fs/jbd2/transaction.c
index 8b08044..bca5f9f 100644
--- a/fs/jbd2/transaction.c
+++ b/fs/jbd2/transaction.c
@@ -497,6 +497,8 @@ EXPORT_SYMBOL(jbd2_journal_free_reserved);
/**
* int jbd2_journal_start_reserved(handle_t *handle) - start reserved handle
* @handle: handle to start
+ * @type: type of handle
+ * @line_no: line number of handle
*
* Start handle that has been previously reserved with jbd2_journal_reserve().
* This attaches @handle to the running transaction (or creates one if there's
--
2.7.4
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions
2017-06-26 4:50 [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions sayli karnik
@ 2017-07-17 9:12 ` Jan Kara
0 siblings, 0 replies; 2+ messages in thread
From: Jan Kara @ 2017-07-17 9:12 UTC (permalink / raw)
To: sayli karnik; +Cc: linux-ext4, Theodore Ts'o, Jan Kara, linux-kernel
On Mon 26-06-17 10:20:22, sayli karnik wrote:
> Add function parameters in kernel-doc comments to fix warnings in the
> Sphinx build:
> transaction.c:511: warning: No description found for parameter 'type'
> transaction.c:511: warning: No description found for parameter 'line_no'
>
> Signed-off-by: sayli karnik <karniksayli1995@gmail.com>
I'd suggest to have more useful description like below:
> + * @type: type of handle
the reason why transaction handle was started - one of EXT4_TH_ defines
> + * @line_no: line number of handle
the line from which the function was called (used for debug output)
Honza
--
Jan Kara <jack@suse.com>
SUSE Labs, CR
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-07-17 9:12 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-06-26 4:50 [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions sayli karnik
2017-07-17 9:12 ` Jan Kara
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).