All of lore.kernel.org
 help / color / mirror / Atom feed
From: Chen Gang <gang.chen@asianux.com>
To: Rob Landley <rob@landley.net>, Joe Perches <joe@perches.com>,
	"'Jiri Kosina'" <trivial@kernel.org>,
	Michael Kerrisk <mtk.manpages@gmail.com>,
	Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Andrew Morton <akpm@linux-foundation.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>,
	Li Zefan <lizefan@huawei.com>,
	Greg KH <gregkh@linuxfoundation.org>,
	Linus Torvalds <torvalds@linux-foundation.org>
Subject: [PATCH trivial v4] include/uapi/Kbuild: modify comment to provide summary descriptions for Linux UAPI
Date: Tue, 01 Oct 2013 11:21:05 +0800	[thread overview]
Message-ID: <524A3FA1.4010805@asianux.com> (raw)
In-Reply-To: <5227D9BE.6060009@asianux.com>

UAPI is whole Linux kernel API, it is important enough to get summary
descriptions by comments.

In "include/uapi/Kbuild", "Makefile..." and "non-arch..." comments are
historical, at present, they need be improved.

Also add more explanations for "include/uapi/" in "include/uapi/Kbuild".


Signed-off-by: Chen Gang <gang.chen@asianux.com>
---
 include/uapi/Kbuild |   13 +++++++++++--
 1 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/include/uapi/Kbuild b/include/uapi/Kbuild
index 81d2106..f396115 100644
--- a/include/uapi/Kbuild
+++ b/include/uapi/Kbuild
@@ -1,6 +1,15 @@
 # UAPI Header export list
-# Top-level Makefile calls into asm-$(ARCH)
-# List only non-arch directories below
+#
+# UAPI ("Userspace API") is in "include/uapi/" and "arch/*/include/uapi/",
+# which will be installed to "/usr/include".
+#
+# Linux generic (architecture independent) UAPI is at "include/uapi/".
+# Except "linux/", other current level sub-directories are for compatibility.
+# It will not accept new additional current level sub-directories or files.
+#
+# "Architecture Specific Mechanism" UAPI is at "arch/*/include/uapi/".
+# Each architecture must have "arch/*/include/uapi/asm" sub-directory.
+# If architecture permits, it can content additional sub-directories.
 
 
 header-y += asm-generic/
-- 
1.7.7.6


  parent reply	other threads:[~2013-10-01  3:22 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
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                   ` Chen Gang [this message]
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=524A3FA1.4010805@asianux.com \
    --to=gang.chen@asianux.com \
    --cc=akpm@linux-foundation.org \
    --cc=arnd@arndb.de \
    --cc=davej@redhat.com \
    --cc=davem@davemloft.net \
    --cc=dhowells@redhat.com \
    --cc=geert@linux-m68k.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=joe@perches.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lizefan@huawei.com \
    --cc=mtk.manpages@gmail.com \
    --cc=paulmck@linux.vnet.ibm.com \
    --cc=rob@landley.net \
    --cc=tglx@linutronix.de \
    --cc=torvalds@linux-foundation.org \
    --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 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.