Skip to content

Commit

Permalink
Improve self-help instructions (#1667)
Browse files Browse the repository at this point in the history
 - structure the information better
 - mention where and how the logging information can be seen
 - mention "troubleshooting" command
  • Loading branch information
rchl authored May 18, 2021
1 parent 4a5785d commit 01a2c4b
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/src/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
## Self-help instructions

Enable LSP logging: In LSP Settings enable the `log_debug` setting.
Enable server logging: set `log_server` to ["panel"]
Run "LSP: Toggle Log Panel" from the command palette. No restart is needed.
To get more visibility into the inner-workings of the LSP client and the server and be able to diagnose problems, open `Preferences: LSP Settings` from the Command Palette and set the following options:

| Option | Description |
| ----------------------- | -------------------------------------------------------------------- |
| `log_debug: true` | Show verbose debug messages in the Sublime Text console. |
| `log_server: ["panel"]` | Log communication from and to language servers in the output panel. |

Once enabled (no restart necessary), the communication log can be seen by running `LSP: Toggle Log Panel` from the Command Palette. It might be a good idea to restart Sublime Text and reproduce the issue again, so that the logs are clean.

If you believe the issue is with this package, please include the output from the Sublime console in your issue report!

If the server is crashing on startup, try running `LSP: Troubleshoot server` from the Command Palette and check the "Server output" for potential errors. Consider sharing the output of this command in the report.

## Updating the PATH used by LSP servers

You can confirm that your issue is due to `PATH` being different by starting Sublime Text from the command line so that it inherits your shell's environment.
Expand Down

0 comments on commit 01a2c4b

Please sign in to comment.