docs/Troubleshooting.md: Specify how to switch to the binary server mode #1037
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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: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.