archives/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-03-08 01:24:47 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: conf.py: get rid of the now unused kerneldoc_bin env var

Browse source 
In the past, this contained the location of the binary file to parse
kernel-doc. Nowadays, it is used only for debugging purposes, inside
kerneldoc.py extension.

Move it to sphinx/kerneldoc.py, to avoid needing to handle with it
on several places.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <c0fa9f561c1dd4370f9096de4195a9214763c51c.1768823489.git.mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2026-01-19 13:05:04 +01:00 • committed by Jonathan Corbet
parent 35c0f975ef
commit 0407f3714c
2 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Documentation/conf.py
View file

@ -582,10 +582,6 @@ pdf_documents = [
("kernel-documentation", "Kernel", "Kernel", "J. Random Bozo"),
]
# kernel-doc extension configuration for running Sphinx directly (e.g. by Read
# the Docs). In a normal build, these are supplied from the Makefile via command
# line arguments.
kerneldoc_bin = "../tools/docs/kernel-doc" # Not used now
kerneldoc_srctree = ".."
def setup(app):

7
Documentation/sphinx/kerneldoc.py
View file

@ -47,6 +47,10 @@ sys.path.insert(0, os.path.join(srctree, "tools/lib/python"))
from kdoc.kdoc_files import KernelFiles
from kdoc.kdoc_output import RestFormat
# Used when verbose is active to show how to reproduce kernel-doc
# issues via command line
kerneldoc_bin = "tools/docs/kernel-doc"
__version__ = '1.0'
kfiles = None
logger = logging.getLogger(__name__)
@ -95,7 +99,7 @@ class KernelDocDirective(Directive):
def handle_args(self):
env = self.state.document.settings.env
cmd = [env.config.kerneldoc_bin, '-rst', '-enable-lineno']
cmd = [kerneldoc_bin, '-rst', '-enable-lineno']
filename = env.config.kerneldoc_srctree + '/' + self.arguments[0]
@ -257,7 +261,6 @@ def setup_kfiles(app):
def setup(app):
app.add_config_value('kerneldoc_bin', None, 'env')
app.add_config_value('kerneldoc_srctree', None, 'env')
app.add_config_value('kerneldoc_verbosity', 1, 'env')