Skip to contentSkip to conversation

Documentation/kbuild/headers_install.txt: update documentation

PATCH New Yann Droneaud 1 participant 3 messages Sep 15, 2014

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

v2 cover Documentation/kbuild/headers_install.txt: update documentation

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/[email protected]

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 <[email protected]>
Cc Kirill A. Shutemov <[email protected]>
Cc Michal Marek <[email protected]>
Cc Rob Landley <[email protected]>
Cc Sam Ravnborg <[email protected]>
Signature · 1 line
1.9.3
#1 lore raw

PATCH v2 1/2 Documentation/kbuild/headers_install.txt: remove obsolete instructions

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/[email protected]
[2] http://lkml.kernel.org/r/3e0d73d0ca3ead75624b552105ce8adf3d63684e.1405246009.git.ydroneaud@opteya.com

Cc Kirill A. Shutemov <[email protected]>
Cc Michal Marek <[email protected]>
Cc David Woodhouse <[email protected]>
Cc Rob Landley <[email protected]>
Cc Sam Ravnborg <[email protected]>
---
 Documentation/kbuild/headers_install.txt | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
Documentation/kbuild/headers_install.txt +1 -4
index 951eb9f1e040..0d8fe5e871c4 100644
@@ -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".
Signature · 1 line
1.9.3
#2 lore raw

PATCH v2 2/2 Documentation/kbuild/headers_install.txt: update installation paths

In reply to 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.

Cc Kirill A. Shutemov <[email protected]>
Cc Michal Marek <[email protected]>
Cc David Woodhouse <[email protected]>
Cc Rob Landley <[email protected]>
Cc Sam Ravnborg <[email protected]>
---
 Documentation/kbuild/headers_install.txt | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/kbuild/headers_install.txt +5 -5
index 0d8fe5e871c4..72ed4d1bd408 100644
@@ -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
Signature · 1 line
1.9.3