search

redhat-developer / vscode-xml

Editing XML in Visual Studio Code made easy
Eclipse Public License 2.0
262 stars 82 forks source link

docs/Troubleshooting.md: Specify how to switch to the binary server mode #1037

Open waldyrious opened 2 weeks ago

waldyrious commented 2 weeks ago

I got an out of memory error message when VS Code tried to parse a large XML file, and this generated a pop-up message in the bottom right:

image

The "More info..." button in the pop-up message pointed to a page displaying the docs/Troubleshooting.md page, focused on the "The Language Server Crashes Due to an Out Of Memory Error" section:

image

That was useful, as the message explained that I could swap to the binary language server to avoid the problem, but didn't specify how to do it.

This PR adds a link to the relevant section of docs/Preferences.md that one can follow to learn more about what these language server modes mean, as well as a reference to the specific settings path that needs to be modified to actually perform the swap. This matches the more detailed instructions that this page already includes regarding the other possible solution for this issue (i.e. increasing the memory available to the Java language server).

Note: I'm not sure if a relative link works here. Happy to swap the link to the full URL https://github.com/redhat-developer/vscode-xml/blob/main/docs/Preferences.md#server-binary-mode if necessary.