[Cmake-commits] CMake branch, master, updated. v3.11.0-rc3-228-gccdd79d
Kitware Robot
kwrobot at kitware.com
Wed Mar 14 10:55:08 EDT 2018
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 ccdd79d38ed3eadabbfcc18e8e6de5bd6080777c (commit)
via 443a52aa850c1a19d3da0608212a41a4f074d3e9 (commit)
via 4fb91a886870dc9b86c7861b2bdd3e572df01624 (commit)
via 6a2a9d107dfeb86187459c224805128ee332f8eb (commit)
via 8b43adc45c2cf7a25b739589dec2010029f91a83 (commit)
via 4b25cc452ae5fdcb1ec2f420f05d98b01054e5e9 (commit)
from 65b7648609fdd37f5926efebfe9c3d7f4434a65d (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=ccdd79d38ed3eadabbfcc18e8e6de5bd6080777c
commit ccdd79d38ed3eadabbfcc18e8e6de5bd6080777c
Merge: 443a52a 6a2a9d1
Author: Brad King <brad.king at kitware.com>
AuthorDate: Wed Mar 14 14:49:14 2018 +0000
Commit: Kitware Robot <kwrobot at kitware.com>
CommitDate: Wed Mar 14 10:51:11 2018 -0400
Merge topic 'cmake_project_xxx_docs'
6a2a9d107d Help: Fix incorrect CMAKE_PROJECT_xxx docs
Acked-by: Kitware Robot <kwrobot at kitware.com>
Merge-request: !1847
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=443a52aa850c1a19d3da0608212a41a4f074d3e9
commit 443a52aa850c1a19d3da0608212a41a4f074d3e9
Merge: 4fb91a8 8b43adc
Author: Brad King <brad.king at kitware.com>
AuthorDate: Wed Mar 14 14:49:06 2018 +0000
Commit: Kitware Robot <kwrobot at kitware.com>
CommitDate: Wed Mar 14 10:50:29 2018 -0400
Merge topic 'build_and_test_mode_docs'
8b43adc45c Help: Clarify ctest build-and-test mode options
Acked-by: Kitware Robot <kwrobot at kitware.com>
Merge-request: !1848
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=4fb91a886870dc9b86c7861b2bdd3e572df01624
commit 4fb91a886870dc9b86c7861b2bdd3e572df01624
Merge: 65b7648 4b25cc4
Author: Brad King <brad.king at kitware.com>
AuthorDate: Wed Mar 14 14:48:57 2018 +0000
Commit: Kitware Robot <kwrobot at kitware.com>
CommitDate: Wed Mar 14 10:49:11 2018 -0400
Merge topic 'doc-vs-workdir-versions'
4b25cc452a Help: Document VS_DEBUGGER_WORKING_DIRECTORY supported VS versions
Acked-by: Kitware Robot <kwrobot at kitware.com>
Merge-request: !1843
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=6a2a9d107dfeb86187459c224805128ee332f8eb
commit 6a2a9d107dfeb86187459c224805128ee332f8eb
Author: Craig Scott <craig.scott at crascit.com>
AuthorDate: Tue Mar 13 22:30:36 2018 +1100
Commit: Craig Scott <craig.scott at crascit.com>
CommitDate: Wed Mar 14 07:33:38 2018 +1100
Help: Fix incorrect CMAKE_PROJECT_xxx docs
The docs for CMAKE_PROJECT_NAME and CMAKE_PROJECT_DESCRIPTION
were erroneously documenting the behavior of PROJECT_NAME and
PROJECT_DESCRIPTION respectively. Fix these and update the
project() docs to also mention CMAKE_PROJECT_NAME and
CMAKE_PROJECT_DESCRIPTION.
Fixes: #17815
diff --git a/Help/command/project.rst b/Help/command/project.rst
index eb185e4..ac71d7a 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -1,7 +1,7 @@
project
-------
-Set a name, version, and enable languages for the entire project.
+Sets project details such as name, version, etc. and enables languages.
.. code-block:: cmake
@@ -63,7 +63,10 @@ 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``).
+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 and its description from
+:variable:`CMAKE_PROJECT_DESCRIPTION`.
.. note::
Call the :command:`cmake_minimum_required` command at the beginning
diff --git a/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst b/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst
index f1911ec..6db5b9e 100644
--- a/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst
+++ b/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst
@@ -1,7 +1,35 @@
CMAKE_PROJECT_DESCRIPTION
-------------------------
-The description of the current project.
+The description of the top level project.
-This specifies description of the current project from the closest inherited
-:command:`project` command.
+This variable holds the description of the project as specified in the top
+level CMakeLists.txt file by a :command:`project` command. In the event that
+the top level CMakeLists.txt contains multiple :command:`project` calls,
+the most recently called one from that top level CMakeLists.txt will determine
+the name that ``CMAKE_PROJECT_DESCRIPTION`` contains. For example, consider
+the following top level CMakeLists.txt:
+
+.. code-block:: cmake
+
+ cmake_minimum_required(VERSION 3.0)
+ project(First DESCRIPTION "I am First")
+ project(Second DESCRIPTION "I am Second")
+ add_subdirectory(sub)
+ project(Third DESCRIPTION "I am Third")
+
+And ``sub/CMakeLists.txt`` with the following contents:
+
+.. code-block:: cmake
+
+ project(SubProj DESCRIPTION "I am SubProj")
+ message("CMAKE_PROJECT_DESCRIPTION = ${CMAKE_PROJECT_DESCRIPTION}")
+
+The most recently seen :command:`project` command from the top level
+CMakeLists.txt would be ``project(Second ...)``, so this will print::
+
+ CMAKE_PROJECT_DESCRIPTION = I am Second
+
+To obtain the description from the most recent call to :command:`project` in
+the current directory scope or above, see the :variable:`PROJECT_DESCRIPTION`
+variable.
diff --git a/Help/variable/CMAKE_PROJECT_NAME.rst b/Help/variable/CMAKE_PROJECT_NAME.rst
index 431e9f3..94b8dba 100644
--- a/Help/variable/CMAKE_PROJECT_NAME.rst
+++ b/Help/variable/CMAKE_PROJECT_NAME.rst
@@ -1,7 +1,35 @@
CMAKE_PROJECT_NAME
------------------
-The name of the current project.
+The name of the top level project.
-This specifies name of the current project from the closest inherited
-:command:`project` command.
+This variable holds the name of the project as specified in the top
+level CMakeLists.txt file by a :command:`project` command. In the event that
+the top level CMakeLists.txt contains multiple :command:`project` calls,
+the most recently called one from that top level CMakeLists.txt will determine
+the name that ``CMAKE_PROJECT_NAME`` contains. For example, consider
+the following top level CMakeLists.txt:
+
+.. code-block:: cmake
+
+ cmake_minimum_required(VERSION 3.0)
+ project(First)
+ project(Second)
+ add_subdirectory(sub)
+ project(Third)
+
+And ``sub/CMakeLists.txt`` with the following contents:
+
+.. code-block:: cmake
+
+ project(SubProj)
+ message("CMAKE_PROJECT_NAME = ${CMAKE_PROJECT_NAME}")
+
+The most recently seen :command:`project` command from the top level
+CMakeLists.txt would be ``project(Second)``, so this will print::
+
+ CMAKE_PROJECT_NAME = Second
+
+To obtain the name from the most recent call to :command:`project` in
+the current directory scope or above, see the :variable:`PROJECT_NAME`
+variable.
diff --git a/Help/variable/PROJECT_DESCRIPTION.rst b/Help/variable/PROJECT_DESCRIPTION.rst
index 05ede8f..2833e11 100644
--- a/Help/variable/PROJECT_DESCRIPTION.rst
+++ b/Help/variable/PROJECT_DESCRIPTION.rst
@@ -3,4 +3,7 @@ PROJECT_DESCRIPTION
Short project description given to the project command.
-This is the description given to the most recent :command:`project` command.
+This is the description given to the most recently called :command:`project`
+command in the current directory scope or above. To obtain the description
+of the top level project, see the :variable:`CMAKE_PROJECT_DESCRIPTION`
+variable.
diff --git a/Help/variable/PROJECT_NAME.rst b/Help/variable/PROJECT_NAME.rst
index 61aa8bc..672680a 100644
--- a/Help/variable/PROJECT_NAME.rst
+++ b/Help/variable/PROJECT_NAME.rst
@@ -3,4 +3,6 @@ PROJECT_NAME
Name of the project given to the project command.
-This is the name given to the most recent :command:`project` command.
+This is the name given to the most recently called :command:`project`
+command in the current directory scope or above. To obtain the name of
+the top level project, see the :variable:`CMAKE_PROJECT_NAME` variable.
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=8b43adc45c2cf7a25b739589dec2010029f91a83
commit 8b43adc45c2cf7a25b739589dec2010029f91a83
Author: Craig Scott <craig.scott at crascit.com>
AuthorDate: Tue Mar 13 23:11:17 2018 +1100
Commit: Craig Scott <craig.scott at crascit.com>
CommitDate: Wed Mar 14 07:27:54 2018 +1100
Help: Clarify ctest build-and-test mode options
Fixes: #17807
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst
index a04c403..75af22e 100644
--- a/Help/manual/ctest.1.rst
+++ b/Help/manual/ctest.1.rst
@@ -368,15 +368,17 @@ for "SubprojectB").
Build and Test Mode
===================
-CTest provides a command-line signature to to configure (i.e. run cmake on),
-build, and or execute a test::
+CTest provides a command-line signature to configure (i.e. run cmake on),
+build, and/or execute a test::
ctest --build-and-test <path-to-source> <path-to-build>
- --build-generator <generator> [<options>...] [-- <build-options>...]
- [--test-command <test>]
+ --build-generator <generator>
+ [<options>...]
+ [--build-options <opts>...]
+ [--test-command <command> [<args>...]]
The configure and test steps are optional. The arguments to this command line
-are the source and binary directories. The ``--build-generator`` option *must*
+are the source and binary directories. The ``--build-generator`` option *must*
be provided to use ``--build-and-test``. If ``--test-command`` is specified
then that will be run after the build is complete. Other options that affect
this mode include:
@@ -425,13 +427,15 @@ this mode include:
should be used. e.g. Debug/Release/etc.
``--build-options``
- Add extra options to the build step.
-
- This option must be the last option with the exception of
- ``--test-command``
+ Additional options for configuring the build (i.e. for CMake, not for
+ the build tool). Note that if this is specified, the ``--build-options``
+ keyword and its arguments must be the last option given on the command
+ line, with the possible exception of ``--test-command``.
``--test-command``
- The test to run with the ``--build-and-test`` option.
+ The command to run as the test step with the ``--build-and-test`` option.
+ All arguments following this keyword will be assumed to be part of the
+ test command line, so it must be the last option given.
``--test-timeout``
The time limit in seconds
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=4b25cc452ae5fdcb1ec2f420f05d98b01054e5e9
commit 4b25cc452ae5fdcb1ec2f420f05d98b01054e5e9
Author: Hannes Mezger <hannes.mezger at ascolab.com>
AuthorDate: Mon Mar 12 16:30:00 2018 +0100
Commit: Hannes Mezger <hannes.mezger at ascolab.com>
CommitDate: Tue Mar 13 10:13:59 2018 +0100
Help: Document VS_DEBUGGER_WORKING_DIRECTORY supported VS versions
diff --git a/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst b/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst
index 0af85cb..fb0389e 100644
--- a/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst
+++ b/Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst
@@ -4,3 +4,6 @@ VS_DEBUGGER_WORKING_DIRECTORY
Sets the local debugger working directory for Visual Studio C++ targets.
This is defined in ``<LocalDebuggerWorkingDirectory>`` in the Visual Studio
project file.
+
+This property only works for Visual Studio 2010 and above;
+it is ignored on other generators.
-----------------------------------------------------------------------
Summary of changes:
Help/command/project.rst | 7 +++--
Help/manual/ctest.1.rst | 24 +++++++++-------
Help/prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY.rst | 3 ++
Help/variable/CMAKE_PROJECT_DESCRIPTION.rst | 34 +++++++++++++++++++++--
Help/variable/CMAKE_PROJECT_NAME.rst | 34 +++++++++++++++++++++--
Help/variable/PROJECT_DESCRIPTION.rst | 5 +++-
Help/variable/PROJECT_NAME.rst | 4 ++-
7 files changed, 91 insertions(+), 20 deletions(-)
hooks/post-receive
--
CMake
More information about the Cmake-commits
mailing list