diff options
| author | Brad King <brad.king@kitware.com> | 2015-04-01 20:25:42 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-04-01 20:29:52 (GMT) |
| commit | 77d466ec556bf6722e20d0c7a9b253d69f113c6c (patch) | |
| tree | d4d44a62157aeeee8c79ec110029048800487b78 | |
| parent | 91eb736390b69d186edda8a1105d898cd58a77ca (diff) | |
| download | CMake-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>
| -rw-r--r-- | Help/command/set.rst | 9 | ||||
| -rw-r--r-- | Help/manual/OPTIONS_BUILD.txt | 10 |
2 files changed, 18 insertions, 1 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 ^^^^^^^^^^^^^^^^^^^^^^^^ 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. |