summaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorTomasz Warniełło <tomasz.warniello@gmail.com>2022-02-18 19:16:22 +0100
committerJonathan Corbet <corbet@lwn.net>2022-02-24 10:52:46 -0700
commitdd803b04b0a0af16e43c2af1a3e67d7ce8e1f899 (patch)
tree8b3bb6e3b099d552d4c868377a56ed5eaae01bd1 /scripts
parent2875f78708219feadf0956dcf9e936ec25fb7a8b (diff)
downloadlinux-dd803b04b0a0af16e43c2af1a3e67d7ce8e1f899.tar.bz2
scripts: kernel-doc: Translate the "Output format selection modifier" subsection of OPTIONS
Aim: unified POD, user more happy This section is renamed to "Output format modifiers" to make it simple. To make it even more simple, a subsection is added: "reStructuredText only". Other notes: - paragraphing correction - article correction Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com> Tested-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Randy Dunlap <rdunlap@infradead.org> Disliked-by: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/20220218181628.1411551-6-tomasz.warniello@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts')
-rwxr-xr-xscripts/kernel-doc22
1 files changed, 15 insertions, 7 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 18eca172c4b5..b926faa16b00 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -83,13 +83,6 @@ sub usage {
my $message = <<"EOF";
Usage: $0 [OPTION ...] FILE ...
-Output format selection modifier (affects only ReST output):
-
- -sphinx-version Use the ReST C domain dialect compatible with an
- specific Sphinx Version.
- If not specified, kernel-doc will auto-detect using
- the sphinx-build version found on PATH.
-
Output selection (mutually exclusive):
-export Only output documentation for symbols that have been
exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
@@ -2583,4 +2576,19 @@ Do not output documentation, only warnings.
=back
+=head2 Output format modifiers
+
+=head3 reStructuredText only
+
+=over 8
+
+=item -sphinx-version VERSION
+
+Use the ReST C domain dialect compatible with a specific Sphinx Version.
+
+If not specified, kernel-doc will auto-detect using the sphinx-build version
+found on PATH.
+
+=back
+
=cut