Skip to content

Commit 8cbfa18

Browse files
committed
README: document test output
1 parent d8c603a commit 8cbfa18

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,16 @@ function (`test_index_racy__diff`)[https://github.com/libgit2/libgit2/blob/maste
182182

183183
$ ./libgit2_clar -sindex::racy::diff
184184

185+
The test suite will print a `.` for every passing test, and an `F` for any
186+
failing test. An `S` indicates that a test was skipped because it is not
187+
applicable to your platform or is particularly expensive.
188+
189+
**Note:** There should be _no_ failing tests when you build an unmodified
190+
source tree from a [release](https://github.com/libgit2/libgit2/releases),
191+
or from the [master branch](https://github.com/libgit2/libgit2/tree/master).
192+
Please contact us or [open an issue](https://github.com/libgit2/libgit2/issues)
193+
if you see test failures.
194+
185195
Installation
186196
------------
187197

0 commit comments

Comments
 (0)