linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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 v3 07/15] scripts: kernel-doc: Translate the "Output selection" subsection of OPTIONS
Date: Tue,  4 Jan 2022 02:59:38 +0100	[thread overview]
Message-ID: <20220104015946.529524-8-tomasz.warniello@gmail.com> (raw)
In-Reply-To: <20220104015946.529524-1-tomasz.warniello@gmail.com>

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

* Transform documentation into POD (7/15)
See step 1 for the series details.

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 f26966dd8bde..629ba514db5d 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


  parent reply	other threads:[~2022-01-04  2:00 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-04  1:59 [PATCH v3 00/15] Transform documentation into POD Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 01/15] scripts: kernel-doc: Add the NAME section Tomasz Warniełło
2022-02-16 23:18   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 02/15] scripts: kernel-doc: Add the SYNOPSIS section Tomasz Warniełło
2022-02-16 23:19   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 03/15] scripts: kernel-doc: Relink argument parsing error handling to pod2usage Tomasz Warniełło
2022-02-16 23:21   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 04/15] scripts: kernel-doc: Translate the DESCRIPTION section Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 05/15] scripts: kernel-doc: Translate the "Output format selection" subsection of OPTIONS Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 06/15] scripts: kernel-doc: Translate the "Output format selection modifier" " Tomasz Warniełło
2022-01-04  1:59 ` Tomasz Warniełło [this message]
2022-01-04  1:59 ` [PATCH v3 08/15] scripts: kernel-doc: Translate the "Output selection modifiers" " Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 09/15] scripts: kernel-doc: Translate the "Other parameters" " Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 10/15] scripts: kernel-doc: Replace the usage function Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 11/15] scripts: kernel-doc: Remove the "format of comments" comment block Tomasz Warniełło
2022-02-16 23:26   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 12/15] scripts: kernel-doc: Archive the pre-git museum Tomasz Warniełło
2022-02-16 23:29   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 13/15] scripts: kernel-doc: License cleanup Tomasz Warniełło
2022-01-04  1:59 ` [PATCH v3 14/15] scripts: kernel-doc: Refresh the copyright lines Tomasz Warniełło
2022-02-16 23:34   ` Jonathan Corbet
2022-01-04  1:59 ` [PATCH v3 15/15] scripts: kernel-doc: Move the TODOs Tomasz Warniełło
2022-02-16 23:34   ` Jonathan Corbet
2022-01-13  6:41 ` [PATCH v3 00/15] Transform documentation into POD Tomasz Warniełło
2022-01-13 16:19   ` Jonathan Corbet
2022-02-16 23:14 ` Jonathan Corbet

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=20220104015946.529524-8-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;
as well as URLs for NNTP newsgroup(s).