From 2a2b0fd397b96c452984cf9ba94e1366a0f60e7e Mon Sep 17 00:00:00 2001
From: Achim Gsell <achim.gsell@psi.ch>
Date: Mon, 4 Aug 2025 17:17:56 +0200
Subject: [PATCH] code cleanup

---
 build | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/build b/build
index 1cf51e3..1e9c131 100755
--- a/build
+++ b/build
@@ -103,6 +103,10 @@ read_config_file() {
 	eval $(std::parse_yaml "${fname}" '') || \
 		std::die 1 "Cannot read configuration file '${fname}'"
 
+	# In the YAML configuration file the root of the base overlay must be
+	# defined with Overlays.base.install_root. The function
+	# std::parse_yaml() stores the value in the environment variable
+	# 'Overlays_base_install_root'.
 	declare -xg INSTALL_ROOT="${Overlays_base_install_root}"
 	if [[ -z "${INSTALL_ROOT}" ]]; then
 		std::die 1 "Error in configuration file '${fname}': install root not defined!"