summaryrefslogtreecommitdiffstats
path: root/Help/command
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/command
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/command')
-rw-r--r--Help/command/set.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/Help/command/set.rst b/Help/command/set.rst
index 9f2bf72..d04b880 100644
--- a/Help/command/set.rst
+++ b/Help/command/set.rst
@@ -70,6 +70,15 @@ Furthermore, any normal variable binding in the current scope will
be removed to expose the newly cached value to any immediately
following evaluation.
+It is possible for the cache entry to exist prior to the call but
+have no type set if it was created on the :manual:`cmake(1)` command
+line by a user through the ``-D<var>=<value>`` option without
+specifying a type. In this case the ``set`` command will add the
+type. Furthermore, if the ``<type>`` is ``PATH`` or ``FILEPATH``
+and the ``<value>`` provided on the command line is a relative path,
+then the ``set`` command will treat the path as relative to the
+current working directory and convert it to an absolute path.
+
Set Environment Variable
^^^^^^^^^^^^^^^^^^^^^^^^