From: Steffen Klassert <steffen.klassert@secunet.com>
To: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Herbert Xu <herbert@gondor.hengli.com.au>,
Andrew Morton <akpm@linux-foundation.org>,
linux-kernel@vger.kernel.org, linux-crypto@vger.kernel.org
Subject: Re: [PATCH 3/4] padata: Add some code comments
Date: Mon, 17 May 2010 09:02:46 +0200 [thread overview]
Message-ID: <20100517070246.GG2184@secunet.com> (raw)
In-Reply-To: <20100514091857.cd576ed2.randy.dunlap@oracle.com>
Hi Randy,
On Fri, May 14, 2010 at 09:18:57AM -0700, Randy Dunlap wrote:
>
> Hi Steffen,
>
> These comments are roughly 90% of the way to being kernel-doc notation,
> so how about going the rest of the way, please?
>
yes of course we can. I read Documentation/kernel-doc-nano-HOWTO.txt,
so I need to use /** for all comments that I want to add to kernel-doc.
Anything else to do?
>
> Use:
> /**
> in multiple places.
>
I wondered several times why some comments start with /** while
others start with /*. Anyway, I did not pay too much attention
to this, because it was just the beginning line of a comment.
Now I know the difference :)
> /**
>
> > + * padata_get_next - Get the next object that needs serialization.
>
This one is a static function, I would not mind to add it to kernel-doc
too, but that's probaply not needed.
I'll resend this one with the suggested changes,
thanks for pointing this out.
Steffen
next prev parent reply other threads:[~2010-05-17 7:04 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-05-14 11:43 [PATCH 1/4] padata: Use a timer to handle remaining objects in the reorder queues Steffen Klassert
2010-05-14 11:44 ` [PATCH 2/4] padata: Flush the padata queues actively Steffen Klassert
2010-05-14 11:46 ` [PATCH 3/4] padata: Add some code comments Steffen Klassert
2010-05-14 16:18 ` Randy Dunlap
2010-05-17 7:02 ` Steffen Klassert [this message]
2010-05-18 5:49 ` [PATCH 3/4 v2] " Steffen Klassert
2010-05-19 3:45 ` Herbert Xu
2010-05-14 11:46 ` [PATCH 4/4] padata: Use get_online_cpus/put_online_cpus in padata_free Steffen Klassert
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=20100517070246.GG2184@secunet.com \
--to=steffen.klassert@secunet.com \
--cc=akpm@linux-foundation.org \
--cc=herbert@gondor.hengli.com.au \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=randy.dunlap@oracle.com \
/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;
as well as URLs for NNTP newsgroup(s).