Add scripts/split-man.pl

Instead of asking the user to copy and paste a small perl script from
the documentation, just distribute the perl script in the scripts
directory.

Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 64ca081d075ee6c61a9472f7d787376541a5b42c..466347067f7901e163878b9463fcc91a1450d880 100644 (file)
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -528,32 +528,6 @@ How to use kernel-doc to generate man pages
 -------------------------------------------
 
 If you just want to use kernel-doc to generate man pages you can do this
-from the Kernel git tree::
+from the kernel git tree::
 
-  $ scripts/kernel-doc -man $(git grep -l '/\*\*' |grep -v Documentation/) | ./split-man.pl /tmp/man
-
-Using the small ``split-man.pl`` script below::
-
-
-  #!/usr/bin/perl
-
-  if ($#ARGV < 0) {
-     die "where do I put the results?\n";
-  }
-
-  mkdir $ARGV[0],0777;
-  $state = 0;
-  while (<STDIN>) {
-      if (/^\.TH \"[^\"]*\" 9 \"([^\"]*)\"/) {
-       if ($state == 1) { close OUT }
-       $state = 1;
-       $fn = "$ARGV[0]/$1.9";
-       print STDERR "Creating $fn\n";
-       open OUT, ">$fn" or die "can't open $fn: $!\n";
-       print OUT $_;
-      } elsif ($state != 0) {
-       print OUT $_;
-      }
-  }
-
-  close OUT;
+  $ scripts/kernel-doc -man $(git grep -l '/\*\*' -- :^Documentation :^tools) | scripts/split-man.pl /tmp/man

diff --git a/scripts/split-man.pl b/scripts/split-man.pl
new file mode 100755 (executable)
index 0000000..bfe16cb
--- /dev/null
+++ b/scripts/split-man.pl
@@ -0,0 +1,28 @@
+#!/usr/bin/perl
+# SPDX-License-Identifier: GPL-2.0
+#
+# Author: Mauro Carvalho Chehab <mchehab@s-opensource.com>
+#
+# Produce manpages from kernel-doc.
+# See Documentation/doc-guide/kernel-doc.rst for instructions
+
+if ($#ARGV < 0) {
+   die "where do I put the results?\n";
+}
+
+mkdir $ARGV[0],0777;
+$state = 0;
+while (<STDIN>) {
+    if (/^\.TH \"[^\"]*\" 9 \"([^\"]*)\"/) {
+       if ($state == 1) { close OUT }
+       $state = 1;
+       $fn = "$ARGV[0]/$1.9";
+       print STDERR "Creating $fn\n";
+       open OUT, ">$fn" or die "can't open $fn: $!\n";
+       print OUT $_;
+    } elsif ($state != 0) {
+       print OUT $_;
+    }
+}
+
+close OUT;