diff options
| author | Matthew Pickering <matthewtpickering@gmail.com> | 2022-04-27 10:29:57 +0100 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2022-04-30 16:56:08 -0400 |
| commit | ab677cc856f7d479b69b8d73e54247fa053cf8d8 (patch) | |
| tree | 6b9482dd885a41235c7e40672258ed5a09b905b4 | |
| parent | ee891c1e25028ca4fb73e89a59b6538b516deae8 (diff) | |
| download | haskell-ab677cc856f7d479b69b8d73e54247fa053cf8d8.tar.gz | |
Hadrian: Update README about the flavour/testsuite contract
There have been a number of tickets about non-tested flavours not
passing the testsuite.. this is expected and now noted in the
documentation. You use other flavours to run the testsuite at your own
risk.
Fixes #21418
| -rw-r--r-- | hadrian/README.md | 5 | ||||
| -rw-r--r-- | hadrian/doc/testsuite.md | 5 |
2 files changed, 10 insertions, 0 deletions
diff --git a/hadrian/README.md b/hadrian/README.md index a815039e7f..4d7ee8456b 100644 --- a/hadrian/README.md +++ b/hadrian/README.md @@ -193,6 +193,11 @@ To run GHC testsuite, use `build test`. See flags, as well as about the equivalents of the features that the Make build system offers. +NOTE: The only build flavours which are expected to pass the testsuite are those +tested in CI. If you use an untested flavour such as "Quick" then you run the +risk that not all tests will pass. In particular you can rely on the `validate` +and `perf` flavours being tested but no others. + `build selftest` runs tests of the build system. The current test coverage is close to zero (see [#197][test-issue]). diff --git a/hadrian/doc/testsuite.md b/hadrian/doc/testsuite.md index ed1205ec0f..49a310d8a8 100644 --- a/hadrian/doc/testsuite.md +++ b/hadrian/doc/testsuite.md @@ -17,6 +17,11 @@ built GHC before, this will also build a stage 2 GHC in the default flavour along with many libraries and programs needed by the tests. +NOTE: The only build flavours which are expected to pass the testsuite are those +tested in CI. If you use an untested flavour such as "Quick" then you run the +risk that not all tests will pass. In particular you can rely on the `validate` +and `perf` flavours being tested but no others. + ## Running only a subset of the testsuite ### Specific tests |