linux-stable.git/Documentation/sphinx, branch v6.7.4

docs: kernel_abi.py: fix command injection

2024-02-01T00:21:00+00:00

commit 3231dd5862779c2e15633c96133a53205ad660ce upstream.

The kernel-abi directive passes its argument straight to the shell.
This is unfortunate and unnecessary.

Let's always use paths relative to $srctree/Documentation/ and use
subprocess.check_call() instead of subprocess.Popen(shell=True).

This also makes the code shorter.

Link: https://fosstodon.org/@jani/111676532203641247
Reported-by: Jani Nikula 
Cc: stable@vger.kernel.org
Signed-off-by: Vegard Nossum 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20231231235959.3342928-2-vegard.nossum@oracle.com
Signed-off-by: Greg Kroah-Hartman

docs: kernel_feat.py: fix potential command injection

2024-01-20T10:53:02+00:00

commit c48a7c44a1d02516309015b6134c9bb982e17008 upstream.

The kernel-feat directive passes its argument straight to the shell.
This is unfortunate and unnecessary.

Let's always use paths relative to $srctree/Documentation/ and use
subprocess.check_call() instead of subprocess.Popen(shell=True).

This also makes the code shorter.

This is analogous to commit 3231dd586277 ("docs: kernel_abi.py: fix
command injection") where we did exactly the same thing for
kernel_abi.py, somehow I completely missed this one.

Link: https://fosstodon.org/@jani/111676532203641247
Reported-by: Jani Nikula 
Signed-off-by: Vegard Nossum 
Cc: stable@vger.kernel.org
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20240110174758.3680506-1-vegard.nossum@oracle.com
Signed-off-by: Greg Kroah-Hartman

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>

docs/sphinx: Explicitly convert Sphinx paths to str

2023-10-10T19:35:54+00:00

Sphinx 7.2+ is switching to using pathlib.Path
instead of str to represent paths. This fixes the
current deprecation warnings and eventual breakage.
This conversion will be a no-op when using older
Sphinx versions.

Signed-off-by: Oliver Faso 
Tested-by: Akira Yokosawa 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20230910040811.53046-1-erer1243@gmail.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

docs: Use HTML comments for the kernel-toc SPDX line

2023-02-16T23:06:44+00:00

This line was initially placed in {# jinja2 comments #}, but that led to an
"invalid token" complaint from spdxcheck.py.  Rather than fix the script
for a usage we'll likely never see anywhere else, just switch to an HTML
comment, which spdxcheck.py thinks is fine.

Signed-off-by: Jonathan Corbet

docs: Add more information to the HTML sidebar

2023-02-08T20:28:27+00:00

Add a new sidebar template that creates a more RTD-like "fisheye" view of
the current place in the document hierarchy.  It is far from ideal, but
some readers may find it better for navigating through the documentation as
a whole.

Add some CSS trickery as well to make the table of contents less intrusive
when viewing the pages on a small screen.

Reviewed-by: Akira Yokosawa 
Reviewed-by: David Gow

docs: Fix the docs build with Sphinx 6.0

2023-01-06T20:04:00+00:00

Sphinx 6.0 removed the execfile_() function, which we use as part of the
configuration process.  They *did* warn us...  Just open-code the
functionality as is done in Sphinx itself.

Tested (using SPHINX_CONF, since this code is only executed with an
alternative config file) on various Sphinx versions from 2.5 through 6.0.

Reported-by: Martin Liška 
Cc: stable@vger.kernel.org
Signed-off-by: Jonathan Corbet

docs: sphinx-pre-install: don't require the RTD theme

2022-10-13T17:14:43+00:00

We don't default to the RTD theme anymore, so sphinx-pre-install need not
insist on installing it.

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