Skip to content

Commit 684c19b

Browse files
authored
Merge pull request #3286 from chris-martin/pr/doc-hpack
Mention hpack a bit more in the docs
2 parents 0ec772d + 0ed6674 commit 684c19b

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

doc/faq.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -521,4 +521,8 @@ where you keep your SSL certificates.
521521
Unfortunately `stack build` does not have an obvious equivalent to `cabal build -vN` which shows verbose output from GHC when building. The easiest workaround is to add `ghc-options: -vN` to the .cabal file or pass it via `stack build --ghc-options="-v"`.
522522
523523
## Does Stack support the Hpack specification?
524-
Yes. You can run `stack init` as usual and Stack will create a matching `stack.yaml`.
524+
525+
Yes:
526+
527+
* If a package directory contains an Hpack `package.yaml` file, then Stack will use it to generate a `.cabal` file when building the package.
528+
* You can run `stack init` to initialize a `stack.yaml` file regardless of whether your packages are declared with `.cabal` files or with Hpack `package.yaml` files.

doc/yaml_configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ project, not in the user or global config files.
2727

2828
> Note: We define **project** to mean a directory that contains a `stack.yaml`
2929
> file, which specifies how to build a set of packages. We define **package** to
30-
> be a package with a `.cabal` file.
30+
> be a package with a `.cabal` file or Hpack `package.yaml` file.
3131
3232
In your project-specific options, you specify both **which local packages** to
3333
build and **which dependencies to use** when building these packages. Unlike the

0 commit comments

Comments
 (0)