Skip to content

Commit a97cd47

Browse files
andreasabelmergify[bot]
authored andcommitted
cabal-testsuite #8401: communicate better that --with-cabal is needed
- Add caveat to `--help` text. - Put `--with-cabal` into very first example in README.
1 parent 06c8fd5 commit a97cd47

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

cabal-testsuite/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ How to run
77
1. Build `cabal-testsuite` (`cabal build cabal-testsuite:cabal-tests`)
88
2. Run the `cabal-tests` executable. It will scan for all tests
99
in your current directory and subdirectories and run them.
10-
To run a specific set of tests, use `cabal-tests PATH ...`.
11-
(e.g. `cabal run cabal-testsuite:cabal-tests -- cabal-testsuite/PackageTests/TestOptions/setup.test.hs`)
10+
To run a specific set of tests, use `cabal-tests --with-cabal=CABALBIN PATH ...`.
11+
(e.g. `cabal run cabal-testsuite:cabal-tests -- --with-cabal=cabal cabal-testsuite/PackageTests/TestOptions/setup.test.hs`)
1212
You can control parallelism using the `-j` flag.
1313

1414
There are a few useful flags:

cabal-testsuite/src/Test/Cabal/Monad.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ data CommonArgs = CommonArgs {
104104
commonArgParser :: Parser CommonArgs
105105
commonArgParser = CommonArgs
106106
<$> optional (option str
107-
( help "Path to cabal-install executable to test"
107+
( help "Path to cabal-install executable to test. If omitted, tests involving cabal-install are skipped!"
108108
<> long "with-cabal"
109109
<> metavar "PATH"
110110
))

0 commit comments

Comments
 (0)