config: improve documentation

1 files changed, 20 insertions, 0 deletions

diff --git a/functions/init.sh b/functions/init.sh
index 1fc653224..4eb6e7299 100755
--- a/functions/init.sh
+++ b/functions/init.sh
@@ -30,6 +30,26 @@ Init_config_data ()
 	Set_config_defaults
 }
 
+# "Auto" script redirection.
+#
+# As a matter of convenience users can have a set of saved commandline options
+# which will be automatically included in every execution of live-build. How
+# this works is that the save file is itself a shell script saved in the config
+# directory (one per top-level live-build command in fact). When `lb config`,
+# `lb build` or `lb clean` is run, these scripts, if they see that an "auto"
+# file exists in the config, they run that file, passing along any user
+# arguments, and terminate once that ends. The "auto" script simply re-executes
+# the same command (e.g. `lb config`), only with a first param of "noauto",
+# used to stop an infinite loop of further redirection, then a fixed saved set
+# of command line options, as saved in the file by the user, then any
+# additional command line arguments passed into the script. This is simply a
+# means of injecting a saved set of command line options into the execution of
+# live-build.
+#
+# As for this function, it is a simple helper, used by the top-level commands
+# to perform the redirection if the relevant "auto" file exists. It should only
+# be called if the calling command script was not run with "noauto" as the
+# first argument (the purpose of which was just described).
 Maybe_auto_redirect ()
 {
 	local TYPE="${1}"; shift