summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
Diffstat (limited to 'Help')
-rw-r--r--Help/command/add_test.rst86
-rw-r--r--Help/release/3.0.0.rst5
-rw-r--r--Help/release/dev/0-sample-topic.rst7
-rw-r--r--Help/release/index.rst2
-rw-r--r--Help/variable/CMAKE_TWEAK_VERSION.rst10
-rw-r--r--Help/variable/CMAKE_VERSION.rst19
6 files changed, 72 insertions, 57 deletions
diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst
index 5714559..7e7e6bd 100644
--- a/Help/command/add_test.rst
+++ b/Help/command/add_test.rst
@@ -1,69 +1,59 @@
add_test
--------
-Add a test to the project with the specified arguments.
+Add a test to the project to be run by :manual:`ctest(1)`.
::
- add_test(testname Exename arg1 arg2 ... )
+ add_test(NAME <name> COMMAND <command> [<arg>...]
+ [CONFIGURATIONS <config>...]
+ [WORKING_DIRECTORY <dir>])
-If the ENABLE_TESTING command has been run, this command adds a test
-target to the current directory. If ENABLE_TESTING has not been run,
-this command does nothing. The tests are run by the testing subsystem
-by executing Exename with the specified arguments. Exename can be
-either an executable built by this project or an arbitrary executable
-on the system (like tclsh). The test will be run with the current
-working directory set to the CMakeList.txt files corresponding
-directory in the binary tree. Tests added using this signature do not
-support generator expressions.
+Add a test called ``<name>``. The test name may not contain spaces,
+quotes, or other characters special in CMake syntax. The options are:
+``COMMAND``
+ Specify the test command-line. If ``<command>`` specifies an
+ executable target (created by :command:`add_executable`) it will
+ automatically be replaced by the location of the executable created
+ at build time.
+``CONFIGURATIONS``
+ Restrict execution of the test only to the named configurations.
-::
-
- add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]]
- [WORKING_DIRECTORY dir]
- COMMAND <command> [arg1 [arg2 ...]])
-
-Add a test called <name>. The test name may not contain spaces,
-quotes, or other characters special in CMake syntax. If COMMAND
-specifies an executable target (created by add_executable) it will
-automatically be replaced by the location of the executable created at
-build time. If a CONFIGURATIONS option is given then the test will be
-executed only when testing under one of the named configurations. If
-a WORKING_DIRECTORY option is given then the test will be executed in
-the given directory.
-
-Arguments after COMMAND may use "generator expressions" with the syntax
-``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual for
-available expressions.
+``WORKING_DIRECTORY``
+ Set the :prop_test:`WORKING_DIRECTORY` test property to
+ specify the working directory in which to execute the test.
+ If not specified the test will be run with the current working
+ directory set to the build directory corresponding to the
+ current source directory.
-Note that tgt is not added as a dependency of the target this
-expression is evaluated on.
+The ``COMMAND`` and ``WORKING_DIRECTORY`` options may use "generator
+expressions" with the syntax ``$<...>``. See the
+:manual:`cmake-generator-expressions(7)` manual for available expressions.
-::
-
- $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies.
- $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise.
+Example usage::
-Boolean expressions:
+ add_test(NAME mytest
+ COMMAND testDriver --config $<CONFIGURATION>
+ --exe $<TARGET_FILE:myexe>)
-::
+This creates a test ``mytest`` whose command runs a ``testDriver`` tool
+passing the configuration name and the full path to the executable
+file produced by target ``myexe``.
- $<AND:?[,?]...> = '1' if all '?' are '1', else '0'
- $<OR:?[,?]...> = '0' if all '?' are '0', else '1'
- $<NOT:?> = '0' if '?' is '1', else '1'
+.. note::
-where '?' is always either '0' or '1'.
+ CMake will generate tests only if the :command:`enable_testing`
+ command has been invoked. The :module:`CTest` module invokes the
+ command automatically when the ``BUILD_TESTING`` option is ``ON``.
-Example usage:
+---------------------------------------------------------------------
::
- add_test(NAME mytest
- COMMAND testDriver --config $<CONFIGURATION>
- --exe $<TARGET_FILE:myexe>)
+ add_test(<name> <command> [<arg>...])
-This creates a test "mytest" whose command runs a testDriver tool
-passing the configuration name and the full path to the executable
-file produced by target "myexe".
+Add a test called ``<name>`` with the given command-line. Unlike
+the above ``NAME`` signature no transformation is performed on the
+command-line to support target names or generator expressions.
diff --git a/Help/release/3.0.0.rst b/Help/release/3.0.0.rst
index 677c7a8..ee8417c 100644
--- a/Help/release/3.0.0.rst
+++ b/Help/release/3.0.0.rst
@@ -394,6 +394,11 @@ Deprecated and Removed Features
Other Changes
=============
+* The version scheme was changed to use only two components for
+ the feature level instead of three. The third component will
+ now be used for bug-fix releases or the date of development versions.
+ See the :variable:`CMAKE_VERSION` variable documentation for details.
+
* The default install locations of CMake itself on Windows and
OS X no longer contain the CMake version number. This allows
for easy replacement without re-generating local build trees
diff --git a/Help/release/dev/0-sample-topic.rst b/Help/release/dev/0-sample-topic.rst
new file mode 100644
index 0000000..e4cc01e
--- /dev/null
+++ b/Help/release/dev/0-sample-topic.rst
@@ -0,0 +1,7 @@
+0-sample-topic
+--------------
+
+* This is a sample release note for the change in a topic.
+ Developers should add similar notes for each topic branch
+ making a noteworthy change. Each document should be named
+ and titled to match the topic name to avoid merge conflicts.
diff --git a/Help/release/index.rst b/Help/release/index.rst
index 752c568..15ce065 100644
--- a/Help/release/index.rst
+++ b/Help/release/index.rst
@@ -5,6 +5,8 @@ CMake Release Notes
This file should include the adjacent "dev.txt" file
in development versions but not in release versions.
+.. include:: dev.txt
+
Releases
========
diff --git a/Help/variable/CMAKE_TWEAK_VERSION.rst b/Help/variable/CMAKE_TWEAK_VERSION.rst
index a2c8f35..be2e050 100644
--- a/Help/variable/CMAKE_TWEAK_VERSION.rst
+++ b/Help/variable/CMAKE_TWEAK_VERSION.rst
@@ -1,5 +1,11 @@
CMAKE_TWEAK_VERSION
-------------------
-Fourth version number component of the :variable:`CMAKE_VERSION`
-variable.
+Defined to ``0`` for compatibility with code written for older
+CMake versions that may have defined higher values.
+
+.. note::
+
+ In CMake versions 2.8.2 through 2.8.12, this variable holds
+ the fourth version number component of the
+ :variable:`CMAKE_VERSION` variable.
diff --git a/Help/variable/CMAKE_VERSION.rst b/Help/variable/CMAKE_VERSION.rst
index 6184f08..bbb1d91 100644
--- a/Help/variable/CMAKE_VERSION.rst
+++ b/Help/variable/CMAKE_VERSION.rst
@@ -1,24 +1,23 @@
CMAKE_VERSION
-------------
-The CMake version string as up to four non-negative integer components
+The CMake version string as three non-negative integer components
separated by ``.`` and possibly followed by ``-`` and other information.
-The first three components represent the feature level and the fourth
+The first two components represent the feature level and the third
component represents either a bug-fix level or development date.
Release versions and release candidate versions of CMake use the format::
- <major>.<minor>.<patch>[.<tweak>][-rc<n>]
+ <major>.<minor>.<patch>[-rc<n>]
-where the ``<tweak>`` component is less than ``20000000``. Development
+where the ``<patch>`` component is less than ``20000000``. Development
versions of CMake use the format::
- <major>.<minor>.<patch>.<date>[-<id>]
+ <major>.<minor>.<date>[-<id>]
where the ``<date>`` component is of format ``CCYYMMDD`` and ``<id>``
may contain arbitrary text. This represents development as of a
-particular date following the ``<major>.<minor>.<patch>`` feature
-release.
+particular date following the ``<major>.<minor>`` feature release.
Individual component values are also available in variables:
@@ -35,6 +34,12 @@ strings as floating-point numbers.
.. note::
+ CMake versions 2.8.2 through 2.8.12 used three components for the
+ feature level. Release versions represented the bug-fix level in a
+ fourth component, i.e. ``<major>.<minor>.<patch>[.<tweak>][-rc<n>]``.
+ Development versions represented the development date in the fourth
+ component, i.e. ``<major>.<minor>.<patch>.<date>[-<id>]``.
+
CMake versions prior to 2.8.2 used three components for the
feature level and had no bug-fix component. Release versions
used an even-valued second component, i.e.