mirror of https://lore.kernel.org/lkml/
 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 v4 02/11] scripts: kernel-doc: Relink argument parsing error handling to pod2usage
Date: Fri, 18 Feb 2022 19:16:19 +0100	[thread overview]
Message-ID: <20220218181628.1411551-3-tomasz.warniello@gmail.com> (raw)
In-Reply-To: <20220218181628.1411551-1-tomasz.warniello@gmail.com>

The former usage function is substituted, although not as the -h and -help
parameter handler yet.

Purpose: Use Pod::Usage to handle documentation printing in an integrated
way.

Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com>
---

If the indentation is still wrong, please state, what you expect exactly.
To me the style in the script is random or eclectic.
---
 scripts/kernel-doc | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index c8fbf1d3d5aa..e7f7251771bb 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -16,6 +16,8 @@ use strict;
 ## This software falls under the GNU General Public License.     ##
 ## Please read the COPYING file for more information             ##
 
+use Pod::Usage qw/pod2usage/;
+
 =head1 NAME
 
 kernel-doc - Print formatted kernel documentation to stdout
@@ -298,7 +300,13 @@ my $blankline_rst = "\n";
 
 # read arguments
 if ($#ARGV == -1) {
-    usage();
+	pod2usage(
+		-message => "No arguments!\n",
+		-exitval => 1,
+		-verbose => 99,
+		-sections => 'SYNOPSIS',
+		-output => \*STDERR,
+	);
 }
 
 my $kernelversion;
@@ -518,8 +526,14 @@ while ($ARGV[0] =~ m/^--?(.*)/) {
 	    die "Sphinx version should either major.minor or major.minor.patch format\n";
 	}
     } else {
-	# Unknown argument
-        usage();
+		# Unknown argument
+		pod2usage(
+			-message => "Argument unknown!\n",
+			-exitval => 1,
+			-verbose => 99,
+			-sections => 'SYNOPSIS',
+			-output => \*STDERR,
+		);
     }
 }
 
-- 
2.30.2


  parent reply	other threads:[~2022-02-18 18:16 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 ` Tomasz Warniełło [this message]
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 ` [PATCH v4 06/11] scripts: kernel-doc: Translate the "Output selection" " Tomasz Warniełło
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-3-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®