[PATCH] Makefile: enable dochelp run from main make level

[PATCH] Makefile: enable dochelp run from main make level

[Shuah Khan]

Change to enable dochelp run from main make level to make it easier to
use it.

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

diff --git a/Makefile b/Makefile
index cf007a31d575..f99d1b36c437 100644
--- a/Makefile
+++ b/Makefile
@@ -1454,7 +1454,7 @@ $(help-board-dirs): help-%:
 
 # Documentation targets
 # ---------------------------------------------------------------------------
-DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
+DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs dochelp
 PHONY += $(DOC_TARGETS)
 $(DOC_TARGETS): scripts_basic FORCE
 	$(Q)$(MAKE) $(build)=Documentation $@
-- 
2.11.0

Re: [PATCH] Makefile: enable dochelp run from main make level

[Masahiro Yamada]

2017-10-03 8:44 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
> Change to enable dochelp run from main make level to make it easier to
> use it.
>
> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
> ---
>  Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index cf007a31d575..f99d1b36c437 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1454,7 +1454,7 @@ $(help-board-dirs): help-%:
>
>  # Documentation targets
>  # ---------------------------------------------------------------------------
> -DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
> +DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs dochelp
>  PHONY += $(DOC_TARGETS)
>  $(DOC_TARGETS): scripts_basic FORCE
>         $(Q)$(MAKE) $(build)=Documentation $@
> --
> 2.11.0
>


The dochelp is invoked from "make help" of the main make level.

Do you mean "make dochelp" is also necessary?



-- 
Best Regards
Masahiro Yamada

Re: [PATCH] Makefile: enable dochelp run from main make level

[Shuah Khan]

On 10/07/2017 05:24 AM, Masahiro Yamada wrote:
> 2017-10-03 8:44 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>> Change to enable dochelp run from main make level to make it easier to
>> use it.
>>
>> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
>> ---
>>  Makefile | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Makefile b/Makefile
>> index cf007a31d575..f99d1b36c437 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -1454,7 +1454,7 @@ $(help-board-dirs): help-%:
>>
>>  # Documentation targets
>>  # ---------------------------------------------------------------------------
>> -DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
>> +DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs dochelp
>>  PHONY += $(DOC_TARGETS)
>>  $(DOC_TARGETS): scripts_basic FORCE
>>         $(Q)$(MAKE) $(build)=Documentation $@
>> --
>> 2.11.0
>>
> 
> 
> The dochelp is invoked from "make help" of the main make level.
> 
> Do you mean "make dochelp" is also necessary?
> 

Right. It is a bit hard to pick out individual help messages from
the 'make help' output and it would make it easier to use to enable
dochelp.

That said, it is your call on whether it would make it cumbersome to
support 'make dochlep' and other sub-makefile help targets.

I can go either way.

thanks,
-- Shuah

Re: [PATCH] Makefile: enable dochelp run from main make level

[Masahiro Yamada]

2017-10-11 5:09 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
> On 10/07/2017 05:24 AM, Masahiro Yamada wrote:
>> 2017-10-03 8:44 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>>> Change to enable dochelp run from main make level to make it easier to
>>> use it.
>>>
>>> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
>>> ---
>>>  Makefile | 2 +-
>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/Makefile b/Makefile
>>> index cf007a31d575..f99d1b36c437 100644
>>> --- a/Makefile
>>> +++ b/Makefile
>>> @@ -1454,7 +1454,7 @@ $(help-board-dirs): help-%:
>>>
>>>  # Documentation targets
>>>  # ---------------------------------------------------------------------------
>>> -DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
>>> +DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs dochelp
>>>  PHONY += $(DOC_TARGETS)
>>>  $(DOC_TARGETS): scripts_basic FORCE
>>>         $(Q)$(MAKE) $(build)=Documentation $@
>>> --
>>> 2.11.0
>>>
>>
>>
>> The dochelp is invoked from "make help" of the main make level.
>>
>> Do you mean "make dochelp" is also necessary?
>>
>
> Right. It is a bit hard to pick out individual help messages from
> the 'make help' output and it would make it easier to use to enable
> dochelp.
>
> That said, it is your call on whether it would make it cumbersome to
> support 'make dochlep' and other sub-makefile help targets.
>
> I can go either way.
>

I thought of this.
The same thing would apply to "make confighelp", "make pkghelp", ...



-- 
Best Regards
Masahiro Yamada

Re: [PATCH] Makefile: enable dochelp run from main make level

[Randy Dunlap]

