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

kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'

2019-11-07T20:17:25Z

The 'functions' directive is not only for functions, but also works for structs/unions. So the name is misleading. This patch renames it to 'identifiers', which specific the functions/types to be included in documentation. We keep the old name as an alias of the new one before all documentation are updated. Signed-off-by: Changbin Du Signed-off-by: Jonathan Corbet

docs: remove extra conf.py files

2019-07-17T09:57:52Z

Now that the latex_documents are handled automatically, we can remove those extra conf.py files. Signed-off-by: Mauro Carvalho Chehab

Doc : doc-guide : Fix a typo

2019-06-28T15:04:14Z

fix the disjunction by replacing "of" with "or". Signed-off-by: Sheriff Esseson Signed-off-by: Jonathan Corbet

docs: Note that :c:func: should no longer be used

2019-06-26T17:20:21Z

Now that we can mark up function() automatically, there is no reason to use :c:func: and every reason to avoid it. Adjust the documentation to reflect that fact. Signed-off-by: Jonathan Corbet

sphinx.rst: Add note about code snippets embedded in the text

2019-06-14T20:43:02Z

There's a paragraph that explains how to create fixed width text block, but it doesn't explains how to create fixed width text inline, although this feature is really used through the documentation. Fix that adding a quick note about it. Signed-off-by: André Almeida Signed-off-by: Jonathan Corbet

docs: requirements.txt: recommend Sphinx 1.7.9

2019-05-30T16:42:05Z

As discussed at the linux-doc ML, while we'll still support version 1.3, it is time to recommend a more modern version. So, let's switch the minimal requirements to Sphinx 1.7.9, as it has the "-jauto" flag, with makes a lot faster when building documentation. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

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