]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: Makefile: update SPHINXDIRS documentation
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 13 Nov 2025 11:00:32 +0000 (12:00 +0100)
committerJonathan Corbet <corbet@lwn.net>
Thu, 13 Nov 2025 16:22:30 +0000 (09:22 -0700)
commit62d785159c7a5ccfae87b5849b17e51cb8fce9b1
tree77ec102f8699e62c1b0a1115f30e87e8a6757025
parentf64c7e113dc937e0987c83ef51a3cd52a2c277c7
docs: Makefile: update SPHINXDIRS documentation

Since the beginning, SPHINXDIRS was meant to be used by any
subdirectory inside Documentation/ that contains a file named
index.rst on it. The typical usecase for SPHINXDIRS is help
building subsystem-specific documentation, without needing to
wait for the entire building (with can take 3 minutes with
Sphinx 8.x and above, and a lot more with older versions).

Yet, the documentation for such feature was written back in
2016, where almost all index.rst files were at the first
level (Documentation/*/index.rst).

Update the documentation to reflect the way it works.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <683469813350214da122c258063dd71803ff700b.1763031632.git.mchehab+huawei@kernel.org>
Documentation/Makefile