Skip to content

Commit 463a489

Browse files
vorburgerguw
andauthored
Add more tips to Troubleshooting doc (#98)
* Add more tips to Troubleshooting doc Signed-off-by: Michael Vorburger <[email protected]> * Add reminder re. Terminal Tabs to Troubleshooting doc * Update troubleshoot.md * Update troubleshoot.md * Update docs/troubleshoot.md Signed-off-by: Gunnar Wagenknecht <[email protected]> --------- Signed-off-by: Michael Vorburger <[email protected]> Signed-off-by: Gunnar Wagenknecht <[email protected]> Co-authored-by: Gunnar Wagenknecht <[email protected]>
1 parent 0a2fcfd commit 463a489

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/troubleshoot.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ see [issue #94](https://github.com/salesforce/bazel-vscode-java/issues/94).
4949
1. Run the _Java: Synchronize Projects with Bazel Project View_ command
5050
1. Run the _Java: Refresh Classpath from Bazel BUILD file_ command
5151

52+
You could also try to uninstall and reinstall the extension, to see if that helps.
53+
5254
## Logs
5355

5456
Check out the following places for log-like details to spot any problems:
@@ -63,6 +65,16 @@ Please attach (or copy/paste) all x3 if you file issues for support.
6365
(Rename `.log` to e.g. `log.txt` and `client.log.YYYY-MM-DD` to e.g. `client.log.YYYY-MM-DD.json`
6466
in order to be able to upload as attachment to GitHub issues.)
6567

68+
The Bazel and JDT Job status is not in these log files, but visible
69+
on the _Terminal_ view _Bazel Build Status_ and _Java Build Status_ tabs;
70+
if in doubt, have a look at that as well (see also [issue #100](https://github.com/salesforce/bazel-vscode-java/issues/100)).
71+
72+
There is a known limitation during initialization of the Java Language Server.
73+
While the initialization is ongoing the _Bazel Build Status_ will remain empty.
74+
It only starts working _after_ initialization completed.
75+
To work around this limitation you should configure a _static_ port for the extension to use.
76+
This can be done by adding `-Djava.bazel.staticProcessStreamSocket=22222` to `"java.jdt.ls.vmargs":` option in `.vscode/settings.json`.
77+
6678
## Extensions
6779

6880
Please note that this _Bazel for Java_ extension (`sfdc.bazel-vscode-java`, which adds support for Bazel's **Java** rules to VSC), is technically completely independent of _[the VSC Bazel](https://marketplace.visualstudio.com/items?itemName=BazelBuild.vscode-bazel)_ extension (`BazelBuild.vscode-bazel`, which adds generic support for Bazel `BUILD` files editing, and "externally running" any Bazel targets; but specific nothing for Java).

0 commit comments

Comments
 (0)