Documentation/make/headers_install.txt: update documentation
Subsystems (2)
PATCH 1/1 Documentation/make/headers_install.txt: update documentation
Documentation in make/headers_install.txt is not up to date regarding:
- way to list the various architectures;
- path where the headers are installed.
This patch try to fix these issues.
--- Documentation/make/headers_install.txt | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)
Documentation/make/headers_install.txt +8 -7
@@ -24,23 +24,24 @@ 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 -is platform-specific, to see a complete list of supported architectures use +current architecture. The asm/ directory of the exported kernel headers +is platform-specific, to see a list of supported architectures use the command: - ls -d include/asm-* | sed 's/.*-//' + /bin/ls -1 arch/*/include/asm/Kbuild | sed -e 's,^arch/,,' \ + -e 's,/include/asm/Kbuild$,,' -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
Dne 30.6.2014 21:11, Yann Droneaud napsal(a):
Quoted 7 lines
Documentation in
make/headers_install.txtis not up to date regarding:
- way to list the various architectures;
- path where the headers are installed.This patch try to fix these issues.
Quoted 8 lines
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]>Signed-off-by Yann Droneaud <[email protected]>--- Documentation/make/headers_install.txt | 15 ++++++++-------
I have never noticed this file :). How about moving it to Documentation/kbuild?
Documentation/make/headers_install.txt The "make headers_install" command can be run in the top level directory of the · line 27
Quoted 12 lines
1 file changed, 8 insertions(+), 7 deletions(-)Documentation/make/headers_install.txt +1
-1@@ -24,23 +24,24 @@ 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=x86 maybe?
Documentation/make/headers_install.txt The "make headers_install" command can be run in the top level directory of the · line 35
Quoted 10 lines
Documentation/make/headers_install.txt +4
-3ARCH 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 +current architecture. The asm/ directory of the exported kernel headers +is platform-specific, to see a list of supported architectures use the command: - ls -d include/asm-* | sed 's/.*-//' + /bin/ls -1 arch/*/include/asm/Kbuild | sed -e 's,^arch/,,' \ + -e 's,/include/asm/Kbuild$,,'
Or, more simply, 'ls arch/'.
Quoted 5 lines
Documentation/make/headers_install.txt +2
-2-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/".
Documentation/make/headers_install.txt The "make headers_install" command can be run in the top level directory of the
Quoted 10 lines
Documentation/make/headers_install.txt +1
-1The 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
Looks good,
Thanks,
Michal
Quoted 17 lines · Michal Marek
Dne 30.6.2014 21:11, Yann Droneaud napsal(a):
Quoted 7 lines
Documentation in
make/headers_install.txtis not up to date regarding:
- way to list the various architectures;
- path where the headers are installed.This patch try to fix these issues.
Quoted 8 lines
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]>Signed-off-by Yann Droneaud <[email protected]>--- Documentation/make/headers_install.txt | 15 ++++++++-------
Quoted 2 lines
I have never noticed this file :). How about moving it to
Documentation/kbuild?
Agree - please get this file moved.
Sam
cover Documentation: move and update headers_install.txt
Quoted 5 lines · Sam Ravnborg
Quoted 2 lines · Michal Marek
I have never noticed this file :). How about moving it to
Documentation/kbuild?Agree - please get this file moved.
Please find a patchset to move and update headers_install.txt.
Regards.
Yann Droneaud (2):
Documentation: headers_install.txt is part of kbuild Documentation/kbuild/headers_install.txt: update documentation
Documentation/kbuild/00-INDEX | 2 ++
Documentation/{make => kbuild}/headers_install.txt | 15 ++++++++-------
2 files changed, 10 insertions(+), 7 deletions(-)
rename Documentation/{make => kbuild}/headers_install.txt (78%)Signature · 1 line
1.9.3
PATCH 1/2 Documentation: headers_install.txt is part of kbuild
'headers_install.txt' from Documentation/make/ is related to Kbuild so it must be moved in Documentation/kbuild/ directory.
As Documentation/make/ directory has only one file, it will be removed as a consequence of moving 'headers_install.txt'.
---
Documentation/kbuild/00-INDEX | 2 ++
Documentation/{make => kbuild}/headers_install.txt | 0
2 files changed, 2 insertions(+)
rename Documentation/{make => kbuild}/headers_install.txt (100%)Documentation/kbuild/00-INDEX +2 -0
@@ -1,5 +1,7 @@ 00-INDEX - this file: info on the kernel build process +headers_install.txt + - how to export Linux headers for use by userspace kbuild.txt - developer information on kbuild kconfig.txt
Documentation/kbuild/headers_install.txt renamed from Documentation/make/headers_install.txt +0 -0
Signature · 1 line
1.9.3
Re: [PATCHv1 1/2] Documentation: headers_install.txt is part of kbuild
Quoted 6 lines · Yann Droneaud
'headers_install.txt' from
Documentation/make/is related toKbuildso it must be moved inDocumentation/kbuild/directory.As
Documentation/make/directory has only one file, it will be removed as a consequence of moving 'headers_install.txt'.
Quoted 6 lines
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]>Signed-off-by Yann Droneaud <[email protected]>
This is much better - thanks.
Quoted 5 lines
---
Documentation/kbuild/00-INDEX | 2 ++
Documentation/{make => kbuild}/headers_install.txt | 0
2 files changed, 2 insertions(+)
rename Documentation/{make => kbuild}/headers_install.txt (100%)Re: [PATCHv1 1/2] Documentation: headers_install.txt is part of kbuild
Quoted 14 lines · Sam Ravnborg
Quoted 6 lines · Yann Droneaud
'headers_install.txt' from
Documentation/make/is related toKbuildso it must be moved inDocumentation/kbuild/directory.As
Documentation/make/directory has only one file, it will be removed as a consequence of moving 'headers_install.txt'.Quoted 6 lines
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]>Signed-off-by Yann Droneaud <[email protected]>
Quoted 2 lines
This is much better - thanks.
Acked-by Sam Ravnborg <[email protected]>
Applied to kbuild.git#misc, thanks.
Michal
PATCH 2/2 Documentation/kbuild/headers_install.txt: update documentation
In reply to Yann DroneaudDocumentation in kbuild/headers_install.txt is not up to date regarding:
- way to list the various architectures;
- path where the headers are installed.
This patch try to fix these issues.
--- Documentation/kbuild/headers_install.txt | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)
Documentation/kbuild/headers_install.txt +8 -7
@@ -24,23 +24,24 @@ 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 -is platform-specific, to see a complete list of supported architectures use +current architecture. The asm/ directory of the exported kernel headers +is platform-specific, to see a list of supported architectures use the command: - ls -d include/asm-* | sed 's/.*-//' + /bin/ls -1 arch/*/include/asm/Kbuild | sed -e 's,^arch/,,' \ + -e 's,/include/asm/Kbuild$,,' -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
Re: [PATCHv1 2/2] Documentation/kbuild/headers_install.txt: update documentation
Quoted 22 lines · Yann Droneaud
Documentation in
kbuild/headers_install.txtis not up to date regarding:
- way to list the various architectures;
- path where the headers are installed.This patch try to fix these issues.
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]>Signed-off-by Yann Droneaud <[email protected]>--- Documentation/kbuild/headers_install.txt | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)Documentation/kbuild/headers_install.txt +0
-0
Documentation/kbuild/headers_install.txt The "make headers_install" command can be run in the top level directory of the · line 27
Quoted 5 lines
Documentation/kbuild/headers_install.txt +1
-1@@ -24,23 +24,24 @@ 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
OK
Documentation/kbuild/headers_install.txt The "make headers_install" command can be run in the top level directory of the · line 35
Quoted 8 lines
to see a list of supported architectures use
the command:Documentation/kbuild/headers_install.txt +2
-1- ls -d include/asm-* | sed 's/.*-//' + /bin/ls -1 arch/*/include/asm/Kbuild | sed -e 's,^arch/,,' \ + -e 's,/include/asm/Kbuild$,,'
This information is nor relevant these days as all architectures support exporting userspace headers. So drop this part of the documentation.
cris is broken - I will send a patch to fix this.
In reality um does not support exporting headers - but it makes no sense either.
We do not want to do anything special just to mention that um is not included.
Quoted 4 lines
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.)
I have seriously considered dropping the "headers_install_all" target. It does not make any sense as some files are optional for the individual archs and only pure luck will define if the relevant fiels are included or not.
We would still like the "headers_check_all" feature but this is better done in a small shell script than as it is today where we need special handling to support it in Makefile.headersinst - and it adds complexity
to the top-level Makefile which we shall avoid.
But this is unrelated to your documentation clean-up.
Sam