From: Andi Kleen <andi@firstfloor.org>
To: randy.dunlap@oracle.com, linux-kernel@vger.kernel.org, rob@landley.com
Subject: Kerneldoc comments in files not mentioned by *.tmpl
Date: Fri, 28 Dec 2007 14:40:36 +0100 [thread overview]
Message-ID: <20071228134036.GA482@basil.nowhere.org> (raw)
I added kerneldoc comments to some files and was a little surprised that
they didn't appear in make mandocs output. It turns out only functions in files
mentioned in Documentation/DocBook/*.tmpl are extracted. Since that's a
pretty unknown requirement (at least I didn't know it) I suppose a lot
of the kerneldoc annotations actually are never generated because of this.
Should that be changed and let the scripts hunt for kerneldoc in all
source files?
A potential problem is that already the kerneldocs contain a lot
of fairly useless driver internal funcions (e.g. nobody does care
a lot about internal MPT interfaces). But that problem is already
there and it's better to have too many than not enough in mandocs.
-Andi
reply other threads:[~2007-12-28 13:57 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20071228134036.GA482@basil.nowhere.org \
--to=andi@firstfloor.org \
--cc=linux-kernel@vger.kernel.org \
--cc=randy.dunlap@oracle.com \
--cc=rob@landley.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.