You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve troubleshooting and installation docs a bit (#3004)
* Add material about using versions of GHC that aren't supported yet
* Add a note about clearing out the build cache
* Add note about cabal update to ghcup instructions
* Minor improvements to installing doc
* Tweak ghcup docs more
* Minor fixes
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/installation.md
+39-38
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,10 @@
1
1
# Installation
2
2
3
-
A typical haskell-language-server installation consists of:
4
-
5
-
- One binary file for each supported ghc version: `haskell-language-server-${ghcVersion}`
6
-
- Another binary named `haskell-language-version-wrapper` which analyzes the project or file in the current working dir
7
-
and calls the appropiate `haskell-language-server-${ghcVersion}` variant.
8
-
- It accepts all executable arguments from the plain `haskell-language-server`
9
-
10
3
## Prerequisites
11
4
12
-
- 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.
13
-
- 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.
14
-
- For Stack based projects, [stack](http://haskellstack.org) must be installed and on the PATH.
5
+
- 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.
6
+
- 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.
7
+
- For Stack based projects, [stack](http://haskellstack.org) must be installed and on the `PATH`.
15
8
16
9
## ghcup
17
10
@@ -21,45 +14,52 @@ If you are using [`ghcup`](https://www.haskell.org/ghcup/) to manage your instal
21
14
ghcup install hls
22
15
```
23
16
24
-
You can check if HLS is available for your platorm via ghcup here: <https://haskell.org/ghcup/install/#supported-platforms>.
17
+
You can check if HLS is available for your platform via `ghcup` here: <https://haskell.org/ghcup/install/#supported-platforms>.
25
18
26
19
You can also install HLS from source without checking out the code manually:
27
20
28
21
```bash
29
-
ghcup compile hls -v 1.6.1.0 --ghc 8.10.7
22
+
# `ghcup compile` uses cabal under the hood to build, so you may
Haskell Language Server is available via the Haskell overlay. Follow the instructions [here](https://github.com/gentoo-haskell/gentoo-haskell) to install the overlay, then run:
93
-
94
-
```bash
95
-
emerge -av dev-util/haskell-language-server
96
-
```
97
-
Depending on your system setup, you may need to enable the unstable flag for this package before install, and possible also for the dependencies. If you enabled the ~testing versions as explained in the gentoo-haskell overlay instructions, then this won't be necessary.
98
-
99
90
### Windows-specific pre-requirements
100
91
101
92
In order to avoid problems with long paths on Windows you can do either one of the following:
@@ -120,7 +111,7 @@ If you are using [`chocolatey`](https://chocolatey.org/) to manage your installa
120
111
121
112
```bash
122
113
choco install haskell-language-server
123
-
````
114
+
```
124
115
125
116
## Visual Studio Code
126
117
@@ -131,7 +122,7 @@ If you need to find the binaries, please consult the [documentation](https://git
131
122
## Pre-built binaries
132
123
133
124
There are pre-built binaries available from the [releases page](https://github.com/haskell/haskell-language-server/releases) for Linux, Windows and macOS.
134
-
To install, download the `haskell-language-server-wrapper` executable for your platform as well as any `haskell-language-server` executables for the GHC versions you plan on working with, and either put them on your PATH or point your client to them.
125
+
To install, download the `haskell-language-server-wrapper` executable for your platform as well as any `haskell-language-server` executables for the GHC versions you plan on working with, and either put them on your `PATH` or point your client to them.
135
126
136
127
## Arch Linux
137
128
@@ -143,6 +134,7 @@ See [ArchWiki](https://wiki.archlinux.org/index.php/Haskell) for the details of
143
134
144
135
## Fedora
145
136
137
+
146
138
Binary packages for Fedora are available from [this Copr repo](https://copr.fedorainfracloud.org/coprs/petersen/haskell-language-server),
to install it. At the moment, HLS installed this way only supports the same GHC
158
150
version as the ports one.
159
151
152
+
## Gentoo
153
+
154
+
Haskell Language Server is available via the Haskell overlay. Follow the instructions [here](https://github.com/gentoo-haskell/gentoo-haskell) to install the overlay, then run:
155
+
156
+
```bash
157
+
emerge -av dev-util/haskell-language-server
158
+
```
159
+
Depending on your system setup, you may need to enable the unstable flag for this package before install, and possible also for the dependencies. If you enabled the ~testing versions as explained in the gentoo-haskell overlay instructions, then this won't be necessary.
160
+
160
161
## Installation from Hackage
161
162
162
163
Direct installation from Hackage, while possible via `cabal install haskell-language-server`, is not recommended for most people.
0 commit comments