summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2020-07-21 12:48:57 +0100
committerGitHub <noreply@github.com>2020-07-21 12:48:57 +0100
commitf31182beeef8b8ba897c22fb62cfb86c0f1a9659 (patch)
tree1a1b2f82eb99008e3c9642e9f98c3875a36305f7 /doc
parentf4668c751fba1af496d933af9fdcf1cf162a26f4 (diff)
parentc2aa01199eb86c1e0e5fbdf59029554c8f491d35 (diff)
downloadale-f31182beeef8b8ba897c22fb62cfb86c0f1a9659.zip
Merge pull request #3060 from hsanson/345-update-javalsp-documentation
Fix 345 - update java language server docs.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-java.txt24
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index d2001ca7..2e736d90 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -131,18 +131,26 @@ javalsp *ale-java-javalsp*
To enable Java LSP linter you need to download and build the vscode-javac
language server from https://github.com/georgewfraser/java-language-server.
-Simply download the source code and then build a distribution:
- scripts/link_mac.sh
+Before building the language server you need to install pre-requisites: npm,
+maven, and protobuf. You also need to have Java 13 and JAVA_HOME properly
+set.
-or
+After downloading the source code and installing all pre-requisites you can
+build the language server with the included build.sh script:
- scripts/link_windows.sh
+ scripts/build.sh
-This generates a dist/mac or dist/windows directory that contains the
-language server. To let ALE use this language server you need to set the
+This will create launch scripts for Linux, Mac, and Windows in the dist folder
+within the repo:
+
+ - lang_server_linux.sh
+ - lang_server_mac.sh
+ - lang_server_windows.sh
+
+To let ALE use this language server you need to set the
g:ale_java_javalsp_executable variable to the absolute path of the launcher
-executable in this directory.
+executable for your platform.
g:ale_java_javalsp_executable *g:ale_java_javalsp_executable*
*b:ale_java_javalsp_executable*
@@ -152,7 +160,7 @@ g:ale_java_javalsp_executable *g:ale_java_javalsp_executable*
This variable must be set to the absolute path of the language server launcher
executable. For example:
>
- let g:ale_java_javalsp_executable=/java-language-server/dist/mac/bin/launcher
+ let g:ale_java_javalsp_executable=/java-language-server/dist/lang_server_linux.sh
<
g:ale_java_javalsp_config *g:ale_java_javalsp_config*