| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Date: Thu, 9 Jun 2022 22:24:58 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@...nel.org>,
"Maciej W. Rozycki" <macro@...am.me.uk>,
Miguel Ojeda <ojeda@...nel.org>, linux-kernel@...r.kernel.org,
Akira Yokosawa <akiyks@...il.com>
Subject: [PATCH 2/5] docs/doc-guide: Mention make variable SPHINXDIRS
SPHINXDIRS is useful when you want test builds of only those
documents affected by your changes.
Mention it in the "Sphinx Build" section.
Signed-off-by: Akira Yokosawa <akiyks@...il.com>
Cc: Maciej W. Rozycki <macro@...am.me.uk>
---
This change is inspired from correspondence with Maciej [1].
[1]: https://lore.kernel.org/r/f4d40da6-756b-9e75-b867-cc9eedc4b232@gmail.com
--
Documentation/doc-guide/sphinx.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index edc4fa023986..efcccab68286 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -151,6 +151,10 @@ If the theme is not available, it will fall-back to the classic one.
The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable.
+There is another make variable ``SPHINXDIRS``, which is useful when test
+building a subset of documentation. Again, see the documentation section
+of ``make help`` for the details.
+
To remove the generated documentation, run ``make cleandocs``.
.. [#ink] Having ``inkscape(1)`` from Inkscape (https://inkscape.org)
--
2.25.1
Powered by blists - more mailing lists