tests: Improve comments.

Fixed the function name for the realMakeOCIBundle() comment header. Also added a warning that tests should call makeOCIBundle(), not realMakeOCIBundle(). Signed-off-by: James O. D. Hunt <[email protected]>
clearcontainers · Aug 29, 2017 · 9df259b · 9df259b
1 parent 111c1e3
commit 9df259b
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/main_test.go b/main_test.go
@@ -340,8 +340,11 @@ func createRootfs(dir string) error {
 	return nil
 }
 
-// makeOCIBundle will create an OCI bundle (including the "config.json"
+// realMakeOCIBundle will create an OCI bundle (including the "config.json"
 // config file) in the directory specified (which must already exist).
+//
+// XXX: Note that tests should *NOT* call this function - they should
+// XXX: instead call makeOCIBundle().
 func realMakeOCIBundle(bundleDir string) error {
 	if bundleDir == "" {
 		return errors.New("BUG: Need bundle directory")