[PATCHv2 0/2] Documentation/kbuild/headers_install.txt: update documentation

[PATCHv2 0/2] Documentation/kbuild/headers_install.txt: update documentation

[Yann Droneaud]

Hi,

Please find some updates to headers_install.txt. In particular the
commands to list the architectures are removed, per Sam Ravnborg's
request.

Changes from v1 [1]:
- remove the shell commands to list architectures with 'asm' headers
  (in a dedicated patch)
- patch to update documentation now only fixes the various paths
  for the headers.

[1] http://lkml.kernel.org/r/cover.1405246007.git.ydroneaud@opteya.com

Yann Droneaud (2):
  Documentation/kbuild/headers_install.txt: remove obsolete instructions
  Documentation/kbuild/headers_install.txt: update installation paths

 Documentation/kbuild/headers_install.txt | 15 ++++++---------
 1 file changed, 6 insertions(+), 9 deletions(-)

Cc: David Woodhouse <dwmw2@infradead.org>
Cc: Kirill A. Shutemov <kirill@shutemov.name>
Cc: Michal Marek <mmarek@suse.cz>
Cc: Rob Landley <rob@landley.net>
Cc: Sam Ravnborg <sam@ravnborg.org>
-- 
1.9.3

[PATCHv2 1/2] Documentation/kbuild/headers_install.txt: remove obsolete instructions

[Yann Droneaud]

As noted by Sam Ravnborg in reply [1] to "[PATCHv1 2/2]
Documentation/kbuild/headers_install.txt: update documentation" [2],
all architectures support exporting userspace headers (while 'um'
being a special case), so there's no need to list them.

This patch removes the obsolete shell commands to list
architectures with a dedicated 'asm' directory.

[1] http://lkml.kernel.org/r/20140713212608.GB16496@ravnborg.org
[2] http://lkml.kernel.org/r/3e0d73d0ca3ead75624b552105ce8adf3d63684e.1405246009.git.ydroneaud@opteya.com

Link: http://lkml.kernel.org/r/cover.1410712841.git.ydroneaud@opteya.com
Cc: Kirill A. Shutemov <kirill@shutemov.name>
Cc: Michal Marek <mmarek@suse.cz>
Cc: David Woodhouse <dwmw2@infradead.org>
Cc: Rob Landley <rob@landley.net>
Cc: Sam Ravnborg <sam@ravnborg.org>
Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
---
 Documentation/kbuild/headers_install.txt | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/Documentation/kbuild/headers_install.txt b/Documentation/kbuild/headers_install.txt
index 951eb9f1e040..0d8fe5e871c4 100644
--- a/Documentation/kbuild/headers_install.txt
+++ b/Documentation/kbuild/headers_install.txt
@@ -28,10 +28,7 @@ optional arguments:
 
 ARCH indicates which architecture to produce headers for, and defaults to the
 current architecture.  The linux/asm directory of the exported kernel headers
-is platform-specific, to see a complete list of supported architectures use
-the command:
-
-  ls -d include/asm-* | sed 's/.*-//'
+is platform-specific.
 
 INSTALL_HDR_PATH indicates where to install the headers.  It defaults to
 "./usr/include".
-- 
1.9.3

[PATCHv2 2/2] Documentation/kbuild/headers_install.txt: update installation paths

[Yann Droneaud]

Documentation in kbuild/headers_install.txt is not up to date
regarding paths where the headers are installed.

This patch fixes the documention with the correct information.

Link: http://lkml.kernel.org/r/cover.1410712841.git.ydroneaud@opteya.com
Cc: Kirill A. Shutemov <kirill@shutemov.name>
Cc: Michal Marek <mmarek@suse.cz>
Cc: David Woodhouse <dwmw2@infradead.org>
Cc: Rob Landley <rob@landley.net>
Cc: Sam Ravnborg <sam@ravnborg.org>
Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
---
 Documentation/kbuild/headers_install.txt | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/kbuild/headers_install.txt b/Documentation/kbuild/headers_install.txt
index 0d8fe5e871c4..72ed4d1bd408 100644
--- a/Documentation/kbuild/headers_install.txt
+++ b/Documentation/kbuild/headers_install.txt
@@ -24,20 +24,20 @@ The "make headers_install" command can be run in the top level directory of the
 kernel source code (or using a standard out-of-tree build).  It takes two
 optional arguments:
 
-  make headers_install ARCH=i386 INSTALL_HDR_PATH=/usr/include
+  make headers_install ARCH=i386 INSTALL_HDR_PATH=/usr
 
 ARCH indicates which architecture to produce headers for, and defaults to the
-current architecture.  The linux/asm directory of the exported kernel headers
+current architecture.  Note: the asm/ directory of the exported kernel headers
 is platform-specific.
 
-INSTALL_HDR_PATH indicates where to install the headers.  It defaults to
-"./usr/include".
+INSTALL_HDR_PATH indicates where to create include/ directory to install the
+headers. It defaults to "./usr/".
 
 The command "make headers_install_all" exports headers for all architectures
 simultaneously.  (This is mostly of interest to distribution maintainers,
 who create an architecture-independent tarball from the resulting include
 directory.)  You also can use HDR_ARCH_LIST to specify list of architectures.
-Remember to provide the appropriate linux/asm directory via "mv" or "ln -s"
+Remember to provide the appropriate asm/ directory via "mv" or "ln -s"
 before building a C library with headers exported this way.
 
 The kernel header export infrastructure is maintained by David Woodhouse
-- 
1.9.3