From: Rob Landley <rob@landley.net>
To: Joe Perches <joe@perches.com>
Cc: Chen Gang <gang.chen@asianux.com>,
"'Jiri Kosina'" <trivial@kernel.org>,
Paul McKenney <paulmck@linux.vnet.ibm.com>,
"dhowells@redhat.com" <dhowells@redhat.com>,
Thomas Gleixner <tglx@linutronix.de>,
davej@redhat.com, Arnd Bergmann <arnd@arndb.de>,
David Miller <davem@davemloft.net>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
Michael Kerrisk <mtk.manpages@gmail.com>
Subject: Re: [PATCH trivial] UAPI: Kbuild: add/modify comments for "uapi/Kbuild" and "uapi/linux/Kbuild"
Date: Wed, 07 Aug 2013 02:32:29 -0500 [thread overview]
Message-ID: <1375860749.8422.25@driftwood> (raw)
In-Reply-To: <1375810303.2424.28.camel@joe-AO722> (from joe@perches.com on Tue Aug 6 12:31:43 2013)
On 08/06/2013 12:31:43 PM, Joe Perches wrote:
> On Tue, 2013-08-06 at 09:46 +0800, Chen Gang wrote:
> > "include/uapi/" is the whole Linux kernel API, it is important
> enough
> > to get more global explanations by comments.
>
> It'd probably be useful to have more descriptions
> of uapi in the Documentation directory too.
I'd rather have comments in the headers that get exported to userspace
and then have other forms of documentation generated from that by some
process similar to "make htmldocs". Otherwise you've got two places to
keep in sync.
(Really the guy you've got to keep in the loop about this is Michael
Kerrisk. The section 2 man pages are the current best reference on UAPI
stuff...)
Rob
next prev parent reply other threads:[~2013-08-07 7:32 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-08-06 1:46 [PATCH trivial] UAPI: Kbuild: add/modify comments for "uapi/Kbuild" and "uapi/linux/Kbuild" Chen Gang
2013-08-06 17:31 ` Joe Perches
2013-08-07 2:42 ` Chen Gang
2013-08-07 7:32 ` Rob Landley [this message]
2013-08-07 8:48 ` Chen Gang
2013-08-08 2:13 ` Chen Gang
2013-08-21 6:34 ` Chen Gang
2013-08-23 10:30 ` Chen Gang
2013-09-03 5:57 ` Chen Gang
2013-09-05 0:46 ` [PATCH trivial v2] " Chen Gang
2013-09-05 1:05 ` Chen Gang
2013-09-05 1:09 ` [PATCH trivial v3] include/uapi/Kbuild: modify the comments for it Chen Gang
2013-10-01 2:19 ` Chen Gang
2013-10-01 3:21 ` [PATCH trivial v4] include/uapi/Kbuild: modify comment to provide summary descriptions for Linux UAPI Chen Gang
2013-09-03 16:41 ` [PATCH trivial] UAPI: Kbuild: add/modify comments for "uapi/Kbuild" and "uapi/linux/Kbuild" Geert Uytterhoeven
2013-09-04 1:08 ` Chen Gang
2013-09-04 7:02 ` Geert Uytterhoeven
2013-09-04 8:09 ` Chen Gang
2013-09-04 9:02 ` Geert Uytterhoeven
2013-09-04 9:13 ` Chen Gang
2013-09-04 9:27 ` Geert Uytterhoeven
2013-09-04 9:38 ` Chen Gang
2013-09-04 11:19 ` Chen Gang
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=1375860749.8422.25@driftwood \
--to=rob@landley.net \
--cc=arnd@arndb.de \
--cc=davej@redhat.com \
--cc=davem@davemloft.net \
--cc=dhowells@redhat.com \
--cc=gang.chen@asianux.com \
--cc=joe@perches.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
--cc=paulmck@linux.vnet.ibm.com \
--cc=tglx@linutronix.de \
--cc=trivial@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