linux-toradex.git/Documentation/sphinx, branch v4.19-rc5

Documentation/sphinx: allow "functions" with no parameters

2018-06-30T13:52:42+00:00

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:57+00:00

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

Documentation: rstFlatTable.py: fix a broken reference

2018-06-15T21:10:01+00:00

The old HOWTO was removed a long time ago. The flat table
version is not metioned elsewhere, so just get rid of the
text.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Jonathan Corbet

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

2018-05-04T10:21:06+00:00

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

Documentation/sphinx: Fix Directive import error

2018-03-09T17:46:14+00:00

Sphinx 1.7 removed sphinx.util.compat.Directive so people
who have upgraded cannot build the documentation.  Switch to
docutils.parsers.rst.Directive which has been available since
docutils 0.5 released in 2009.

Bugzilla: https://bugzilla.opensuse.org/show_bug.cgi?id=1083694
Co-developed-by: Takashi Iwai 
Acked-by: Jani Nikula 
Cc: stable@vger.kernel.org
Signed-off-by: Matthew Wilcox 
Signed-off-by: Jonathan Corbet

linux-next: docs-rst: Fix typos in kfigure.py

2018-01-17T23:49:05+00:00

This patch fixes some spelling typos found in kfigure.py

Signed-off-by: Masanari Iida 
Signed-off-by: Jonathan Corbet

Documentation/sphinx: fix kernel-doc decode for non-utf-8 locale

2017-08-31T19:36:28+00:00

On python3, Popen() universal_newlines=True converts the subprocess
stdout to unicode text using a codec based on user preferences. Given
LANG indicating ascii and utf-8 stdout from the subprocess, you'd get:

WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno
../drivers/media/dvb-core/demux.h' processing failed with: 'ascii' codec can't
decode byte 0xe2 in position 6368: ordinal not in range(128)

Fix this by dropping universal_newlines=True and replacing the implicit
LANG specific decode with an explicit utf-8 decode. This also gets rid
of the annoying conditional code for python 2 vs. 3.

Fixes: ba3501859354 ("Documentation/sphinx: fix kernel-doc extension on python3")
Reference: http://mid.mail-archive.com/54c23e8e-89c0-5cea-0dcc-e938952c5642@infradead.org
Reported-and-tested-by: Randy Dunlap 
Cc: Jonathan Corbet 
Cc: Mauro Carvalho Chehab 
Signed-off-by: Jani Nikula 
Signed-off-by: Jonathan Corbet

sphinx-pre-install: use a requirements file

2017-07-23T21:51:24+00:00

Instead of using 3 commands to install a virtualenv, use
a single one, reading the requirements from this file:

	Documentation/sphinx/requirements.txt

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

Docs: clean up some DocBook loose ends

2017-06-23T20:17:38+00:00

There were a few bits and pieces left over from the now-disused DocBook
toolchain; git rid of them.

Reported-by: Markus Heiser 
Signed-off-by: Jonathan Corbet

docs-rst: get rid of Documentation/sphinx/tmplcvt script

2017-05-16T11:44:24+00:00

As everything was converted to ReST, we don't need this
script anymore.

Signed-off-by: Mauro Carvalho Chehab