From: Dave Chinner <david@fromorbit.com>
To: Kevin Diggs <kevdig@hypersurf.com>
Cc: linux-kernel@vger.kernel.org, stefanr@s5r6.in-berlin.de, arnd@arndb.de
Subject: Re: {NOT a PATCH} Corrections please ...
Date: Wed, 20 Aug 2008 11:52:44 +1000 [thread overview]
Message-ID: <20080820015244.GA6061@disturbed> (raw)
In-Reply-To: <48AB73A3.9010404@hypersurf.com>
On Tue, Aug 19, 2008 at 06:30:11PM -0700, Kevin Diggs wrote:
> Hi,
>
> It was recommended that I use a completion in a driver I am working on.
> While figuring out how to use one, I noticed that there was no kernel
> doc block comments. I am trying to add them. I would rather not have to
> respin the patch for corrections.
Rather than documenting exactly how the queuing and wakeup occurs on
all functions, you should document it once. i.e. that completions
currently use FIFO queuing. It is probably best to do this at the
definition of the struct completion.
The reason is that if the implementation changes (e.g. to support
priorities and inheritence) the comments are then incorrect and
then there's lots of comments to remove^Wchange.
Cheers,
Dave.
--
Dave Chinner
david@fromorbit.com
next prev parent reply other threads:[~2008-08-20 1:52 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-08-20 1:30 {NOT a PATCH} Corrections please Kevin Diggs
2008-08-20 1:52 ` Dave Chinner [this message]
2008-08-20 9:59 ` Ingo Molnar
2008-08-20 10:57 ` Stefan Richter
2008-08-20 19:59 ` Kevin Diggs
2008-08-21 10:30 ` Ingo Molnar
2008-08-21 19:47 ` Kevin Diggs
2008-08-22 7:02 ` Ingo Molnar
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=20080820015244.GA6061@disturbed \
--to=david@fromorbit.com \
--cc=arnd@arndb.de \
--cc=kevdig@hypersurf.com \
--cc=linux-kernel@vger.kernel.org \
--cc=stefanr@s5r6.in-berlin.de \
/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