diff options
Diffstat (limited to 'Help')
-rw-r--r-- | Help/dev/maint.rst | 30 | ||||
-rw-r--r-- | Help/manual/cmake-compile-features.7.rst | 6 | ||||
-rw-r--r-- | Help/release/3.9.rst | 2 |
3 files changed, 34 insertions, 4 deletions
diff --git a/Help/dev/maint.rst b/Help/dev/maint.rst index 78c06df..c448445 100644 --- a/Help/dev/maint.rst +++ b/Help/dev/maint.rst @@ -8,6 +8,36 @@ See documentation on `CMake Development`_ for more information. .. contents:: Maintainer Processes: +Review a Merge Request +====================== + +The `CMake Review Process`_ requires a maintainer to issue the ``Do: merge`` +command to integrate a merge request. Please check at least the following: + +* If the MR source branch is not named well for the change it makes + (e.g. it is just ``master`` or the patch changed during review), + add a ``Topic-rename: <topic>`` trailing line to the MR description + to provide a better topic name. + +* If the MR introduces a new feature or a user-facing behavior change, + such as a policy, ensure that a ``Help/release/dev/$topic.rst`` file + is added with a release note. + +* If a commit changes a specific area, such as a module, its commit + message should have an ``area:`` prefix on its first line. + +* If a commit fixes a tracked issue, its commit message should have + a trailing line such as ``Fixes: #00000``. + +* Ensure that the MR has been tested sufficiently. Typically it should + be staged for nightly testing with ``Do: stage``. Then manually + review the `CMake CDash Page`_ to verify that no regressions were + introduced. (Learn to tolerate spurious failures due to idiosyncrasies + of various nightly builders.) + +.. _`CMake Review Process`: review.rst +.. _`CMake CDash Page`: https://open.cdash.org/index.php?project=CMake + Branch a New Release ==================== diff --git a/Help/manual/cmake-compile-features.7.rst b/Help/manual/cmake-compile-features.7.rst index cfb1b78..0124395 100644 --- a/Help/manual/cmake-compile-features.7.rst +++ b/Help/manual/cmake-compile-features.7.rst @@ -334,7 +334,7 @@ versions specified for each: * ``AppleClang``: Apple Clang for Xcode versions 4.4 though 6.2. * ``Clang``: Clang compiler versions 2.9 through 3.4. * ``GNU``: GNU compiler versions 4.4 through 5.0. -* ``MSVC``: Microsoft Visual Studio versions 2010 through 2015. +* ``MSVC``: Microsoft Visual Studio versions 2010 through 2017. * ``SunPro``: Oracle SolarisStudio versions 12.4 through 12.5. * ``Intel``: Intel compiler versions 12.1 through 17.0. @@ -347,7 +347,7 @@ versions specified for each: * ``GNU``: GNU compiler versions 3.4 through 5.0. CMake is currently aware of the :prop_tgt:`C++ standards <CXX_STANDARD>` and -thier associated meta-features (e.g. ``cxx_std_11``) available from the +their associated meta-features (e.g. ``cxx_std_11``) available from the following :variable:`compiler ids <CMAKE_<LANG>_COMPILER_ID>` as of the versions specified for each: @@ -356,7 +356,7 @@ versions specified for each: * ``XL``: IBM XL version 10.1 through 13.1.5. CMake is currently aware of the :prop_tgt:`C standards <C_STANDARD>` and -thier associated meta-features (e.g. ``c_std_99``) available from the +their associated meta-features (e.g. ``c_std_99``) available from the following :variable:`compiler ids <CMAKE_<LANG>_COMPILER_ID>` as of the versions specified for each: diff --git a/Help/release/3.9.rst b/Help/release/3.9.rst index 7222196..cd9476d 100644 --- a/Help/release/3.9.rst +++ b/Help/release/3.9.rst @@ -18,7 +18,7 @@ Languages :ref:`Makefile Generators` and the :generator:`Ninja` generator. * CMake is now aware of the :prop_tgt:`C++ standards <CXX_STANDARD>` and - :prop_tgt:`C standards <C_STANDARD>` and thier associated meta-features for + :prop_tgt:`C standards <C_STANDARD>` and their associated meta-features for the following :variable:`compiler ids <CMAKE_<LANG>_COMPILER_ID>`: ``Cray``, ``PGI``, and ``XL``. |