Skip to content

Commit 7b421f0

Browse files
Clarify Revise and testing workflow (JuliaLang#35604)
* Clarify Revise and testing workflow Co-authored-by: Stefan Karpinski <[email protected]>
1 parent 0f2ed77 commit 7b421f0

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -201,11 +201,12 @@ Add new code to Julia's base libraries as follows (this is the "basic" approach;
201201
202202
Build as usual, and do `make clean testall` to test your contribution. If your contribution includes changes to Makefiles or external dependencies, make sure you can build Julia from a clean tree using `git clean -fdx` or equivalent (be careful – this command will delete any files lying around that aren't checked into git).
203203
204-
Note: You can run specific test files with `make`:
204+
#### Running specific tests
205+
There are `make` targets for running specific tests:
205206
206207
make test-bitarray
207208
208-
or with the `runtests.jl` script, e.g. to run `test/bitarray.jl` and `test/math.jl`:
209+
You can also use the `runtests.jl` script, e.g. to run `test/bitarray.jl` and `test/math.jl`:
209210
210211
./usr/bin/julia test/runtests.jl bitarray math
211212
@@ -242,9 +243,9 @@ If you need to restart your Julia session, just start at step 2 above.
242243
built and incorporate them automatically. You only need to rebuild
243244
Julia if you made code-changes that Revise cannot handle.
244245

245-
For convenience, there are also `test-revise-*` targets for every `test-*`
246-
target that use Revise to load any modifications to Base into the current
247-
process before running the corresponding test. This can be useful as a shortcut
246+
For convenience, there are also `test-revise-*` targets for every [`test-*`
247+
target](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#running-specific-tests) that use Revise to load any modifications to Base into the current
248+
system image before running the corresponding test. This can be useful as a shortcut
248249
on the command line (since tests aren't always designed to be run outside the
249250
runtest harness).
250251

0 commit comments

Comments
 (0)