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, master has been updated
via b62d15c216136d81c9318913333f3b4947394279 (commit)
via 2f43bd3b6ca886b52fadae50a3bfbbf44029b9cd (commit)
via e3e5445d83c253c3ddc18b5b02b59e90aa0b9df9 (commit)
via 5b56795d57ad79dcc4ce9070481101f28f737eda (commit)
from d24227da68114b493d1e44a0f0af65c2a8a9305c (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 -----------------------------------------------------------------
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=b62d15c216136d81c9318913333f3b4947394279
commit b62d15c216136d81c9318913333f3b4947394279
Merge: d24227d 2f43bd3
Author: Brad King <brad.k...@kitware.com>
AuthorDate: Wed Oct 10 11:04:32 2018 +0000
Commit: Kitware Robot <kwro...@kitware.com>
CommitDate: Wed Oct 10 07:05:03 2018 -0400
Merge topic 'project-version'
2f43bd3b6c Help: move description of CMAKE_PROJECT_* variables
e3e5445d83 Help: Describe options of command project in a definition list.
5b56795d57 Help: make the two signatures of command "project" orthogonal
Acked-by: Kitware Robot <kwro...@kitware.com>
Merge-request: !2450
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=2f43bd3b6ca886b52fadae50a3bfbbf44029b9cd
commit 2f43bd3b6ca886b52fadae50a3bfbbf44029b9cd
Author: Joachim Wuttke (o) <j.wut...@fz-juelich.de>
AuthorDate: Tue Oct 9 15:28:53 2018 +0200
Commit: Joachim Wuttke (o) <j.wut...@fz-juelich.de>
CommitDate: Tue Oct 9 15:28:53 2018 +0200
Help: move description of CMAKE_PROJECT_* variables
Describe these variables along with the other variables.
diff --git a/Help/command/project.rst b/Help/command/project.rst
index 18420e4..688e56c 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -16,7 +16,11 @@ Synopsis
[LANGUAGES <language-name>...])
Sets the name of the project, and stores it in the variable
-:variable:`PROJECT_NAME`. Also sets the variables
+:variable:`PROJECT_NAME`. When called from the top-level
+``CMakeLists.txt`` also stores the project name in the
+variable :variable:`CMAKE_PROJECT_NAME`.
+
+Also sets the variables
* :variable:`PROJECT_SOURCE_DIR`,
:variable:`<PROJECT-NAME>_SOURCE_DIR`
@@ -55,6 +59,9 @@ The options are:
* :variable:`PROJECT_VERSION_TWEAK`,
:variable:`<PROJECT-NAME>_VERSION_TWEAK`.
+ When the :command:`project()` command is called from the top-level
``CMakeLists.txt``,
+ then the version is also stored in the variable
:variable:`CMAKE_PROJECT_VERSION`.
+
``DESCRIPTION <project-description-string>``
Optional.
Sets the variables
@@ -65,6 +72,9 @@ The options are:
It is recommended that this description is a relatively short string,
usually no more than a few words.
+ When the :command:`project()` command is called from the top-level
``CMakeLists.txt``,
+ then the description is also stored in the variable
:variable:`CMAKE_PROJECT_DESCRIPTION`.
+
``HOMEPAGE_URL <url-string>``
Optional.
Sets the variables
@@ -73,6 +83,9 @@ The options are:
to ``<url-string>``, which should be the canonical home URL for the project.
+ When the :command:`project()` command is called from the top-level
``CMakeLists.txt``,
+ then the URL also is stored in the variable
:variable:`CMAKE_PROJECT_HOMEPAGE_URL`.
+
``LANGUAGES <language-name>...``
Optional.
Can also be specified without ``LANGUAGES`` keyword per the first, short
signature.
@@ -96,16 +109,11 @@ The top-level ``CMakeLists.txt`` file for a project must
contain a
literal, direct call to the :command:`project` command; loading one
through the :command:`include` command is not sufficient. If no such
call exists CMake will implicitly add one to the top that enables the
-default languages (``C`` and ``CXX``). The name of the project set in
-the top level ``CMakeLists.txt`` file is available from the
-:variable:`CMAKE_PROJECT_NAME` variable, its description from
-:variable:`CMAKE_PROJECT_DESCRIPTION`, its homepage URL from
-:variable:`CMAKE_PROJECT_HOMEPAGE_URL` and its version from
-:variable:`CMAKE_PROJECT_VERSION`.
+default languages (``C`` and ``CXX``).
.. note::
Call the :command:`cmake_minimum_required` command at the beginning
of the top-level ``CMakeLists.txt`` file even before calling the
- ``project()`` command. It is important to establish version and
+ :command:`project()` command. It is important to establish version and
policy settings before invoking other commands whose behavior they
may affect. See also policy :policy:`CMP0000`.
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=e3e5445d83c253c3ddc18b5b02b59e90aa0b9df9
commit e3e5445d83c253c3ddc18b5b02b59e90aa0b9df9
Author: Joachim Wuttke (l) <j.wut...@fz-juelich.de>
AuthorDate: Fri Oct 5 15:32:46 2018 +0200
Commit: Joachim Wuttke (o) <j.wut...@fz-juelich.de>
CommitDate: Tue Oct 9 14:29:57 2018 +0200
Help: Describe options of command project in a definition list.
Also add section headers;
explain default setting of optional argument variables.
diff --git a/Help/command/project.rst b/Help/command/project.rst
index f91eed8..18420e4 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -1,7 +1,10 @@
project
-------
-Sets project details such as name, version, etc. and enables languages.
+Set the name of the project.
+
+Synopsis
+^^^^^^^^
.. code-block:: cmake
@@ -12,65 +15,83 @@ Sets project details such as name, version, etc. and
enables languages.
[HOMEPAGE_URL <url-string>]
[LANGUAGES <language-name>...])
-Sets the name of the project and stores the name in the
-:variable:`PROJECT_NAME` variable. Additionally this sets variables
+Sets the name of the project, and stores it in the variable
+:variable:`PROJECT_NAME`. Also sets the variables
* :variable:`PROJECT_SOURCE_DIR`,
:variable:`<PROJECT-NAME>_SOURCE_DIR`
* :variable:`PROJECT_BINARY_DIR`,
:variable:`<PROJECT-NAME>_BINARY_DIR`
-If ``VERSION`` is specified, given components must be non-negative integers.
-If ``VERSION`` is not specified, the default version is the empty string.
-The ``VERSION`` option may not be used unless policy :policy:`CMP0048` is
-set to ``NEW``.
-
-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`
-
-Variables corresponding to unspecified versions are set to the empty string
-(if policy :policy:`CMP0048` is set to ``NEW``).
-
-If the optional ``DESCRIPTION`` is given, then :variable:`PROJECT_DESCRIPTION`
-and :variable:`<PROJECT-NAME>_DESCRIPTION` will be set to its argument.
-These variables will be cleared if ``DESCRIPTION`` is not given.
-The description is expected to be a relatively short string, usually no more
-than a few words.
-
-The optional ``HOMEPAGE_URL`` sets the analogous variables
-:variable:`PROJECT_HOMEPAGE_URL` and :variable:`<PROJECT-NAME>_HOMEPAGE_URL`.
-When this option is given, the URL provided should be the canonical home for
-the project.
-These variables will be cleared if ``HOMEPAGE_URL`` is not given.
-
-Note that the description and homepage URL may be used as defaults for
-things like packaging meta-data, documentation, etc.
-
-Optionally you can specify which languages your project supports.
-Example languages include ``C``, ``CXX`` (i.e. C++), ``CUDA``,
-``Fortran``, and ``ASM``.
-By default ``C`` and ``CXX`` are enabled if no language options are
-given. Specify language ``NONE``, or use the ``LANGUAGES`` keyword
-and list no languages, to skip enabling any languages.
-
-If enabling ``ASM``, list it last so that CMake can check whether
-compilers for other languages like ``C`` work for assembly too.
-
-If a variable exists called :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`,
+Further variables are set by the optional arguments described in the following.
+If any of these arguments is not used, then the corresponding variables are
+set to the empty string.
+
+If the variable :variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE` exists,
the file pointed to by that variable will be included as the last step of the
project command.
+Options
+^^^^^^^
+
+The options are:
+
+``VERSION <version>``
+ Optional; may not be used unless policy :policy:`CMP0048` is
+ set to ``NEW``.
+
+ Takes a ``<version>`` argument composed of non-negative integer components,
+ i.e. ``<major>[.<minor>[.<patch>[.<tweak>]]]``,
+ and sets the 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`.
+
+``DESCRIPTION <project-description-string>``
+ Optional.
+ Sets the variables
+
+ * :variable:`PROJECT_DESCRIPTION`, :variable:`<PROJECT-NAME>_DESCRIPTION`
+
+ to ``<project-description-string>``.
+ It is recommended that this description is a relatively short string,
+ usually no more than a few words.
+
+``HOMEPAGE_URL <url-string>``
+ Optional.
+ Sets the variables
+
+ * :variable:`PROJECT_HOMEPAGE_URL`, :variable:`<PROJECT-NAME>_HOMEPAGE_URL`
+
+ to ``<url-string>``, which should be the canonical home URL for the project.
+
+``LANGUAGES <language-name>...``
+ Optional.
+ Can also be specified without ``LANGUAGES`` keyword per the first, short
signature.
+
+ Selects which programming languages are needed to build the project.
+ Supported languages include ``C``, ``CXX`` (i.e. C++), ``CUDA``,
``Fortran``, and ``ASM``.
+ By default ``C`` and ``CXX`` are enabled if no language options are given.
+ Specify language ``NONE``, or use the ``LANGUAGES`` keyword and list no
languages,
+ to skip enabling any languages.
+
+ If enabling ``ASM``, list it last so that CMake can check whether
+ compilers for other languages like ``C`` work for assembly too.
+
+The variables set through the ``VERSION``, ``DESCRIPTION`` and ``HOMEPAGE_URL``
+options are intended for use as default values in package metadata and
documentation.
+
+Usage
+^^^^^
+
The top-level ``CMakeLists.txt`` file for a project must contain a
literal, direct call to the :command:`project` command; loading one
through the :command:`include` command is not sufficient. If no such
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=5b56795d57ad79dcc4ce9070481101f28f737eda
commit 5b56795d57ad79dcc4ce9070481101f28f737eda
Author: Joachim Wuttke (l) <j.wut...@fz-juelich.de>
AuthorDate: Fri Oct 5 15:23:15 2018 +0200
Commit: Joachim Wuttke (o) <j.wut...@fz-juelich.de>
CommitDate: Tue Oct 9 14:22:09 2018 +0200
Help: make the two signatures of command "project" orthogonal
diff --git a/Help/command/project.rst b/Help/command/project.rst
index bd8b4ef..f91eed8 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -5,7 +5,7 @@ Sets project details such as name, version, etc. and enables
languages.
.. code-block:: cmake
- project(<PROJECT-NAME> [LANGUAGES] [<language-name>...])
+ project(<PROJECT-NAME> [<language-name>...])
project(<PROJECT-NAME>
[VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
[DESCRIPTION <project-description-string>]
-----------------------------------------------------------------------
Summary of changes:
Help/command/project.rst | 147 ++++++++++++++++++++++++++++-------------------
1 file changed, 88 insertions(+), 59 deletions(-)
hooks/post-receive
--
CMake
_______________________________________________
Cmake-commits mailing list
Cmake-commits@cmake.org
https://cmake.org/mailman/listinfo/cmake-commits
