linux-kernel - Re: [PATCH v4 01/11] scripts: kernel-doc: Add the basic POD sections

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: <20220222222729.404611b7@fuji.fritz.box>
Date:   Tue, 22 Feb 2022 22:27:29 +0100
From:   Tomasz Warniełło <tomasz.warniello@...il.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     corbet@....net, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 01/11] scripts: kernel-doc: Add the basic POD
 sections

On Mon, 21 Feb 2022 22:10:22 -0800
Randy Dunlap <rdunlap@...radead.org> wrote:

> Nit:
> $ ./scripts/kernel-doc -h
> says:
>     Run `kernel-doc -h` for details.

Hi Randy,

The -h printout is complete and the synopsis section is only a doc section.
To me this is a very minor concern. I wouldn't even bother to correct this.
The phrasing is not very intelligent in the -h context, but I wouldn't
contextualise this sentence for simplicity. It might be toned down to fit
nicer in multiple contexts, but in the end someone running the -h mode
doesn't need this information at all. And the same applies to this parameter's
description in the "Other parameters" subsection. A user running -h will
know that. What counts to me is syntactical coherence and again - simplicity.

Thanks,

Tomasz