summaryrefslogtreecommitdiffstats
path: root/doc/userguide/partials/options-unittests.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/userguide/partials/options-unittests.rst')
-rw-r--r--doc/userguide/partials/options-unittests.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/userguide/partials/options-unittests.rst b/doc/userguide/partials/options-unittests.rst
new file mode 100644
index 0000000..971e8fd
--- /dev/null
+++ b/doc/userguide/partials/options-unittests.rst
@@ -0,0 +1,25 @@
+.. Options for developers - unittests.
+
+.. option:: -u
+
+ Run the unit tests and exit. Requires that Suricata be configured
+ with *--enable-unittests*.
+
+.. option:: -U, --unittest-filter=REGEX
+
+ With the -U option you can select which of the unit tests you want
+ to run. This option uses REGEX. Example of use: suricata -u -U
+ http
+
+.. option:: --list-unittests
+
+ Lists available unit tests.
+
+.. option:: --fatal-unittests
+
+ Enables fatal failure on a unit test error. Suricata will exit
+ instead of continuing more tests.
+
+.. option:: --unittests-coverage
+
+ Display unit test coverage report.