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/01/25 19:41:19 UTC
[plc4x] branch develop updated: - Merged some changes from the
release branch
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 5e12b09 - Merged some changes from the release branch
5e12b09 is described below
commit 5e12b09eddf7bf82371e6b25334327d75a8959e8
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Mon Jan 25 20:41:12 2021 +0100
- Merged some changes from the release branch
---
README.md | 23 +++++++++++++----------
src/site/asciidoc/developers/release/release.adoc | 6 +++---
2 files changed, 16 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 82d3d70..d7a1a06 100644
--- a/README.md
+++ b/README.md
@@ -182,7 +182,7 @@ For `.Net`, you need the `Developer Pack` in order to build .Net applications. S
If you're building a source-distribution and haven't installed git yet, be sure to do so.
-The windows version of the PCAP library can be found here: https://sourceforge.net/projects/winpcap413-176/
+The Windows version of the PCAP library can be found here: https://sourceforge.net/projects/winpcap413-176/
(In order to read PCAPNG files we require a libpcap version 1.1.0 or greater. The default
Windows version is 1.0. At this location there is a patched version based on libpcap 1.7.4)
@@ -193,6 +193,8 @@ Make sure the `bin` directories of containing the executables `mingw32-make.exe`
### Building with Docker
+WARNING: Currently the Docker build seems to be not working so please have patience till we fixed the issues.
+
If you don't want to bother setting up the environment on your normal system and you have Docker installed, you can also build everything in a Docker container:
```
@@ -203,13 +205,14 @@ If you don't want to bother setting up the environment on your normal system and
You must have at least Java 8 installed on your system and connectivity to Maven Central
(for downloading external third party dependencies). However in order to build all parts
-of PLC4X exactly Java 11 is required. Maven will be automatically downloaded and
-installed by the maven wrapper `mvnw`.
+of PLC4X exactly Java 11 is required. Maven 3.6 is required to build, so be sure it's installed and available on your system.
+
+NOTE: There is a convenience Maven-Wrapper installed in the repo, when used, this automatically downloads and installs Maven. If you want to use this, please use `./mvnw` or `mvnw` instead of the normal `mvn` command.
Build PLC4X Java jars and install them in your local maven repository
```
-./mvnw install # add -DskipTests to omit running the tests
+mvn install # add -DskipTests to omit running the tests
```
You can now construct Java applications that use PLC4X. The PLC4X examples
@@ -219,21 +222,21 @@ directory.
The `Go` drivers can be built by enabling the `with-go` profile:
```
-./mvnw -P with-go install # add -DskipTests to omit running the tests
+mvn -P with-go install # add -DskipTests to omit running the tests
```
The `C++` drivers are still under development and still not really usable.
-Therefore they are located in the so-called `sandbox`.
+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:
```
-./mvnw -P with-sandbox,with-cpp install # add -DskipTests to omit running the tests
+mvn -P with-sandbox,with-cpp install # add -DskipTests to omit running the tests
```
Same applies for the `C# / .Net` implementation with `with-dotnet` profiles.
```
-./mvnw -P with-sandbox,with-dotnet install # add -DskipTests to omit running the tests
+mvn -P with-sandbox,with-dotnet install # add -DskipTests to omit running the tests
```
The Python implementation is currently in a somewhat unclean state and still needs refactoring.
@@ -241,13 +244,13 @@ In order to be able to build the Python module, you currently need to activate t
`with-sandbox`, `with-python` and `with-proxies` profiles.
```
-./mvnw -P with-sandbox,with-python,with-proxies install # add -DskipTests to omit running the tests
+mvn -P with-sandbox,with-python,with-proxies install # add -DskipTests to omit running the tests
```
In order to build everything the following command should work:
```
-./mvnw -P with-go,with-boost,with-cpp,with-dotnet,with-logstash,with-proxies,with-python,with-sandbox install
+mvn -P with-go,with-boost,with-cpp,with-dotnet,with-logstash,with-proxies,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 c4ccfa2..ec09614 100644
--- a/src/site/asciidoc/developers/release/release.adoc
+++ b/src/site/asciidoc/developers/release/release.adoc
@@ -140,7 +140,7 @@ According to SemVer, we have: Major, Minor and Bugfix releases.
For each new Major and Minor release we create a new branch at the beginning of a code-freeze phase.
-So if currently the project version in develop is `{current-full-version}-SNAPSHOT`, we create a branch `release/{current-short-version}`.
+So if currently the project version in develop is `{current-full-version}-SNAPSHOT`, we create a branch `rel/{current-short-version}`.
When creating the branch is exactly the moment in which the version in `develop` is incremented to the next minor version.
@@ -489,14 +489,14 @@ This has to be done with git
[subs="verbatim,attributes"]
----
git checkout release
-git merge release/{current-full-version}
+git merge v{current-full-version}
----
When there are conflicts it could help to use the `theirs` merge strategy, i.e.,
[subs="verbatim,attributes"]
----
-git merge -X theirs release/{current-full-version}
+git merge -X theirs v{current-full-version}
----
Possibly a manual conflict resolution has to be done afterwards. After that, changes need to