Docs: Clarify CMAKE_PARENT_LIST_FILE (#14194)

Fix the wording of the documentation for CMAKE_PARENT_LIST_FILE to
clarify that it only applies to the include stack in the current
directory.  Specify exactly what commands can include files instead of
saying "somehow invoke".
This commit is contained in:
Brad King 2013-06-04 08:18:15 -04:00
parent c9be17c860
commit b62d440ea8
1 changed files with 6 additions and 5 deletions

View File

@ -345,11 +345,12 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
cm->DefineProperty
("CMAKE_PARENT_LIST_FILE", cmProperty::VARIABLE,
"Full path to the parent listfile of the one currently being processed.",
"As CMake processes the listfiles in your project this "
"variable will always be set to the listfile that included "
"or somehow invoked the one currently being "
"processed. See also CMAKE_CURRENT_LIST_FILE.",false,
"Full path to the CMake file that included the current one.",
"While processing a CMake file loaded by include() or find_package() "
"this variable contains the full path to the file including it. "
"The top of the include stack is always the CMakeLists.txt for the "
"current directory. "
"See also CMAKE_CURRENT_LIST_FILE.",false,
"Variables that Provide Information");
cm->DefineProperty