You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by cd...@apache.org on 2021/12/14 15:52:57 UTC
[plc4x] branch develop updated: documentation: fixed us incorrectly stating java 8 or 9 was enough to build PLC4X
This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/develop by this push:
new 18fa26b documentation: fixed us incorrectly stating java 8 or 9 was enough to build PLC4X
18fa26b is described below
commit 18fa26ba5a0d9811471f0dddb830ba6598f8bd30
Author: cdutz <ch...@c-ware.de>
AuthorDate: Tue Dec 14 16:52:23 2021 +0100
documentation: fixed us incorrectly stating java 8 or 9 was enough to build PLC4X
---
src/site/asciidoc/developers/building.adoc | 6 +++---
src/site/asciidoc/developers/index.adoc | 2 +-
src/site/asciidoc/developers/preparing/index.adoc | 2 +-
src/site/asciidoc/developers/release/release.adoc | 2 +-
src/site/asciidoc/developers/release/validation.adoc | 2 +-
5 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/site/asciidoc/developers/building.adoc b/src/site/asciidoc/developers/building.adoc
index bc869a6..bb3d97c 100644
--- a/src/site/asciidoc/developers/building.adoc
+++ b/src/site/asciidoc/developers/building.adoc
@@ -25,15 +25,15 @@ We have partitioned the build to allow selecting the parts that are of interest.
This is done by selecting so-called `Maven profiles`.
More about these later down in this manual.
-For your convenience we also have provided a `Maven-Wrapper`, that should allow building of PLC4X with only `Java 9` or greater as requirement.
+For your convenience we also have provided a `Maven-Wrapper`, that should allow building of PLC4X with only `Java 11` or greater as requirement.
=== Requirements
The only requirements to building PLC4X should be:
-* Java 9 JDK (or newer - latest tested version: Java 17)
+* Java 11 JDK (or newer)
* Git (Even if you are building the source distribution, the Kafka plugin seems to require a `git` executable being available on the systems `PATH`)
-* Apache Maven (3.1.0 or newer) *(Optional)* (See next chapter)
+* Apache Maven (3.6.0 or newer) *(Optional)* (See next chapter)
=== Using the Maven-Wrapper
diff --git a/src/site/asciidoc/developers/index.adoc b/src/site/asciidoc/developers/index.adoc
index 9be25d0..94e7c7b 100644
--- a/src/site/asciidoc/developers/index.adoc
+++ b/src/site/asciidoc/developers/index.adoc
@@ -27,7 +27,7 @@ We have tried to make the PLC4X build experience as smooth as possible and have
The full PLC4X build however builds not only `Java` libraries, but also `C++`, `Python` and `C#` libraries as well as builds `Docker` images on `Linux`, `Mac` and `Windows`.
-As a start, you will basically need a `Java VM` of at least `Java 1.8`.
+As a start, you will basically need a `Java VM` of at least `Java 11`.
Using the `Maven-Wrapper` you don't even need a `Maven` installation. The build will automatically fetch the right version for you.
diff --git a/src/site/asciidoc/developers/preparing/index.adoc b/src/site/asciidoc/developers/preparing/index.adoc
index 4d9d4a9..fe1de9e 100644
--- a/src/site/asciidoc/developers/preparing/index.adoc
+++ b/src/site/asciidoc/developers/preparing/index.adoc
@@ -30,7 +30,7 @@ As soon as you're building with the `with-c`, `with-cpp` or `with-proxies` you n
TIP: Currently, Java 11 is the sweet-spot for being able to build all parts of PLC4X.
-TIP: We have tested the build with Java 9 up to Java 14 (Latest version at the time of writing this document).
+TIP: We have tested the build with Java 11 up to Java 16 (Latest version at the time of writing this document).
If a new version comes out, please give us a little time to verify and handle any related issues.
We'll probably fix them as soon as possible.
diff --git a/src/site/asciidoc/developers/release/release.adoc b/src/site/asciidoc/developers/release/release.adoc
index 97bf780..f02a026 100644
--- a/src/site/asciidoc/developers/release/release.adoc
+++ b/src/site/asciidoc/developers/release/release.adoc
@@ -21,7 +21,7 @@
=== TL/DR
-IMPORTANT: Please be sure to execute the release with a Java version between 1.8 and 11 or the Karaf feature tests will not run.
+IMPORTANT: Please be sure to execute the release with a Java version 11 or the Karaf feature tests will not run.
[%interactive]
* [ ] Update the `RELEASE_NOTES`
diff --git a/src/site/asciidoc/developers/release/validation.adoc b/src/site/asciidoc/developers/release/validation.adoc
index e9d627a..8fdf73e 100644
--- a/src/site/asciidoc/developers/release/validation.adoc
+++ b/src/site/asciidoc/developers/release/validation.adoc
@@ -120,7 +120,7 @@ Name
[] Verify the content of LICENSE, NOTICE, README, RELEASE_NOTES files in the extracted source bundle.
[] [RM] Verify the staged source README, RELEASE_NOTE files correspond to those in the extracted source bundle.
[] [RM] Run RAT externally to ensure there are no surprises.
-[] Search for SNAPSHOT references: Only found some in the dummy website copy in the integration-tests
+[] Search for SNAPSHOT references
[] Search for Copyright references, and if they are in headers, make sure these files containing them are mentioned in the LICENSE file.
[] Build the project according to the information in the README.md file.
[] [RM] Build the project with all with-xyz profiles and tests enabled and an empty maven local repo.