From: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
To: Jens Axboe <axboe@kernel.dk>
Cc: linux-kernel@vger.kernel.org, linux-block@vger.kernel.org,
Chaitanya.Kulkarni@wdc.com, marcos.souza.org@gmail.com
Subject: Re: [PATCH v2 1/3] blk-mq.c: Add documention of function blk_mq_init_queue
Date: Fri, 3 May 2019 13:06:53 -0300 [thread overview]
Message-ID: <20190503160650.GA1174610@laptop> (raw)
In-Reply-To: <698e2ef1-e45a-e66b-f604-5c6bf76c40b5@kernel.dk>
On Thu, May 02, 2019 at 02:37:56PM -0600, Jens Axboe wrote:
> On 5/1/19 8:04 PM, Marcos Paulo de Souza wrote:
> > gentle ping v2.
>
> It's not that I hate the series, I just don't see it adding any real
> value. It should already be quite clear what the functions do, by name,
> and the comments don't really add to that.
My first goal was to make someone to first read the function comment without
going into the details of the code, and at the same time, by adding these
documentations, having these functions being listed at
https://www.kernel.org/doc/html/latest/.
So, in IMHO, they add a fast way, for someone who is trying to understand how
things work, to understand exactly what the function does in some seconds, than
reading the functions code.
In you're now happy with these comments, can you point how can I improve them?
Thanks in advance,
Marcos
>
> --
> Jens Axboe
>
--
Thanks,
Marcos
prev parent reply other threads:[~2019-05-03 16:07 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-16 3:27 [PATCH v2 1/3] blk-mq.c: Add documention of function blk_mq_init_queue Marcos Paulo de Souza
2019-04-16 3:28 ` [PATCH v2 2/3] blk-mq.c: Rework documention of blk_mq_init_sq_queue function Marcos Paulo de Souza
2019-04-16 3:33 ` Chaitanya Kulkarni
2019-04-16 14:59 ` Bart Van Assche
2019-04-16 3:28 ` [PATCH v2 3/3] Documentation: kernel-api.rst: Add block/blk-mq.c Marcos Paulo de Souza
2019-04-16 3:34 ` Chaitanya Kulkarni
2019-04-16 15:00 ` [PATCH v2 1/3] blk-mq.c: Add documention of function blk_mq_init_queue Bart Van Assche
2019-05-02 2:04 ` Marcos Paulo de Souza
2019-05-02 20:37 ` Jens Axboe
2019-05-03 16:06 ` Marcos Paulo de Souza [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=20190503160650.GA1174610@laptop \
--to=marcos.souza.org@gmail.com \
--cc=Chaitanya.Kulkarni@wdc.com \
--cc=axboe@kernel.dk \
--cc=linux-block@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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