better docs around the change2

Author: clemensutschig

src/org/ods/orchestration/util/MROPipelineUtil.groovy

@@ -313,13 +313,15 @@ class MROPipelineUtil extends PipelineUtil {
                     if (preExecute) {
                         preExecute(this.steps, repo)
                     }
-                    // force this to happen on master - if an agent is needed, the closure has to 
-                    // take care about it.
+                    // force this to happen on master - if an agent is needed, the closure has to
+                    // take care about it. The reason for this is the closure to have access to files
+                    // from the component, e.g. jenkinsfile, shell scripts,...
                     this.steps.node {
-                        // when a node switch happens, jenkins creates a new dir @xxx - so we need to copy.
+                        // when a node switch happens, jenkins creates a new dir workspace@xxx
+                        // so we need to copy.
                         def currentNodeBaseDir = "${this.steps.env.WORKSPACE}/${REPOS_BASE_DIR}/${repo.id}"
                         this.steps.sh "cp -r ${currentBaseDir} ${currentNodeBaseDir}"
-                        
+
                         if (repo.type?.toLowerCase() == PipelineConfig.REPO_TYPE_ODS_CODE) {
                             if (this.project.isAssembleMode && name == PipelinePhases.BUILD) {
                                 executeODSComponent(repo, currentNodeBaseDir)
@@ -350,7 +352,7 @@ class MROPipelineUtil extends PipelineUtil {
                             def phaseConfig = repo.pipelineConfig.phases ? repo.pipelineConfig.phases[name] : null
                             if (phaseConfig) {
                                 def label = "${repo.id} (${repo.url})"
-    
+
                                 if (phaseConfig.type == PipelineConfig.PHASE_EXECUTOR_TYPE_MAKEFILE) {
                                     this.steps.dir(currentNodeBaseDir) {
                                         def steps = "make ${phaseConfig.target}"
@@ -368,6 +370,7 @@ class MROPipelineUtil extends PipelineUtil {
                         }
                     }
                     // we keep this outside the node, as there are various code pieces in the different stages
+                    // that organize their (own) agent / master concept
                     if (postExecute) {
                         postExecute(this.steps, repo)
                     }