[Cmake-commits] CMake branch, next, updated. v2.8.12.1-7300-g84feb1f
Brad King
brad.king at kitware.com
Mon Jan 27 13:40:44 EST 2014
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 84feb1f1b29d681878a5f61cf0f813076737cb26 (commit)
via 73019d661746fbbd3bc4cffb8fa9b7c5a144fb6f (commit)
from 6a65a425c9be5285201257d90063414a7be95af2 (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=84feb1f1b29d681878a5f61cf0f813076737cb26
commit 84feb1f1b29d681878a5f61cf0f813076737cb26
Merge: 6a65a42 73019d6
Author: Brad King <brad.king at kitware.com>
AuthorDate: Mon Jan 27 13:40:43 2014 -0500
Commit: CMake Topic Stage <kwrobot at kitware.com>
CommitDate: Mon Jan 27 13:40:43 2014 -0500
Merge topic 'AddVersionToProjectCommand' into next
73019d66 Help: Cleanup project() command and variable documentation
http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=73019d661746fbbd3bc4cffb8fa9b7c5a144fb6f
commit 73019d661746fbbd3bc4cffb8fa9b7c5a144fb6f
Author: Brad King <brad.king at kitware.com>
AuthorDate: Mon Jan 27 13:39:04 2014 -0500
Commit: Brad King <brad.king at kitware.com>
CommitDate: Mon Jan 27 13:39:04 2014 -0500
Help: Cleanup project() command and variable documentation
Add documents for each PROJECT_VERSION and <PROJECT_NAME>_VERSION
variable. Format the project() command documentation to link to each of
the variables in bullet lists. Tweak some documentation wording.
diff --git a/Help/command/project.rst b/Help/command/project.rst
index 04c953e..5ecfcb1 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -1,28 +1,42 @@
project
-------
-Set a name for the entire project.
-
-::
-
- project(<projectname> [VERSION major[.minor[.patch[.tweak]]]] [languageName1 languageName2 ... ] )
-
-Sets the name of the project, the name is also stored in the PROJECT_NAME
-variable. Additionally this sets the cache variables
-<projectName>_BINARY_DIR and <projectName>_SOURCE_DIR to the
-respective values, as well as the PROJECT_BINARY_DIR and PROJECT_SOURCE_DIR
-variables.
-
-If a version is specified, the :command:`project()` command sets the variables
-PROJECT_VERSION and <projectName>_VERSION to this version.
-Additionally the up to 4 components of the version string are stored in the
-PROJECT_VERSION_MAJOR, PROJECT_VERSION_MINOR, PROJECT_VERSION_PATCH and
-PROJECT_VERSION_TWEAK, as well as the <projectName>_VERSION_MAJOR,
-<projectName>_VERSION_MINOR, <projectName>_VERSION_PATCH> and
-<projectName>_VERSION_TWEAK variables.
-If VERSION is not used, the PROJECT_VERSION variables will be unset if they
-have been set by a :command:`project(VERSION)` call before. This can be disabled
-by setting the variable CMAKE_PROJECT_VERSION_SET_BY_PROJECT_COMMAND to FALSE.
+Set a name, version, and enable languages for the entire project.
+
+.. code-block:: cmake
+
+ project(<PROJECT-NAME>
+ [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
+ [<language-name>...])
+
+Sets the name of the project and stores the name in the
+:variable:`PROJECT_NAME` variable. Additionally this sets variables
+
+* :variable:`PROJECT_SOURCE_DIR`,
+ :variable:`<PROJECT-NAME>_SOURCE_DIR`
+* :variable:`PROJECT_BINARY_DIR`,
+ :variable:`<PROJECT-NAME>_BINARY_DIR`
+
+If ``VERSION`` is specified, the components must be non-negative integers.
+The :command:`project()` command stores the version number and its components
+in variables
+
+* :variable:`PROJECT_VERSION`,
+ :variable:`<PROJECT-NAME>_VERSION`
+* :variable:`PROJECT_VERSION_MAJOR`,
+ :variable:`<PROJECT-NAME>_VERSION_MAJOR`
+* :variable:`PROJECT_VERSION_MINOR`,
+ :variable:`<PROJECT-NAME>_VERSION_MINOR`
+* :variable:`PROJECT_VERSION_PATCH`,
+ :variable:`<PROJECT-NAME>_VERSION_PATCH`
+* :variable:`PROJECT_VERSION_TWEAK`,
+ :variable:`<PROJECT-NAME>_VERSION_TWEAK`
+
+If ``VERSION`` is not used, the :variable:`PROJECT_VERSION` variables will be
+unset if they have been set by a :command:`project(VERSION)` call before.
+(This can be disabled by setting the variable
+``CMAKE_PROJECT_VERSION_SET_BY_PROJECT_COMMAND`` to ``FALSE`` before
+invoking the command.)
Optionally you can specify which languages your project supports.
Example languages are CXX (i.e. C++), C, Fortran, etc. By default C
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst
index aebfe87..6467d66 100644
--- a/Help/manual/cmake-variables.7.rst
+++ b/Help/manual/cmake-variables.7.rst
@@ -78,7 +78,17 @@ Variables that Provide Information
/variable/PROJECT-NAME_BINARY_DIR
/variable/PROJECT_NAME
/variable/PROJECT-NAME_SOURCE_DIR
+ /variable/PROJECT-NAME_VERSION
+ /variable/PROJECT-NAME_VERSION_MAJOR
+ /variable/PROJECT-NAME_VERSION_MINOR
+ /variable/PROJECT-NAME_VERSION_PATCH
+ /variable/PROJECT-NAME_VERSION_TWEAK
/variable/PROJECT_SOURCE_DIR
+ /variable/PROJECT_VERSION
+ /variable/PROJECT_VERSION_MAJOR
+ /variable/PROJECT_VERSION_MINOR
+ /variable/PROJECT_VERSION_PATCH
+ /variable/PROJECT_VERSION_TWEAK
Variables that Change Behavior
==============================
diff --git a/Help/variable/PROJECT-NAME_BINARY_DIR.rst b/Help/variable/PROJECT-NAME_BINARY_DIR.rst
index a19940f..49bc558 100644
--- a/Help/variable/PROJECT-NAME_BINARY_DIR.rst
+++ b/Help/variable/PROJECT-NAME_BINARY_DIR.rst
@@ -3,6 +3,6 @@
Top level binary directory for the named project.
-A variable is created with the name used in the PROJECT command, and
-is the binary directory for the project. This can be useful when
-SUBDIR is used to connect several projects.
+A variable is created with the name used in the :command:`project` command,
+and is the binary directory for the project. This can be useful when
+:command:`add_subdirectory` is used to connect several projects.
diff --git a/Help/variable/PROJECT-NAME_SOURCE_DIR.rst b/Help/variable/PROJECT-NAME_SOURCE_DIR.rst
index f2f5caf..4df3e22 100644
--- a/Help/variable/PROJECT-NAME_SOURCE_DIR.rst
+++ b/Help/variable/PROJECT-NAME_SOURCE_DIR.rst
@@ -3,6 +3,6 @@
Top level source directory for the named project.
-A variable is created with the name used in the PROJECT command, and
-is the source directory for the project. This can be useful when
-add_subdirectory is used to connect several projects.
+A variable is created with the name used in the :command:`project` command,
+and is the source directory for the project. This can be useful when
+:command:`add_subdirectory` is used to connect several projects.
diff --git a/Help/variable/PROJECT-NAME_VERSION.rst b/Help/variable/PROJECT-NAME_VERSION.rst
new file mode 100644
index 0000000..0f6ed51
--- /dev/null
+++ b/Help/variable/PROJECT-NAME_VERSION.rst
@@ -0,0 +1,11 @@
+<PROJECT-NAME>_VERSION
+----------------------
+
+Value given to the ``VERSION`` option of the most recent call to the
+:command:`project` command with project name ``<PROJECT-NAME>``, if any.
+
+See also the component-wise version variables
+:variable:`<PROJECT-NAME>_VERSION_MAJOR`,
+:variable:`<PROJECT-NAME>_VERSION_MINOR`,
+:variable:`<PROJECT-NAME>_VERSION_PATCH`, and
+:variable:`<PROJECT-NAME>_VERSION_TWEAK`.
diff --git a/Help/variable/PROJECT-NAME_VERSION_MAJOR.rst b/Help/variable/PROJECT-NAME_VERSION_MAJOR.rst
new file mode 100644
index 0000000..9e2d755
--- /dev/null
+++ b/Help/variable/PROJECT-NAME_VERSION_MAJOR.rst
@@ -0,0 +1,5 @@
+<PROJECT-NAME>_VERSION_MAJOR
+----------------------------
+
+First version number component of the :variable:`<PROJECT-NAME>_VERSION`
+variable as set by the :command:`project` command.
diff --git a/Help/variable/PROJECT-NAME_VERSION_MINOR.rst b/Help/variable/PROJECT-NAME_VERSION_MINOR.rst
new file mode 100644
index 0000000..fa2cdab
--- /dev/null
+++ b/Help/variable/PROJECT-NAME_VERSION_MINOR.rst
@@ -0,0 +1,5 @@
+<PROJECT-NAME>_VERSION_MINOR
+----------------------------
+
+Second version number component of the :variable:`<PROJECT-NAME>_VERSION`
+variable as set by the :command:`project` command.
diff --git a/Help/variable/PROJECT-NAME_VERSION_PATCH.rst b/Help/variable/PROJECT-NAME_VERSION_PATCH.rst
new file mode 100644
index 0000000..85b5e6b
--- /dev/null
+++ b/Help/variable/PROJECT-NAME_VERSION_PATCH.rst
@@ -0,0 +1,5 @@
+<PROJECT-NAME>_VERSION_PATCH
+----------------------------
+
+Third version number component of the :variable:`<PROJECT-NAME>_VERSION`
+variable as set by the :command:`project` command.
diff --git a/Help/variable/PROJECT-NAME_VERSION_TWEAK.rst b/Help/variable/PROJECT-NAME_VERSION_TWEAK.rst
new file mode 100644
index 0000000..65c4044
--- /dev/null
+++ b/Help/variable/PROJECT-NAME_VERSION_TWEAK.rst
@@ -0,0 +1,5 @@
+<PROJECT-NAME>_VERSION_TWEAK
+----------------------------
+
+Fourth version number component of the :variable:`<PROJECT-NAME>_VERSION`
+variable as set by the :command:`project` command.
diff --git a/Help/variable/PROJECT_BINARY_DIR.rst b/Help/variable/PROJECT_BINARY_DIR.rst
index e506bdd..09e9ef2 100644
--- a/Help/variable/PROJECT_BINARY_DIR.rst
+++ b/Help/variable/PROJECT_BINARY_DIR.rst
@@ -3,4 +3,4 @@ PROJECT_BINARY_DIR
Full path to build directory for project.
-This is the binary directory of the most recent PROJECT command.
+This is the binary directory of the most recent :command:`project` command.
diff --git a/Help/variable/PROJECT_NAME.rst b/Help/variable/PROJECT_NAME.rst
index 7559af6..61aa8bc 100644
--- a/Help/variable/PROJECT_NAME.rst
+++ b/Help/variable/PROJECT_NAME.rst
@@ -3,4 +3,4 @@ PROJECT_NAME
Name of the project given to the project command.
-This is the name given to the most recent PROJECT command.
+This is the name given to the most recent :command:`project` command.
diff --git a/Help/variable/PROJECT_SOURCE_DIR.rst b/Help/variable/PROJECT_SOURCE_DIR.rst
index c9ba132..27f2838 100644
--- a/Help/variable/PROJECT_SOURCE_DIR.rst
+++ b/Help/variable/PROJECT_SOURCE_DIR.rst
@@ -3,4 +3,4 @@ PROJECT_SOURCE_DIR
Top level source directory for the current project.
-This is the source directory of the most recent PROJECT command.
+This is the source directory of the most recent :command:`project` command.
diff --git a/Help/variable/PROJECT_VERSION.rst b/Help/variable/PROJECT_VERSION.rst
new file mode 100644
index 0000000..234558d
--- /dev/null
+++ b/Help/variable/PROJECT_VERSION.rst
@@ -0,0 +1,11 @@
+PROJECT_VERSION
+---------------
+
+Value given to the ``VERSION`` option of the most recent call to the
+:command:`project` command, if any.
+
+See also the component-wise version variables
+:variable:`PROJECT_VERSION_MAJOR`,
+:variable:`PROJECT_VERSION_MINOR`,
+:variable:`PROJECT_VERSION_PATCH`, and
+:variable:`PROJECT_VERSION_TWEAK`.
diff --git a/Help/variable/PROJECT_VERSION_MAJOR.rst b/Help/variable/PROJECT_VERSION_MAJOR.rst
new file mode 100644
index 0000000..4b6072c
--- /dev/null
+++ b/Help/variable/PROJECT_VERSION_MAJOR.rst
@@ -0,0 +1,5 @@
+PROJECT_VERSION_MAJOR
+---------------------
+
+First version number component of the :variable:`PROJECT_VERSION`
+variable as set by the :command:`project` command.
diff --git a/Help/variable/PROJECT_VERSION_MINOR.rst b/Help/variable/PROJECT_VERSION_MINOR.rst
new file mode 100644
index 0000000..5f31220
--- /dev/null
+++ b/Help/variable/PROJECT_VERSION_MINOR.rst
@@ -0,0 +1,5 @@
+PROJECT_VERSION_MINOR
+---------------------
+
+Second version number component of the :variable:`PROJECT_VERSION`
+variable as set by the :command:`project` command.
diff --git a/Help/variable/PROJECT_VERSION_PATCH.rst b/Help/variable/PROJECT_VERSION_PATCH.rst
new file mode 100644
index 0000000..ac72ec0
--- /dev/null
+++ b/Help/variable/PROJECT_VERSION_PATCH.rst
@@ -0,0 +1,5 @@
+PROJECT_VERSION_PATCH
+---------------------
+
+Third version number component of the :variable:`PROJECT_VERSION`
+variable as set by the :command:`project` command.
diff --git a/Help/variable/PROJECT_VERSION_TWEAK.rst b/Help/variable/PROJECT_VERSION_TWEAK.rst
new file mode 100644
index 0000000..d7f96d6
--- /dev/null
+++ b/Help/variable/PROJECT_VERSION_TWEAK.rst
@@ -0,0 +1,5 @@
+PROJECT_VERSION_TWEAK
+---------------------
+
+Fourth version number component of the :variable:`PROJECT_VERSION`
+variable as set by the :command:`project` command.
-----------------------------------------------------------------------
Summary of changes:
Help/command/project.rst | 58 ++++++++++++++++----------
Help/manual/cmake-variables.7.rst | 10 +++++
Help/variable/PROJECT-NAME_BINARY_DIR.rst | 6 +--
Help/variable/PROJECT-NAME_SOURCE_DIR.rst | 6 +--
Help/variable/PROJECT-NAME_VERSION.rst | 11 +++++
Help/variable/PROJECT-NAME_VERSION_MAJOR.rst | 5 +++
Help/variable/PROJECT-NAME_VERSION_MINOR.rst | 5 +++
Help/variable/PROJECT-NAME_VERSION_PATCH.rst | 5 +++
Help/variable/PROJECT-NAME_VERSION_TWEAK.rst | 5 +++
Help/variable/PROJECT_BINARY_DIR.rst | 2 +-
Help/variable/PROJECT_NAME.rst | 2 +-
Help/variable/PROJECT_SOURCE_DIR.rst | 2 +-
Help/variable/PROJECT_VERSION.rst | 11 +++++
Help/variable/PROJECT_VERSION_MAJOR.rst | 5 +++
Help/variable/PROJECT_VERSION_MINOR.rst | 5 +++
Help/variable/PROJECT_VERSION_PATCH.rst | 5 +++
Help/variable/PROJECT_VERSION_TWEAK.rst | 5 +++
17 files changed, 117 insertions(+), 31 deletions(-)
create mode 100644 Help/variable/PROJECT-NAME_VERSION.rst
create mode 100644 Help/variable/PROJECT-NAME_VERSION_MAJOR.rst
create mode 100644 Help/variable/PROJECT-NAME_VERSION_MINOR.rst
create mode 100644 Help/variable/PROJECT-NAME_VERSION_PATCH.rst
create mode 100644 Help/variable/PROJECT-NAME_VERSION_TWEAK.rst
create mode 100644 Help/variable/PROJECT_VERSION.rst
create mode 100644 Help/variable/PROJECT_VERSION_MAJOR.rst
create mode 100644 Help/variable/PROJECT_VERSION_MINOR.rst
create mode 100644 Help/variable/PROJECT_VERSION_PATCH.rst
create mode 100644 Help/variable/PROJECT_VERSION_TWEAK.rst
hooks/post-receive
--
CMake
More information about the Cmake-commits
mailing list