From cdbd1ae64bb61da1932033909fb93d600594cdf2 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 18 Feb 2021 10:53:33 -0500 Subject: Utilities/Sphinx: Avoid converting -- to an en-dash --- Utilities/Sphinx/conf.py.in | 1 + 1 file changed, 1 insertion(+) diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in index 42b0951..5def681 100644 --- a/Utilities/Sphinx/conf.py.in +++ b/Utilities/Sphinx/conf.py.in @@ -29,6 +29,7 @@ extensions = ['cmake'] templates_path = ['@conf_path@/templates'] nitpicky = True +smartquotes = False cmake_manuals = sorted(glob.glob(r'@conf_docs@/manual/*.rst')) cmake_manual_description = re.compile('^\.\. cmake-manual-description:(.*)$') -- cgit v0.12 From dd6165fbd4d2898cc14222495c6deacd33dc6694 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 18 Feb 2021 10:25:07 -0500 Subject: Help: Mention version 2 in cmake-presets(7) Version 2 is required for build and test presets. Fixes: #21829 --- Help/manual/cmake-presets.7.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index 49eb157..3be6c6f 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -38,8 +38,8 @@ The root object recognizes the following fields: ``version`` - A required integer representing the version of the JSON schema. Currently, - the only supported version is 1. + A required integer representing the version of the JSON schema. + The supported versions are ``1`` and ``2``. ``cmakeMinimumRequired`` @@ -70,14 +70,17 @@ The root object recognizes the following fields: ``configurePresets`` An optional array of `Configure Preset`_ objects. + This is allowed in preset files specifying version 1 or above. ``buildPresets`` An optional array of `Build Preset`_ objects. + This is allowed in preset files specifying version 2 or above. ``testPresets`` An optional array of `Test Preset`_ objects. + This is allowed in preset files specifying version 2 or above. Configure Preset ^^^^^^^^^^^^^^^^ -- cgit v0.12 From 0e3c361f7733a073375d44802daa3c69016eb8d4 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 18 Feb 2021 10:31:34 -0500 Subject: Help: Link to tool-specific preset arguments from cmake-presets(7) Fixes: #21835 --- Help/manual/cmake-presets.7.rst | 13 +++++++------ Help/manual/ctest.1.rst | 2 ++ 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index 3be6c6f..fb4babe 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -91,8 +91,8 @@ that may contain the following fields: ``name`` A required string representing the machine-friendly name of the preset. - This identifier is used in the ``--preset`` argument. There must not be - two presets in the union of ``CMakePresets.json`` and + This identifier is used in the :ref:`cmake --preset ` option. + There must not be two presets in the union of ``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same directory with the same name. ``hidden`` @@ -309,8 +309,9 @@ that may contain the following fields: ``name`` A required string representing the machine-friendly name of the preset. - This identifier is used in the ``--preset`` argument. There must not be - two presets (configure, build, or test) in the union of + This identifier is used in the + :ref:`cmake --build --preset ` option. + There must not be two presets (configure, build, or test) in the union of ``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same directory with the same name. @@ -427,8 +428,8 @@ that may contain the following fields: ``name`` A required string representing the machine-friendly name of the preset. - This identifier is used in the ``--preset`` argument. There must not be - two presets (configure, build, or test) in the union of + This identifier is used in the :ref:`ctest --preset ` option. + There must not be two presets (configure, build, or test) in the union of ``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same directory with the same name. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 43157b6..0a3614f 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -25,6 +25,8 @@ CMake-generated build trees created for projects that use the :command:`enable_testing` and :command:`add_test` commands have testing support. This program will run the tests and report results. +.. _`CTest Options`: + Options ======= -- cgit v0.12 From 47ab2d4d2ec282aee655ebc3e6079e6c5bb29427 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 18 Feb 2021 10:58:32 -0500 Subject: Help: Clarify role of binaryDir inheritance in cmake-presets(7) Suggested-by: Michael Hirsch --- Help/manual/cmake-presets.7.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index fb4babe..e3815b6 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -377,8 +377,9 @@ that may contain the following fields: An optional string specifying the name of a configure preset to associate with this build preset. If ``configurePreset`` is not specified, it must be inherited from the inherits preset (unless this - preset is hidden). The build tree directory is inferred from the - configure preset. + preset is hidden). The build directory is inferred from the configure + preset, so the build will take place in the same ``binaryDir`` that the + configuration did. ``inheritConfigureEnvironment`` @@ -495,8 +496,9 @@ that may contain the following fields: An optional string specifying the name of a configure preset to associate with this test preset. If ``configurePreset`` is not specified, it must be inherited from the inherits preset (unless this - preset is hidden). The build tree directory is inferred from the - configure preset. + preset is hidden). The build directory is inferred from the configure + preset, so tests will run in the same ``binaryDir`` that the + configuration did and build did. ``inheritConfigureEnvironment`` -- cgit v0.12