summaryrefslogtreecommitdiff
path: root/static/inferno/man1/sh-test.1
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-26 16:38:00 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-26 16:38:00 -0400
commit97d5c458cfa039d857301e1ca7d5af3beb37131d (patch)
treeb460cd850d0537eb71806ba30358840377b27688 /static/inferno/man1/sh-test.1
parentb89dc2331a50c63f8b33272a5c4c61ab98abdaa3 (diff)
build: Better Build System
Diffstat (limited to 'static/inferno/man1/sh-test.1')
-rw-r--r--static/inferno/man1/sh-test.146
1 files changed, 46 insertions, 0 deletions
diff --git a/static/inferno/man1/sh-test.1 b/static/inferno/man1/sh-test.1
new file mode 100644
index 00000000..fb4ed49d
--- /dev/null
+++ b/static/inferno/man1/sh-test.1
@@ -0,0 +1,46 @@
+.TH SH-TEST 1
+.SH NAME
+report \- shell module for test reporting.
+.SH SYNOPSIS
+.B load test
+
+.br
+.B report
+.I severity verbosity message[...]
+.br
+.SH DESCRIPTION
+.B Its
+is a loadable module for
+.IR sh (1)
+that provides a simple error reporting facility for tests which can be run
+by
+.IR itest (1) .
+It provides one command,
+.BR report ,
+which is used by a test to report a message with specified severity and verbosity.
+.I Severity
+must be one of INF, WRN, ERR or FTL for Information, warnings, errors and fatal errors
+respectively.
+.I Verbosity
+is an integer between 0 and 9.
+For informatory messages (severity INF), the message will only be
+displayed if the current
+verbosity level is greater than or equal to
+.I verbosity.
+.SH EXAMPLE
+.EX
+#!/dis/sh
+
+load std test
+
+echo 1 > /tmp/a
+echo 2 >/tmp/b
+report INF 5 testing cmp command
+if {cmp /tmp/a /tmp/b} {
+ report ERR 0 'cmp failed - reported different files as the same'
+}{
+ report INF 6 'cmp ok - reported different files as different'
+}
+.EE
+.SH SEE ALSO
+.IR itest (1)