| Message ID | 20170626045022.GA32222@sayli-HP-15-Notebook-PC |
|---|---|
| State | Superseded, archived |
| Headers | show |
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
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
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(+)