summaryrefslogtreecommitdiffstats
path: root/Help/manual/OPTIONS_BUILD.txt
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-04-01 20:25:42 (GMT)
committerBrad King <brad.king@kitware.com>2015-04-01 20:29:52 (GMT)
commit77d466ec556bf6722e20d0c7a9b253d69f113c6c (patch)
treed4d44a62157aeeee8c79ec110029048800487b78 /Help/manual/OPTIONS_BUILD.txt
parent91eb736390b69d186edda8a1105d898cd58a77ca (diff)
downloadCMake-77d466ec556bf6722e20d0c7a9b253d69f113c6c.zip
CMake-77d466ec556bf6722e20d0c7a9b253d69f113c6c.tar.gz
CMake-77d466ec556bf6722e20d0c7a9b253d69f113c6c.tar.bz2
Help: Document conversion of PATH/FILEPATH cache values to absolute paths
Suggested-by: Roger Leigh <rleigh@codelibre.net>
Diffstat (limited to 'Help/manual/OPTIONS_BUILD.txt')
-rw-r--r--Help/manual/OPTIONS_BUILD.txt10
1 files changed, 9 insertions, 1 deletions
diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt
index 363d0aa..986b541 100644
--- a/Help/manual/OPTIONS_BUILD.txt
+++ b/Help/manual/OPTIONS_BUILD.txt
@@ -10,7 +10,7 @@
containing SET commands that use the CACHE option, not a
cache-format file.
-``-D <var>:<type>=<value>``
+``-D <var>:<type>=<value>, -D <var>=<value>``
Create a cmake cache entry.
When cmake is first run in an empty build tree, it creates a
@@ -19,6 +19,14 @@
takes priority over the project's default value. The option may be
repeated for as many cache entries as desired.
+ If the ``:<type>`` portion is given it must be one of the types
+ specified by the :command:`set` command documentation for its
+ ``CACHE`` signature.
+ If the ``:<type>`` portion is omitted the entry will be created
+ with no type if it does not exist with a type already. If a
+ command in the project sets the type to ``PATH`` or ``FILEPATH``
+ then the ``<value>`` will be converted to an absolute path.
+
``-U <globbing_expr>``
Remove matching entries from CMake cache.