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

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

MAINTAINERS & files: Canonize the e-mails I use at files

2018-05-04T10:21:06Z

From now on, I'll start using my @kernel.org as my development e-mail. As such, let's remove the entries that point to the old mchehab@s-opensource.com at MAINTAINERS file. For the files written with a copyright with mchehab@s-opensource, let's keep Samsung on their names, using mchehab+samsung@kernel.org, in order to keep pointing to my employer, with sponsors the work. For the files written before I join Samsung (on July, 4 2013), let's just use mchehab@kernel.org. For bug reports, we can simply point to just kernel.org, as this will reach my mchehab+samsung inbox anyway. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Brian Warner Signed-off-by: Mauro Carvalho Chehab

doc-guide: kernel-doc: add comment about formatting verification

2018-02-23T15:06:15Z

Currently there is no automated checking for kernel-doc comments except running 'kernel-doc -v -none '. Mention the possibility to run kernel-doc to verify formatting of the comments in the kernel-doc guide. Signed-off-by: Mike Rapoport Signed-off-by: Jonathan Corbet

doc-guide: kernel-doc: add examples about nested union/structs

2018-02-18T23:55:10Z

It helps to give some examples about how to use in-line comments also when nested union/structs are present. So add it. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

doc-guide: kernel-doc: move in-line section to be after nested struct

2018-02-18T23:54:56Z

We want to give some examples about how to do in-line comments for nested structs. So, move it to be after nested structs/unions chapter. The section content was not changed on this patch. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

doc-guide: kernel-doc: fix example for inlined comments

2018-02-18T23:54:44Z

Without ending with a ";", kernel-doc doesn't recognize it as an struct, and it fails to parse the example. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet