improve docs

Author: daler

images/image_config.sh

@@ -18,6 +18,8 @@ BOT_IMAGE_NAME="tmp-bot"
 BASE_TAG="0.2"
 BASE_IMAGE_CONDAFORGE_AMD64="quay.io/condaforge/linux-anvil-x86_64:cos7"
 BASE_IMAGE_CONDAFORGE_ARM64="quay.io/condaforge/linux-anvil-aarch64:cos7"
+
+# May be set within loops sourcing this script, in which case respect it
 CURRENT_ARCH=${CURRENT_ARCH:-""}
 
 # Inspect this repo to get the currently-checked-out version, which matches
@@ -72,24 +74,24 @@ function tag_exists() {
 }
 
 function build_and_push_manifest() {
-  # Creates a local manifest, adds containers for multiple archs, and pushes to
-  # a registry.
+  # Creates a local manifest, pull containers for multiple archs, adds them to
+  # the manifest, and pushes the manifest & images to a registry.
   #
   # build_and_push_manifest <source> <dest> <podman manifest push args> <use_arch_suffix>
   #
   # (last two args are optional)
   #
   # For pushing to a local registry:
   #
-  #   build_and_push_manifest ${BASE_BUSYBOX_IMAGE_NAME}:${BASE_TAG} docker://localhost:5000 ${BASE_BUSYBOX_IMAGE_NAME}:${BASE_TAG} "--tls-verify=false"
+  #   build_and_push_manifest image:tag docker://localhost:5000/image:tag "--tls-verify=false"
   #
   # For pushing the manifest from local images to quay.io:
   #
-  #   build_and_push_manifest ${BASE_BUSYBOX_IMAGE_NAME}:${BASE_TAG} quay.io/bioconda/${BASE_BUSYBOX_IMAGE_NAME}:latest
+  #   build_and_push_manifest image:tag quay.io/bioconda/image:master
   #
-  # For re-tagging a manifest (with its component images):
+  # For re-tagging a manifest already on quay.io (with its component images):
   #
-  #   build_and_push_manifest ${BASE_BUSYBOX_IMAGE_NAME}:${BASE_TAG} quay.io/bioconda/${BASE_BUSYBOX_IMAGE_NAME}:latest "" "false"
+  #   build_and_push_manifest quay.io/bioconda/image:master quay.io/bioconda/image:latest "" "false"
   local source=$1
   local dest=$2
   local additional_args=${3:-""}
@@ -109,6 +111,12 @@ function build_and_push_manifest() {
     # skip non-amd64 if configured
     [ "${ONLY_AMD64:-false}" == "true" -a "${arch}" != "amd64" ] && continue
 
+    # When first creating a manifest, we have local images that have
+    # arch-specific suffixes so use the default, "true".
+    #
+    # However, when re-tagging a manifest already on quay.io, the arch-specific
+    # images are inside the manifest and do not have arch-specific suffixes, so
+    # use "false".
     if [ $use_arch_suffix == "true" ]; then 
       imgid=$(buildah pull --arch=$arch "${source}-${arch}")
     else