init-and-build.sh: add some comments about the init_env vs custom init_env

Change-Id: If8d9fcd30d4cb9fb9b5ccb9d21f05f8fa6d02b15
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>

1 files changed, 10 insertions, 0 deletions

diff --git a/init-and-build.sh b/init-and-build.sh
index 41c72e1..1c1b458 100755
--- a/init-and-build.sh
+++ b/init-and-build.sh
@@ -59,6 +59,16 @@ show_setup
 
 git_clone_update
 
+# the purpose of the 'init' function is to prepare the <build> folder
+# the default init function suitable for Linaro Platform builds, but
+# the user can specify a custom function if needed. In any case, the
+# init function must ensure :
+#  - oe-init-build-env is called
+#  - path is changed to <build> folder
+#  - user configuration files (local.conf, bblayers.conf, ..) are
+#    created.
+# Once the build init is done, we are adding some Linaro CI specific
+# build options, when running on Jenkins.
 if [ -z "$init_env" ]; then
     init_env
 else