From: Ralph Corderoy <ralph@inputplus.co.uk>
Date: Sat, 10 Dec 2016 14:51:06 +0000 (+0000)
Subject: showbuildenv: Add comment describing exit-status convention.
X-Git-Url: https://diplodocus.org/git/nmh/commitdiff_plain/8a260e95d18fbaee659cd6ed662e97e0c10fcdf0?hp=542cddb8324fead28ff5ddd56e206af31ed39e24

showbuildenv: Add comment describing exit-status convention.

It helps explain why some commands are `... || true' despite no `set -e'
being in effect.
---

diff --git a/tools/showbuildenv b/tools/showbuildenv
index 2338bc6c..81f278e8 100755
--- a/tools/showbuildenv
+++ b/tools/showbuildenv
@@ -9,6 +9,10 @@
 # This script should *only* report basic information about the build
 # environment, and only that necessary to reproduce the build
 # environment.
+#
+# The script's exit status must be zero if all went acceptably well as
+# buildbot checks for this and marks the `environment' stage as failed
+# otherwise.
 
 offset () {
     sed -e '/./s/^/    /' "$@"