3 files changed, 46 insertions, 0 deletions

diff --git a/share/doc/Makefile b/share/doc/Makefile
index fda977f118e0..c752c51b33eb 100644
--- a/share/doc/Makefile
+++ b/share/doc/Makefile
@@ -7,10 +7,12 @@ SUBDIR=	${_IPv6} \
 	${_atf} \
 	legal \
 	${_llvm} \
+	${_pjdfstest} \
 	${_roffdocs}
 
 .if ${MK_TESTS} != "no"
 _atf= atf
+_pjdfstest= pjdfstest
 .endif
 
 .if ${MK_CLANG} != "no"
diff --git a/share/doc/pjdfstest/Makefile b/share/doc/pjdfstest/Makefile
new file mode 100644
index 000000000000..21d72f36e353
--- /dev/null
+++ b/share/doc/pjdfstest/Makefile
@@ -0,0 +1,8 @@
+# $FreeBSD$
+
+NO_OBJ=
+
+FILESDIR=	${SHAREDIR}/doc/pjdfstest
+FILES=		README
+
+.include <bsd.prog.mk>
diff --git a/share/doc/pjdfstest/README b/share/doc/pjdfstest/README
new file mode 100644
index 000000000000..d09011789e42
--- /dev/null
+++ b/share/doc/pjdfstest/README
@@ -0,0 +1,36 @@
+pjdfstest test suite execution is integrated into kyua. This README describes
+how to use pjdfstest in the default configuration (kyua work directory), and
+with a specific filesystem path.
+
+Method 1. Executing with default configuration (kyua work directory)
+
+    1. Elevate privileges:
+       % su -
+    2. cd to the tests directory:
+       % cd /usr/tests/sys/pjdfstest
+    3. Run kyua:
+       % kyua test
+
+   Executing the commands as shown above will run pjdfstest in the kyua work
+   directory. The kyua work directory defaults to a random generated path under
+   /tmp; please see TMPDIR in kyua(1) for more details on how the temporary path
+   is chosen with kyua.
+
+Method 2. Executing with a specific filesystem path (in this case /mnt)
+
+    1. Elevate privileges:
+       % su -
+    2. cd to the tests directory:
+       % cd /usr/tests/sys/pjdfstest
+    3. Run kyua:
+       % env PJDFSTEST_TEST_PATH=/mnt kyua test
+
+   WARNING: the above method violates the test program isolation algorithm
+   described in kyua(1); as such, $PJDFSTEST_TEST_PATH must be cleaned up after
+   executing the testcases.
+
+   It's highly recommended that $PJDFSTEST_TEST_PATH be pointed to a sandboxed
+   filesystem, e.g. a small UFS-formatted memory disk or ZFS dataset with
+   quotas enabled, so the filesystem can be easily destroyed after the test
+   execution is complete, and the testcases are properly bounded both in terms
+   of time and space.