linux-kernel - Re: [PATCH v4 00/11] Transform documentation into POD

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <1abcb226-dbfd-b3d2-5453-208af7faa0c2@gmail.com>
Date:   Wed, 23 Feb 2022 22:16:30 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     Tomasz Warniełło <tomasz.warniello@...il.com>
Cc:     Randy Dunlap <rdunlap@...radead.org>, corbet@....net,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH v4 00/11] Transform documentation into POD

On Wed, 23 Feb 2022 13:55:48 +0100,
Tomasz Warniełło wrote:
> Hi Akira,
> 
> Take a look at `man perl` and you will find a synopsis also.

When I do "man perl", I want to see a detailed explanation, and
somewhat hard-to-parse synopsis is ok.

I'm saying that I don't like to see such a thing when I type
"./scripts/kerneldoc -h".  I expect a hint to recall which option I
should use.  I don't want to scroll back the terminal.

It would be nice if the verbose man page can be shown by
"./scripts/kerneldoc -v -h" or "perldoc -F ./scripts/kerneldoc".

>                                                              It's simply
> better in depicting grammar relations than a flat switch list. Especially
> when the grammar gets complex. I dislike it also. And I don't think it
> looks good. Rather creepy and overwhelming.
> 
>>> I don't see much point for such a non-user-facing script having nice-looking
>>> well-structured documentation in the first place.
> 
> You're touching the very essence of kernel-doc here. What and who is it for?
> Not just the script - all of it.

Sorry, I have no idea what I am being asked.
Could you rephrase above for a non-native speaker of English, please?

        Thanks, Akira

> 
> Regards,
> 
> Tomasz