[Cmake-commits] [cmake-commits] king committed cmCacheManager.cxx 1.106 1.107 cmCacheManager.h 1.51 1.52 cmDocumentation.cxx 1.74 1.75 cmake.cxx 1.410 1.411

[cmake-commits at cmake.org]

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

Modified Files:
	cmCacheManager.cxx cmCacheManager.h cmDocumentation.cxx 
	cmake.cxx 
Log Message:
ENH: Document CACHE entry properties

This adds a property documentation section for CACHE properties.
We document the ADVANCED, HELPSTRING, TYPE, and VALUE properties.


Index: cmDocumentation.cxx
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmDocumentation.cxx,v
retrieving revision 1.74
retrieving revision 1.75
diff -C 2 -d -r1.74 -r1.75
*** cmDocumentation.cxx	11 Oct 2008 19:35:30 -0000	1.74
--- cmDocumentation.cxx	10 Mar 2009 15:11:15 -0000	1.75
***************
*** 268,271 ****
--- 268,272 ----
    this->PropertySections.push_back("Properties on Tests");
    this->PropertySections.push_back("Properties on Source Files");
+   this->PropertySections.push_back("Properties on Cache Entries");
  
    this->VariableSections.push_back("Variables that Provide Information");

Index: cmCacheManager.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmCacheManager.h,v
retrieving revision 1.51
retrieving revision 1.52
diff -C 2 -d -r1.51 -r1.52
*** cmCacheManager.h	10 Mar 2009 15:10:59 -0000	1.51
--- cmCacheManager.h	10 Mar 2009 15:11:15 -0000	1.52
***************
*** 156,159 ****
--- 156,162 ----
    bool NeedCacheCompatibility(int major, int minor);
  
+   /** Define and document CACHE entry properties.  */
+   static void DefineProperties(cmake *cm);
+ 
  protected:
    ///! Add an entry into the cache

Index: cmake.cxx
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmake.cxx,v
retrieving revision 1.410
retrieving revision 1.411
diff -C 2 -d -r1.410 -r1.411
*** cmake.cxx	5 Mar 2009 20:17:06 -0000	1.410
--- cmake.cxx	10 Mar 2009 15:11:15 -0000	1.411
***************
*** 229,232 ****
--- 229,233 ----
  
    // initialize properties
+   cmCacheManager::DefineProperties(this);
    cmSourceFile::DefineProperties(this);
    cmTarget::DefineProperties(this);

Index: cmCacheManager.cxx
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmCacheManager.cxx,v
retrieving revision 1.106
retrieving revision 1.107
diff -C 2 -d -r1.106 -r1.107
*** cmCacheManager.cxx	10 Mar 2009 15:10:59 -0000	1.106
--- cmCacheManager.cxx	10 Mar 2009 15:11:15 -0000	1.107
***************
*** 1011,1012 ****
--- 1011,1057 ----
            actual_compat <= CMake_VERSION_ENCODE(major, minor, 0));
  }
+ 
+ //----------------------------------------------------------------------------
+ void cmCacheManager::DefineProperties(cmake *cm)
+ {
+   cm->DefineProperty
+     ("ADVANCED", cmProperty::CACHE,
+      "True if entry should be hidden by default in GUIs.",
+      "This is a boolean value indicating whether the entry is considered "
+      "interesting only for advanced configuration.  "
+      "The mark_as_advanced() command modifies this property."
+       );
+ 
+   cm->DefineProperty
+     ("HELPSTRING", cmProperty::CACHE,
+      "Help associated with entry in GUIs.",
+      "This string summarizes the purpose of an entry to help users set it "
+      "through a CMake GUI."
+       );
+ 
+   cm->DefineProperty
+     ("TYPE", cmProperty::CACHE,
+      "Widget type for entry in GUIs.",
+      "Cache entry values are always strings, but CMake GUIs present widgets "
+      "to help users set values.  "
+      "The GUIs use this property as a hint to determine the widget type.  "
+      "Valid TYPE values are:\n"
+      "  BOOL          = Boolean ON/OFF value.\n"
+      "  PATH          = Path to a directory.\n"
+      "  FILEPATH      = Path to a file.\n"
+      "  STRING        = Generic string value.\n"
+      "  INTERNAL      = Do not present in GUI at all.\n"
+      "  STATIC        = Value managed by CMake, do not change.\n"
+      "  UNINITIALIZED = Type not yet specified.\n"
+      "Generally the TYPE of a cache entry should be set by the command "
+      "which creates it (set, option, find_library, etc.)."
+       );
+ 
+   cm->DefineProperty
+     ("VALUE", cmProperty::CACHE,
+      "Value of a cache entry.",
+      "This property maps to the actual value of a cache entry.  "
+      "Setting this property always sets the value without checking, so "
+      "use with care."
+       );
+ }