diff options
Diffstat (limited to 'Help')
-rw-r--r-- | Help/dev/review.rst | 39 | ||||
-rw-r--r-- | Help/manual/cmake-modules.7.rst | 1 | ||||
-rw-r--r-- | Help/module/CheckIPOSupported.rst | 1 | ||||
-rw-r--r-- | Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst | 7 | ||||
-rw-r--r-- | Help/release/dev/CheckIPOSupported.rst | 6 | ||||
-rw-r--r-- | Help/release/dev/module-def-and-WINDOWS_EXPORT_ALL_SYMBOLS.rst | 8 | ||||
-rw-r--r-- | Help/variable/MSVC.rst | 2 | ||||
-rw-r--r-- | Help/variable/MSVC10.rst | 2 | ||||
-rw-r--r-- | Help/variable/MSVC11.rst | 2 | ||||
-rw-r--r-- | Help/variable/MSVC12.rst | 2 | ||||
-rw-r--r-- | Help/variable/MSVC14.rst | 6 | ||||
-rw-r--r-- | Help/variable/MSVC60.rst | 2 | ||||
-rw-r--r-- | Help/variable/MSVC70.rst | 2 | ||||
-rw-r--r-- | Help/variable/MSVC71.rst | 2 | ||||
-rw-r--r-- | Help/variable/MSVC80.rst | 2 | ||||
-rw-r--r-- | Help/variable/MSVC90.rst | 2 |
16 files changed, 80 insertions, 6 deletions
diff --git a/Help/dev/review.rst b/Help/dev/review.rst index e23c0fb..3004a14 100644 --- a/Help/dev/review.rst +++ b/Help/dev/review.rst @@ -65,9 +65,17 @@ The "Kitware Robot" (``@kwrobot``) automatically performs basic checks on the commits proposed in a MR. If all is well the robot silently reports a successful "build" status to GitLab. Otherwise the robot posts a comment with its diagnostics. **A topic may not be merged until the automatic -review succeeds.** The MR submitter is expected to address the robot's -comments by *rewriting* the commits named by the robot's diagnostics -(e.g. via ``git rebase -i``). +review succeeds.** + +Note that the MR submitter is expected to address the robot's comments by +*rewriting* the commits named by the robot's diagnostics (e.g., via +``git rebase -i``). This is because the robot checks each commit individually, +not the topic as a whole. This is done in order to ensure that commits in the +middle of a topic do not, for example, add a giant file which is then later +removed in the topic. + +Automatic Check +--------------- The automatic check is repeated whenever the topic branch is updated. One may explicitly request a re-check by adding a comment with the @@ -78,6 +86,21 @@ following command among the `comment trailing lines`_:: ``@kwrobot`` will add an award emoji to the comment to indicate that it was processed and also run its checks again. +Automatic Format +---------------- + +The automatic check will reject commits introducing source code not +formatted according to ``clang-format``. One may ask the robot to +automatically rewrite the MR topic branch with expected formatting +by adding a comment with the following command among the +`comment trailing lines`_:: + + Do: reformat + +``@kwrobot`` will add an award emoji to the comment to indicate that it +was processed and also rewrite the MR topic branch and force-push an +updated version with every commit formatted as expected by the check. + Human Review ============ @@ -149,7 +172,8 @@ Comment Trailer Commands Among the `comment trailing lines`_ authorized users may issue special commands to ``@kwrobot`` using the form ``Do: ...``: -* ``Do: check`` explicitly re-runs `Robot Review`_ checks. +* ``Do: check`` explicitly re-runs the robot `Automatic Check`_. +* ``Do: reformat`` rewrites the MR topic for `Automatic Format`_. * ``Do: test`` submits the MR for `Topic Testing`_. * ``Do: stage`` submits the MR for `Integration Testing`_. * ``Do: merge`` submits the MR for `Merge`_. @@ -286,6 +310,13 @@ The ``Do: merge`` command accepts the following arguments: * ``-t <topic>``: substitute ``<topic>`` for the name of the MR topic branch in the constructed merge commit message. +Additionally, ``Do: merge`` extracts configuration from trailing lines +in the MR description: + +* ``Topic-rename: <topic>``: substitute ``<topic>`` for the name of + the MR topic branch in the constructed merge commit message. + The ``-t`` option overrides this. + .. _`CMake GitLab Project Masters`: https://gitlab.kitware.com/cmake/cmake/settings/members Close diff --git a/Help/manual/cmake-modules.7.rst b/Help/manual/cmake-modules.7.rst index 5e96d79..1e8342c 100644 --- a/Help/manual/cmake-modules.7.rst +++ b/Help/manual/cmake-modules.7.rst @@ -27,6 +27,7 @@ All Modules /module/CheckFortranFunctionExists /module/CheckFortranSourceCompiles /module/CheckFunctionExists + /module/CheckIPOSupported /module/CheckIncludeFileCXX /module/CheckIncludeFile /module/CheckIncludeFiles diff --git a/Help/module/CheckIPOSupported.rst b/Help/module/CheckIPOSupported.rst new file mode 100644 index 0000000..9c8a77b --- /dev/null +++ b/Help/module/CheckIPOSupported.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckIPOSupported.cmake diff --git a/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst b/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst index 06c3e6d..86711bf 100644 --- a/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst +++ b/Help/prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS.rst @@ -14,6 +14,13 @@ be automatically exported and imported by callers. This simplifies porting projects to Windows by reducing the need for explicit ``dllexport`` markup, even in ``C++`` classes. +When this property is enabled, zero or more ``.def`` files may also be +specified as source files of the target. The exports named by these files +will be merged with those detected from the object files to generate a +single module definition file to be passed to the linker. This can be +used to export symbols from a ``.dll`` that are not in any of its object +files but are added by the linker from dependencies (e.g. ``msvcrt.lib``). + This property is initialized by the value of the :variable:`CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS` variable if it is set when a target is created. diff --git a/Help/release/dev/CheckIPOSupported.rst b/Help/release/dev/CheckIPOSupported.rst new file mode 100644 index 0000000..dbc84e6 --- /dev/null +++ b/Help/release/dev/CheckIPOSupported.rst @@ -0,0 +1,6 @@ +CheckIPOSupported +----------------- + +* A :module:`CheckIPOSupported` module was added to help projects + check whether interprocedural optimization (IPO) is supported by + the current toolchain and CMake version. diff --git a/Help/release/dev/module-def-and-WINDOWS_EXPORT_ALL_SYMBOLS.rst b/Help/release/dev/module-def-and-WINDOWS_EXPORT_ALL_SYMBOLS.rst new file mode 100644 index 0000000..dfa9ef1 --- /dev/null +++ b/Help/release/dev/module-def-and-WINDOWS_EXPORT_ALL_SYMBOLS.rst @@ -0,0 +1,8 @@ +module-def-and-WINDOWS_EXPORT_ALL_SYMBOLS +----------------------------------------- + +* The :prop_tgt:`WINDOWS_EXPORT_ALL_SYMBOLS` target property may now + be used in combination with explicit ``.def`` files in order to + export all symbols from the object files within a target plus + an explicit list of symbols that the linker finds in dependencies + (e.g. ``msvcrt.lib``). diff --git a/Help/variable/MSVC.rst b/Help/variable/MSVC.rst index 913ed08..22a087a 100644 --- a/Help/variable/MSVC.rst +++ b/Help/variable/MSVC.rst @@ -4,3 +4,5 @@ MSVC ``True`` when using Microsoft Visual C++. Set to ``true`` when the compiler is some version of Microsoft Visual C++. + +See also the :variable:`MSVC_VERSION` variable. diff --git a/Help/variable/MSVC10.rst b/Help/variable/MSVC10.rst index 98e0493..55c6337 100644 --- a/Help/variable/MSVC10.rst +++ b/Help/variable/MSVC10.rst @@ -1,5 +1,7 @@ MSVC10 ------ +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + ``True`` when using the Microsoft Visual Studio ``v100`` toolset (``cl`` version 16) or another compiler that simulates it. diff --git a/Help/variable/MSVC11.rst b/Help/variable/MSVC11.rst index 42b7b86..17943dc 100644 --- a/Help/variable/MSVC11.rst +++ b/Help/variable/MSVC11.rst @@ -1,5 +1,7 @@ MSVC11 ------ +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + ``True`` when using the Microsoft Visual Studio ``v110`` toolset (``cl`` version 17) or another compiler that simulates it. diff --git a/Help/variable/MSVC12.rst b/Help/variable/MSVC12.rst index 0648f35..a524fab 100644 --- a/Help/variable/MSVC12.rst +++ b/Help/variable/MSVC12.rst @@ -1,5 +1,7 @@ MSVC12 ------ +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + ``True`` when using the Microsoft Visual Studio ``v120`` toolset (``cl`` version 18) or another compiler that simulates it. diff --git a/Help/variable/MSVC14.rst b/Help/variable/MSVC14.rst index f67ebc7..79e0c10 100644 --- a/Help/variable/MSVC14.rst +++ b/Help/variable/MSVC14.rst @@ -1,5 +1,7 @@ MSVC14 ------ -``True`` when using the Microsoft Visual Studio ``v140`` toolset -(``cl`` version 19) or another compiler that simulates it. +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + +``True`` when using the Microsoft Visual Studio ``v140`` or ``v141`` +toolset (``cl`` version 19) or another compiler that simulates it. diff --git a/Help/variable/MSVC60.rst b/Help/variable/MSVC60.rst index 14f09cf..14164bf 100644 --- a/Help/variable/MSVC60.rst +++ b/Help/variable/MSVC60.rst @@ -1,6 +1,8 @@ MSVC60 ------ +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + ``True`` when using Microsoft Visual C++ 6.0. Set to ``true`` when the compiler is version 6.0 of Microsoft Visual C++. diff --git a/Help/variable/MSVC70.rst b/Help/variable/MSVC70.rst index 76fa96f..ed3b0bb 100644 --- a/Help/variable/MSVC70.rst +++ b/Help/variable/MSVC70.rst @@ -1,6 +1,8 @@ MSVC70 ------ +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + ``True`` when using Microsoft Visual C++ 7.0. Set to ``true`` when the compiler is version 7.0 of Microsoft Visual C++. diff --git a/Help/variable/MSVC71.rst b/Help/variable/MSVC71.rst index d69d4fc..0237592 100644 --- a/Help/variable/MSVC71.rst +++ b/Help/variable/MSVC71.rst @@ -1,6 +1,8 @@ MSVC71 ------ +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + ``True`` when using Microsoft Visual C++ 7.1. Set to ``true`` when the compiler is version 7.1 of Microsoft Visual C++. diff --git a/Help/variable/MSVC80.rst b/Help/variable/MSVC80.rst index 0d33e82..1533218 100644 --- a/Help/variable/MSVC80.rst +++ b/Help/variable/MSVC80.rst @@ -1,5 +1,7 @@ MSVC80 ------ +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + ``True`` when using the Microsoft Visual Studio ``v80`` toolset (``cl`` version 14) or another compiler that simulates it. diff --git a/Help/variable/MSVC90.rst b/Help/variable/MSVC90.rst index 1716e6f..4981ecf 100644 --- a/Help/variable/MSVC90.rst +++ b/Help/variable/MSVC90.rst @@ -1,5 +1,7 @@ MSVC90 ------ +Discouraged. Use the :variable:`MSVC_VERSION` variable instead. + ``True`` when using the Microsoft Visual Studio ``v90`` toolset (``cl`` version 15) or another compiler that simulates it. |