diff options
| author | Brad King <brad.king@kitware.com> | 2020-07-06 14:10:49 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2020-07-06 14:11:24 (GMT) |
| commit | 0c87afceab51e59537026b9fc39ed3b290e3e54d (patch) | |
| tree | d554c0629fc1da042bb2eb6c474e372c54348836 /Help | |
| parent | dbd453c2ff71acae98423e0d84f2405acfa81a97 (diff) | |
| download | CMake-0c87afceab51e59537026b9fc39ed3b290e3e54d.zip CMake-0c87afceab51e59537026b9fc39ed3b290e3e54d.tar.gz CMake-0c87afceab51e59537026b9fc39ed3b290e3e54d.tar.bz2 | |
Help/dev: Add maintainer guide step for 'versionadded' documentation markup
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/dev/maint.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/Help/dev/maint.rst b/Help/dev/maint.rst index 9b6774b..4c2c89f 100644 --- a/Help/dev/maint.rst +++ b/Help/dev/maint.rst @@ -200,6 +200,23 @@ the notes, and revise wording. Then commit with a message such as:: Add section headers similar to the $prev release notes and move each individual bullet into an appropriate section. Revise a few bullets. +Update Sphinx ``versionadded`` directives in documents added since +the previous release by running the `update_versions.py`_ script: + +.. code-block:: shell + + Utilities/Sphinx/update_versions.py --since v$prev.0 --overwrite + +.. _`update_versions.py`: ../../Utilities/Sphinx/update_versions.py + +Commit the changes with a message such as:: + + Help: Update Sphinx versionadded directives for $ver release + + Run the script: + + Utilities/Sphinx/update_versions.py --since v$prev.0 --overwrite + Open a merge request with the ``doc-$ver-relnotes`` branch for review and integration. Further steps may proceed after this has been merged to ``master``. |