diff options
author | Edward Thomson <ethomson@edwardthomson.com> | 2017-11-15 22:42:35 +0000 |
---|---|---|
committer | Edward Thomson <ethomson@edwardthomson.com> | 2017-11-24 22:24:43 +0000 |
commit | 8cbfa1839f599148449c0e8ee7f9320586c9316c (patch) | |
tree | 2b02d0c44a016c79a743d656ea70f3bcc503586e | |
parent | d8c603aa39ba572090749464d80db746e2351985 (diff) | |
download | libgit2-8cbfa1839f599148449c0e8ee7f9320586c9316c.tar.gz |
README: document test output
-rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -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 ------------ |