* [PATCH] docs: kernel-doc: update commands to generate man page
@ 2019-02-01 21:54 frowand.list
2019-02-01 22:59 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: frowand.list @ 2019-02-01 21:54 UTC (permalink / raw)
To: Jonathan Corbet, Matthew Wilcox
Cc: Mauro Carvalho Chehab, Mike Rapoport, Joris Gutjahr, linux-doc,
linux-kernel
From: Frank Rowand <frank.rowand@sony.com>
(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>
---
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 <frank.rowand@sony.com>
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: kernel-doc: update commands to generate man page
2019-02-01 21:54 [PATCH] docs: kernel-doc: update commands to generate man page frowand.list
@ 2019-02-01 22:59 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2019-02-01 22:59 UTC (permalink / raw)
To: frowand.list
Cc: Matthew Wilcox, Mauro Carvalho Chehab, Mike Rapoport,
Joris Gutjahr, linux-doc, linux-kernel
On Fri, 1 Feb 2019 13:54:39 -0800
frowand.list@gmail.com 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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-02-01 22:59 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-02-01 21:54 [PATCH] docs: kernel-doc: update commands to generate man page frowand.list
2019-02-01 22:59 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).