Add comment in configuration to document verify_images_present setting

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

1 files changed, 13 insertions, 0 deletions

diff --git a/config.toml b/config.toml
index 813d801..84ae352 100644
--- a/config.toml
+++ b/config.toml
@@ -79,6 +79,19 @@ available_phases = [ "unpack", "patch", "configure", "build", "fixup", "pack" ]
 # Images which can be used to build
 # images not listed here are automatically rejected
 images = [ "debian:bullseye" ]
+
+#
+# Verify whether the requested images are present
+#
+# This setting is twofold:
+# First, it checks whether the image requested on the commandline (when
+# building) is actually in the whitelist (`docker.images` setting in the
+# configuration file).
+# Second, it checks that every used endpoint actually has the requested image
+# present.
+# This check is done when setting up the connection to the endpoints, so this
+# will fail _before_ any actual building starts.
+#
 verify_images_present = true
 
 # List of docker endpoints