summaryrefslogtreecommitdiffstats
path: root/Documentation/sphinx
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-11-30 08:00:20 -0200
committerJonathan Corbet <corbet@lwn.net>2016-11-30 17:08:09 -0700
commitc3396656666c2c98db306dc91c480d9fbde35cc9 (patch)
tree1781dbbb72dd7425a124f8e4205a5a9e42df81fe /Documentation/sphinx
parent293fbd4fefec92f5d8e7d8256f9228a9aaf99070 (diff)
downloadlinux-c3396656666c2c98db306dc91c480d9fbde35cc9.tar.gz
linux-c3396656666c2c98db306dc91c480d9fbde35cc9.tar.bz2
linux-c3396656666c2c98db306dc91c480d9fbde35cc9.zip
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/sphinx')
-rwxr-xr-xDocumentation/sphinx/parse-headers.pl116
1 files changed, 9 insertions, 107 deletions
diff --git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index 20dbdf55c71e..a958d8b5e99d 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -10,8 +10,8 @@ my $man;
GetOptions(
"debug" => \$debug,
- 'help|?' => \$help,
- man => \$man
+ 'usage|?' => \$help,
+ 'help' => \$man
) or pod2usage(2);
pod2usage(1) if $help;
@@ -354,13 +354,13 @@ Where <options> can be: --debug, --help or --man.
Put the script in verbose mode, useful for debugging.
-=item B<--help>
+=item B<--usage>
Prints a brief help message and exits.
-=item B<--man>
+=item B<--help>
-Prints the manual page and exits.
+Prints a more detailed help message and exits.
=back
@@ -379,109 +379,11 @@ enums and enum symbols and create cross-references for all of them.
It is also capable of distinguish #define used for specifying a Linux
ioctl.
-The EXCEPTIONS_FILE contain two types of statements: B<ignore> or B<replace>.
-
-The syntax for the ignore tag is:
-
-=over 8
-
-ignore B<type> B<name>
-
-=back
-
-The B<ignore> means that it won't generate cross references for a
-B<name> symbol of type B<type>.
-
-The syntax for the replace tag is:
-
-=over 8
-
-replace B<type> B<name> B<new_value>
-
-=back
-
-The B<replace> means that it will generate cross references for a
-B<name> symbol of type B<type>, but, instead of using the default
-replacement rule, it will use B<new_value>.
-
-For both statements, B<type> can be either one of the following:
-
-=over 8
-
-=item B<ioctl>
-
-The ignore or replace statement will apply to ioctl definitions like:
-
-#define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
-
-=item B<define>
-
-The ignore or replace statement will apply to any other #define found
-at C_FILE.
-
-=item B<typedef>
-
-The ignore or replace statement will apply to typedef statements at C_FILE.
-
-=item B<struct>
-
-The ignore or replace statement will apply to the name of struct statements
-at C_FILE.
-
-=item B<enum>
-
-The ignore or replace statement will apply to the name of enum statements
-at C_FILE.
+The EXCEPTIONS_FILE contain two rules to allow ignoring a symbol or
+to replace the default references by a custom one.
-=item B<symbol>
-
-The ignore or replace statement will apply to the name of enum statements
-at C_FILE.
-
-
-For replace statements, B<new_value> will automatically use :c:type:
-references for B<typedef>, B<enum> and B<struct> types. It will use :ref:
-for B<ioctl>, B<define> and B<symbol> types. The type of reference can
-also be explicitly defined at the replace statement.
-
-=back
-
-=head1 EXAMPLES
-
-ignore define _VIDEODEV2_H
-
-=over 8
-
-
-Ignore a #define _VIDEODEV2_H at the C_FILE.
-
-=back
-
-ignore symbol PRIVATE
-
-=over 8
-
-On a struct like:
-
-enum foo { BAR1, BAR2, PRIVATE };
-
-It won't generate cross-references for B<PRIVATE>.
-
-=back
-
-replace symbol BAR1 :c:type:`foo`
-replace symbol BAR2 :c:type:`foo`
-
-=over 8
-
-On a struct like:
-
-enum foo { BAR1, BAR2, PRIVATE };
-
-It will make the BAR1 and BAR2 enum symbols to cross reference the foo
-symbol at the C domain.
-
-=back
+Please read Documentation/doc-guide/parse-headers.rst at the Kernel's
+tree for more details.
=head1 BUGS