[Cmake-commits] CMake branch, next, updated. v2.8.8-3218-g86b2e5c
Brad King
brad.king at kitware.com
Mon Jun 18 10:02:06 EDT 2012
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".
The branch, next has been updated
via 86b2e5c2df7b21d062142a68d7d3172c5ca99c56 (commit)
via 212fe2edd68cad900421dd54ee64d4d2a2def8ab (commit)
from e883262a2fdd498963ffe9552ff1aead74a6cb0f (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=86b2e5c2df7b21d062142a68d7d3172c5ca99c56
commit 86b2e5c2df7b21d062142a68d7d3172c5ca99c56
Merge: e883262 212fe2e
Author: Brad King <brad.king at kitware.com>
AuthorDate: Mon Jun 18 10:02:04 2012 -0400
Commit: CMake Topic Stage <kwrobot at kitware.com>
CommitDate: Mon Jun 18 10:02:04 2012 -0400
Merge topic 'doc-set-command' into next
212fe2e STYLE: Fix line length
http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=212fe2edd68cad900421dd54ee64d4d2a2def8ab
commit 212fe2edd68cad900421dd54ee64d4d2a2def8ab
Author: Brad King <brad.king at kitware.com>
AuthorDate: Mon Jun 18 10:01:43 2012 -0400
Commit: Brad King <brad.king at kitware.com>
CommitDate: Mon Jun 18 10:01:43 2012 -0400
STYLE: Fix line length
diff --git a/Source/cmSetCommand.h b/Source/cmSetCommand.h
index a62c204..2dd80e3 100644
--- a/Source/cmSetCommand.h
+++ b/Source/cmSetCommand.h
@@ -63,12 +63,13 @@ public:
return
" set(<variable> <value>\n"
" [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])\n"
- "Within CMake sets <variable> to the value <value>. <value> is expanded "
- "before <variable> is set to it. Normally, set will set a regular CMake "
- "variable. If CACHE is present, then the <variable> is put in the cache "
- "instead, unless it is already in the cache. See section 'Variable types "
- "in CMake' below for details of regular and cache variables and their "
- "interactions. "
+ "Within CMake sets <variable> to the value <value>. "
+ "<value> is expanded before <variable> is set to it. "
+ "Normally, set will set a regular CMake variable. "
+ "If CACHE is present, then the <variable> is put in the cache "
+ "instead, unless it is already in the cache. "
+ "See section 'Variable types in CMake' below for details of "
+ "regular and cache variables and their interactions. "
"If CACHE is used, <type> and <docstring> are required. <type> is used "
"by the CMake GUI to choose a widget with which the user sets a value. "
"The value for <type> may be one of\n"
@@ -79,10 +80,12 @@ public:
" INTERNAL = No GUI entry (used for persistent variables).\n"
"If <type> is INTERNAL, the cache variable is marked as internal, "
"and will not be shown to the user in tools like cmake-gui. "
- "This is intended for values that should be persisted in the cache, but "
- "which users should not normally change. INTERNAL implies FORCE.\n"
- "Normally, set(...CACHE...) creates cache variables, but does not modify "
- "them. If FORCE is specified, the value of the cache variable is set, even "
+ "This is intended for values that should be persisted in the cache, "
+ "but which users should not normally change. INTERNAL implies FORCE."
+ "\n"
+ "Normally, set(...CACHE...) creates cache variables, but does not "
+ "modify them. "
+ "If FORCE is specified, the value of the cache variable is set, even "
"if the variable is already in the cache. This should normally be "
"avoided, as it will remove any changes to the cache variable's value "
"by the user.\n"
@@ -103,17 +106,19 @@ public:
"In CMake there are two types of variables: normal variables and cache "
"variables. Normal variables are meant for the internal use of the "
"script (just like variables in most programming languages); they are "
- "not persisted across CMake runs. Cache variables (unless set with "
- "INTERNAL) are mostly intended for configuration settings where the "
- "first CMake run determines a suitable default value, which the user can "
- "then override, by editing the cache with tools such as ccmake or "
- "cmake-gui. Cache variables are stored in the CMake cache file, and "
+ "not persisted across CMake runs. "
+ "Cache variables (unless set with INTERNAL) are mostly intended for "
+ "configuration settings where the first CMake run determines a "
+ "suitable default value, which the user can then override, by editing "
+ "the cache with tools such as ccmake or cmake-gui. "
+ "Cache variables are stored in the CMake cache file, and "
"are persisted across CMake runs. \n"
"Both types can exist at the same time with the same name "
- "but different values. When ${FOO} is evaluated, CMake first looks for "
- "a normal variable 'FOO' in scope and uses it if set. If and only if no "
- "normal variable exists then it falls back to the cache variable "
- "'FOO'.\n"
+ "but different values. "
+ "When ${FOO} is evaluated, CMake first looks for "
+ "a normal variable 'FOO' in scope and uses it if set. "
+ "If and only if no normal variable exists then it falls back to the "
+ "cache variable 'FOO'.\n"
"Some examples:\n"
"The code 'set(FOO \"x\")' sets the normal variable 'FOO'. It does not "
"touch the cache, but it will hide any existing cache value 'FOO'.\n"
@@ -126,15 +131,18 @@ public:
"CMake also *removes* the normal variable of the same name from the "
"current scope so that an immediately following evaluation of "
"it will expose the newly cached value.\n"
- "Normally projects should avoid using normal and cache variables of the "
- "same name, as this interaction can be hard to follow. However, in some "
- "situations it can be useful. One example (used by some projects): \n"
+ "Normally projects should avoid using normal and cache variables of "
+ "the same name, as this interaction can be hard to follow. "
+ "However, in some situations it can be useful. "
+ "One example (used by some projects):"
+ "\n"
"A project has a subproject in its source tree. The child project has "
"its own CMakeLists.txt, which is included from the parent "
- "CMakeLists.txt using add_subdirectory(). Now, if the parent and the "
- "child project provide the same option (for example a compiler "
- "option), the parent gets the first chance to add a user-editable option "
- "to the cache. Normally, the child would then use the same value "
+ "CMakeLists.txt using add_subdirectory(). "
+ "Now, if the parent and the child project provide the same option "
+ "(for example a compiler option), the parent gets the first chance "
+ "to add a user-editable option to the cache. "
+ "Normally, the child would then use the same value "
"that the parent uses. "
"However, it may be necessary to hard-code the value for the child "
"project's option while still allowing the user to edit the value used "
-----------------------------------------------------------------------
Summary of changes:
Source/cmSetCommand.h | 60 +++++++++++++++++++++++++++---------------------
1 files changed, 34 insertions(+), 26 deletions(-)
hooks/post-receive
--
CMake
More information about the Cmake-commits
mailing list