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 for Android: free password hash cracker in your pocket

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

Date:   Wed, 23 Feb 2022 13:55:48 +0100
From:   Tomasz Warniełło <tomasz.warniello@...il.com>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     Randy Dunlap <rdunlap@...radead.org>, corbet@....net,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        tomasz.warniello@...il.com
Subject: Re: [PATCH v4 00/11] Transform documentation into POD

Hi Akira,

Take a look at `man perl` and you will find a synopsis also. 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.

Regards,

Tomasz