mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-11 16:32:14 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help/dev: Mention 'envvar' domain object in CMake Documentation Guide

Browse Source 
This was accidentally left out of commit 8acf46caf1 (Utilities/Sphinx:
Add role and directive for 'envvar' in CMake domain, 2018-04-19,
v3.12.0-rc1~200^2~1).
This commit is contained in:
Brad King
2021-01-15 13:58:42 -05:00
parent 621ba5e1f2
commit 954a9e9893
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Help/dev/documentation.rst
View File

@@ -123,6 +123,11 @@ documentation:
``command``
A CMake language command.
``envvar``
An environment variable.
See the `cmake-env-variables(7)`_ manual
and the `set()`_ command.
``generator``
A CMake native build system generator.
See the `cmake(1)`_ command-line tool's ``-G`` option.
@@ -174,6 +179,10 @@ other documents:
This indented block documents <command-name>.
.. envvar:: <envvar-name>
This indented block documents <envvar-name>.
.. variable:: <variable-name>
This indented block documents <variable-name>.
@@ -183,6 +192,7 @@ the first approach above.
.. _`Sphinx Domain`: http://sphinx-doc.org/domains.html
.. _`cmake(1)`: https://cmake.org/cmake/help/latest/manual/cmake.1.html
.. _`cmake-env-variables(7)`: https://cmake.org/cmake/help/latest/manual/cmake-env-variables.7.html
.. _`cmake-modules(7)`: https://cmake.org/cmake/help/latest/manual/cmake-modules.7.html
.. _`cmake-policies(7)`: https://cmake.org/cmake/help/latest/manual/cmake-policies.7.html
.. _`cmake-properties(7)`: https://cmake.org/cmake/help/latest/manual/cmake-properties.7.html