Commit 8cbfa1839f599148449c0e8ee7f9320586c9316c

Edward Thomson 2017-11-15T22:42:35

README: document test output

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
diff --git a/README.md b/README.md
index 35bc55c..8449ba3 100644
--- a/README.md
+++ b/README.md
@@ -182,6 +182,16 @@ function (`test_index_racy__diff`)[https://github.com/libgit2/libgit2/blob/maste
 
     $ ./libgit2_clar -sindex::racy::diff
 
+The test suite will print a `.` for every passing test, and an `F` for any
+failing test.  An `S` indicates that a test was skipped because it is not
+applicable to your platform or is particularly expensive.
+
+**Note:** There should be _no_ failing tests when you build an unmodified
+source tree from a [release](https://github.com/libgit2/libgit2/releases),
+or from the [master branch](https://github.com/libgit2/libgit2/tree/master).
+Please contact us or [open an issue](https://github.com/libgit2/libgit2/issues)
+if you see test failures.
+
 Installation
 ------------