From 41dfbe67f827ecaebd7dd81a079f38a676288800 Mon Sep 17 00:00:00 2001
From: Jakob Unterwurzacher
Date: Wed, 1 May 2019 12:47:54 +0200
Subject: test_helpers: better function comments for InitFS and Mount

It's confusing that you must pass "-extpass" for Mount but not
for InitFS. Note that in the comment.
---
 tests/test_helpers/mount_unmount.go | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'tests/test_helpers/mount_unmount.go')

diff --git a/tests/test_helpers/mount_unmount.go b/tests/test_helpers/mount_unmount.go
index 5e5b6f3..30d1c0d 100644
--- a/tests/test_helpers/mount_unmount.go
+++ b/tests/test_helpers/mount_unmount.go
@@ -26,6 +26,9 @@ type mountInfo struct {
 
 // Mount CIPHERDIR "c" on PLAINDIR "p"
 // Creates "p" if it does not exist.
+//
+// Contrary to InitFS(), you MUST passt "-extpass=echo test" (or another way for
+// getting the master key) explicitely.
 func Mount(c string, p string, showOutput bool, extraArgs ...string) error {
 	args := []string{"-q", "-wpanic", "-nosyslog", "-fg", fmt.Sprintf("-notifypid=%d", os.Getpid())}
 	args = append(args, extraArgs...)
@@ -93,6 +96,9 @@ func Mount(c string, p string, showOutput bool, extraArgs ...string) error {
 }
 
 // MountOrExit calls Mount() and exits on failure.
+//
+// Contrary to InitFS(), you MUST passt "-extpass=echo test" (or another way for
+// getting the master key) explicitely.
 func MountOrExit(c string, p string, extraArgs ...string) {
 	err := Mount(c, p, true, extraArgs...)
 	if err != nil {
@@ -102,6 +108,9 @@ func MountOrExit(c string, p string, extraArgs ...string) {
 }
 
 // MountOrFatal calls Mount() and calls t.Fatal() on failure.
+//
+// Contrary to InitFS(), you MUST passt "-extpass=echo test" (or another way for
+// getting the master key) explicitely.
 func MountOrFatal(t *testing.T, c string, p string, extraArgs ...string) {
 	err := Mount(c, p, true, extraArgs...)
 	if err != nil {
-- 
cgit v1.2.3