diff options
author | David Allsopp <david.allsopp@metastack.com> | 2017-08-12 21:24:41 +0100 |
---|---|---|
committer | David Allsopp <david.allsopp@metastack.com> | 2018-06-14 15:15:34 +0100 |
commit | b5d1929e878d6d2ccfe6ea349960ee803e9e45c6 (patch) | |
tree | ee497c424f62d64cc71626401469ca7efff37686 /testsuite/HACKING.adoc | |
parent | c226df2716e63214c6a3bb2c8cfdff820cd7d661 (diff) | |
download | ocaml-b5d1929e878d6d2ccfe6ea349960ee803e9e45c6.tar.gz |
Whitespace and overlong line fixes.
Diffstat (limited to 'testsuite/HACKING.adoc')
-rw-r--r-- | testsuite/HACKING.adoc | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/testsuite/HACKING.adoc b/testsuite/HACKING.adoc index f634cda705..6e4ff900b0 100644 --- a/testsuite/HACKING.adoc +++ b/testsuite/HACKING.adoc @@ -4,10 +4,29 @@ == Useful Makefile targets -`make parallel`:: runs the tests in parallel using the link:https://www.gnu.org/software/parallel/[GNU parallel] tool: tests run twice as fast with no difference in output order. +`make parallel`:: + runs the tests in parallel using the + link:https://www.gnu.org/software/parallel/[GNU parallel] tool: tests run + twice as fast with no difference in output order. -`make all-foo`, `make parallel-foo`:: runs only the tests in the directories whose name starts with `foo`: `parallel-typing`, `all-lib`, etc. +`make all-foo`, `make parallel-foo`:: + runs only the tests in the directories whose name starts with `foo`: + `parallel-typing`, `all-lib`, etc. -`make one DIR=tests/foo`:: runs only the tests in the directory `tests/foo`. This is often equivalent to `cd tests/foo && make`, but sometimes the latter breaks the test makefile if it contains fragile relative filesystem paths. Such errors should be fixed if you find them, but `make one DIR=...` is the more reliable option as it runs exactly as `make all` which is heavily tested. +`make one DIR=tests/foo`:: + runs only the tests in the directory `tests/foo`. This is often equivalent to + `cd tests/foo && make`, but sometimes the latter breaks the test makefile if + it contains fragile relative filesystem paths. Such errors should be fixed if + you find them, but `make one DIR=...` is the more reliable option as it runs + exactly as `make all` which is heavily tested. -`make promote DIR=tests/foo`:: most test run a program and compare the result of the program, store in a file `foo.result`, with a reference output stored in `foo.reference` -- the test fails if the two output differ. Sometimes a change in result is innocuous, it comes from an intended change in output instead of a regression. `make promote` copies the new result file into the reference file, making the test pass again. Whenever you use this rule please check carefully, using `git diff`, that the change really corresponds to an intended output difference, and not to a regression. You then need to commit the change to reference file, and your commit message should explain why the output changed. +`make promote DIR=tests/foo`:: + most test run a program and compare the result of the program, store in a file + `foo.result`, with a reference output stored in `foo.reference` -- the test + fails if the two output differ. Sometimes a change in result is innocuous, it + comes from an intended change in output instead of a regression. + `make promote` copies the new result file into the reference file, making the + test pass again. Whenever you use this rule please check carefully, using + `git diff`, that the change really corresponds to an intended output + difference, and not to a regression. You then need to commit the change to + reference file, and your commit message should explain why the output changed. |