[CMake] set command - Proposed patch for more explicit documentation associated with INTERNAL cache type

[Jean-Christophe Fillion-Robin]

Hi Folks,

Currently the documentation associated with set command is the following:

       [...]

         FILEPATH = File chooser dialog.
         PATH     = Directory chooser dialog.
         STRING   = Arbitrary string.
         BOOL     = Boolean ON/OFF checkbox.
         INTERNAL = No GUI entry (used for persistent variables).

       If <type> is INTERNAL, then the <value> is always written into the
       cache, replacing any values existing in the cache.  If it is not a
       cache variable, then this always writes into the current makefile.
       The FORCE option will overwrite the cache value removing any changes
       by the user.
       [...]

The proposed patch will modify it so that it look like:

       [...]
         FILEPATH = File chooser dialog.
         PATH     = Directory chooser dialog.
         STRING   = Arbitrary string.
         BOOL     = Boolean ON/OFF checkbox.
         INTERNAL = No GUI entry (used for persistent variables).

       If <type> is INTERNAL, then the <value> is always written into the
       cache, replacing any values existing in the cache.  If it is not a
       cache variable, then this always writes into the current makefile.

       If FORCE is present, the cache value will be overwritten removing any
       changes by the user.  Note that the FORCE option is ignored if <type>
       is INTERNAL.
       [...]


More details:

  $ cmake --help-command set

  http://www.cmake.org/Bug/view.php?id=13293


https://github.com/jcfr/CMake/compare/13293-update-set-internal-documentation


Thanks for your feedback,
Jc

-- 
+1 919 869 8849
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.cmake.org/pipermail/cmake/attachments/20120612/d4f60f68/attachment.htm>