linux-kernel - Re: [PATCH v3 02/15] scripts: kernel-doc: Add the SYNOPSIS section

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: <87sfsi2ydh.fsf@meer.lwn.net>
Date:   Wed, 16 Feb 2022 16:19:22 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Tomasz Warniełło <tomasz.warniello@...il.com>
Cc:     Tomasz Warniełło <tomasz.warniello@...il.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 02/15] scripts: kernel-doc: Add the SYNOPSIS section

Tomasz Warniełło <tomasz.warniello@...il.com> writes:

> Rst-only options are grouped around rst, the rest is arranged
> as in the OPTIONS susections (yet to be translated into POD,
> check at the end of the series).

Again: *what* does *this* patch do, and *why*?  The above isn't be all
that illuminating to most readers.

> * Transform documentation into POD (2/15)
> See step 1 for the series details.

Don't put this kind of stuff into your changelogs, please.

> Signed-off-by: Tomasz Warniełło <tomasz.warniello@...il.com>
> ---
>  scripts/kernel-doc | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)

Thanks,

jon