Step 1) Add the NAME section You can see the POD with: $ perldoc scripts/kernel-doc = Series explanation = This series transforms the free-form general comments - mainly the usage instructions and the meta information - into the standard Perl documentation format. Some of the original text is reduced out. The transformation includes language, paragraphing and editorial corrections. The only change in the script execution flow is the replacement of the 'usage' function with the native core Perl 'pod2usage'. The TODO suggestion to write POD found in the script is ancient, thus I can't address its author with a "Suggested-by" tag. The process consists of 15 steps. 1) Add the NAME section 2) Add the SYNOPSIS section 3) Relink argument parsing error handling to pod2usage The following subseries is disfunctional before its last part. 4) Translate the DESCRIPTION section 5) Translate the "Output format selection" subsection of OPTIONS 6) Translate the "Output format selection modifier" subsection of OPTIONS 7) Translate the "Output selection" subsection of OPTIONS 8) Translate the "Output selection modifiers" subsection of OPTIONS 9) Translate the "Other parameters" subsection of OPTIONS 10) Replace the usage function Here the DESCRIPTION and OPTIONS subseries is finished. The -h and -help parameters are handled by POD now. 11) Remove the "format of comments" comment block 12) Archive the pre-git museum 13) License cleanup 14) Refresh the copyright lines 15) Move the TODOs Signed-off-by: Tomasz Warniełło <tomasz.warniello@xxxxxxxxx> --- scripts/kernel-doc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 3106b7536b89..46d3e779bf5d 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -16,6 +16,12 @@ use strict; ## This software falls under the GNU General Public License. ## ## Please read the COPYING file for more information ## +=head1 NAME + +kernel-doc - Print formatted kernel documentation to stdout + +=cut + # 18/01/2001 - Cleanups # Functions prototyped as foo(void) same as foo() # Stop eval'ing where we don't need to. base-commit: 2a987e65025e2b79c6d453b78cb5985ac6e5eb26 -- 2.30.2