On 10/10/17 17:54, Masahiro Yamada wrote:
> 2017-10-11 5:09 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>> On 10/07/2017 05:24 AM, Masahiro Yamada wrote:
>>> 2017-10-03 8:44 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>>>> Change to enable dochelp run from main make level to make it easier to
>>>> use it.
>>>>
>>>> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
>>>> ---
>>>>  Makefile | 2 +-
>>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>>
>>>> diff --git a/Makefile b/Makefile
>>>> index cf007a31d575..f99d1b36c437 100644
>>>> --- a/Makefile
>>>> +++ b/Makefile
>>>> @@ -1454,7 +1454,7 @@ $(help-board-dirs): help-%:
>>>>
>>>>  # Documentation targets
>>>>  # ---------------------------------------------------------------------------
>>>> -DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
>>>> +DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs dochelp
>>>>  PHONY += $(DOC_TARGETS)
>>>>  $(DOC_TARGETS): scripts_basic FORCE
>>>>         $(Q)$(MAKE) $(build)=Documentation $@
>>>> --
>>>> 2.11.0
>>>>
>>>
>>>
>>> The dochelp is invoked from "make help" of the main make level.
>>>
>>> Do you mean "make dochelp" is also necessary?
>>>
>>
>> Right. It is a bit hard to pick out individual help messages from
>> the 'make help' output and it would make it easier to use to enable
>> dochelp.
>>
>> That said, it is your call on whether it would make it cumbersome to
>> support 'make dochlep' and other sub-makefile help targets.
>>
>> I can go either way.
>>
> 
> I thought of this.
> The same thing would apply to "make confighelp", "make pkghelp", ...

Yes, especially confighelp.  I have to use grep, otherwise there is too
much noise.


-- 
~Randy

Re: [PATCH] Makefile: enable dochelp run from main make level

[Shuah Khan]

On 10/10/2017 06:58 PM, Randy Dunlap wrote:
> On 10/10/17 17:54, Masahiro Yamada wrote:
>> 2017-10-11 5:09 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>>> On 10/07/2017 05:24 AM, Masahiro Yamada wrote:
>>>> 2017-10-03 8:44 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>>>>> Change to enable dochelp run from main make level to make it easier to
>>>>> use it.
>>>>>
>>>>> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
>>>>> ---
>>>>>  Makefile | 2 +-
>>>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>>>
>>>>> diff --git a/Makefile b/Makefile
>>>>> index cf007a31d575..f99d1b36c437 100644
>>>>> --- a/Makefile
>>>>> +++ b/Makefile
>>>>> @@ -1454,7 +1454,7 @@ $(help-board-dirs): help-%:
>>>>>
>>>>>  # Documentation targets
>>>>>  # ---------------------------------------------------------------------------
>>>>> -DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
>>>>> +DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs dochelp
>>>>>  PHONY += $(DOC_TARGETS)
>>>>>  $(DOC_TARGETS): scripts_basic FORCE
>>>>>         $(Q)$(MAKE) $(build)=Documentation $@
>>>>> --
>>>>> 2.11.0
>>>>>
>>>>
>>>>
>>>> The dochelp is invoked from "make help" of the main make level.
>>>>
>>>> Do you mean "make dochelp" is also necessary?
>>>>
>>>
>>> Right. It is a bit hard to pick out individual help messages from
>>> the 'make help' output and it would make it easier to use to enable
>>> dochelp.
>>>
>>> That said, it is your call on whether it would make it cumbersome to
>>> support 'make dochlep' and other sub-makefile help targets.
>>>
>>> I can go either way.
>>>
>>
>> I thought of this.
>> The same thing would apply to "make confighelp", "make pkghelp", ...
> 
> Yes, especially confighelp.  I have to use grep, otherwise there is too
> much noise.
> 
> 

If you would like I can send patches to cover some of these cases.

thanks,
-- Shuah

Re: [PATCH] Makefile: enable dochelp run from main make level

[Randy Dunlap]

