linux-kernel - Re: [PATCH trivial] UAPI: Kbuild: add/modify comments for "uapi/Kbuild" and "uapi/linux/Kbuild"

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <1375860749.8422.25@driftwood>
Date:	Wed, 07 Aug 2013 02:32:29 -0500
From:	Rob Landley <rob@...dley.net>
To:	Joe Perches <joe@...ches.com>
Cc:	Chen Gang <gang.chen@...anux.com>,
	'Jiri Kosina' <trivial@...nel.org>,
	Paul McKenney <paulmck@...ux.vnet.ibm.com>,
	"dhowells@...hat.com" <dhowells@...hat.com>,
	Thomas Gleixner <tglx@...utronix.de>, davej@...hat.com,
	Arnd Bergmann <arnd@...db.de>,
	David Miller <davem@...emloft.net>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	Michael Kerrisk <mtk.manpages@...il.com>
Subject: Re: [PATCH trivial] UAPI: Kbuild: add/modify comments for
 "uapi/Kbuild" and "uapi/linux/Kbuild"

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--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/