diff options
| author | Zack Galbreath <zack.galbreath@kitware.com> | 2019-05-02 14:40:33 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2019-05-03 10:26:50 (GMT) |
| commit | 7ddac9512188d1dbfcac76b24957956a197370ad (patch) | |
| tree | 759bb3a752fa84b674b69193281345e1d6296d53 | |
| parent | a0d04d8810cb40daaaa7876453df81ff228beb82 (diff) | |
| download | CMake-7ddac9512188d1dbfcac76b24957956a197370ad.zip CMake-7ddac9512188d1dbfcac76b24957956a197370ad.tar.gz CMake-7ddac9512188d1dbfcac76b24957956a197370ad.tar.bz2 | |
Help: cross-ref and wording of docs related to ctest_update()
Provide better motivation for users to click through to the CTest manual
from the ctest_update command help page.
| -rw-r--r-- | Help/command/ctest_update.rst | 3 | ||||
| -rw-r--r-- | Help/manual/ctest.1.rst | 2 | ||||
| -rw-r--r-- | Help/variable/CTEST_UPDATE_VERSION_ONLY.rst | 2 |
3 files changed, 5 insertions, 2 deletions
diff --git a/Help/command/ctest_update.rst b/Help/command/ctest_update.rst index df1a4e5..96a11c9 100644 --- a/Help/command/ctest_update.rst +++ b/Help/command/ctest_update.rst @@ -35,4 +35,5 @@ The options are: The update always follows the version control branch currently checked out in the source directory. See the :ref:`CTest Update Step` -documentation for more information. +documentation for information about variables that change the behavior +of ``ctest_update()``. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 5a6b329..fab045b 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -822,6 +822,8 @@ Configuration settings to specify the version control tool include: * :module:`CTest` module variable: ``UPDATE_TYPE`` if set, else ``CTEST_UPDATE_TYPE`` +.. _`UpdateVersionOnly`: + ``UpdateVersionOnly`` Specify that you want the version control update command to only discover the current version that is checked out, and not to update diff --git a/Help/variable/CTEST_UPDATE_VERSION_ONLY.rst b/Help/variable/CTEST_UPDATE_VERSION_ONLY.rst index e646e6e..a862baa 100644 --- a/Help/variable/CTEST_UPDATE_VERSION_ONLY.rst +++ b/Help/variable/CTEST_UPDATE_VERSION_ONLY.rst @@ -1,5 +1,5 @@ CTEST_UPDATE_VERSION_ONLY ------------------------- -Specify the CTest ``UpdateVersionOnly`` setting +Specify the CTest :ref:`UpdateVersionOnly <UpdateVersionOnly>` setting in a :manual:`ctest(1)` dashboard client script. |