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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAK7LNATL+mVnBzwvY8aXuKWd7ebtaT95rpt-sK=P+fLJNtd4Mg@mail.gmail.com>
Date:   Wed, 18 Oct 2017 08:57:51 +0900
From:   Masahiro Yamada <yamada.masahiro@...ionext.com>
To:     Shuah Khan <shuahkh@....samsung.com>
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Michal Marek <mmarek@...e.com>,
        Jonathan Corbet <corbet@....net>,
        Linux Kbuild mailing list <linux-kbuild@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] Makefile: enable dochelp run from main make level

2017-10-11 10:06 GMT+09:00 Shuah Khan <shuahkh@....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@....samsung.com>:
>>>> On 10/07/2017 05:24 AM, Masahiro Yamada wrote:
>>>>> 2017-10-03 8:44 GMT+09:00 Shuah Khan <shuahkh@....samsung.com>:
>>>>>> Change to enable dochelp run from main make level to make it easier to
>>>>>> use it.
>>>>>>
>>>>>> Signed-off-by: Shuah Khan <shuahkh@....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