summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_HOME_DIRECTORY.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/variable/CMAKE_HOME_DIRECTORY.rst')
-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.