You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Cabal/doc/developing-packages.rst
+11-7Lines changed: 11 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -2063,7 +2063,8 @@ system-dependent values for these fields.
2063
2063
.. pkg-field:: build-tool-depends: package:executable list
2064
2064
:since: 2.0
2065
2065
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.
2067
2068
2068
2069
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.
2069
2070
@@ -2078,12 +2079,15 @@ system-dependent values for these fields.
2078
2079
2079
2080
a) For Nix-style local builds, both internal and external dependencies.
2080
2081
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.`
2082
2083
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.
2087
2091
2088
2092
.. pkg-field:: build-tools: program list
2089
2093
:deprecated:
@@ -3489,7 +3493,7 @@ a few options:
3489
3493
3490
3494
.. [#old-style-build-tool-depends] Some packages (ab)use :pkg-field:`build-depends` on old-style builds, but this has a few major drawbacks:
3491
3495
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
0 commit comments