Add a description of what the relayd and sosplice regression tests

do.  Also explain the optional environment variables.

diff --git a/regress/sys/kern/sosplice/README b/regress/sys/kern/sosplice/README
new file mode 100644 (file)
index 0000000..0a03383
--- /dev/null
+++ b/regress/sys/kern/sosplice/README
@@ -0,0 +1,12 @@
+Run socket splicing regressions tests.  The error directory contains
+tests, that invoke the splicing system call with invalid arguments.
+The tcp and udp framework run a client, and a server, and a relay.
+Each test starts those three processes.  All processes write log
+files that are checked for certain messages.  The test arguments
+are kept in the args-*.pl files.  The perf directory contains a C
+program that can compare copy and splice performance.
+
+LOCAL_ADDR, REMOTE_ADDR, REMOTE_SSH
+Set these to run the relay process on a remote machine.  As the
+client and server run locally, network timing may influence the
+test results.

diff --git a/regress/usr.sbin/relayd/README b/regress/usr.sbin/relayd/README
index 8bfb99d..180475f 100644 (file)
--- a/regress/usr.sbin/relayd/README
+++ b/regress/usr.sbin/relayd/README
@@ -1,3 +1,25 @@
-$OpenBSD: README,v 1.1 2014/07/09 22:35:35 reyk Exp $
+Run relayd regressions tests.  The framework runs a client, and a
+server, and a relayd.  Currently the tcp and http forwarding code
+path is covered.  Each test creates a special relayd.conf and starts
+those three processes.  All processes write log files that are
+checked for certain messages.  The test arguments are kept in the
+args-*.pl files.  To find socket splicing bugs, each test is run
+in both copy and splice mode.
+
+SUDO=sudo
+As relayd needs root privileges either run the tests as root or set
+this variable and run make as a regular user.  Only the code that
+requires it, is run as root.
+
+KTRACE=ktrace
+Set this variable if you want a ktrace output from relayd.  Note that
+ktrace is invoked after sudo as sudo would disable it.
+
+RELAYD=/usr/src/usr.sbin/relayd/obj/relayd
+Start an alternative relayd program that is not in the path.
+
+LOCAL_ADDR, REMOTE_ADDR, REMOTE_SSH
+Set these to run the relayd on a remote machine.  As the client and
+server run locally, network timing may influence the test results.
 
 Changes here have to be discussed with bluhm@, reyk@ or benno@.