From: "Tomasz Warniełło" <tomasz.warniello@gmail.com>
To: corbet@lwn.net
Cc: "Tomasz Warniełło" <tomasz.warniello@gmail.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 06/15] scripts: kernel-doc: Transform documentation into POD (6/15)
Date: Mon, 3 Jan 2022 05:50:47 +0100 [thread overview]
Message-ID: <20220103045051.506526-1-tomasz.warniello@gmail.com> (raw)
Step 6) Translate the "Output format selection modifier" subsection
of OPTIONS
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
See step 1 for the series details.
Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com>
---
scripts/kernel-doc | 22 +++++++++++++++-------
1 file changed, 15 insertions(+), 7 deletions(-)
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 896c4775102d..d1a4d98726b3 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
--
2.30.2
next reply other threads:[~2022-01-03 4:51 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-03 4:50 Tomasz Warniełło [this message]
2022-01-03 4:50 ` [PATCH v2 07/15] scripts: kernel-doc: Transform documentation into POD (7/15) Tomasz Warniełło
2022-01-03 4:50 ` [PATCH v2 08/15] scripts: kernel-doc: Transform documentation into POD (8/15) Tomasz Warniełło
2022-01-03 4:50 ` [PATCH v2 09/15] scripts: kernel-doc: Transform documentation into POD (9/15) Tomasz Warniełło
2022-01-03 4:50 ` [PATCH v2 10/15] scripts: kernel-doc: Transform documentation into POD (10/15) Tomasz Warniełło
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220103045051.506526-1-tomasz.warniello@gmail.com \
--to=tomasz.warniello@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®