Skip to content
/ linux Public
forked from torvalds/linux

Commit

Permalink
scripts: kernel-doc: Translate the "Output selection modifiers" subse…
Browse files Browse the repository at this point in the history
…ction of OPTIONS

Aim: unified POD, user more satisfied, script better structured

A subsection "reStructuredText only" is added for -enable-lineno.

Other notes:
- paragraphing correction

Signed-off-by: Tomasz Warniełło <[email protected]>
Tested-by: Randy Dunlap <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Disliked-by: Akira Yokosawa <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
c362 authored and Jonathan Corbet committed Feb 24, 2022
1 parent 9c77f10 commit c15de5a
Showing 1 changed file with 29 additions and 8 deletions.
37 changes: 29 additions & 8 deletions scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,6 @@ sub usage {
my $message = <<"EOF";
Usage: $0 [OPTION ...] FILE ...
Output selection modifiers:
-no-doc-sections Do not output DOC: sections.
-enable-lineno Enable output of #define LINENO lines. Only works with
reStructuredText format.
-export-file FILE Specify an additional FILE in which to look for
EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
-export or -internal. May be specified multiple times.
Other parameters:
-v Verbose output, more warnings and other information.
-h Print this help.
Expand Down Expand Up @@ -2607,4 +2599,33 @@ May be specified multiple times.
=back
=head2 Output selection modifiers:
=over 8
=item -no-doc-sections
Do not output DOC: sections.
=item -export-file FILE
Specify an additional FILE in which to look for EXPORT_SYMBOL() and
EXPORT_SYMBOL_GPL().
To be used with -export or -internal.
May be specified multiple times.
=back
=head3 reStructuredText only
=over 8
=item -enable-lineno
Enable output of #define LINENO lines.
=back
=cut

0 comments on commit c15de5a

Please sign in to comment.