You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by dc...@apache.org on 2021/06/17 16:17:15 UTC

[datasketches-memory] branch support-newer-java-versions updated: Update IDE documentation

This is an automated email from the ASF dual-hosted git repository.

dcromberge pushed a commit to branch support-newer-java-versions
in repository https://gitbox.apache.org/repos/asf/datasketches-memory.git


The following commit(s) were added to refs/heads/support-newer-java-versions by this push:
     new 52c7af8  Update IDE documentation
52c7af8 is described below

commit 52c7af8b05a8029449bce091413654a22b38f172
Author: David Cromberge <dc...@apache.org>
AuthorDate: Thu Jun 17 17:17:03 2021 +0100

    Update IDE documentation
---
 docs/development.md                           |  36 ++++++++++++++++++++++++--
 docs/img/eclipse-java-compiler-arguments.png  | Bin 0 -> 182269 bytes
 docs/img/eclipse-project-structure.png        | Bin 0 -> 162174 bytes
 docs/img/intellij-java-compiler-arguments.png | Bin 0 -> 178688 bytes
 docs/img/intellij-project-structure.png       | Bin 0 -> 99638 bytes
 5 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/docs/development.md b/docs/development.md
index 5da239e..e3d8280 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -33,6 +33,38 @@ compiler.  These are usually synchronised with the `pom.xml` configuration:
     </compilerArgs>
 ```
 
-### IntelliJ configuration
+---
 
-### Eclipse configuration
+## IntelliJ configuration
+
+Note that the following configuration was verified using IntelliJ IDEA 2021.1.2 (Community Edition).
+
+#### Java compiler versions
+
+Ensure that the correct SDK is used for each module using the IntelliJ project structure dialog:
+
+![IntelliJ project structure dialog](img/intellij-project-structure.png "Intellij project structure dialogue")
+
+#### Compiler arguments for JPMS
+
+Ensure that the required JPMS arguments are set for the compiler (Java 9 only)
+
+![IntelliJ java compiler arguments](img/intellij-java-compiler-arguments.png "Intellij project compiler arguments")
+
+---
+
+## Eclipse configuration
+
+Note that the following configuration was verified using Eclipse Version: 2020-12 (4.18.0)
+
+#### Java compiler versions
+
+Ensure that the correct SDK is used for each module using the Eclipse build path dialog:
+
+![Eclipse project structure dialog](img/eclipse-project-structure.png "Eclipse project structure dialogue")
+
+#### Compiler arguments for JPMS
+
+Ensure that the required JPMS arguments are set for the compiler (Java 9 only)
+
+![Eclipse java compiler arguments](img/eclipse-java-compiler-arguments.png "Eclipse project compiler arguments")
diff --git a/docs/img/eclipse-java-compiler-arguments.png b/docs/img/eclipse-java-compiler-arguments.png
new file mode 100644
index 0000000..b9893b8
Binary files /dev/null and b/docs/img/eclipse-java-compiler-arguments.png differ
diff --git a/docs/img/eclipse-project-structure.png b/docs/img/eclipse-project-structure.png
new file mode 100644
index 0000000..9032cfd
Binary files /dev/null and b/docs/img/eclipse-project-structure.png differ
diff --git a/docs/img/intellij-java-compiler-arguments.png b/docs/img/intellij-java-compiler-arguments.png
new file mode 100644
index 0000000..01a039a
Binary files /dev/null and b/docs/img/intellij-java-compiler-arguments.png differ
diff --git a/docs/img/intellij-project-structure.png b/docs/img/intellij-project-structure.png
new file mode 100644
index 0000000..214e4d7
Binary files /dev/null and b/docs/img/intellij-project-structure.png differ

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org