Skip to content

Commit 9f1bde6

Browse files
committed
review feedback
1 parent 41ff30f commit 9f1bde6

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

Cabal/doc/developing-packages.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2063,7 +2063,8 @@ system-dependent values for these fields.
20632063
.. pkg-field:: build-tool-depends: package:executable list
20642064
:since: 2.0
20652065

2066-
A list of Haskell executabes needed to build this component.
2066+
A list of Haskell executables needed to build this component. Executables are provided during the whole duration of the build,
2067+
so this field can be used for executables needed during :pkg-section:`test-suite` as well.
20672068

20682069
Each is specified by the package containing the executable and the name of the executable itself, separated by a colon, and optionally followed by a version bound.
20692070

@@ -2078,12 +2079,15 @@ system-dependent values for these fields.
20782079

20792080
a) For Nix-style local builds, both internal and external dependencies.
20802081
b) For old-style builds, only for internal dependencies [#old-style-build-tool-depends]_.
2081-
It's up to the user to specify needed executables in this case.
2082+
It's up to the user to provide needed executables in this case under `$PATH.`
20822083

2083-
:pkg-field:`build-tool-depends` was added in Cabal 2.0, and it will
2084-
be ignored (with a warning) with old versions of Cabal. See
2085-
:pkg-field:`build-tools` for more information about backwards
2086-
compatibility.
2084+
2085+
.. note::
2086+
2087+
:pkg-field:`build-tool-depends` was added in Cabal 2.0, and it will
2088+
be ignored (with a warning) with old versions of Cabal. See
2089+
:pkg-field:`build-tools` for more information about backwards
2090+
compatibility.
20872091

20882092
.. pkg-field:: build-tools: program list
20892093
:deprecated:
@@ -3489,7 +3493,7 @@ a few options:
34893493
34903494
.. [#old-style-build-tool-depends] Some packages (ab)use :pkg-field:`build-depends` on old-style builds, but this has a few major drawbacks:
34913495
3492-
- using new-build it's considered an error if you depend on a exe-only package via build-depends: the solver will refuse it
3496+
- using Nix-style builds it's considered an error if you depend on a exe-only package via build-depends: the solver will refuse it
34933497
34943498
- it may or may not place the executable on $PATH
34953499

0 commit comments

Comments
 (0)