From e6d606e93644c1f3090096f3a4db37ed4b6cb31d Mon Sep 17 00:00:00 2001
From: Lars Frost <larsf@fsmpi.rwth-aachen.de>
Date: Wed, 5 Oct 2022 18:24:03 +0200
Subject: [PATCH] Start documenting assemble_image.sh

---
 assemble_image.sh | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/assemble_image.sh b/assemble_image.sh
index 54fd5f7..7adb060 100755
--- a/assemble_image.sh
+++ b/assemble_image.sh
@@ -13,10 +13,13 @@ REGULAR_USER_HOME=$(getent passwd "$REGULAR_USER" | cut -d: -f6)
 ISO_PROFILES_REPO="$REGULAR_USER_HOME/iso-profiles"
 PROFILE="$ISO_PROFILES_REPO/osak/lip"
 
+# prepare workspace
 rm -rf "$ISO_PROFILES_REPO"
 rm -rf "$WORKSPACE"
 mkdir "$WORKSPACE"
 chmod a+rx "$WORKSPACE"
+
+# configure iso profile
 git clone --depth 1 https://gitlab.manjaro.org/profiles-and-settings/iso-profiles.git "$ISO_PROFILES_REPO"
 mkdir -p "$PROFILE"
 rsync -a --copy-links "$ISO_PROFILES_REPO/manjaro/kde/" "$PROFILE"
@@ -41,6 +44,12 @@ remove_desktop_package "manjaro-hello"
 mkdir -p "$PROFILE/live-overlay/usr/share/grub/cfg"
 rsync --recursive grub-cfg/ "$PROFILE/live-overlay/usr/share/grub/cfg"
 
+# At this point we are finished with the profile configuration.
+# We now generate the filesystems with `buildiso -x`.
+# The resulting filesystems are  placed in /var/lib/manjaro-tools/buildiso/lip/x86_64.
+# F.e. the live system takes its filesystem from /var/lib/manjaro-tools/buildiso/lip/x86_64/livefs.
+# From now on we will configure the iso further by configuring the filesystems directly instead of configuring them through the iso profile.
+
 set +e # buildiso returns a 1 on partial builds
 buildiso -p lip -x -k linux515 # build only filesystems, but not the iso
 BO="$?"
-- 
GitLab