From: Andrew Morton <akpm@linux-foundation.org>
To: David Brownell <david-b@pacbell.net>
Cc: Dmitry Baryshkov <dbaryshkov@gmail.com>,
linux-kernel@vger.kernel.org,
Haavard Skinnemoen <haavard.skinnemoen@atmel.com>,
Russell King <rmk+lkml@arm.linux.org.uk>,
Paul Mundt <lethal@linux-sh.org>,
pHilipp Zabel <philipp.zabel@gmail.com>,
Pavel Machek <pavel@ucw.cz>,
tony@atomide.com, paul@pwsan.com,
Mark Brown <broonie@opensource.wolfsonmicro.com>,
ian <spyro@f2s.com>
Subject: Re: [PATCH 1/3] genclk: add generic framework for managing clocks.
Date: Sun, 13 Jul 2008 14:23:17 -0700 [thread overview]
Message-ID: <20080713142317.97111c81.akpm@linux-foundation.org> (raw)
In-Reply-To: <200807131412.32961.david-b@pacbell.net>
On Sun, 13 Jul 2008 14:12:32 -0700 David Brownell <david-b@pacbell.net> wrote:
> On Saturday 12 July 2008, Andrew Morton wrote:
> > > +EXPORT_SYMBOL(clk_get_parent);
> >
> > As this is a new kernel-wide utility library, it is appropriate that
> > all of its public interfaces (at least) be documented. __An appropriate
> > way of doing that is via kerneldoc annotation. __Please don't forget to
> > document return values and call environment prerequisites (eg: requires
> > foo_lock, may be called from interrupt context, etc, etc).
>
> That is, the stuff that's not already documented in <linux/clk.h>;
> that's where clk_get_parent() is documented, for example.
argh. That's why I missed it - please don't document stuff in header
files. The usual approach is to document interfaces at the
implementation site.
Except for structs where of course there is no choice. But then,
the .h file _is_ the definition site.
next prev parent reply other threads:[~2008-07-13 21:23 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-07-08 13:42 [PATCH 0/3] Genclk: generic framework for clocks managing [v3.1] Dmitry Baryshkov
2008-07-08 13:43 ` [PATCH 1/3] genclk: add generic framework for managing clocks Dmitry Baryshkov
2008-07-13 6:48 ` Andrew Morton
2008-07-13 20:53 ` Dmitry
2008-07-13 21:03 ` Andrew Morton
2008-07-13 21:12 ` David Brownell
2008-07-13 21:23 ` Andrew Morton [this message]
2008-07-13 21:54 ` David Brownell
2008-07-14 22:30 ` Russell King
2008-07-14 21:00 ` Dmitry Baryshkov
2008-07-08 13:43 ` [PATCH 2/3] Refactor arm/pxa to use generic clocks support Dmitry Baryshkov
2008-07-08 13:44 ` [PATCH 3/3] Clocklib: refactor SA-1100 to use clocklib Dmitry Baryshkov
2008-07-08 14:07 ` [PATCH 0/3] Genclk: generic framework for clocks managing [v3.1] Ben Dooks
2008-07-08 14:28 ` Dmitry Baryshkov
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=20080713142317.97111c81.akpm@linux-foundation.org \
--to=akpm@linux-foundation.org \
--cc=broonie@opensource.wolfsonmicro.com \
--cc=david-b@pacbell.net \
--cc=dbaryshkov@gmail.com \
--cc=haavard.skinnemoen@atmel.com \
--cc=lethal@linux-sh.org \
--cc=linux-kernel@vger.kernel.org \
--cc=paul@pwsan.com \
--cc=pavel@ucw.cz \
--cc=philipp.zabel@gmail.com \
--cc=rmk+lkml@arm.linux.org.uk \
--cc=spyro@f2s.com \
--cc=tony@atomide.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