Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

waldyrious
Copy link
Contributor

@waldyrious waldyrious commented Nov 10, 2024

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

Clicking the "More info..." button in the pop-up message opened a pane 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;
  • a reference to the specific settings path that needs to be modified to actually perform the swap. This matches the more detailed instructions that the Troubleshooting.md 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.

@datho7561 datho7561 self-requested a review December 2, 2024 13:53
Copy link
Contributor

@datho7561 datho7561 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Waldir!

@datho7561 datho7561 merged commit de92c05 into redhat-developer:main Dec 2, 2024
1 check passed
@waldyrious waldyrious deleted the patch-1 branch December 8, 2024 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants