]> git.baikalelectronics.ru Git - kernel.git/commit
scripts: kernel-doc: Add the basic POD sections
authorTomasz Warniełło <tomasz.warniello@gmail.com>
Fri, 18 Feb 2022 18:16:18 +0000 (19:16 +0100)
committerJonathan Corbet <corbet@lwn.net>
Thu, 24 Feb 2022 17:52:45 +0000 (10:52 -0700)
commit6010edc5bdc0fe1ef4d8d6c38f101e004cd50dc3
tree31090808a9e0e757bb327164d13c69bec59a80c0
parentf22cfb185a3de62318250a5d3d7a4f28f79e5c84
scripts: kernel-doc: Add the basic POD sections

The NAME section provides the doc title, while SYNOPSIS contains
the basic syntax and usage description, which will be printed
in the help document and in the error output produced on wrong script
usage.

The rationale is to give users simple and succinct enlightment,
at the same time structuring the script internally for the maintainers.

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

The third of the basic sections, DESCRIPTION, is added separately.

Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Disliked-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/20220218181628.1411551-2-tomasz.warniello@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc