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.
Showing the changes to scripts/kernel-doc (1 of 1 file). Show all
Unified · Split
| @@ -16,6 +16,31 @@ use strict; · 15 unmodified lines | |||
| 16 | ## This software falls under the GNU General Public License. ## | 16 | ## This software falls under the GNU General Public License. ## |
| 17 | ## Please read the COPYING file for more information ## | 17 | ## Please read the COPYING file for more information ## |
| 18 | 18 | ||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | kernel-doc - Print formatted kernel documentation to stdout | ||
| 22 | |||
| 23 | =head1 SYNOPSIS | ||
| 24 | |||
| 25 | kernel-doc [-h] [-v] [-Werror] | ||
| 26 | [ -man | | ||
| 27 | -rst [-sphinx-version VERSION] [-enable-lineno] | | ||
| 28 | -none | ||
| 29 | ] | ||
| 30 | [ | ||
| 31 | -export | | ||
| 32 | -internal | | ||
| 33 | [-function NAME] ... | | ||
| 34 | [-nosymbol NAME] ... | ||
| 35 | ] | ||
| 36 | [-no-doc-sections] | ||
| 37 | [-export-file FILE] ... | ||
| 38 | FILE ... | ||
| 39 | |||
| 40 | Run `kernel-doc -h` for details. | ||
| 41 | |||
| 42 | =cut | ||
| 43 | |||
| 19 | # 18/01/2001 - Cleanups | 44 | # 18/01/2001 - Cleanups |
| 20 | # Functions prototyped as foo(void) same as foo() | 45 | # Functions prototyped as foo(void) same as foo() |
| 21 | # Stop eval'ing where we don't need to. | 46 | # Stop eval'ing where we don't need to. |