diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-11-30 08:00:20 -0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-11-30 17:08:09 -0700 |
| commit | c3396656666c2c98db306dc91c480d9fbde35cc9 (patch) | |
| tree | 1781dbbb72dd7425a124f8e4205a5a9e42df81fe /Documentation/doc-guide | |
| parent | 293fbd4fefec92f5d8e7d8256f9228a9aaf99070 (diff) | |
| download | op-kernel-dev-c3396656666c2c98db306dc91c480d9fbde35cc9.zip op-kernel-dev-c3396656666c2c98db306dc91c480d9fbde35cc9.tar.gz | |
docs-rst: parse-headers.pl: cleanup the documentation
Keeping both rst and in-file documentation in sync can be harsh.
So, simplify the script's internal documntation to a bare minimum,
and add a mention to the ReST file with its full documentation.
This way, a quick help is still available at the command line,
while the complete one is maintained at the ReST format.
As we won't be using pad2rst anymore, do a cleanup at the ReST
file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/parse-headers.rst | 22 |
1 files changed, 3 insertions, 19 deletions
diff --git a/Documentation/doc-guide/parse-headers.rst b/Documentation/doc-guide/parse-headers.rst index 615e25e..96a0423 100644 --- a/Documentation/doc-guide/parse-headers.rst +++ b/Documentation/doc-guide/parse-headers.rst @@ -18,13 +18,6 @@ about how to use it inside the Kernel tree. parse_headers.pl ^^^^^^^^^^^^^^^^ -.. NOTE: the man pages below were generated using pod2rst tool: -.. http://search.cpan.org/~dowens/Pod-POM-View-Restructured-0.02/bin/pod2rst -.. If you need to change anything below this point, please do the changes -.. at parse-headers.pl directly, re-run the script and paste the output of -.. the script here. - -**** NAME **** @@ -33,7 +26,6 @@ parse_headers.pl - parse a C file, in order to identify functions, structs, enums and defines and create cross-references to a Sphinx book. -******** SYNOPSIS ******** @@ -43,7 +35,6 @@ SYNOPSIS Where <options> can be: --debug, --help or --man. -******* OPTIONS ******* @@ -55,20 +46,17 @@ OPTIONS -\ **--help**\ +\ **--usage**\ Prints a brief help message and exits. -\ **--man**\ - - Prints the manual page and exits. - +\ **--help**\ + Prints a more detailed help message and exits. -*********** DESCRIPTION *********** @@ -155,8 +143,6 @@ For both statements, \ **type**\ can be either one of the following: - -******** EXAMPLES ******** @@ -187,7 +173,6 @@ It will make the BAR1 and BAR2 enum symbols to cross reference the foo symbol at the C domain. -**** BUGS **** @@ -195,7 +180,6 @@ BUGS Report bugs to Mauro Carvalho Chehab <mchehab@s-opensource.com> -********* COPYRIGHT ********* |
