Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Tue, 22 Feb 2022 22:27:29 +0100
From:   Tomasz =?UTF-8?B?V2FybmllxYLFgm8=?= <tomasz.warniello@gmail.com>
To:     Randy Dunlap <rdunlap@infradead.org>
Cc:     corbet@lwn.net, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH v4 01/11] scripts: kernel-doc: Add the basic POD
 sections
Message-ID: <20220222222729.404611b7@fuji.fritz.box>
In-Reply-To: <7852b505-a65a-6cdd-29a8-3bc966dfc750@infradead.org>
References: <20220218181628.1411551-1-tomasz.warniello@gmail.com>
        <20220218181628.1411551-2-tomasz.warniello@gmail.com>
        <7852b505-a65a-6cdd-29a8-3bc966dfc750@infradead.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Precedence: bulk

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