"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "Help/dev/review.rst" between
cmake-3.13.4.tar.gz and cmake-3.14.0-rc1.tar.gz

About: CMake is a cross-platform build system designed to build, test and package software. Release candidate.

review.rst  (cmake-3.13.4):review.rst  (cmake-3.14.0-rc1)
skipping to change at line 241 skipping to change at line 241
GitLab will automatically create relevant links to the merge request and will GitLab will automatically create relevant links to the merge request and will
close the issue when the commit is merged into master. GitLab understands a few close the issue when the commit is merged into master. GitLab understands a few
other synonyms for ``Fixes`` and allows much more flexible forms than the other synonyms for ``Fixes`` and allows much more flexible forms than the
above, but committers should aim for this format for consistency. Note that above, but committers should aim for this format for consistency. Note that
such details can alternatively be specified in the merge request description. such details can alternatively be specified in the merge request description.
Referencing Commits in Commit Messages Referencing Commits in Commit Messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The preferred form for references to other commits is The preferred form for references to other commits is
``commit <commit> (<subject>, <date>)``, where: ``commit <shorthash> (<subject>, <date>)``, where:
* ``<commit>``: * ``<shorthash>``:
If available, a tag-relative name of the commit produced by The abbreviated hash of the commit.
``git describe --contains <commit-ish>``. Otherwise, the first
8-10 characters of the commit ``<hash>``.
* ``<subject>``: * ``<subject>``:
The first line of the commit message. The first line of the commit message.
* ``<date>``: * ``<date>``:
The author date of the commit, in its original time zone, formatted as The author date of the commit, in its original time zone, formatted as
``CCYY-MM-DD``. ``git-log(1)`` shows the original time zone by default. ``CCYY-MM-DD``. ``git-log(1)`` shows the original time zone by default.
This may be generated with
``git show -s --date=short --pretty="format:%h (%s, %ad)" <commit>``.
If the commit is a fix for the mentioned commit, consider using a ``Fixes:``
trailer in the commit message with the specified format. This trailer should
not be word-wrapped. Note that if there is also an issue for what is being
fixed, it is preferrable to link to the issue instead.
If relevant, add the first release tag of CMake containing the commit after
the ``<date>``, i.e., ``commit <shorthash> (<subject>, <date>, <tag>)``.
Alternatively, the full commit ``<hash>`` may be used. Alternatively, the full commit ``<hash>`` may be used.
Revising Commit Messages Revising Commit Messages
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
Reviewers are encouraged to ask the committer to amend commit messages to Reviewers are encouraged to ask the committer to amend commit messages to
follow these guidelines, but prefer to focus on the changes themselves as a follow these guidelines, but prefer to focus on the changes themselves as a
first priority. Maintainers will also make a check of commit messages before first priority. Maintainers will also make a check of commit messages before
merging. merging.
skipping to change at line 326 skipping to change at line 335
run tests on a nightly basis (or continuously during the day), and run tests on a nightly basis (or continuously during the day), and
post to the `CMake CDash Page`_. Some follow ``master``. Most follow post to the `CMake CDash Page`_. Some follow ``master``. Most follow
a special integration branch, the *topic stage*. a special integration branch, the *topic stage*.
The topic stage is a special branch maintained by the "Kitware Robot" The topic stage is a special branch maintained by the "Kitware Robot"
(``@kwrobot``). It consists of the head of the MR target integration (``@kwrobot``). It consists of the head of the MR target integration
branch (e.g. ``master``) branch followed by a sequence of merges each branch (e.g. ``master``) branch followed by a sequence of merges each
integrating changes from an open MR that has been staged for integration integrating changes from an open MR that has been staged for integration
testing. Each time the target integration branch is updated the stage testing. Each time the target integration branch is updated the stage
is rebuilt automatically by merging the staged MR topics again. is rebuilt automatically by merging the staged MR topics again.
The branch is stored in the upstream repository by special refs:
* ``refs/stage/master/head``: The current topic stage branch.
This is used by continuous builds that report to CDash.
* ``refs/stage/master/nightly/latest``: Topic stage as of 1am UTC each night.
This is used by most nightly builds that report to CDash.
* ``refs/stage/master/nightly/<yyyy>/<mm>/<dd>``: Topic stage as of 1am UTC
on the date specified. This is used for historical reference.
`CMake GitLab Project Developers`_ may stage a MR for integration testing `CMake GitLab Project Developers`_ may stage a MR for integration testing
by adding a comment with a command among the `comment trailing lines`_:: by adding a comment with a command among the `comment trailing lines`_::
Do: stage Do: stage
``@kwrobot`` will add an award emoji to the comment to indicate that it ``@kwrobot`` will add an award emoji to the comment to indicate that it
was processed and also attempt to add the MR topic branch to the topic was processed and also attempt to add the MR topic branch to the topic
stage. If the MR cannot be added (e.g. due to conflicts) the robot will stage. If the MR cannot be added (e.g. due to conflicts) the robot will
post a comment explaining what went wrong. post a comment explaining what went wrong.
 End of changes. 4 change blocks. 
5 lines changed or deleted 22 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)