tests/futility/test_update.sh: Document test_update function
BUG=b:231084609
BRANCH=None
TEST=None
Change-Id: Id76f2469faa13c136c6ec2761577acec4ad810e5
Signed-off-by: Evan Benn <evanbenn@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/vboot_reference/+/3831833
Reviewed-by: Hung-Te Lin <hungte@chromium.org>
diff --git a/tests/futility/test_update.sh b/tests/futility/test_update.sh
index 8d8a559..df6c77b 100755
--- a/tests/futility/test_update.sh
+++ b/tests/futility/test_update.sh
@@ -160,6 +160,12 @@
RW_VPD:"${TMP}.to/RW_VPD"
patch_file "${TMP}.expected.full.empty_rw_vpd" FMAP 0x3fc "$(printf '\010')"
+# Has 3 modes:
+# 1. $3 = "!something", run command, expect failure,
+# grep for something in log, fail if it is not present
+# 2. $3 = "something", run command, expect success,
+# cmp output to file named $3, fail if they are not the same
+# 3. $3 = "!", run command, expect success, fail to find a file named !
test_update() {
local test_name="$1"
local emu_src="$2"
