Skip to content

Commit 5e73ff5

Browse files
committed
Update docs again
1 parent ef2b7b7 commit 5e73ff5

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,12 @@ as the server uses the XDG specification for cache directories.
6969

7070
### Downloaded binaries
7171

72-
This extension will download `haskell-language-server` binaries to a specific location depending on your system. 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.
72+
This extension will download `haskell-language-server` binaries to a specific location depending on your system.
73+
74+
It will download the newer version of the server which has support for the required ghc.
75+
That means it could use an older version than the latest one, without the last features and bug fixes.
76+
77+
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.
7378

7479
| Platform | Path |
7580
| -------- | ------------------------------------------------------------------------- |
@@ -105,8 +110,8 @@ The language server is now started for each workspace folder you have in your mu
105110
## Investigating and reporting problems
106111

107112
1. Go to extensions and right click `Haskell Language Server` and choose `Extensions Settings`
108-
2. Scroll down to `Haskell › Trace: Server` and set it to `messages`
109-
3. Set `Haskell › Trace: Client` to `debug`
113+
2. Scroll down to `Haskell › Trace: Server` and set it to `messages`.
114+
3. Set `Haskell › Trace: Client` to `debug`. It will print all the environment variables so take care it does not contain any sensible information before sharing it.
110115
4. Restart vscode and reproduce your problem
111116
5. Go to the main menu and choose `View -> Output` (`Ctrl + Shift + U`)
112117
6. On the new Output panel that opens on the right side in the drop down menu choose `Haskell (<your project>)`
@@ -115,9 +120,14 @@ Please include the output when filing any issues on the [haskell-language-server
115120

116121
### Troubleshooting
117122

123+
- In Linux/MacOS systems, opening vscode in the windows system could not use the `$PATH` set in the shell
124+
so it will not see required tools as ghc, cabal or stack. This usually happens if you have installed them
125+
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).
126+
See [this stackoverflow question](https://stackoverflow.com/questions/43983718/set-global-path-environment-variable-in-vs-code) for more tricks.
118127
- Sometimes the language server might get stuck in a rut and stop responding to your latest changes.
119128
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.
120129
- 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.
130+
- You can also check the troubleshooting section in the server documentation: <https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html>
121131

122132
## Contributing
123133

0 commit comments

Comments
 (0)