[Cmake-commits] CMake branch, next, updated. v3.5.2-1306-g46b19a6
Brad King
brad.king at kitware.com
Tue May 10 09:46:14 EDT 2016
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 46b19a6e31126863606f8b414c607fc794289d1a (commit)
via 3e503fe1acc7f341a160db30cd2d2db4ab0e8b8e (commit)
via d4faed2f7ffa1267b52e0cce9c0c32d8f88b6abc (commit)
from 3880c440e0a73b5b9898343bf17886ddfc50bd26 (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=46b19a6e31126863606f8b414c607fc794289d1a
commit 46b19a6e31126863606f8b414c607fc794289d1a
Merge: 3880c44 3e503fe
Author: Brad King <brad.king at kitware.com>
AuthorDate: Tue May 10 09:46:13 2016 -0400
Commit: CMake Topic Stage <kwrobot at kitware.com>
CommitDate: Tue May 10 09:46:13 2016 -0400
Merge topic 'doc-cmake-command-modes' into next
3e503fe1 Help: Document `cmake --build` as a separate command mode (#16093)
d4faed2f Help: Document `cmake --find-package` as a separate command mode
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=3e503fe1acc7f341a160db30cd2d2db4ab0e8b8e
commit 3e503fe1acc7f341a160db30cd2d2db4ab0e8b8e
Author: Brad King <brad.king at kitware.com>
AuthorDate: Tue May 10 09:42:37 2016 -0400
Commit: Brad King <brad.king at kitware.com>
CommitDate: Tue May 10 09:45:45 2016 -0400
Help: Document `cmake --build` as a separate command mode (#16093)
The `--build` mode was confusingly documented among other options,
falsely implying that it can be used anywhere on the command line.
Move the documentation to a dedicated section and clarify its usage
as s separate command line mode.
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 12b4012..65153af 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -10,7 +10,7 @@ Synopsis
cmake [<options>] (<path-to-source> | <path-to-existing-build>)
cmake [(-D <var>=<value>)...] -P <cmake-script-file>
- cmake --build <dir> [<options>] [-- <build-tool-options>...]
+ cmake --build <dir> [<options>...] [-- <build-tool-options>...]
cmake -E <command> [<options>...]
cmake --find-package <options>...
@@ -49,23 +49,7 @@ Options
display help for each variable.
``--build <dir>``
- Build a CMake-generated project binary tree.
-
- This abstracts a native build tool's command-line interface with the
- following options:
-
- ::
-
- <dir> = Project binary directory to be built.
- --target <tgt> = Build <tgt> instead of default targets.
- May only be specified once.
- --config <cfg> = For multi-configuration tools, choose <cfg>.
- --clean-first = Build target 'clean' first, then build.
- (To clean only, use --target 'clean'.)
- --use-stderr = Ignored. Behavior is default in CMake >= 3.0.
- -- = Pass remaining options to the native tool.
-
- Run ``cmake --build`` with no options for quick help.
+ See `Build Tool Mode`_.
``-N``
View mode only.
@@ -149,6 +133,38 @@ Options
.. include:: OPTIONS_HELP.txt
+Build Tool Mode
+===============
+
+CMake provides a command-line signature to build an already-generated
+project binary tree::
+
+ cmake --build <dir> [<options>...] [-- <build-tool-options>...]
+
+This abstracts a native build tool's command-line interface with the
+following options:
+
+``--build <dir>``
+ Project binary directory to be built. This is required and must be first.
+
+``--target <tgt>``
+ Build ``<tgt>`` instead of default targets. May only be specified once.
+
+``--config <cfg>``
+ For multi-configuration tools, choose configuration ``<cfg>``.
+
+``--clean-first``
+ Build target ``clean`` first, then build.
+ (To clean only, use ``--target clean``.)
+
+``--use-stderr``
+ Ignored. Behavior is default in CMake >= 3.0.
+
+``--``
+ Pass remaining options to the native tool.
+
+Run ``cmake --build`` with no options for quick help.
+
Command-Line Tool Mode
======================
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=d4faed2f7ffa1267b52e0cce9c0c32d8f88b6abc
commit d4faed2f7ffa1267b52e0cce9c0c32d8f88b6abc
Author: Brad King <brad.king at kitware.com>
AuthorDate: Tue May 10 09:35:48 2016 -0400
Commit: Brad King <brad.king at kitware.com>
CommitDate: Tue May 10 09:37:55 2016 -0400
Help: Document `cmake --find-package` as a separate command mode
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 3ae2baf..12b4012 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -82,12 +82,7 @@ Options
done before the -P argument.
``--find-package``
- Run in pkg-config like mode.
-
- Search a package using find_package() and print the resulting flags
- to stdout. This can be used to use cmake instead of pkg-config to
- find installed libraries in plain Makefile-based projects or in
- autoconf-based projects (via share/aclocal/cmake.m4).
+ See `Find-Package Tool Mode`_.
``--graphviz=[file]``
Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more.
@@ -278,6 +273,24 @@ The following ``cmake -E`` commands are available only on Windows:
``write_regv <key> <value>``
Write Windows registry value.
+Find-Package Tool Mode
+======================
+
+CMake provides a helper for Makefile-based projects with the signature::
+
+ cmake --find-package <options>...
+
+This runs in a pkg-config like mode.
+
+Search a package using :command:`find_package()` and print the resulting flags
+to stdout. This can be used to use cmake instead of pkg-config to find
+installed libraries in plain Makefile-based projects or in autoconf-based
+projects (via ``share/aclocal/cmake.m4``).
+
+.. note::
+ This mode is not well-supported due to some technical limitations.
+ It is kept for compatibility but should not be used in new projects.
+
See Also
========
-----------------------------------------------------------------------
Summary of changes:
Help/manual/cmake.1.rst | 77 ++++++++++++++++++++++++++++++++---------------
1 file changed, 53 insertions(+), 24 deletions(-)
hooks/post-receive
--
CMake
More information about the Cmake-commits
mailing list