From b62d440ea8cf16e1eab3d8fec5f36abdee0f4bab Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 4 Jun 2013 08:18:15 -0400 Subject: [PATCH] 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". --- Source/cmDocumentVariables.cxx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Source/cmDocumentVariables.cxx b/Source/cmDocumentVariables.cxx index b383265fc..689508f5a 100644 --- a/Source/cmDocumentVariables.cxx +++ b/Source/cmDocumentVariables.cxx @@ -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