2019-02-01 21:56:48

by Frank Rowand

Subject: [PATCH] docs: kernel-doc: update commands to generate man page

From: Frank Rowand <[email protected]>

(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 <[email protected]>
---
Documentation/doc-guide/kernel-doc.rst | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)

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
--
Frank Rowand <[email protected]>

2019-02-01 23:00:17

by Jonathan Corbet

Subject: Re: [PATCH] docs: kernel-doc: update commands to generate man page

On Fri, 1 Feb 2019 13:54:39 -0800
[email protected] wrote:

> (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.

Applied, thanks.

(Though it would sure be nice if we could document which versions of the
syntax should be used with which versions of git...:)

jon