[Cmake-commits] [cmake-commits] king committed cmDocumentVariables.cxx 1.43 1.44

[cmake-commits at cmake.org]

Update of /cvsroot/CMake/CMake/Source
In directory public:/mounts/ram/cvs-serv12283/Source

Modified Files:
	cmDocumentVariables.cxx 
Log Message:
Document CMAKE_CURRENT_LIST_FILE more precisely

There is confusion whether the file "currently being processed" inside a
function or macro is the file containing the definition or not.  This
commit explicitly describes the behavior.  See issue #9646.


Index: cmDocumentVariables.cxx
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmDocumentVariables.cxx,v
retrieving revision 1.43
retrieving revision 1.44
diff -C 2 -d -r1.43 -r1.44
*** cmDocumentVariables.cxx	23 Sep 2009 12:48:35 -0000	1.43
--- cmDocumentVariables.cxx	2 Oct 2009 17:22:13 -0000	1.44
***************
*** 57,61 ****
       "As CMake processes the listfiles in your project this "
       "variable will always be set to the one currently being "
!      "processed. See also CMAKE_PARENT_LIST_FILE.",false,
       "Variables that Provide Information");
  
--- 57,72 ----
       "As CMake processes the listfiles in your project this "
       "variable will always be set to the one currently being "
!      "processed.  "
!      "The value has dynamic scope.  "
!      "When CMake starts processing commands in a source file "
!      "it sets this variable to the location of the file.  "
!      "When CMake finishes processing commands from the file it "
!      "restores the previous value.  "
!      "Therefore the value of the variable inside a macro or "
!      "function is the file invoking the bottom-most entry on "
!      "the call stack, not the file containing the macro or "
!      "function definition."
!      "\n"
!      "See also CMAKE_PARENT_LIST_FILE.",false,
       "Variables that Provide Information");