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.
This commit is contained in:
Zack Galbreath
2019-05-02 10:40:33 -04:00
committed by Craig Scott
parent a0d04d8810
commit 7ddac95121
3 changed files with 5 additions and 2 deletions
+2 -1
View File
@@ -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()``.
+2
View File
@@ -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
+1 -1
View File
@@ -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.