linux/Documentation/doc-guide, branch v5.2

docs: doc-guide: remove the extension from .rst files

2019-04-19T18:46:27Z

On almost all places, we're including ReST files without the extension. Let's remove the extension here as well, in order to use just one standard. Suggested-by: Jani Nikula Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

docs: kernel-doc: typo "if ... if" -> "if ... is"

2019-02-17T22:38:47Z

"If no *function* if specified" should instead be "If no *function* is specified". Reported-by: Matthew Wilcox Signed-off-by: Frank Rowand Signed-off-by: Jonathan Corbet

docs: kernel-doc: typo "documentaion"

2019-02-01T22:59:46Z

Fix a typo in kernel-doc.rst Signed-off-by: Frank Rowand Signed-off-by: Jonathan Corbet

docs: kernel-doc: update commands to generate man page

2019-02-01T22:59:02Z

(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 Signed-off-by: Jonathan Corbet

docs-rst: doc-guide: Minor grammar fixes

2019-01-15T00:36:53Z

While using this guide to learn the new documentation method, I saw a few phrases that I felt could be improved. These small changes improve the grammar and choice of words to further enhance the installation instructions. Signed-off-by: Joel Nider Acked-by: Mike Rapoport Acked-by: Matthew Wilcox Signed-off-by: Jonathan Corbet

doc:process: add links where missing

2018-12-06T17:21:19Z

Some documents are refering to others without links. With this patch I add those missing links. This patch affects only documents under process/ and labels where necessary. Signed-off-by: Federico Vaga Signed-off-by: Jonathan Corbet

doc-guide:kernel-doc.rst: Reference to foobar

2018-11-07T22:31:51Z

In the Function documentation Section of kernel-doc.rst there is a function_name() function as an example for how to make a comment about a function. But at the end of that example there is a reference to foobar instead of function_name. I think that should rather be function_name, because that was the placeholder the whole example was using. Signed-off-by: Joris Gutjahr Signed-off-by: Jonathan Corbet

Documentation/sphinx: allow "functions" with no parameters

2018-06-30T13:52:42Z

When kernel-doc:: specified in .rst document without explicit directives, it outputs both comment and DOC: sections. If a DOC: section was explicitly included in the same document it will be duplicated. For example, the output generated for Documentation/core-api/idr.rst [1] has "IDA description" in the "IDA usage" section and in the middle of the API reference. This patch enables using "functions" directive without parameters to output all the documentation excluding DOC: sections. [1] https://www.kernel.org/doc/html/v4.17/core-api/idr.html Signed-off-by: Mike Rapoport Acked-by: Matthew Wilcox Signed-off-by: Jonathan Corbet

doc:sphinx: fix parse-header description

2018-06-26T15:07:57Z

The description speaks about the option ``--man`` but it does not exist. Instead, there is the option ``--usage`` $ ./Documentation/sphinx/parse-headers.pl --man Unknown option: man Usage: parse_headers.pl [] [] Where can be: --debug, --help or --man. Signed-off-by: Federico Vaga Signed-off-by: Jonathan Corbet

doc:doc-guide: fix a typo and an error

2018-06-26T15:07:25Z

Fix a typo in sphinx.rst and a minor error in parse-header.rst Signed-off-by: Federico Vaga Signed-off-by: Jonathan Corbet