[PATCH v2 1/1] kbuild: Add a help message for "headers"

[PATCH v2 1/1] kbuild: Add a help message for "headers"

[Xin Li (Intel)]

Meanwhile explicitly state that the headers are uapi headers.

Suggested-by: Borislav Petkov <bp@alien8.de>
Signed-off-by: Xin Li (Intel) <xin@zytor.com>
---

Changes in v2:
* Revise the help message for "headers" (Masahiro Yamada).
* Revise the shortlog (Masahiro Yamada).
---
 Makefile | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index 70bdbf2218fc..62afeda58080 100644
--- a/Makefile
+++ b/Makefile
@@ -1659,7 +1659,8 @@ help:
 	@echo  '  kernelrelease	  - Output the release version string (use with make -s)'
 	@echo  '  kernelversion	  - Output the version stored in Makefile (use with make -s)'
 	@echo  '  image_name	  - Output the image name (use with make -s)'
-	@echo  '  headers_install - Install sanitised kernel headers to INSTALL_HDR_PATH'; \
+	@echo  '  headers	  - Build read-to-install uapi headers in usr/include'
+	@echo  '  headers_install - Install sanitised kernel uapi headers to INSTALL_HDR_PATH'; \
 	 echo  '                    (default: $(INSTALL_HDR_PATH))'; \
 	 echo  ''
 	@echo  'Static analysers:'

base-commit: 7eb172143d5508b4da468ed59ee857c6e5e01da6
-- 
2.48.1

Re: [PATCH v2 1/1] kbuild: Add a help message for "headers"

[Nicolas Schier]

On Tue Mar 11, 2025 at 06:49 CET, Xin Li (Intel) wrote:
> Meanwhile explicitly state that the headers are uapi headers.
>
> Suggested-by: Borislav Petkov <bp@alien8.de>
> Signed-off-by: Xin Li (Intel) <xin@zytor.com>
> ---
>
> Changes in v2:
> * Revise the help message for "headers" (Masahiro Yamada).
> * Revise the shortlog (Masahiro Yamada).
> ---
>  Makefile | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 70bdbf2218fc..62afeda58080 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1659,7 +1659,8 @@ help:
>  	@echo  '  kernelrelease	  - Output the release version string (use with make -s)'
>  	@echo  '  kernelversion	  - Output the version stored in Makefile (use with make -s)'
>  	@echo  '  image_name	  - Output the image name (use with make -s)'
> -	@echo  '  headers_install - Install sanitised kernel headers to INSTALL_HDR_PATH'; \
> +	@echo  '  headers	  - Build read-to-install uapi headers in usr/include'

ready-to-install (a 'y' is missing)

> +	@echo  '  headers_install - Install sanitised kernel uapi headers to INSTALL_HDR_PATH'; \

In documentation and comments, UAPI is written in capital letters.  I 
think it would be good to keep it this way here, too.

Kind regards,
Nicolas