scripts: kernel-doc: Replace the usage function
authorTomasz Warniełło <tomasz.warniello@gmail.com>
Fri, 18 Feb 2022 18:16:26 +0000 (19:16 +0100)
committerJonathan Corbet <corbet@lwn.net>
Thu, 24 Feb 2022 17:52:46 +0000 (10:52 -0700)
Aim: unified POD, user more satisfied, script better structured

You can see the results with:

$ scripts/kernel-doc -help

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-10-tomasz.warniello@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc

index 4a26a74..d7ca487 100755 (executable)
@@ -79,15 +79,6 @@ See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
 # 25/07/2012 - Added support for HTML5
 # -- Dan Luedtke <mail@danrl.de>
 
-sub usage {
-    my $message = <<"EOF";
-Usage: $0 [OPTION ...] FILE ...
-
-EOF
-    print $message;
-    exit 1;
-}
-
 #
 # format of comments.
 # In the following table, (...)? signifies optional structure.
@@ -468,7 +459,7 @@ while ($ARGV[0] =~ m/^--?(.*)/) {
     } elsif ($cmd eq "Werror") {
        $Werror = 1;
     } elsif (($cmd eq "h") || ($cmd eq "help")) {
-       usage();
+               pod2usage(-exitval => 0, -verbose => 2);
     } elsif ($cmd eq 'no-doc-sections') {
            $no_doc_sections = 1;
     } elsif ($cmd eq 'enable-lineno') {