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

[Tomasz Warniełło]

On Mon, 21 Feb 2022 22:10:22 -0800
Randy Dunlap <rdunlap@xxxxxxxxxxxxx> 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