diff options
| author |   Frank Rowand <frank.rowand@sony.com> | 2019-02-01 13:54:39 -0800 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2019-02-01 15:59:02 -0700 |
| commit | 7d1179f0dbcd88dea67bdf3d69c93ab39750bbbb (patch) | |
| tree | 6d7029e7076b0bac9ef11cf40d3046e91718accf /Documentation/doc-guide | |
| parent | Documentation: DMA-API: fix two typos (diff) | |
| download | wireguard-linux-7d1179f0dbcd88dea67bdf3d69c93ab39750bbbb.tar.xz wireguard-linux-7d1179f0dbcd88dea67bdf3d69c93ab39750bbbb.zip | |
docs: kernel-doc: update commands to generate man page
(1) The command to generate man pages is truncated in the pdf version
of the document. Reformat the command into multiple lines to prevent
the truncation.
(2) Older versions of git do not support all variants of pathspec
syntax. Provide commands to generate man pages for various
alternate syntax.
Signed-off-by: Frank Rowand <frank.rowand@sony.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 51be62aa4385..450ac634e92e 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -517,4 +517,17 @@ 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:: - $ scripts/kernel-doc -man $(git grep -l '/\*\*' -- :^Documentation :^tools) | scripts/split-man.pl /tmp/man + $ scripts/kernel-doc -man \ + $(git grep -l '/\*\*' -- :^Documentation :^tools) \ + | scripts/split-man.pl /tmp/man + +Some older versions of git do not support some of the variants of syntax for +path exclusion. One of the following commands may work for those versions:: + + $ scripts/kernel-doc -man \ + $(git grep -l '/\*\*' -- . ':!Documentation' ':!tools') \ + | scripts/split-man.pl /tmp/man + + $ scripts/kernel-doc -man \ + $(git grep -l '/\*\*' -- . ":(exclude)Documentation" ":(exclude)tools") \ + | scripts/split-man.pl /tmp/man |