From 95a16f7805a73f777945676d13a93b324e4c1d0d Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Thu, 18 Jun 2020 20:23:57 +1000 Subject: Help: Fix formatting error and consistency for gtest_discover_tests() --- Modules/GoogleTest.cmake | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Modules/GoogleTest.cmake b/Modules/GoogleTest.cmake index 975ce6c..f75d6ad 100644 --- a/Modules/GoogleTest.cmake +++ b/Modules/GoogleTest.cmake @@ -155,7 +155,7 @@ same as the Google Test name (i.e. ``suite.testcase``); see also [DISCOVERY_MODE ] ) - ``gtest_discover_tests`` sets up a post-build command on the test executable + ``gtest_discover_tests()`` sets up a post-build command on the test executable that generates the list of tests by parsing the output from running the test with the ``--gtest_list_tests`` argument. Compared to the source parsing approach of :command:`gtest_add_tests`, this ensures that the full list of @@ -212,7 +212,7 @@ same as the Google Test name (i.e. ``suite.testcase``); see also ``PROPERTIES name1 value1...`` Specifies additional properties to be set on all tests discovered by this - invocation of ``gtest_discover_tests``. + invocation of ``gtest_discover_tests()``. ``TEST_LIST var`` Make the list of tests available in the variable ``var``, rather than the @@ -246,7 +246,7 @@ same as the Google Test name (i.e. ``suite.testcase``); see also XML result output when using parallel test execution. ``DISCOVERY_MODE`` - Provides greater control over when ``gtest_discover_tests``performs test + Provides greater control over when ``gtest_discover_tests()`` performs test discovery. By default, ``POST_BUILD`` sets up a post-build command to perform test discovery at build time. In certain scenarios, like cross-compiling, this ``POST_BUILD`` behavior is not desirable. @@ -257,7 +257,7 @@ same as the Google Test name (i.e. ``suite.testcase``); see also ``DISCOVERY_MODE`` defaults to the value of the ``CMAKE_GTEST_DISCOVER_TESTS_DISCOVERY_MODE`` variable if it is not - passed when calling ``gtest_discover_tests``. This provides a mechanism + passed when calling ``gtest_discover_tests()``. This provides a mechanism for globally selecting a preferred test discovery behavior without having to modify each call site. -- cgit v0.12 From a12d53acf3e2a5aa67a484907335b0286667fee2 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Thu, 18 Jun 2020 20:26:03 +1000 Subject: Help: Add missing PCH_WARN_INVALID docs and related cleanups --- Help/manual/cmake-properties.7.rst | 2 +- Help/prop_tgt/PCH_WARN_INVALID.rst | 6 ++++-- Help/release/3.18.rst | 3 +++ 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst index 7f7ed50..30b2a05 100644 --- a/Help/manual/cmake-properties.7.rst +++ b/Help/manual/cmake-properties.7.rst @@ -128,7 +128,6 @@ Properties on Targets /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY /prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG /prop_tgt/ARCHIVE_OUTPUT_NAME - /prop_tgt/PCH_WARN_INVALID /prop_tgt/AUTOGEN_BUILD_DIR /prop_tgt/AUTOGEN_ORIGIN_DEPENDS /prop_tgt/AUTOGEN_PARALLEL @@ -312,6 +311,7 @@ Properties on Targets /prop_tgt/OSX_ARCHITECTURES /prop_tgt/OUTPUT_NAME_CONFIG /prop_tgt/OUTPUT_NAME + /prop_tgt/PCH_WARN_INVALID /prop_tgt/PDB_NAME_CONFIG /prop_tgt/PDB_NAME /prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG diff --git a/Help/prop_tgt/PCH_WARN_INVALID.rst b/Help/prop_tgt/PCH_WARN_INVALID.rst index 36ec348..96e1abd 100644 --- a/Help/prop_tgt/PCH_WARN_INVALID.rst +++ b/Help/prop_tgt/PCH_WARN_INVALID.rst @@ -2,7 +2,9 @@ PCH_WARN_INVALID ---------------- When this property is set to true, the precompile header compiler options -will contain a compiler flag wich should warn about invalid precompiled +will contain a compiler flag which should warn about invalid precompiled headers e.g. ``-Winvalid-pch`` for GNU compiler. -The defalut value is ``ON``. +This property is initialized by the value of the +:variable:`CMAKE_PCH_WARN_INVALID` variable if it is set when a target is +created. If that variable is not set, the property defaults to ``ON``. diff --git a/Help/release/3.18.rst b/Help/release/3.18.rst index 2efef88..d72454f 100644 --- a/Help/release/3.18.rst +++ b/Help/release/3.18.rst @@ -117,6 +117,9 @@ Properties * The :prop_sf:`OBJECT_OUTPUTS` source file property now supports :manual:`generator expressions `. +* The :prop_tgt:`PCH_WARN_INVALID` target property was added to allow the + removal of the precompiled header invalid warning. + * The :prop_tgt:`UNITY_BUILD_MODE` target property was added to tell generators which algorithm to use for grouping included source files. -- cgit v0.12 From 013f7a2647e8682ccf745649a94d5238e80c2c8f Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Thu, 18 Jun 2020 20:43:23 +1000 Subject: Help: Formatting, crossref for FRAMEWORK_MULTI_CONFIG_POSTFIX_ --- .../FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst | 23 +++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst b/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst index 2b20bf9..5d0fc3d 100644 --- a/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst +++ b/Help/prop_tgt/FRAMEWORK_MULTI_CONFIG_POSTFIX_CONFIG.rst @@ -1,24 +1,25 @@ FRAMEWORK_MULTI_CONFIG_POSTFIX_ --------------------------------------- -Postfix to append to the framework file name for configuration , +Postfix to append to the framework file name for configuration ````, when using a multi-config generator (like Xcode and Ninja Multi-Config). -When building with configuration the value of this property +When building with configuration ```` the value of this property is appended to the framework file name built on disk. -For example given a framework called ``my_fw``, a value of ``_debug`` -for the :prop_tgt:`FRAMEWORK_MULTI_CONFIG_POSTFIX_` property, and -``Debug;Release`` in `CMAKE_CONFIGURATION_TYPES`, the following relevant -files would be created for the ``Debug`` and ``Release`` configurations: +For example, given a framework called ``my_fw``, a value of ``_debug`` +for the ``FRAMEWORK_MULTI_CONFIG_POSTFIX_`` property, and +``Debug;Release`` in :variable:`CMAKE_CONFIGURATION_TYPES`, the following +relevant files would be created for the ``Debug`` and ``Release`` +configurations: -- Release/my_fw.framework/my_fw -- Release/my_fw.framework/Versions/A/my_fw -- Debug/my_fw.framework/my_fw_debug -- Debug/my_fw.framework/Versions/A/my_fw_debug +- ``Release/my_fw.framework/my_fw`` +- ``Release/my_fw.framework/Versions/A/my_fw`` +- ``Debug/my_fw.framework/my_fw_debug`` +- ``Debug/my_fw.framework/Versions/A/my_fw_debug`` For framework targets, this property is initialized by the value of the -variable :variable:`CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_` if it +:variable:`CMAKE_FRAMEWORK_MULTI_CONFIG_POSTFIX_` variable if it is set when a target is created. This property is ignored for non-framework targets, and when using single -- cgit v0.12 From 0420de10b534fb8bdd83eb33b70af7acf2b09f56 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Thu, 18 Jun 2020 20:29:21 +1000 Subject: Help: Add missing cross-referencing for generator expressions --- Help/prop_sf/VS_SETTINGS.rst | 2 +- Help/prop_tgt/VS_SOLUTION_DEPLOY.rst | 2 +- Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Help/prop_sf/VS_SETTINGS.rst b/Help/prop_sf/VS_SETTINGS.rst index 0719406..50034fb 100644 --- a/Help/prop_sf/VS_SETTINGS.rst +++ b/Help/prop_sf/VS_SETTINGS.rst @@ -15,4 +15,4 @@ For example: will set ``Key`` to ``Value`` and ``Key2`` to ``Value2`` on the ``file.hlsl`` item as metadata. -Generator expressions are supported. +:manual:`Generator expressions ` are supported. diff --git a/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst b/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst index 7906d75..a664d0c 100644 --- a/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst +++ b/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst @@ -6,7 +6,7 @@ Windows CE, Windows Phone or a Windows Store application. If the target platform doesn't support deployment, this property won't have any effect. -Generator expressions are supported. +:manual:`Generator expressions ` are supported. Example 1 ^^^^^^^^^ diff --git a/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst b/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst index f706888..738a912 100644 --- a/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst +++ b/Help/prop_tgt/VS_SOURCE_SETTINGS_tool.rst @@ -16,4 +16,4 @@ For example: will set ``Key`` to ``Value`` and ``Key2`` to ``Value2`` for all non-built files that use ``FXCompile``. -Generator expressions are supported. +:manual:`Generator expressions ` are supported. -- cgit v0.12 From 90c73479bcc581b59111891650bd12a9149a35c5 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Thu, 18 Jun 2020 20:30:30 +1000 Subject: Help: Correct and condense examples for VS_SOLUTION_DEPLOY --- Help/prop_tgt/VS_SOLUTION_DEPLOY.rst | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst b/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst index a664d0c..eef848f 100644 --- a/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst +++ b/Help/prop_tgt/VS_SOLUTION_DEPLOY.rst @@ -4,24 +4,22 @@ VS_SOLUTION_DEPLOY Specify that the target should be marked for deployment when not targeting Windows CE, Windows Phone or a Windows Store application. -If the target platform doesn't support deployment, this property won't have any effect. +If the target platform doesn't support deployment, this property won't have +any effect. :manual:`Generator expressions ` are supported. -Example 1 -^^^^^^^^^ +Examples +^^^^^^^^ -This shows setting the variable for the target foo. +Always deploy target ``foo``: .. code-block:: cmake add_executable(foo SHARED foo.cpp) set_property(TARGET foo PROPERTY VS_SOLUTION_DEPLOY ON) -Example 2 -^^^^^^^^^ - -This shows setting the variable for the Release configuration only. +Deploy target ``foo`` for all configurations except ``Release``: .. code-block:: cmake -- cgit v0.12 From 947cfc732d6a83081fec28cce9a2d9deeeb47a8d Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Thu, 18 Jun 2020 20:32:36 +1000 Subject: Help: Explicitly say transaction, don't abbreviate to trans The release notes need to make sense to people not so familiar with each item. For those less familiar with RPM, spelling out "transaction" makes this line item much clearer in isolation. --- Help/release/3.18.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Help/release/3.18.rst b/Help/release/3.18.rst index d72454f..c98b12a 100644 --- a/Help/release/3.18.rst +++ b/Help/release/3.18.rst @@ -246,9 +246,9 @@ CPack installer is DPI-aware. * The :cpack_gen:`CPack RPM Generator` gained - :variable:`CPACK_RPM_PRE_TRANS_SCRIPT_FILE` + :variable:`CPACK_RPM_PRE_TRANS_SCRIPT_FILE` and :variable:`CPACK_RPM_POST_TRANS_SCRIPT_FILE` - variables to specify pre- and post-trans scripts. + variables to specify pre- and post-transaction scripts. Other ----- -- cgit v0.12