diff options
| author | Tobias Nießen <tniessen@tnie.de> | 2022-03-29 23:49:29 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2022-03-30 13:20:18 (GMT) |
| commit | cf4100d7da85e714df727cebd591124486a026ab (patch) | |
| tree | c4f947b280b989cedc044acd1f2b97bae0ec049f /Help | |
| parent | 00677703d00f94702ef94d8dd07387c8405a3caf (diff) | |
| download | CMake-cf4100d7da85e714df727cebd591124486a026ab.zip CMake-cf4100d7da85e714df727cebd591124486a026ab.tar.gz CMake-cf4100d7da85e714df727cebd591124486a026ab.tar.bz2 | |
Help: Add that CMAKE_CACHEFILE_DIR might not be defined
CMake only sets `CMAKE_CACHEFILE_DIR` when writing `CMakeCache.txt`,
so the variable will usually be undefined when `CMakeLists.txt` runs.
Revise its documentation to clarify that `CMAKE_BINARY_DIR` should
be used instead.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/variable/CMAKE_CACHEFILE_DIR.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/Help/variable/CMAKE_CACHEFILE_DIR.rst b/Help/variable/CMAKE_CACHEFILE_DIR.rst index 8604d0e..3fee09f 100644 --- a/Help/variable/CMAKE_CACHEFILE_DIR.rst +++ b/Help/variable/CMAKE_CACHEFILE_DIR.rst @@ -1,7 +1,6 @@ CMAKE_CACHEFILE_DIR ------------------- -The directory with the ``CMakeCache.txt`` file. - -This is the full path to the directory that has the ``CMakeCache.txt`` -file in it. This is the same as :variable:`CMAKE_BINARY_DIR`. +This variable is used internally by CMake, and may not be set during +the first configuration of a build tree. When it is set, it has the +same value as :variable:`CMAKE_BINARY_DIR`. Use that variable instead. |