Skip to content

Commit b046f09

Browse files
committed
Some rewording recommended by @phadej
1 parent 082edf9 commit b046f09

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
<div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://rawgit.com/commercialhaskell/stack/master/doc/img/hidden-warning.svg"></a></div>
22

3-
# stack vs cabal config files
3+
# stack.yaml vs cabal package file
44

55
Due to their apparent overlap, the purpose of the following three files can be
66
unclear:
77

88
* `stack.yaml`
9-
* A cabal file, e.g. `my-package.cabal`
9+
* A cabal package file, e.g. `my-package.cabal`
1010
* `package.yaml`
1111

1212
The last two are easy to explain: `package.yaml` is a file format supported by
13-
[hpack](https://github.com/sol/hpack#readme), which adds some niceties on top
14-
of cabal like YAML syntax support and automatic generation of `exposed-modules`
15-
lists. However, it's just a frontend to cabal files. So for this document,
16-
we're instead going to focus on the first two and try to answer:
13+
[hpack](https://github.com/sol/hpack#readme). It adds some niceties on top of
14+
cabal. For example, hpack has YAML syntax support and will automatically
15+
generate of `exposed-modules` lists. However, it's just a frontend to cabal
16+
package files. So for this document, we're instead going to focus on the first
17+
two and try to answer:
1718

18-
_What's the difference between a `stack.yaml` file and a cabal file?_
19+
_What's the difference between a `stack.yaml` file and a cabal package file?_
1920

2021
## Package versus project
2122

doc/yaml_configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ used, and `~/.stack/global-project/stack.yaml` is ignored.
2424

2525
*Note 2:* A common source of confusion is the distinction between configuration
2626
in a `stack.yaml` file versus a cabal file. If you're trying to understand this
27-
breakdown, see [stack vs cabal config](stack_vs_cabal_config.md)
27+
breakdown, see [stack vs cabal config](stack_yaml_vs_cabal_package_file.md).
2828

2929
## Project-specific config
3030

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ pages:
1919
- User guide: GUIDE.md
2020
- FAQ: faq.md
2121
- Configuration (Project and Global): yaml_configuration.md
22-
- stack.yaml vs cabal config: stack_vs_cabal_config.md
22+
- stack.yaml vs cabal package files: stack_yaml_vs_cabal_package_file.md
2323
- Build command: build_command.md
2424
- Dependency visualization: dependency_visualization.md
2525
- Docker integration: docker_integration.md

0 commit comments

Comments
 (0)