Skip to content

Commit 8e452db

Browse files
authored
Merge pull request #516 from haskell/reorg-trouble
Reorganize troubleshooting section
2 parents 70f6883 + 14e3a31 commit 8e452db

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,9 @@ The environment _only will be visible for the lsp server_, not for other extensi
7373

7474
This extension will download `haskell-language-server` binaries to a specific location depending on your system.
7575

76-
It will download the newer version of the server which has support for the required ghc.
76+
It will download the newest version of haskell-language-server which has support for the required ghc.
7777
That means it could use an older version than the latest one, without the last features and bug fixes.
78+
For example, if a project needs ghc-8.10.4 the extension will download and use haskell-language-server-1.4.0, the lastest version which supported ghc-8.10.4. Even if the lastest global haskell language-server version is 1.5.1.
7879

7980
If you find yourself running out of disk space, you can try deleting old versions of language servers in this directory. The extension will redownload them, no strings attached.
8081

@@ -123,15 +124,27 @@ Please include the output when filing any issues on the [haskell-language-server
123124

124125
### Troubleshooting
125126

126-
- In Linux/MacOS systems, opening vscode in the windows system could not use the `$PATH` set in the shell
127-
so it will not see required tools as ghc, cabal or stack. This usually happens if you have installed them
128-
via ghcup. It could be fixed changing the `$PATH` variable in the init config file used by the windows system (f.e. `~/.profile`, but i can vary depending on your system setup).
129-
See [this stackoverflow question](https://stackoverflow.com/questions/43983718/set-global-path-environment-variable-in-vs-code) for more tricks.
130-
- Sometimes the language server might get stuck in a rut and stop responding to your latest changes.
131-
Should this occur you can try restarting the language server with <kbd>Ctrl</kbd> <kbd>shift</kbd> <kbd>P</kbd>/<kbd>⌘</kbd> <kbd>shift</kbd> <kbd>P</kbd> > Restart Haskell LSP Server.
127+
#### Check issues and tips in the haskell-language-server project
128+
132129
- Usually the error or unexpected behaviour is already reported in the [haskell language server issue tracker](https://github.com/haskell/haskell-language-server/issues). Finding the issue could be useful to help resolve it and sometimes includes a workaround for the issue.
133130
- You can also check the [troubleshooting section](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html) in the server documentation.
134131

132+
#### Restarting the language server
133+
134+
- Sometimes the language server might get stuck in a rut and stop responding to your latest changes.
135+
Should this occur you can try restarting the language server with <kbd>Ctrl</kbd> <kbd>shift</kbd> <kbd>P</kbd>/<kbd>⌘</kbd> <kbd>shift</kbd> <kbd>P</kbd> > Restart Haskell LSP Server.
136+
137+
#### `Cradle requires ghc/cabal/stack but it isn't installed`
138+
139+
- In Linux/MacOS systems, opening vscode in the windows system could not use the `$PATH` set in the shell
140+
so it will not see required tools as ghc, cabal or stack. This usually happens if you have installed them
141+
via ghcup.
142+
- It could be fixed changing the `$PATH` variable in the init config file used by the windows system
143+
(f.e. `~/.profile`, but i can vary depending on your system setup).
144+
- See [this stackoverflow question](https://stackoverflow.com/questions/43983718/set-global-path-environment-variable-in-vs-code) for more tricks.
145+
146+
147+
135148
## Contributing
136149

137150
If you want to help, get started by reading [Contributing](https://github.com/haskell/vscode-haskell/blob/master/Contributing.md) for more details.

0 commit comments

Comments
 (0)