Messages in this thread Patch in this message | | | From | Tomasz Warniełło <> | Subject | [PATCH v2 02/15] scripts: kernel-doc: Transform documentation into POD (2/15) | Date | Mon, 3 Jan 2022 05:43:35 +0100 |
| |
Step 2) Add the SYNOPSIS section
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).
See step 1 for the series details.
Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com> --- scripts/kernel-doc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 46d3e779bf5d..c8fbf1d3d5aa 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -20,6 +20,25 @@ use strict; kernel-doc - Print formatted kernel documentation to stdout +=head1 SYNOPSIS + + kernel-doc [-h] [-v] [-Werror] + [ -man | + -rst [-sphinx-version VERSION] [-enable-lineno] | + -none + ] + [ + -export | + -internal | + [-function NAME] ... | + [-nosymbol NAME] ... + ] + [-no-doc-sections] + [-export-file FILE] ... + FILE ... + +Run `kernel-doc -h` for details. + =cut # 18/01/2001 - Cleanups -- 2.30.2
| |