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/09/10 10:16:13 UTC
[plc4x] branch develop updated: Updated the documentation a bit.
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 5b668b2 Updated the documentation a bit.
5b668b2 is described below
commit 5b668b25a59443c99b4011eb386771ad8acdcd8d
Author: cdutz <ch...@c-ware.de>
AuthorDate: Fri Sep 10 12:15:56 2021 +0200
Updated the documentation a bit.
---
README.md | 20 ++++++++++++--------
src/site/asciidoc/developers/release/release.adoc | 14 +++++++-------
src/site/asciidoc/developers/release/validation.adoc | 2 +-
3 files changed, 20 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 5c13cc1..a6408d3 100644
--- a/README.md
+++ b/README.md
@@ -83,7 +83,7 @@ See the PLC4J user guide on the website to start using PLC4X in your Java applic
### Environment
-Currently the project is configured to require the following software:
+Currently, the project is configured to require the following software:
1. Java 8 JDK: For running Maven in general as well as compiling the Java and Scala modules `JAVA_HOME` configured to
point to that.
@@ -227,14 +227,18 @@ mvn -P with-go install # add -DskipTests to omit running the tests
NOTE: The C++ build is considered experimental and currently not working properly.
The `C++` drivers are still under development and still not really usable.
-Therefore, they are located in the so-called `sandbox`.
-If you want to build them, this has to be enabled by activating the `with-sandbox` and `with-cpp` maven profiles:
+Therefore, they are located in the so-called `sandbox`. Also does it rely on a
+library called, `boost`, which needs to also be built.
+
+If you want to build them, this has to be enabled by activating the `with-boost`, `with-sandbox` and `with-cpp` maven profiles:
```
-mvn -P with-sandbox,with-cpp install # add -DskipTests to omit running the tests
+mvn -P with-boost,with-sandbox,with-cpp install # add -DskipTests to omit running the tests
```
-Same applies for the `C# / .Net` implementation with `with-dotnet` profiles.
+The `C# / .Net` implementation is currently in a `work in progress` state.
+In order to be able to build the `C# / .Net` module, you currently need to activate the:
+`with-sandbox` and `with-dotnet` profiles.
```
mvn -P with-sandbox,with-dotnet install # add -DskipTests to omit running the tests
@@ -242,16 +246,16 @@ mvn -P with-sandbox,with-dotnet install # add -DskipTests to omit running the t
The Python implementation is currently in a somewhat unclean state and still needs refactoring.
In order to be able to build the Python module, you currently need to activate the:
-`with-sandbox`, `with-python` and `with-proxies` profiles.
+`with-sandbox` and `with-python` profiles.
```
-mvn -P with-sandbox,with-python,with-proxies install # add -DskipTests to omit running the tests
+mvn -P with-sandbox,with-python install # add -DskipTests to omit running the tests
```
In order to build everything the following command should work:
```
-mvn -P with-go,with-boost,with-dotnet,with-proxies,with-python,with-sandbox install
+mvn -P with-c,with-dotnet,with-go,with-python,with-sandbox install
```
## Community
diff --git a/src/site/asciidoc/developers/release/release.adoc b/src/site/asciidoc/developers/release/release.adoc
index b378090..e142a71 100644
--- a/src/site/asciidoc/developers/release/release.adoc
+++ b/src/site/asciidoc/developers/release/release.adoc
@@ -29,14 +29,14 @@ IMPORTANT: Please be sure to execute the release with a Java version between 1.8
* [ ] Create release branch:
[subs="verbatim,attributes"]
----
- mvn release:branch -P with-boost,with-c,with-docker,with-dotnet,with-go,with-python,with-sandbox -DbranchName=rel/{current-short-version}
+ mvn release:branch -P with-c,with-dotnet,with-go,with-python,with-sandbox -DbranchName=rel/{current-short-version}
----
[%interactive]
* [ ] Add a new section to the `RELEASE_NOTES` on `develop`
* [ ] Prepare the release:
[subs="verbatim,attributes"]
----
- mvn release:prepare -P with-boost,with-c,with-docker,with-dotnet,with-go,with-python,with-sandbox
+ mvn release:prepare -P with-c,with-dotnet,with-go,with-python,with-sandbox
----
[%interactive]
* [ ] Perform the release:
@@ -152,14 +152,14 @@ This is the version the `develop` branch will be changed to.
In contrast to normal builds, it is important to enable all profiles when creating the branch as only this way will all modules versions be updated.
Otherwise, the non-default modules on develop will reference the old version which will cause problems when building.
- mvn release:branch -P with-boost,with-c,with-cpp,with-docker,with-dotnet,with-go,with-python,with-sandbox -DbranchName=rel/{minor-version}
+ mvn release:branch -P with-c,with-dotnet,with-go,with-python,with-sandbox -DbranchName=rel/{minor-version}
Per default the plugin suggests the next bugfix version as working version, however we want it to use the next minor version.
So in case of preparing the release branch for `{current-full-version}-SNAPSHOT` the command would be the following:
[subs="verbatim,attributes"]
----
- mvn release:branch -P with-boost,with-c,with-cpp,with-docker,with-dotnet,with-go,with-python,with-sandbox -DbranchName=rel/{current-short-version}
+ mvn release:branch -P with-c,with-dotnet,with-go,with-python,with-sandbox -DbranchName=rel/{current-short-version}
----
The plugin will then aks for the version:
@@ -224,9 +224,9 @@ In order to prepare a release-candidate, the first step is switching to the corr
After that, the following command will to all preparation steps for the release:
- mvn release:prepare -P with-boost,with-c,with-docker,with-dotnet,with-go,with-python,with-sandbox
+ mvn release:prepare -P with-c,with-dotnet,with-go,with-python,with-sandbox
-(The `-P with-boost,with-c,with-docker,with-dotnet,with-go,with-python,with-sandbox` tells maven to activate the all profiles that partition the build and makes sure the versions of all modules are updated as part of the release)
+(The `-P with-c,with-dotnet,with-go,with-python,with-sandbox` tells maven to activate the all profiles that partition the build and makes sure the versions of all modules are updated as part of the release)
In general the plugin will now ask you 3 questions:
1. The version we want to release as (It will suggest the version you get by omitting the `-SNAPSHOT` suffix)
@@ -284,7 +284,7 @@ However, it will not delete the tag in GIT (locally and remotely). So you have t
This is done by executing another goal of the `maven-release-plugin`:
- mvn release:perform -DreleaseProfiles=apache-release
+ mvn release:perform
This executes automatically as all information it requires is located in the `release.properties` file the `prepare`-goal prepared.
diff --git a/src/site/asciidoc/developers/release/validation.adoc b/src/site/asciidoc/developers/release/validation.adoc
index 9c79590..ebb9b0a 100644
--- a/src/site/asciidoc/developers/release/validation.adoc
+++ b/src/site/asciidoc/developers/release/validation.adoc
@@ -89,7 +89,7 @@ By piping the result into a text file gives you the chance to investigate the co
=== Release Tooling
-In the `tools` directory we have a little script that can help downloading and checking the hashes and signatures automatically.
+In the `tools` directory we have a little script that can help with downloading and checking the hashes and signatures automatically.
In order to execute this, please change directories into the projects base directory and execute the following command: