tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet 62d78515 f64c7e11

+3 -1
+3 -1
Documentation/Makefile
··· 104 104 @echo ' cleandocs - clean all generated files' 105 105 @echo 106 106 @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' 107 - @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)' 107 + @echo ' top level values for SPHINXDIRS are: $(_SPHINXDIRS)' 108 + @echo ' you may also use a subdirectory like SPHINXDIRS=userspace-api/media,' 109 + @echo ' provided that there is an index.rst file at the subdirectory.' 108 110 @echo 109 111 @echo ' make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.' 110 112 @echo