rename binary_loopback_cfg to binary_grub_cfg

when loopback support was introduced, it initially duplicated the code
for generating a grub2 config, before the duplicated code was removed from
the grub-pc script, effectively thus moving grub config generation to the
loopback feature script.

grub-efi support was added after this.

this results in a misleading filename, since the `binary_loopback_cfg`
script is essential for use of grub-pc|grub-efi, and actually only has a
single line of code on top that's needed for adding actual loopback
support on top. (when grub-pc and grub-efi are not used, the entire script
is still needed for loopback support to work).

so here we rename it to make better sense, and correct/clarify bits of
documentation.

Gbp-Dch: Short

4 files changed, 14 insertions, 11 deletions

diff --git a/scripts/build/binary b/scripts/build/binary
index a759a7899..aa1d06ab2 100755
--- a/scripts/build/binary
+++ b/scripts/build/binary
@@ -54,7 +54,7 @@ lb binary_linux-image "${@}"
 lb binary_memtest "${@}"
 lb binary_grub-legacy "${@}"
 lb binary_grub-pc "${@}"
-lb binary_loopback_cfg "${@}"
+lb binary_grub_cfg "${@}"
 lb binary_syslinux "${@}"
 lb binary_disk "${@}"
 lb binary_loadlin "${@}"
diff --git a/scripts/build/binary_grub-efi b/scripts/build/binary_grub-efi
index 2ee26f40d..a7181bfed 100755
--- a/scripts/build/binary_grub-efi
+++ b/scripts/build/binary_grub-efi
@@ -31,6 +31,8 @@ fi
 
 Echo_message "Begin preparing Grub based EFI support..."
 
+# NOTE: We rely on `binary_grub_cfg` to generate grub.cfg and other configuration files!
+
 # Requiring stage file
 Require_stagefiles config bootstrap
 
@@ -295,7 +297,5 @@ rm -rf chroot/grub-efi-temp-arm-efi
 rm -rf chroot/grub-efi-temp-cfg
 rm -rf chroot/grub-efi-temp
 
-# We rely on: binary_loopback_cfg to generate grub.cfg and other configuration files
-
 # Creating stage file
 Create_stagefile
diff --git a/scripts/build/binary_grub-pc b/scripts/build/binary_grub-pc
index f639b1aa1..9fca63272 100755
--- a/scripts/build/binary_grub-pc
+++ b/scripts/build/binary_grub-pc
@@ -31,6 +31,8 @@ fi
 
 Echo_message "Begin installing grub-pc..."
 
+# NOTE: We rely on `binary_grub_cfg` to generate grub.cfg and other configuration files!
+
 # Requiring stage file
 Require_stagefiles config bootstrap
 
@@ -71,8 +73,6 @@ then
 	FILES="$(echo ${FILES} | sed -e 's|chroot||g')"
 fi
 
-# We rely on: binary_loopback_cfg to generate grub.cfg and other configuration files
-
 # Copying grub
 cp ${FILES} binary/boot/grub/i386-pc
 
diff --git a/scripts/build/binary_loopback_cfg b/scripts/build/binary_grub_cfg
index 4f4e1b95d..54649e187 100755
--- a/scripts/build/binary_loopback_cfg
+++ b/scripts/build/binary_grub_cfg
@@ -15,17 +15,19 @@ set -e
 [ -e "${LIVE_BUILD}/scripts/build.sh" ] && . "${LIVE_BUILD}/scripts/build.sh" || . /usr/lib/live/build.sh
 
 # Setting static variables
-DESCRIPTION="Installs loopback.cfg into binary"
+DESCRIPTION="Generates config for grub-pc and grub-efi, and installs loopback support"
 USAGE="${PROGRAM} [--force]"
 
 # Processing arguments and configuration files
 Init_config_data "${@}"
 
-# We avoid checking if we need to be running this bootloader
-# on purpose. The reason: You will always want to have
-# a loopback.cfg file
-# TODO: Add an option to be able to disable this file creation
-Echo_message "Begin installing loopback.cfg..."
+# NOTE: This creates the config used for both grub-pc and grub-efi.
+# It also installs loopback.cfg for looback support, which depends upon that
+# config. Since loopback support is added unconditionally, this script is
+# thus run unconditionally!
+# TODO: Add an option to allow disabling loopback.cfg creation? (and thus conditionally run the script)
+
+Echo_message "Begin installing config for grub-pc and/or grub-pc, and loopback support..."
 
 # Requiring stage file
 Require_stagefiles config bootstrap
@@ -280,6 +282,7 @@ sed -i \
 sed -i -e 's|//|/|g' "${_TARGET}"/*.cfg
 sed -i -e 's|\ $||g' "${_TARGET}"/*.cfg
 
+# Add loopback support
 echo "source /boot/grub/grub.cfg" > "${_TARGET}"/loopback.cfg
 
 # Creating stage file