summaryrefslogtreecommitdiffstats
path: root/contrib/file/tests/README
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/file/tests/README')
-rw-r--r--contrib/file/tests/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/contrib/file/tests/README b/contrib/file/tests/README
new file mode 100644
index 0000000..31f9b14
--- /dev/null
+++ b/contrib/file/tests/README
@@ -0,0 +1,17 @@
+file tests
+==========
+
+This directory contains tests for file. It is highly encouraged to add
+one each time a bug is found, and each time new magic is added. Each
+test consists of three files:
+
+ TEST.magic
+ TEST.testfile
+ TEST.result
+
+where TEST is the base name of the test, TEST.magic contains the magic
+used, TEST.testfile is the input, and TEST.result is the desired
+output from file.
+
+It suffices to add a triplet of test files to the directory to have
+them included in "make check".
OpenPOWER on IntegriCloud