[mltk] added some comments on the code...

1 files changed, 28 insertions, 3 deletions

diff --git a/mltk b/mltk
index 4635f5dd..3f8442a0 100755
--- a/mltk
+++ b/mltk
@@ -32,6 +32,7 @@ qnd_exit() {
 	[ $# -ge 1 ] && kill "$1"
 }
 
+# source all helper functions files that are found under helper/*.inc
 for HELPER in $ROOT_DIR/helper/*.inc; do
 	. "$HELPER" && continue
 	unset_quiet
@@ -100,7 +101,15 @@ initial_checks() {
 	pinfo "Kernel version: $KERNEL_VERSION"
 	pinfo "System's packet manager is $PACKET_MANAGER"
 
-	# setup_target and export_target
+	# source the 2 central scripts:
+	# setup_target
+	#	- builds all modules activated under the target directory
+	#	  (basic targets are 'stage31' and 'stage32')
+	# export_target
+	#	- pack given target as a cpio or squashfs depending on
+	#	  the export type:
+	#	  	stage31 (cpio archive of the complete stage31-filesystem)
+	#		stage32 (cpio archive containing the squashfs'ed stage32-filesystem)
 	REMOTE_SETUP_TARGET="${ROOT_DIR}/remote/setup_target"
 	SERVER_EXPORT_TARGET="${ROOT_DIR}/server/export_target"
 
@@ -111,7 +120,11 @@ initial_checks() {
 read_params() {
 	local MODE=""
 	local SUBMODE=""
-	# select mode: remote or server
+	# mltk knows two modes in which to run:
+	#	- remote: functions to be run on the reference system
+	#		  from which to build the mini-linux
+	#	- server: functions for rsyncing the generated stage31/stage32
+	# 		  to a server, exporting the stage31-/stage32-filesystems
 	case "$1" in
 		server)
 			MODE="SERVER"
@@ -130,8 +143,20 @@ read_params() {
 	esac
 	shift
 
+	# A target represents a set of modules to be build for a specific stage.
+	# i.e. a very basic stage31 includes:
+	#	- busybox
+	#	- kernel
+	#	- rootfs-stage31
+	# a basic stage32 would also contain these and additionally:
+	#	- systemd
+	#	- dbus
+	#	- pam
+	# for a GUI, you could add:
+	#	- xorg
+	#	- kdm
+	# 	- plymouth
 	TARGET=""
-	# set target.
 	if [[ $1 != "-"* ]]; then
 		TARGET=$1
 		shift