diff options
| author | Matthew Wilcox <mawilcox@microsoft.com> | 2018-02-14 00:15:35 +0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2018-02-14 00:21:52 +0300 |
| commit | 5b229fbec89b90f73d1829e022163d9b896dc94c (patch) | |
| tree | 07f60b861b370a38879cd3ba0681c0d775d99fd6 /Documentation/doc-guide | |
| parent | dcb50d979ecc80e1f2d90acb7734d7bcd0e44672 (diff) | |
| download | linux-5b229fbec89b90f73d1829e022163d9b896dc94c.tar.xz | |
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>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 30 |
1 files changed, 2 insertions, 28 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 64ca081d075e..466347067f79 100644 --- 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 |