Skip to content

Remove stack from installation docs since it is not supported anymore #3314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 5, 2022
Merged

Remove stack from installation docs since it is not supported anymore #3314

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8eb6469
Remove stack from installation docs since it is not supported anymore
fendor Nov 2, 2022
a87134e
Merge branch 'master' into docs/remove-stack-from-installation-instru…
michaelpj Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

- For standalone `.hs`/`.lhs` files, [ghc](https://www.haskell.org/ghc/) must be installed and on the `PATH`. The easiest way to install it is with [ghcup](https://www.haskell.org/ghcup/) or [chocolatey](https://community.chocolatey.org/packages/ghc) on Windows.
- For Cabal based projects, both ghc and [cabal-install](https://www.haskell.org/cabal/) must be installed and on the `PATH`. It can also be installed with [ghcup](https://www.haskell.org/ghcup/) or [chocolatey](https://community.chocolatey.org/packages/cabal) on Windows.
- For Stack based projects, [stack](http://haskellstack.org) must be installed and on the `PATH`.

## ghcup

Expand All @@ -26,18 +25,16 @@ More information here: <https://www.haskell.org/ghcup/guide/#hls>

## Installation from source

Direct installation from source, while possible via `cabal install exe:haskell-language-server`
and `stack install --stack-yaml stack-<GHCVER>.yaml`, is not recommended for most people.
Direct installation from source, while possible via `cabal install exe:haskell-language-server`, is not recommended for most people.
Said command builds the `haskell-language-server` binary and installs it in the default `cabal` binaries folder,
but the binary will only work with projects that use the same GHC version that built it.

### Common pre-requirements

- `stack` or `cabal` must be in your `PATH`
- You need `stack` version >= 2.1.1 or `cabal` >= 2.4.0.0
- `cabal` must be in your `PATH`
- You need `cabal` >= 2.4.0.0
- `git` must be in your `PATH`
- The directory where `stack`or `cabal` put the binaries must be in you PATH:
- For `stack` you can get it with `stack path --local-bin`
- The directory where `cabal` put the binaries must be in you PATH:
- For `cabal` it is by default `$HOME/.cabal/bin` in Linux and `%APPDATA%\cabal\bin` in windows.

Tip: you can quickly check if some command is in your path by running the command.
Expand Down