mirror of
https://github.com/Kitware/CMake.git
synced 2026-05-04 05:10:10 -05:00
Merge topic 'doco'
6f354a6d57Help: ctest(1): emphasize the --test-dir optionf0e60ea867Help: cmake (1): put modern configure signature first Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Alex <leha-bot@yandex.ru> Merge-request: !8222
This commit is contained in:
@@ -8,6 +8,7 @@ Synopsis
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
ccmake [<options>] -B <path-to-build> [-S <path-to-source>]
|
||||
ccmake [<options>] <path-to-source | path-to-existing-build>
|
||||
|
||||
Description
|
||||
|
||||
@@ -9,8 +9,8 @@ Synopsis
|
||||
.. parsed-literal::
|
||||
|
||||
cmake-gui [<options>]
|
||||
cmake-gui [<options>] -B <path-to-build> [-S <path-to-source>]
|
||||
cmake-gui [<options>] <path-to-source | path-to-existing-build>
|
||||
cmake-gui [<options>] -S <path-to-source> -B <path-to-build>
|
||||
cmake-gui [<options>] --browse-manual [<filename>]
|
||||
|
||||
Description
|
||||
|
||||
+18
-18
@@ -9,8 +9,8 @@ Synopsis
|
||||
.. parsed-literal::
|
||||
|
||||
`Generate a Project Buildsystem`_
|
||||
cmake [<options>] -B <path-to-build> [-S <path-to-source>]
|
||||
cmake [<options>] <path-to-source | path-to-existing-build>
|
||||
cmake [<options>] -S <path-to-source> -B <path-to-build>
|
||||
|
||||
`Build a Project`_
|
||||
cmake --build <dir> [<options>] [-- <build-tool-options>]
|
||||
@@ -116,6 +116,20 @@ Generate a Project Buildsystem
|
||||
Run CMake with one of the following command signatures to specify the
|
||||
source and build trees and generate a buildsystem:
|
||||
|
||||
``cmake [<options>] -B <path-to-build> [-S <path-to-source>]``
|
||||
|
||||
.. versionadded:: 3.13
|
||||
|
||||
Uses ``<path-to-build>`` as the build tree and ``<path-to-source>``
|
||||
as the source tree. The specified paths may be absolute or relative
|
||||
to the current working directory. The source tree must contain a
|
||||
``CMakeLists.txt`` file. The build tree will be created automatically
|
||||
if it does not already exist. For example:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cmake -S src -B build
|
||||
|
||||
``cmake [<options>] <path-to-source>``
|
||||
Uses the current working directory as the build tree, and
|
||||
``<path-to-source>`` as the source tree. The specified path may
|
||||
@@ -141,20 +155,6 @@ source and build trees and generate a buildsystem:
|
||||
$ cd build
|
||||
$ cmake .
|
||||
|
||||
``cmake [<options>] -S <path-to-source> -B <path-to-build>``
|
||||
|
||||
.. versionadded:: 3.13
|
||||
|
||||
Uses ``<path-to-build>`` as the build tree and ``<path-to-source>``
|
||||
as the source tree. The specified paths may be absolute or relative
|
||||
to the current working directory. The source tree must contain a
|
||||
``CMakeLists.txt`` file. The build tree will be created automatically
|
||||
if it does not already exist. For example:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cmake -S src -B build
|
||||
|
||||
In all cases the ``<options>`` may be zero or more of the `Options`_ below.
|
||||
|
||||
The above styles for specifying the source and build trees may be mixed.
|
||||
@@ -167,14 +167,14 @@ the current working directory (cwd) is used for the other. For example:
|
||||
============================== ============ ===========
|
||||
Command Line Source Dir Build Dir
|
||||
============================== ============ ===========
|
||||
``cmake -B build`` `cwd` ``build``
|
||||
``cmake -B build src`` ``src`` ``build``
|
||||
``cmake -B build -S src`` ``src`` ``build``
|
||||
``cmake src`` ``src`` `cwd`
|
||||
``cmake build`` (existing) `loaded` ``build``
|
||||
``cmake -S src`` ``src`` `cwd`
|
||||
``cmake -S src build`` ``src`` ``build``
|
||||
``cmake -S src -B build`` ``src`` ``build``
|
||||
``cmake -B build`` `cwd` ``build``
|
||||
``cmake -B build src`` ``src`` ``build``
|
||||
``cmake -B build -S src`` ``src`` ``build``
|
||||
============================== ============ ===========
|
||||
|
||||
.. versionchanged:: 3.23
|
||||
|
||||
@@ -11,7 +11,7 @@ Synopsis
|
||||
.. parsed-literal::
|
||||
|
||||
`Run Tests`_
|
||||
ctest [<options>]
|
||||
ctest [<options>] [--test-dir <path-to-build>]
|
||||
|
||||
`Build and Test Mode`_
|
||||
ctest --build-and-test <path-to-source> <path-to-build>
|
||||
@@ -354,7 +354,8 @@ Run Tests
|
||||
|
||||
.. option:: --test-dir <dir>
|
||||
|
||||
Specify the directory in which to look for tests.
|
||||
Specify the directory in which to look for tests, typically a CMake project
|
||||
build directory. If not specified, the current directory is used.
|
||||
|
||||
.. option:: --test-output-size-passed <size>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user