diff options
| author | Joachim Wuttke (o) <j.wuttke@fz-juelich.de> | 2019-01-30 12:04:56 (GMT) |
|---|---|---|
| committer | Joachim Wuttke (o) <j.wuttke@fz-juelich.de> | 2019-01-30 12:04:56 (GMT) |
| commit | 9c4cdc43f68c46984cbf7ce7d5f22aadcdde1a00 (patch) | |
| tree | 09ddf2b67516f663a0349260f93cf66bf1fc0c8b | |
| parent | d21769d5ddad9a76c3f2c773b8be6961ad159af3 (diff) | |
| download | CMake-9c4cdc43f68c46984cbf7ce7d5f22aadcdde1a00.zip CMake-9c4cdc43f68c46984cbf7ce7d5f22aadcdde1a00.tar.gz CMake-9c4cdc43f68c46984cbf7ce7d5f22aadcdde1a00.tar.bz2 | |
Help: declare CMAKE_HOME_DIRECTORY obsolete
| -rw-r--r-- | Help/manual/cmake-variables.7.rst | 9 | ||||
| -rw-r--r-- | Help/variable/CMAKE_HOME_DIRECTORY.rst | 7 |
2 files changed, 13 insertions, 3 deletions
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index de4ce3d..83a1ccd 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -55,7 +55,6 @@ Variables that Provide Information /variable/CMAKE_GENERATOR_INSTANCE /variable/CMAKE_GENERATOR_PLATFORM /variable/CMAKE_GENERATOR_TOOLSET - /variable/CMAKE_HOME_DIRECTORY /variable/CMAKE_IMPORT_LIBRARY_PREFIX /variable/CMAKE_IMPORT_LIBRARY_SUFFIX /variable/CMAKE_JOB_POOL_COMPILE @@ -608,3 +607,11 @@ Variable Expansion Operators /variable/CACHE /variable/ENV + +Obsolete Variables +================== + +.. toctree:: + :maxdepth: 1 + + /variable/CMAKE_HOME_DIRECTORY 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. |