From: Jan Kara <jack@suse.cz>
To: sayli karnik <karniksayli1995@gmail.com>
Cc: linux-ext4@vger.kernel.org, "Theodore Ts'o" <tytso@mit.edu>,
Jan Kara <jack@suse.com>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions
Date: Mon, 17 Jul 2017 11:12:33 +0200 [thread overview]
Message-ID: <20170717091233.GA18199@quack2.suse.cz> (raw)
In-Reply-To: <20170626045022.GA32222@sayli-HP-15-Notebook-PC>
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
prev parent reply other threads:[~2017-07-17 9:20 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-26 4:50 sayli karnik
2017-07-17 9:12 ` Jan Kara [this message]
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=20170717091233.GA18199@quack2.suse.cz \
--to=jack@suse.cz \
--cc=jack@suse.com \
--cc=karniksayli1995@gmail.com \
--cc=linux-ext4@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--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
all inboxes | Powered by JetHome®