Skip to content

Commit 1308059

Browse files
author
Edward Thomson
committed
CONTRIBUTING: document the optional tests
1 parent ba34932 commit 1308059

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

Diff for: CONTRIBUTING.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ the change, but pass with your changes.
9494
In addition to new tests, please ensure that your changes do not cause
9595
any other test failures. Running the entire test suite is helpful
9696
before you submit a pull request. When you build libgit2, the test
97-
suite will also be built. You can run all tests by simply running
97+
suite will also be built. You can run most of the tests by simply running
9898
the resultant `libgit2_clar` binary. If you want to run a specific
9999
unit test, you can name it with the `-s` option. For example:
100100

@@ -105,6 +105,21 @@ worktree status tests:
105105

106106
libgit2_clar -sstatus::worktree
107107

108+
The default test run is fairly exhaustive, but it will exclude some
109+
unit tests by default: in particular, those that talk to network
110+
servers and the tests that manipulate the filesystem in onerous
111+
ways (and may need to have special privileges to run). To run the
112+
network tests:
113+
114+
libgit2_clar -ionline
115+
116+
In addition, various tests may be enabled by environment variables,
117+
like the ones that write exceptionally large repositories or manipulate
118+
the filesystem structure in unexpected ways. These tests *may be
119+
dangerous* to run on a normal machine and may harm your filesystem. It's
120+
not recommended that you run these; instead, the continuous integration
121+
servers will run these (in a sandbox).
122+
108123
## Porting Code From Other Open-Source Projects
109124

110125
`libgit2` is licensed under the terms of the GPL v2 with a linking

0 commit comments

Comments
 (0)