diff options
| author | Brad King <brad.king@kitware.com> | 2019-01-31 16:09:54 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2019-01-31 16:11:28 (GMT) |
| commit | 9aef4a732ba6b0d20c9953d171514fa4c0daaddf (patch) | |
| tree | 65e2cb97176785578d04934e6300f17b2750883c /Help/variable | |
| parent | 1b3b0fa43a51aed03f38b98f30d9383bc6d377d6 (diff) | |
| parent | 9d20fe014f3b81fa7d7a3b7d203b58abe6fd5ce6 (diff) | |
| download | CMake-9aef4a732ba6b0d20c9953d171514fa4c0daaddf.zip CMake-9aef4a732ba6b0d20c9953d171514fa4c0daaddf.tar.gz CMake-9aef4a732ba6b0d20c9953d171514fa4c0daaddf.tar.bz2 | |
Merge topic 'variables1'
9d20fe014f Help: moved 7 variables to "internal" section
dfb2d6178e Help: "internal variables" instead of "obsolete", with some explanatory prose
9c4cdc43f6 Help: declare CMAKE_HOME_DIRECTORY obsolete
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2881
Diffstat (limited to 'Help/variable')
| -rw-r--r-- | Help/variable/CMAKE_HOME_DIRECTORY.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Help/variable/CMAKE_HOME_DIRECTORY.rst b/Help/variable/CMAKE_HOME_DIRECTORY.rst index fdc5d81..b03d956 100644 --- a/Help/variable/CMAKE_HOME_DIRECTORY.rst +++ b/Help/variable/CMAKE_HOME_DIRECTORY.rst @@ -1,6 +1,9 @@ CMAKE_HOME_DIRECTORY -------------------- -Path to top of source tree. +Path to top of source tree. Same as :variable:`CMAKE_SOURCE_DIR`. -This is the path to the top level of the source tree. +This is an internal cache entry used to locate the source directory +when loading a ``CMakeCache.txt`` from a build tree. It should not +be used in project code. The variable :variable:`CMAKE_SOURCE_DIR` +has the same value and should be preferred. |