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 v4 06/11] scripts: kernel-doc: Translate the "Output selection" subsection of OPTIONS
Date: Fri, 18 Feb 2022 19:16:23 +0100 [thread overview]
Message-ID: <20220218181628.1411551-7-tomasz.warniello@gmail.com> (raw)
In-Reply-To: <20220218181628.1411551-1-tomasz.warniello@gmail.com>
Aim: unified POD, user more satisfied, script better structured
The plurals in -function and -nosymbol are corrected to singulars.
That's how the script works now. I think this describes the syntax better.
The plurar suggests multiple FILE arguments might be possible. So this
seems more coherent.
Other notes:
- paragraphing correction
- article correction
Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com>
---
scripts/kernel-doc | 42 +++++++++++++++++++++++++++++-------------
1 file changed, 29 insertions(+), 13 deletions(-)
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index b926faa16b00..e49cdb307a35 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -83,19 +83,6 @@ sub usage {
my $message = <<"EOF";
Usage: $0 [OPTION ...] FILE ...
-Output selection (mutually exclusive):
- -export Only output documentation for symbols that have been
- exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
- in any input FILE or -export-file FILE.
- -internal Only output documentation for symbols that have NOT been
- exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
- in any input FILE or -export-file FILE.
- -function NAME Only output documentation for the given function(s)
- or DOC: section title(s). All other functions and DOC:
- sections are ignored. May be specified multiple times.
- -nosymbol NAME Exclude the specified symbols from the output
- documentation. May be specified multiple times.
-
Output selection modifiers:
-no-doc-sections Do not output DOC: sections.
-enable-lineno Enable output of #define LINENO lines. Only works with
@@ -2591,4 +2578,33 @@ found on PATH.
=back
+=head2 Output selection (mutually exclusive):
+
+=over 8
+
+=item -export
+
+Only output documentation for the symbols that have been exported using
+EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() in any input FILE or -export-file FILE.
+
+=item -internal
+
+Only output documentation for the symbols that have NOT been exported using
+EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() in any input FILE or -export-file FILE.
+
+=item -function NAME
+
+Only output documentation for the given function or DOC: section title.
+All other functions and DOC: sections are ignored.
+
+May be specified multiple times.
+
+=item -nosymbol NAME
+
+Exclude the specified symbol from the output documentation.
+
+May be specified multiple times.
+
+=back
+
=cut
--
2.30.2
next prev parent reply other threads:[~2022-02-18 18:17 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-18 18:16 [PATCH v4 00/11] Transform documentation into POD Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 01/11] scripts: kernel-doc: Add the basic POD sections Tomasz Warniełło
2022-02-22 6:10 ` Randy Dunlap
2022-02-22 21:27 ` Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 02/11] scripts: kernel-doc: Relink argument parsing error handling to pod2usage Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 03/11] scripts: kernel-doc: Translate the DESCRIPTION section Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 04/11] scripts: kernel-doc: Translate the "Output format selection" subsection of OPTIONS Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 05/11] scripts: kernel-doc: Translate the "Output format selection modifier" " Tomasz Warniełło
2022-02-18 18:16 ` Tomasz Warniełło [this message]
2022-02-18 18:16 ` [PATCH v4 07/11] scripts: kernel-doc: Translate the "Output selection modifiers" " Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 08/11] scripts: kernel-doc: Translate the "Other parameters" " Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 09/11] scripts: kernel-doc: Replace the usage function Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 10/11] scripts: kernel-doc: Drop obsolete comments Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 11/11] scripts: kernel-doc: Refresh the copyright lines Tomasz Warniełło
2022-02-22 5:39 ` [PATCH v4 00/11] Transform documentation into POD Randy Dunlap
2022-02-22 21:31 ` Randy Dunlap
2022-02-23 3:08 ` Akira Yokosawa
2022-02-23 3:17 ` Akira Yokosawa
2022-02-23 12:55 ` Tomasz Warniełło
2022-02-23 13:16 ` Akira Yokosawa
2022-02-23 14:04 ` Tomasz Warniełło
2022-02-24 18:42 ` Jonathan Corbet
2022-02-24 22:04 ` 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=20220218181628.1411551-7-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®