linux.git/Documentation/sphinx/cdomain.py, branch for-next

docs: Raise the minimum Sphinx requirement to 2.4.4

2023-12-15T15:36:33+00:00

Commit 31abfdda6527 (docs: Deprecate use of Sphinx < 2.4.x) in 6.2 added a
warning that support for older versions of Sphinx would be going away.
There have been no complaints, so the time has come.  Raise the minimum
Sphinx version to 2.4.4 and clean out some compatibility code that we no
longer need.

Reviewed-by: Mauro Carvalho Chehab 
Link: https://lore.kernel.org/r/874jgs47fq.fsf@meer.lwn.net
Signed-off-by: Jonathan Corbet

Documentation/sphinx: Remove the repeated word "the" in comments.

2023-10-23T02:33:38+00:00

Remove the repeated word "the" in comments.

Signed-off-by: Charles Han 
Signed-off-by: Jonathan Corbet 
Message-ID: <20231018023046.30022-1-hanchunchao@inspur.com>

Documentation/sphinx: fix Python string escapes

2023-09-12T20:27:45+00:00

Python 3.6 introduced a DeprecationWarning for invalid escape sequences.
This is upgraded to a SyntaxWarning in Python 3.12, and will eventually
be a syntax error.

Fix these now to get ahead of it before it's an error.

Signed-off-by: Benjamin Gray 
Message-ID: <20230912060801.95533-3-bgray@linux.ibm.com>
Signed-off-by: Jonathan Corbet

Documentation: Fix typos

2023-08-18T17:29:03+00:00

Fix typos in Documentation.

Signed-off-by: Bjorn Helgaas 
Link: https://lore.kernel.org/r/20230814212822.193684-4-helgaas@kernel.org
Signed-off-by: Jonathan Corbet

Move our minimum Sphinx version to 1.7

2021-02-01T23:29:12+00:00

As promised, drop support for some ancient sphinx releases, along with a
lot of the cruft that was required to make that support work.

Signed-off-by: Jonathan Corbet

docs: cdomain.py: extend it to handle new Sphinx 3.x tags

2020-10-15T05:49:37+00:00

While most of the C domain parsing is done via kernel-doc,
some RST files use C domain tags directly.

While several of them can be removed for Sphinx < 3.0, due
to automarkup.py, and several others that could be
converted into kernel-doc markups, changes like that are
time-consuming, and may not fit all cases.

As we already have the cdomain.py for handing backward
compatibility with Sphinx versions below 3.0, let's
make it more complete, in order to cover any usage of the
newer tags outside kernel-doc.

This way, it should be feasible to use the new tags inside
the Kernel tree, without losing backward compatibility.

This should allow fixing the remaining warnings with
the Kernel tags.

Signed-off-by: Mauro Carvalho Chehab

docs: cdomain.py: add support for a new Sphinx 3.1+ tag

2020-10-15T05:49:37+00:00

Since Sphinx 3.0, the C domain code was rewritten, but only
after version 3.1 it got support for setting namespaces on
C domains, with is something that it is required, in order to
document system calls, like ioctl() and others.

As part of changing the documentation subsystem to properly
build with Sphinx 3.1+, add support for such new tag:

	.. c:namespace::"

Such tag optionally replaces the optional "name" tag for functions,
setting a single namespace domain for all C references found
at the file.

With that, it should be possible to convert existing
documentation to be compatible with both Sphinx 1.x/2.x and
3.1+.

Signed-off-by: Mauro Carvalho Chehab

docs: cdomain.py: get rid of a warning since version 1.8

2019-05-29T21:47:32+00:00

There's a new warning about a deprecation function. Add a
logic at cdomain.py to avoid that.

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

Use sphinx.version_info directly instead of parsing

2017-03-31T15:19:37+00:00

Using the development version of sphinx caused the parsing of the
version to fail.

Signed-off-by: Rémy Léone 
Signed-off-by: Jonathan Corbet

doc-rst:c-domain: function-like macros arguments

2016-09-16T15:53:40+00:00

Handle signatures of function-like macros well. Don't try to deduce
arguments types of function-like macros.

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