Skip to content

Commit 5cda34c

Browse files
authored
Merge pull request #6399 from commercialhaskell/b/docs-no-drop-cabal
Remove mention of Cabal in drop-packages
2 parents 88011fa + ceb1e39 commit 5cda34c

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

doc/yaml_configuration.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,11 @@ Cabal file (named `<package_name>.cabal`), see the
6969
Project-specific configuration options are valid only in a project-level
7070
configuration file (`stack.yaml`).
7171

72-
> Note: We define **project** to mean a directory that contains a `stack.yaml`
73-
> file, which specifies how to build a set of packages. We define **package** to
74-
> be a package with a Cabal file or an Hpack `package.yaml` file.
72+
!!! note
73+
74+
We define **project** to mean a directory that contains a `stack.yaml`
75+
file, which specifies how to build a set of packages. We define **package** to
76+
be a package with a Cabal file or an Hpack `package.yaml` file.
7577

7678
In your project-specific options, you specify both **which local packages** to
7779
build and **which dependencies to use** when building these packages. Unlike the
@@ -256,19 +258,23 @@ be included in our package. This can be used for a few different purposes, e.g.:
256258

257259
* Ensure that packages you don't want used in your project cannot be used in a
258260
`package.yaml` file (e.g., for license reasons)
259-
* Prevent overriding of a global package like `Cabal`. For more information, see
260-
Stackage issue
261-
[#4425](https://github.com/commercialhaskell/stackage/issues/4425)
262261
* When using a custom GHC build, avoid incompatible packages (see this
263262
[comment](https://github.com/commercialhaskell/stack/pull/4655#issuecomment-477954429)).
264263

265264
~~~yaml
266265
drop-packages:
267-
- Cabal
268266
- buggy-package
269267
- package-with-unacceptable-license
270268
~~~
271269

270+
!!! info
271+
272+
In older snapshots, it used to be handy to drop Cabal for reasons listed in
273+
Stackage issue
274+
[#4425](https://github.com/commercialhaskell/stackage/issues/4425). However,
275+
since around February 2020 (LTS-14.27 and nightly-2020-02-08), Cabal is not
276+
directly included in snapshots, so dropping Cabal no longer has any effect.
277+
272278
### user-message
273279

274280
If present, specifies a message to be displayed every time the configuration is

0 commit comments

Comments
 (0)