docs/releasing: improve wording
authorEric Engestrom <eric@engestrom.ch>
Wed, 8 Jul 2020 23:26:31 +0000 (01:26 +0200)
committerMarge Bot <eric+marge@anholt.net>
Wed, 22 Jul 2020 21:55:58 +0000 (21:55 +0000)
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5833>

docs/releasing.rst

index 529dcd62d44e46675e5ae3d26462f7237dd85da6..dbaa0e17afb6ccfd93c6671f545b5b8593723b63 100644 (file)
@@ -261,18 +261,13 @@ Create release notes for the new release
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The release notes are completely generated by the
-``bin/gen_release_notes.py`` script. Simply run this script before
-bumping the version. The only thing left to do
-is add the sha256 sums.
+``bin/gen_release_notes.py`` script. Simply run this script **before**
+bumping the version. You'll need to come back to this file once the
+tarball is generated to add its ``sha256sum``.
 
-Increment the version contained in the file VERSION at Mesa's top-level,
-then commit this change.
-
-Commit these changes and push the branch.
-
-::
-
-   git push origin HEAD
+Increment the version contained in the file ``VERSION`` at Mesa's top-level,
+then commit this change and **push the branch** (if you forget to do
+this, ``release.sh`` below will fail).
 
 Use the release.sh script from xorg `util-modular <https://cgit.freedesktop.org/xorg/util/modular/>`__
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -295,8 +290,8 @@ release notes, and is published in `release-maintainers-keys.asc
 Add the sha256sums to the release notes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Edit docs/relnotes/X.Y.Z.rst to add the sha256sum as available in the
-mesa-X.Y.Z.announce template. Commit this change.
+Edit ``docs/relnotes/X.Y.Z.rst`` to add the ``sha256sum`` as available in the
+``mesa-X.Y.Z.announce`` template. Commit this change.
 
 Back on mesa master, add the new release notes into the tree
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~