[PATCH] Makefile: add targets for config-help and pkg-help

[PATCH] Makefile: add targets for config-help and pkg-help

[Shuah Khan]

Change to enable config help and package help from the main make level
to make it easier to use. It has become difficult to find config help
and pkg help specific output from the "help" information.

Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
---
 Makefile | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/Makefile b/Makefile
index 46bfb0ed2257..1d6f86df1b6c 100644
--- a/Makefile
+++ b/Makefile
@@ -1441,6 +1441,13 @@ help:
 	@echo  'Execute "make" or "make all" to build all targets marked with [*] '
 	@echo  'For further info see the ./README file'
 
+PHONY += config-help
+config-help:
+	@$(MAKE) -f $(srctree)/scripts/kconfig/Makefile help
+
+PHONY += pkg-help
+pkg-help:
+	@$(MAKE) $(build)=$(package-dir) help
 
 help-board-dirs := $(addprefix help-,$(board-dirs))
 
-- 
2.11.0

Re: [PATCH] Makefile: add targets for config-help and pkg-help

[Randy Dunlap]

On 10/17/17 08:18, Shuah Khan wrote:
> Change to enable config help and package help from the main make level
> to make it easier to use. It has become difficult to find config help
> and pkg help specific output from the "help" information.
> 
> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
> ---
>  Makefile | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/Makefile b/Makefile
> index 46bfb0ed2257..1d6f86df1b6c 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1441,6 +1441,13 @@ help:
>  	@echo  'Execute "make" or "make all" to build all targets marked with [*] '
>  	@echo  'For further info see the ./README file'
>  
> +PHONY += config-help
> +config-help:
> +	@$(MAKE) -f $(srctree)/scripts/kconfig/Makefile help
> +
> +PHONY += pkg-help
> +pkg-help:
> +	@$(MAKE) $(build)=$(package-dir) help
>  
>  help-board-dirs := $(addprefix help-,$(board-dirs))
>  
> 

Hi,

It now looks like we need these help sub-options listed somewhere,
like the patch below.



Also, it would be very nice if we could use 'make <some>help' without
running 'make silentoldconfig' and/or expecting a .config file to be present.
As it is, we get all of this noise before seeing the config-help:
(but this is a separate issue IMO)


rdunlap@midway:lnx-414-rc5> make ARCH=um O=UM64 config-help
make[1]: Entering directory '/local/lnx/kernel/lnx-414-rc5/UM64'
  GEN     ./Makefile
scripts/kconfig/conf  --silentoldconfig arch/x86/um/Kconfig
***
*** Configuration file ".config" not found!
***
*** Please run some configurator (e.g. "make oldconfig" or
*** "make menuconfig" or "make xconfig").
***
../scripts/kconfig/Makefile:37: recipe for target 'silentoldconfig' failed
make[3]: *** [silentoldconfig] Error 1
../Makefile:547: recipe for target 'silentoldconfig' failed
make[2]: *** [silentoldconfig] Error 2
  config	  - Update current config utilising a line-oriented program
  nconfig         - Update current config utilising a ncurses menu based
                    program



For your patch:
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

If you want to, you can fold the patch below into your patch.

---
From: Randy Dunlap <rdunlap@infradead.org>

Add info on "make help" sub-targets "make config-help" and
"make pkg-help".

References to "make dochelp" and "make kselftest-help" etc. can also
be added.

Or a few lines could be added to the end of the "make help" output,
but I think that it is too long already.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
 Makefile |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- lnx-414-rc5.orig/Makefile
+++ lnx-414-rc5/Makefile
@@ -1359,7 +1359,7 @@ help:
 	@echo  '  mrproper	  - Remove all generated files + config + various backup files'
 	@echo  '  distclean	  - mrproper + remove editor backup and patch files'
 	@echo  ''
-	@echo  'Configuration targets:'
+	@echo  'Configuration targets:  (or use "make config-help")'
 	@$(MAKE) -f $(srctree)/scripts/kconfig/Makefile help
 	@echo  ''
 	@echo  'Other generic targets:'
@@ -1406,7 +1406,7 @@ help:
 	@echo '  use "make tools/help"'
 	@echo '  or  "cd tools; make help"'
 	@echo  ''
-	@echo  'Kernel packaging:'
+	@echo  'Kernel packaging:  (or use "make pkg-help")'
 	@$(MAKE) $(build)=$(package-dir) help
 	@echo  ''
 	@echo  'Documentation targets:'

Re: [PATCH] Makefile: add targets for config-help and pkg-help

[Masahiro Yamada]

2017-10-18 0:18 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
> Change to enable config help and package help from the main make level
> to make it easier to use. It has become difficult to find config help
> and pkg help specific output from the "help" information.
>
> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
> ---
>  Makefile | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/Makefile b/Makefile
> index 46bfb0ed2257..1d6f86df1b6c 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1441,6 +1441,13 @@ help:
>         @echo  'Execute "make" or "make all" to build all targets marked with [*] '
>         @echo  'For further info see the ./README file'
>
> +PHONY += config-help
> +config-help:
> +       @$(MAKE) -f $(srctree)/scripts/kconfig/Makefile help
> +
> +PHONY += pkg-help
> +pkg-help:
> +       @$(MAKE) $(build)=$(package-dir) help
>
>  help-board-dirs := $(addprefix help-,$(board-dirs))
>
> --


What happened to "doc-help" ?
(I want to see consistent hyphenation)

Please follow Randy's suggestion.

Also you need to add %-help pattern to no-dot-config-targets.



-- 
Best Regards
Masahiro Yamada

Re: [PATCH] Makefile: add targets for config-help and pkg-help

[Shuah Khan]

On 10/18/2017 10:23 AM, Masahiro Yamada wrote:
> 2017-10-18 0:18 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>> Change to enable config help and package help from the main make level
>> to make it easier to use. It has become difficult to find config help
>> and pkg help specific output from the "help" information.
>>
>> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
>> ---
>>  Makefile | 7 +++++++
>>  1 file changed, 7 insertions(+)
>>
>> diff --git a/Makefile b/Makefile
>> index 46bfb0ed2257..1d6f86df1b6c 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -1441,6 +1441,13 @@ help:
>>         @echo  'Execute "make" or "make all" to build all targets marked with [*] '
>>         @echo  'For further info see the ./README file'
>>
>> +PHONY += config-help
>> +config-help:
>> +       @$(MAKE) -f $(srctree)/scripts/kconfig/Makefile help
>> +
>> +PHONY += pkg-help
>> +pkg-help:
>> +       @$(MAKE) $(build)=$(package-dir) help
>>
>>  help-board-dirs := $(addprefix help-,$(board-dirs))
>>
>> --
> 
> 
> What happened to "doc-help" ?
> (I want to see consistent hyphenation)

I added doc-help to DOC_TARGETS directly. I should have done this
patch on top of the last one.

> 
> Please follow Randy's suggestion.

I will re-do this patch as per Randy's suggestions.
> 
> Also you need to add %-help pattern to no-dot-config-targets.
> 

Right. I will send v2 this week if possible. I have a couple of
trips coming up including the Kernel Summit.

thanks,
-- Shuah