Re: [PATCH] Documentation/make/headers_install.txt: update documentation

Michal Marek
2014-07-03T21:12:24Z

Dne 30.6.2014 21:11, Yann Droneaud napsal(a):
> 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.
>
> 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/make/headers_install.txt | 15 ++++++++-------

I have never noticed this file :). How about moving it to
Documentation/kbuild?

> 1 file changed, 8 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/make/headers_install.txt b/Documentation/make/headers_install.txt
> index 951eb9f1e040..8b6751f10dd3 100644
> --- a/Documentation/make/headers_install.txt
> +++ b/Documentation/make/headers_install.txt
> @@ -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?

> 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$,,'

Or, more simply, 'ls arch/'.

> -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
>

Looks good,

Thanks,
Michal