summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorCharles Barto <chbarto@microsoft.com>2019-10-31 11:30:29 -0700
committerBrad King <brad.king@kitware.com>2019-11-01 10:00:28 -0400
commit657fb0aa6fadf0c3aa4f8a914feb621cdfb6af4f (patch)
tree261c1c5730f8d7b3003dc140e04fa948396a672a /Help
parentc1d5d5eb11e0260ffadda0851ac844ab46b6b179 (diff)
downloadcmake-657fb0aa6fadf0c3aa4f8a914feb621cdfb6af4f.tar.gz
Help: Clarify load_cache documentation of first parameter
The first parameter is the path to the *directory* containing the `CMakeCache.txt` file, not the file itself.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/load_cache.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/Help/command/load_cache.rst b/Help/command/load_cache.rst
index 33625c4635..b89eb61776 100644
--- a/Help/command/load_cache.rst
+++ b/Help/command/load_cache.rst
@@ -5,7 +5,7 @@ Load in the values from another project's CMake cache.
.. code-block:: cmake
- load_cache(pathToCacheFile READ_WITH_PREFIX prefix entry1...)
+ load_cache(pathToBuildDirectory READ_WITH_PREFIX prefix entry1...)
Reads the cache and store the requested entries in variables with their
name prefixed with the given prefix. This only reads the values, and
@@ -13,7 +13,7 @@ does not create entries in the local project's cache.
.. code-block:: cmake
- load_cache(pathToCacheFile [EXCLUDE entry1...]
+ load_cache(pathToBuildDirectory [EXCLUDE entry1...]
[INCLUDE_INTERNALS entry1...])
Loads in the values from another cache and store them in the local