Skip to content

Commit 5201289

Browse files
committed
Consistently use extra-dep, as defined in the glossary
1 parent c0a1a79 commit 5201289

7 files changed

+18
-18
lines changed

Diff for: ChangeLog.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Bug fixes:
255255
Hackage-only release of the `stack` package:
256256

257257
* Supports building against snapshot Stackage LTS Haskell 21.0 (GHC 9.4.5),
258-
without extra deps.
258+
without extra-deps.
259259
* Supports build with `persistent-2.14.5.0`, using CPP directives.
260260
* Supports build with `unix-compat-0.7`, by removing reliance on the module
261261
`System.PosixCompat.User` removed in that package.
@@ -1626,7 +1626,7 @@ Bug fixes:
16261626
* `stack script` can now handle relative paths to source files.
16271627
See [#3372](https://github.com/commercialhaskell/stack/issues/3372).
16281628
* Fixes explanation of why a target is needed by the build plan, when the
1629-
target is an extra dependency from the commandline.
1629+
target is an extra-dep from the commandline.
16301630
See [#3378](https://github.com/commercialhaskell/stack/issues/3378).
16311631
* Previously, if you delete a yaml file from ~/.stack/build-plan, it would
16321632
trust the etag and not re-download. Fixed in this version.
@@ -2456,8 +2456,8 @@ Major changes:
24562456
* Overall it should now be able to initialize almost all existing Cabal
24572457
packages out of the box as long as the package itself is consistently
24582458
defined.
2459-
* Choose the best possible snapshot and add extra dependencies on top
2460-
of a snapshot resolver rather than a compiler resolver -
2459+
* Choose the best possible snapshot and add extra-deps on top
2460+
of a snapshot other than a compiler snapshot -
24612461
[#1583](https://github.com/commercialhaskell/stack/pull/1583)
24622462
* Automatically omit a package (`--omit-packages`) when it is compiler
24632463
incompatible or when there are packages with conflicting dependency
@@ -2924,7 +2924,7 @@ Bug fixes:
29242924

29252925
* Hacky workaround for optparse-applicative issue with `stack exec --help`
29262926
[#806](https://github.com/commercialhaskell/stack/issues/806)
2927-
* Build executables for local extra deps
2927+
* Build executables for local extra-deps
29282928
[#920](https://github.com/commercialhaskell/stack/issues/920)
29292929
* copyFile can't handle directories
29302930
[#942](https://github.com/commercialhaskell/stack/pull/942)

Diff for: doc/GUIDE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1337,7 +1337,7 @@ followed by the module name.
13371337
!!! note
13381338

13391339
If you have added packages to your project please make sure to mark them as
1340-
extra deps for faster and reliable usage of `stack ghci`. Otherwise GHCi may
1340+
extra-deps for faster and reliable usage of `stack ghci`. Otherwise GHCi may
13411341
have trouble due to conflicts of compilation flags or having to
13421342
unnecessarily interpret too many modules. See Stack's project-level
13431343
[configuration](yaml_configuration.md#extra-deps) to learn how to

Diff for: doc/build_command.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ supported syntaxes for targets are:
7676

7777
* *package*, e.g. `stack build foobar`, is the most commonly used target. It
7878
will try to find the package in the following locations: project packages,
79-
extra deps, snapshots, and package index (e.g. Hackage). If it's found in
80-
the package index, then the latest version of that package from the index is
81-
implicitly added to your extra dependencies.
79+
extra-deps, the snapshot, and the package index (e.g. Hackage). If it's
80+
found in the package index, then the latest version of that package from the
81+
index is implicitly added as an extra-dep.
8282

8383
If the package is a project package, the library and executable components
8484
are selected to be built. If the `--test` and `--bench` flags are set, then

Diff for: doc/glossary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The following terms are used in Stack's documentation.
1515
|dependency |A Haskell package other than a project package and on which a project package depends (directly or indirectly), located locally or elsewhere.|
1616
|Docker |A [platform](https://www.docker.com/) for developing, shipping, and running applications. It can package and run an application in a loosely isolated environment called a _container_.|
1717
|Emacs |[GNU Emacs](https://www.gnu.org/software/emacs/), an extensible, customisable text editor.|
18-
|extra-deps |Packages (one version of each) that add to, or amend, those specified in a snapshot. Named after a key used in `stack.yaml` files.|
18+
|extra-deps |Extra dependencies (one version of each) that add to, or shadow, those specified in a snapshot.|
1919
|FreeBSD |A Unix-like operating system. |
2020
|GCC |The [GNU Compiler Collection](https://gcc.gnu.org/) or its executable `gcc`.|
2121
|GHC |The [Glasgow Haskell Compiler](https://www.haskell.org/ghc/).|

Diff for: doc/lock_files.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ common case of no changes.
103103

104104
The lock file contains the following information:
105105

106-
* Completed package locations for extra deps and packages in snapshot files
106+
* Completed package locations for extra-deps and packages in snapshot files
107107

108108
!!! note
109109

Diff for: doc/script_command.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -138,17 +138,17 @@ LTS Haskell 20.25, where considerations on Windows differ from non-Windows. The
138138
~~~
139139

140140
`acme-missiles` is not in the snapshot and so needs to be specified as an
141-
extra dep.
141+
extra-dep.
142142

143143
Stack can deduce that the module imports imply that the required packages
144144
are `acme-missiles`, `time` and `extra` (which is in the snapshot).
145145

146146
`extra` depends on `directory` and `process`. If `directory` and `process`
147-
are not specified as extra deps, Stack will complain that they have been
147+
are not specified as extra-deps, Stack will complain that they have been
148148
'pruned'.
149149

150150
`directory-1.3.6.2` depends on `time < 1.12`. If `time` is not specified as
151-
an extra dep, Stack will try to construct a build plan based on the latest
151+
an extra-dep, Stack will try to construct a build plan based on the latest
152152
version in the package index (which will fail, as the latest version is
153153
`>= 1.12`)
154154

@@ -168,7 +168,7 @@ LTS Haskell 20.25, where considerations on Windows differ from non-Windows. The
168168
~~~
169169

170170
`acme-missiles` is not in the snapshot and so needs to be specified as an
171-
extra dep.
171+
extra-dep.
172172

173173
Stack can deduce that the module imports imply that the required packages
174174
are `acme-missiles`, `time` and `extra` (which is in the snapshot).

Diff for: doc/stack_yaml_vs_cabal_package_file.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ Stack defines a new concept called a _project_. A project has:
5050
* And a bunch more Stack configuration
5151

5252
Often you will have a project that defines only one local Cabal package that you
53-
are working on. If you need to specify an extra dependency, a source of
54-
confusion can be why you need to specify it both in the `stack.yaml` file _and_
53+
are working on. If you need to specify a dependency, a source of confusion can
54+
be why you need to specify it both in the `stack.yaml` file _and_
5555
in the Cabal file. To explain, let's take a quick detour to talk about snapshots
5656
and how Stack resolves dependencies.
5757

5858
## Snapshots and resolvers
5959

60-
Stack follows a rule that says, for any projects, there is precisely one version
60+
Stack follows a rule that says, for any project, there is precisely one version
6161
of each package available. Obviously, for many packages there are _many_
6262
versions available in the world. But when resolving a `stack.yaml` file, Stack
6363
requires that you have chosen a specific version for each package available.

0 commit comments

Comments
 (0)