From 13a2ccae6683079655a4354b3a0ae3ef4efa55d5 Mon Sep 17 00:00:00 2001
From: David Adam <zanchey@ucc.gu.uwa.edu.au>
Date: Tue, 10 Feb 2026 14:29:16 +0800
Subject: [PATCH] release.sh: add a couple of explanatory comments

---
 build_tools/release.sh | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/build_tools/release.sh b/build_tools/release.sh
index ca50840da..fa8af2bed 100755
--- a/build_tools/release.sh
+++ b/build_tools/release.sh
@@ -90,7 +90,7 @@ Created by ./build_tools/release.sh $version"
 }
 
 sed -i "s/^version = \".*\"/version = \"$1\"/g" Cargo.toml
-cargo fetch --offline
+cargo fetch --offline # bumps the version in Cargo.lock
 if [ "$1" = "$version" ]; then
     # debchange is a Debian script to manage the Debian changelog, but
     # it's too annoying to install everywhere. Just do it by hand.
@@ -110,6 +110,8 @@ fi
 git add CHANGELOG.rst Cargo.toml Cargo.lock
 CreateCommit "Release $version"
 
+# Tags must be full objects, not lightweight tags, for
+# git_version-gen.sh to work.
 git -c "user.signingKey=$committer" \
     tag --sign --message="Release $version" $version