[Cmake-commits] [cmake-commits] king committed cmCMakePolicyCommand.h 1.6 1.7

[cmake-commits at cmake.org]

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

Modified Files:
	cmCMakePolicyCommand.h 
Log Message:
ENH: Improve stack discussion in cmake_policy

This re-organizes the discussion of the policy stack in documentation of
the cmake_policy() command.  The new organization clearer and easier to
extend with new information.


Index: cmCMakePolicyCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmCMakePolicyCommand.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -C 2 -d -r1.6 -r1.7
*** cmCMakePolicyCommand.h	18 Aug 2008 13:53:06 -0000	1.6
--- cmCMakePolicyCommand.h	22 Jan 2009 18:16:33 -0000	1.7
***************
*** 114,127 ****
        "policy is set, and empty otherwise."
        "\n"
        "  cmake_policy(PUSH)\n"
        "  cmake_policy(POP)\n"
!       "Push and pop the current policy setting state on a stack.  "
!       "Each PUSH must have a matching POP.  "
!       "This is useful when mixing multiple projects, subprojects, and "
!       "files included from external projects that may each have been "
!       "written for a different version of CMake.  "
!       "Each subdirectory entered by the project automatically pushes "
!       "a new level on the stack to isolate the subdirectories from "
!       "their parents.";
      }
    
--- 114,128 ----
        "policy is set, and empty otherwise."
        "\n"
+       "CMake keeps policy settings on a stack, so changes made by the "
+       "cmake_policy command affect only the top of the stack.  "
+       "A new entry on the policy stack is managed automatically for each "
+       "subdirectory to protect its parents and siblings.  "
+       "The cmake_policy command provides an interface to manage custom "
+       "entries on the policy stack:\n"
        "  cmake_policy(PUSH)\n"
        "  cmake_policy(POP)\n"
!       "Each PUSH must have a matching POP to erase any changes.  "
!       "This is useful to make temporary changes to policy settings."
!       ;
      }