summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2019-01-30 12:04:56 (GMT)
committerJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2019-01-30 12:04:56 (GMT)
commit9c4cdc43f68c46984cbf7ce7d5f22aadcdde1a00 (patch)
tree09ddf2b67516f663a0349260f93cf66bf1fc0c8b /Help/variable
parentd21769d5ddad9a76c3f2c773b8be6961ad159af3 (diff)
downloadCMake-9c4cdc43f68c46984cbf7ce7d5f22aadcdde1a00.zip
CMake-9c4cdc43f68c46984cbf7ce7d5f22aadcdde1a00.tar.gz
CMake-9c4cdc43f68c46984cbf7ce7d5f22aadcdde1a00.tar.bz2
Help: declare CMAKE_HOME_DIRECTORY obsolete
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_HOME_DIRECTORY.rst7
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.