On 10/10/17 18:06, Shuah Khan wrote:
> On 10/10/2017 06:58 PM, Randy Dunlap wrote:
>> On 10/10/17 17:54, Masahiro Yamada wrote:
>>> 2017-10-11 5:09 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>>>> On 10/07/2017 05:24 AM, Masahiro Yamada wrote:
>>>>> 2017-10-03 8:44 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>>>>>> Change to enable dochelp run from main make level to make it easier to
>>>>>> use it.
>>>>>>
>>>>>> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
>>>>>> ---
>>>>>>  Makefile | 2 +-
>>>>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>>>>
>>>>>> diff --git a/Makefile b/Makefile
>>>>>> index cf007a31d575..f99d1b36c437 100644
>>>>>> --- a/Makefile
>>>>>> +++ b/Makefile
>>>>>> @@ -1454,7 +1454,7 @@ $(help-board-dirs): help-%:
>>>>>>
>>>>>>  # Documentation targets
>>>>>>  # ---------------------------------------------------------------------------
>>>>>> -DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
>>>>>> +DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs dochelp
>>>>>>  PHONY += $(DOC_TARGETS)
>>>>>>  $(DOC_TARGETS): scripts_basic FORCE
>>>>>>         $(Q)$(MAKE) $(build)=Documentation $@
>>>>>> --
>>>>>> 2.11.0
>>>>>>
>>>>>
>>>>>
>>>>> The dochelp is invoked from "make help" of the main make level.
>>>>>
>>>>> Do you mean "make dochelp" is also necessary?
>>>>>
>>>>
>>>> Right. It is a bit hard to pick out individual help messages from
>>>> the 'make help' output and it would make it easier to use to enable
>>>> dochelp.
>>>>
>>>> That said, it is your call on whether it would make it cumbersome to
>>>> support 'make dochlep' and other sub-makefile help targets.
>>>>
>>>> I can go either way.
>>>>
>>>
>>> I thought of this.
>>> The same thing would apply to "make confighelp", "make pkghelp", ...
>>
>> Yes, especially confighelp.  I have to use grep, otherwise there is too
>> much noise.
>>
>>
> 
> If you would like I can send patches to cover some of these cases.

I would be happy to see that...

thanks,
-- 
~Randy

Re: [PATCH] Makefile: enable dochelp run from main make level

[Masahiro Yamada]

2017-10-11 10:06 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
> On 10/10/2017 06:58 PM, Randy Dunlap wrote:
>> On 10/10/17 17:54, Masahiro Yamada wrote:
>>> 2017-10-11 5:09 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>>>> On 10/07/2017 05:24 AM, Masahiro Yamada wrote:
>>>>> 2017-10-03 8:44 GMT+09:00 Shuah Khan <shuahkh@osg.samsung.com>:
>>>>>> Change to enable dochelp run from main make level to make it easier to
>>>>>> use it.
>>>>>>
>>>>>> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
>>>>>> ---
>>>>>>  Makefile | 2 +-
>>>>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>>>>
>>>>>> diff --git a/Makefile b/Makefile
>>>>>> index cf007a31d575..f99d1b36c437 100644
>>>>>> --- a/Makefile
>>>>>> +++ b/Makefile
>>>>>> @@ -1454,7 +1454,7 @@ $(help-board-dirs): help-%:
>>>>>>
>>>>>>  # Documentation targets
>>>>>>  # ---------------------------------------------------------------------------
>>>>>> -DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
>>>>>> +DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs dochelp
>>>>>>  PHONY += $(DOC_TARGETS)
>>>>>>  $(DOC_TARGETS): scripts_basic FORCE
>>>>>>         $(Q)$(MAKE) $(build)=Documentation $@
>>>>>> --
>>>>>> 2.11.0
>>>>>>
>>>>>
>>>>>
>>>>> The dochelp is invoked from "make help" of the main make level.
>>>>>
>>>>> Do you mean "make dochelp" is also necessary?
>>>>>
>>>>
>>>> Right. It is a bit hard to pick out individual help messages from
>>>> the 'make help' output and it would make it easier to use to enable
>>>> dochelp.
>>>>
>>>> That said, it is your call on whether it would make it cumbersome to
>>>> support 'make dochlep' and other sub-makefile help targets.
>>>>
>>>> I can go either way.
>>>>
>>>
>>> I thought of this.
>>> The same thing would apply to "make confighelp", "make pkghelp", ...
>>
>> Yes, especially confighelp.  I have to use grep, otherwise there is too
>> much noise.
>>
>>
>
> If you would like I can send patches to cover some of these cases.
>


We have a kind of hierarchy
when arch/$(SRCARCH)/configs has sub-directories.
For example,

$ make ARCH=powerpc help
  [ snip ]
  storcenter_defconfig     - Build for storcenter
  tqm8xx_defconfig         - Build for tqm8xx
  wii_defconfig            - Build for wii

  help-40x         - Show 40x-specific targets
  help-44x         - Show 44x-specific targets
  help-52xx        - Show 52xx-specific targets
  help-83xx        - Show 83xx-specific targets
  help-85xx        - Show 85xx-specific targets
  help-boards      - Show all of the above




I think your suggestion is, to keep the top "make help" as-is
and add new targets to display subsets.


All targets you can run from the top-level
must be described in "make help".

Maybe like this?

   confighelp   - Show only configuration targets
   dochelp      - Show only documentation targets


I feel a bit cumbersome, but I will probably accept it
if people think it is useful.




-- 
Best Regards
Masahiro Yamada