01/02: doc: Add a caveat to the release section.

[Maxim Cournoyer]

apteryx pushed a commit to branch master
in repository maintenance.

commit 42dc5e0d2cd49bd0544a61f4301a116be3e57ac1
Author: Maxim Cournoyer <maxim.cournoyer@gmail.com>
AuthorDate: Tue Apr 20 15:43:01 2021 -0400

    doc: Add a caveat to the release section.
    
    The 'release' target doesn't behave well when re-run after failing.
    Document it as such.
    
    * doc/release.org (Run “make release” for one or several release
    candidates): Add caveat.
---
 doc/release.org | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/release.org b/doc/release.org
index 7344e9e..7359a12 100644
--- a/doc/release.org
+++ b/doc/release.org
@@ -107,6 +107,13 @@ commits, so you need to keep an eye on it or to increase 
the
 time-to-live for cached passphrases in =~/.gnupg/gpg-agent.conf= (do
 that only if your machine is in a safe place!):
 
+Caveat: If the release target fails, you'll be left in the middle of
+something which cannot be resumed from where it stopped.  You can try
+to debug the underlying commands that failed, but after fixing the
+problem, you should restart the release process from the beginning,
+cleaning the tree and removing any automatic commits that were done to
+update the ~guix~ package.
+
 #+begin_example
   default-cache-ttl 36000
   max-cache-ttl 36000