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

From: Jonathan Corbet
Date: Wed Feb 16 2022 - 18:19:27 EST


Tomasz Warniełło <tomasz.warniello@xxxxxxxxx> 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@xxxxxxxxx>
> ---
> scripts/kernel-doc | 19 +++++++++++++++++++
> 1 file changed, 19 insertions(+)

Thanks,

jon