add some code documentation

gvallee · gvallee · commit 5b89e854bcff · 2019-12-14T20:19:59.000-05:00
Signed-off-by: Geoffroy Vallee &lt;geoffroy.vallee@gmail.com&gt;
diff --git a/internal/pkg/buildenv/buildenv.go b/internal/pkg/buildenv/buildenv.go
@@ -540,6 +540,8 @@ func createContainerPersistentMPIBuildEnv(containerBuildEnv *Info, kvs []kv.KV,
 	return cleanup, err
 }
 
+// CreateDefaultContainerEnvCfg sets all the details for a default build environment for any
+// type of application (it does not have to be a MPI application)
 func CreateDefaultContainerEnvCfg(containerBuildEnv *Info, kvs []kv.KV, sysCfg *sys.Config) (func(), error) {
 	var err error
 	var cleanup func()

Original file line number	Diff line number	Diff line change
`@@ -540,6 +540,8 @@ func createContainerPersistentMPIBuildEnv(containerBuildEnv *Info, kvs []kv.KV,`
`540`	`540`	`return cleanup, err`
`541`	`541`	`}`
`542`	`542`
	`543`	`+// CreateDefaultContainerEnvCfg sets all the details for a default build environment for any`
	`544`	`+// type of application (it does not have to be a MPI application)`
`543`	`545`	`func CreateDefaultContainerEnvCfg(containerBuildEnv Info, kvs []kv.KV, sysCfg sys.Config) (func(), error) {`
`544`	`546`	`var err error`
`545`	`547`	`var cleanup func()`