diff options
| author | Brad King <brad.king@kitware.com> | 2021-01-15 13:58:42 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-01-18 12:35:40 -0500 |
| commit | 954a9e9893221c4ffe56b5534c4919329d511b74 (patch) | |
| tree | 66423947a96d39274f6c865daa070cdc0601d8d2 /Help | |
| parent | 621ba5e1f217aabb401d1401117ee2a3652fcc5d (diff) | |
| download | cmake-954a9e9893221c4ffe56b5534c4919329d511b74.tar.gz | |
Help/dev: Mention 'envvar' domain object in CMake Documentation Guide
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).
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/dev/documentation.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Help/dev/documentation.rst b/Help/dev/documentation.rst index c302790aaf..07f04d26c3 100644 --- a/Help/dev/documentation.rst +++ b/Help/dev/documentation.rst @@ -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 |