branch master updated: doc: Update release.org.

[Maxim Cournoyer]

This is an automated email from the git hooks/post-receive script.

apteryx pushed a commit to branch master
in repository maintenance.

The following commit(s) were added to refs/heads/master by this push:
     new f182f52  doc: Update release.org.
f182f52 is described below

commit f182f52d18497c56f0033985c9acbf02bb09a837
Author: Maxim Cournoyer <maxim.cournoyer@gmail.com>
AuthorDate: Tue Apr 20 14:02:04 2021 -0400

    doc: Update release.org.
    
    * doc/release.org (Enter a guix environment containing everything
    needed): New step.
    (Add a Git tag): Reinstate the 'autoreconf -f' command.  It's needed
    although 'make release' reruns autoreconf itself, as at that time the
    PACKAGE_VERSION has already been inherited by the previous Makefile.
    Stress that point in case the tag is recreated.
    (Updating the translation files): Move the bootstrap invocation to the
    new step added above.
    (Run “make release” for one or several release candidates): Use Org
    markup for file names and other literals.
---
 doc/release.org | 39 ++++++++++++++++++++++++++-------------
 1 file changed, 26 insertions(+), 13 deletions(-)

diff --git a/doc/release.org b/doc/release.org
index ceb9bd6..7344e9e 100644
--- a/doc/release.org
+++ b/doc/release.org
@@ -24,7 +24,7 @@ The update-NEWS script expects some sections to already exist 
such as
 
 ** Commit the new list of packages in maintenance.git
 
-Running “make update-NEWS” creates a ‘data/packages-X.Y.Z.txt’ file in
+Running “make update-NEWS” creates a =data/packages-X.Y.Z.txt= file in
 your maintenance.git checkout.  Make sure to commit it:
 
   git add data/packages-X.Y.Z.txt
@@ -37,25 +37,37 @@ your maintenance.git checkout.  Make sure to commit it:
   $ git branch version-X.Y.Z
   $ git checkout version-X.Y.Z
 
+** Enter a guix environment containing everything needed
+
+The documentation has a few extra requirements:
+
+  $ guix environment guix --ad-hoc imagemagick perl
+
+** Bootstrapping
+
+If you haven done so already, the build system should be initialized
+using:
+
+  $ ./bootstrap && ./configure --localstatedir=/var --sysconfdir=/etc
+
 ** Add a Git tag
 
 Create a signed Git tag, like this:
 
-  $ git tag -s -u MY-KEY -m "GNU Guix X.YrcZ." vX.YrcZ
+  $ git tag -s -u MY-KEY -m "GNU Guix X.Y.ZrcN." vX.Y.ZrcN
+  $ autoreconf -f  # to update $(PACKAGE_VERSION)
 
-Use “rcZ” for release candidates, drop it otherwise.
+Use “rcN” for release candidates, drop it otherwise.
 
-The tag must be `vX.Y'.  For the sake of consistency, always use
-"GNU Guix X.Y." as the tag comment.
+The tag must be =vX.Y.Z=.  For the sake of consistency, always use
+=GNU Guix X.Y.Z= as the tag comment.  The ~autoreconf -f~ invocation
+is important, and should be re-run anytime you create a new tag.
 
 ** Updating the translation files
 
 If running from a pristine checkout, you'll need to run bootstrap and
 configure to have the 'release' target available in the Makefile.
 
-  $ ./bootstrap
-  $ ./configure --localstatedir=/var --sysconfdir=/etc
-
 If you already have the 'release' target available, invoking 'make
 release' will automatically invoke ./bootstrap.
 
@@ -80,14 +92,14 @@ time it runs.
 
 This will automatically build:
 
-  1. The source tarball, with “make distcheck” (commit V).
+  1. The source tarball, with ~make dist~ (commit V).
   2. The binary tarballs for each architecture, after first updating the
-     ‘guix’ package in (gnu packages package-management) so that it uses
+     ~guix~ package in (gnu packages package-management) so that it uses
      the commit above (we’re now at V + 1).
-  3. The GuixSD installation images, after first updating the ‘guix’
+  3. The GuixSD installation images, after first updating the ~guix~
      package again to refer to the 2nd commit above (we’re now at V + 2).
 
-All these files will end up in a ‘release-X.Y.Z’ sub-directory.
+All these files will end up in a =release-X.Y.Z= sub-directory.
 
 Needless to say, this operation takes some time.  Since this is
 committing on your behalf, it will contact your gpg-agent to sign
@@ -104,7 +116,7 @@ that only if your machine is in a safe place!):
 Steps #2 and #3 require you to have 
[[info:guix#Daemon%20Offload%20Setup][offloading]] set up so you can build
 for all the supported architectures.  For instance, if you’re running
 this on an x86_64 machine, you should have an “armhf-linux” machine in
-/etc/guix/machines.scm.
+=/etc/guix/machines.scm=.
 
 ** Push the branch
 
@@ -183,6 +195,7 @@ details.  Add the 
[[./announcements/savannah/about.txt]["About" footer]] at the
 
 
 Copyright © 2014, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
+Copyright © 2021 Maxim Cournoyer <maxim.cournoyer@gmail.com>
 Copyright © 2011, 2012, 2013 Free Software Foundation, Inc.
 
   Copying and distribution of this file, with or without modification,