From: Jason Ish <jason.ish@oisf.net>
Date: Tue, 6 Jun 2023 18:19:46 +0000 (-0600)
Subject: readme: add exit-code example
X-Git-Tag: suricata-6.0.13~14
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7111bdc726c48c69e1899a914f3191eae269c719;p=thirdparty%2Fsuricata-verify.git

readme: add exit-code example

Document how a specific exit-code can be tested for.
---

diff --git a/README.md b/README.md
index 8bd109c96..674e4803b 100644
--- a/README.md
+++ b/README.md
@@ -100,6 +100,11 @@ pre-check: |
 # "pcap: false" in the requires section.
 pcap: input.pcap
 
+# Test for a specific exit code. By default a test will fail if the
+# exit code is anything other than 0, however sometimes we may be
+# testing for failure.
+exit-code: 1
+
 checks:
 
   # A verification filter that is run over the eve.json. Multiple