From: Juliana Fajardini <jufajardini@oisf.net>
Date: Wed, 3 Jul 2024 19:36:14 +0000 (-0300)
Subject: README/help: add info on IPS mode tests creation
X-Git-Tag: suricata-7.0.7~13
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9e2de61683db26e90689134d153541dba729a165;p=thirdparty%2Fsuricata-verify.git

README/help: add info on IPS mode tests creation

It is possible to create a test that runs in IPS mode by just adding ips
to its name. But that is not documented. This will might not work when
using the createst script, though, as when the script runs the test for
the first time to create the `test.yaml` checks, the test-name is not
taken into consideration (therefore, the checks are valid for IDS mode).

Related to
Task #7039
---

diff --git a/README.md b/README.md
index f2477dcbb..f11ac3fa6 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,10 @@ Or to run a single test:
 
 - Create a directory that is the name of the new test.
 
+  If you want a test to be run in IPS mode, add `ips` to the test name.
+  This will make the `--simulate-ips` command-line argument be passed when
+  the test is run.
+
 - Copy a single pcap file into the test directory. It must end in
   ".pcap".