Skip to content

Commit cd90a31

Browse files
committed
Update README documentation on tests.
Signed-off-by: Edward Z. Yang <[email protected]>
1 parent b32cfbc commit cd90a31

File tree

1 file changed

+8
-18
lines changed

1 file changed

+8
-18
lines changed

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Here are some other useful variations on the commands:
5151

5252
~~~~
5353
cabal new-build Cabal # build library only
54-
cabal new-build Cabal:package-tests # build Cabal's package test suite
54+
cabal new-build Cabal:unit-tests # build Cabal's unit test suite
5555
cabal new-build cabal-install:integration-tests # etc...
5656
~~~~
5757

@@ -88,23 +88,13 @@ several. In general, the test executable for
8888

8989
To run a single test, use `-p` which applies a regex filter to the test names.
9090

91-
* `Cabal:package-tests` are out-of-process integration tests on the top-level `Setup`
92-
command line interface. If you are hacking on the Cabal library you
93-
want to run this test suite. It must be run from the `Cabal` subdirectory
94-
(ugh!) This test suite can be a bit touchy; see
95-
[Cabal/tests/README.md](Cabal/tests/README.md) for more information.
96-
Build products and test logs are generated and stored in
97-
`Cabal/tests/PackageTests` under folders named `dist-test` and
98-
`dist-test.$subname`.
99-
100-
Handy command line spell to find test logs is:
101-
```sh
102-
find . -name test.log|grep test-name
103-
```
104-
105-
`test.sh` in the same directory as `test.log` is intended to let you rerun
106-
the test without running the actual test driver.
107-
91+
* `cabal-testsuite:cabal-tests` is an executable runner for out-of-process
92+
integration tests for both the `Setup` interface, as well as
93+
`cabal-install` (if you pass the path to the executable
94+
to test via the `--with-cabal` flag). Most user-visible changes
95+
to Cabal should come with a test in this framework. See
96+
[cabal-testsuite/README.md](cabal-testsuite/README.md) for more
97+
information about how to run tests and write new ones.
10898

10999
* `Cabal:unit-tests` are small, quick-running unit tests
110100
on small pieces of functionality in Cabal. If you are working

0 commit comments

Comments
 (0)