Skip to content
This repository was archived by the owner on Oct 7, 2020. It is now read-only.

Commit 5ce3eae

Browse files
authored
Merge pull request #1336 from w1gz/fix-documentation-build
Replace every occurrence of build-doc by build-data
2 parents e624719 + 9964ca2 commit 5ce3eae

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -221,14 +221,14 @@ Install **Nightly** (and hoogle docs):
221221

222222
```bash
223223
stack ./install.hs hie-8.6.4
224-
stack ./install.hs build-doc
224+
stack ./install.hs build-data
225225
```
226226

227227
Install **LTS** (and hoogle docs):
228228

229229
```bash
230230
stack ./install.hs hie-8.4.4
231-
stack ./install.hs build-doc
231+
stack ./install.hs build-data
232232
```
233233

234234
The Haskell IDE Engine can also be built with `cabal new-build` instead of `stack build`.
@@ -237,7 +237,7 @@ However, this approach does currently not work for windows due to a missing feat
237237
To see what GHC versions are available, the command `stack install.hs cabal-ghcs` can be used.
238238
It will list all GHC versions that are on the path and their respective installation directory.
239239
If you think, this list is incomplete, you can try to modify the PATH variable, such that the executables can be found.
240-
Note, that the targets `cabal-build`, `cabal-build-doc` and `cabal-build-all` depend on the found GHC versions.
240+
Note, that the targets `cabal-build`, `cabal-build-data` and `cabal-build-all` depend on the found GHC versions.
241241
They install Haskell IDE Engine only for the found GHC versions.
242242

243243
An example output is:
@@ -256,7 +256,7 @@ If your desired ghc has been found, you use it to install Haskell IDE Engine.
256256

257257
```bash
258258
stack install.hs cabal-hie-8.4.4
259-
stack install.hs cabal-build-doc
259+
stack install.hs cabal-build-data
260260
```
261261

262262
To install HIE for all GHC versions that are present on your system, use:

docs/Build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The build script `install.hs` defines several targets using the `shake` build sy
2929

3030
* `hie-*`: builds and installs the `hie` binaries. Also renames the binaries to contain the correct version-number.
3131
* `build`: builds and installs `hie` binaries for all supported `ghc` versions.
32-
* `build-doc`: builds the hoogle-db required by `hie`
32+
* `build-data`: builds the hoogle-db required by `hie`
3333
* `cabal-*`: execute the same task as the original target, but with `cabal` instead of `stack`
3434

3535
Each `stack-*.yaml` contains references to packages in the submodules. Calling `stack` with one of those causes the build to fail if the submodules have not been initialized already. The file `shake.yaml` solves this issue invoking the `git` binary itself to update the submodules. Moreover, it specifies the correct version of `shake` and is used for installing all run-time dependencies such as `cabal` and `hoogle` if necessary.

0 commit comments

Comments
 (0)