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 2022/09/22 12:13:28 UTC

svn commit: r56945 - in /dev/plc4x/build-tools/code-generation/1.6.0: ./ rc1/

Author: cdutz
Date: Thu Sep 22 12:13:27 2022
New Revision: 56945

Log:
Staging of rc1 of PLC4X Build-Tools (Code-Generation) 1.6.0

Added:
    dev/plc4x/build-tools/code-generation/1.6.0/
    dev/plc4x/build-tools/code-generation/1.6.0/rc1/
    dev/plc4x/build-tools/code-generation/1.6.0/rc1/README
    dev/plc4x/build-tools/code-generation/1.6.0/rc1/RELEASE_NOTES
    dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip   (with props)
    dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip.asc
    dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip.sha512

Added: dev/plc4x/build-tools/code-generation/1.6.0/rc1/README
==============================================================================
--- dev/plc4x/build-tools/code-generation/1.6.0/rc1/README (added)
+++ dev/plc4x/build-tools/code-generation/1.6.0/rc1/README Thu Sep 22 12:13:27 2022
@@ -0,0 +1,54 @@
+Apache PLC4X Build-Tools
+========================
+
+Apache PLC4X Build-Tools is a sub-project of the Apache PLC4X project and contains
+all the tools needed to build the main project.
+
+Currently the only tool it contains is a maven plugin used to generate drivers.
+
+It currently doesn't contain any actual code-generation modules, but just the plugin
+and the API required to load and use code-generation modules.
+
+The actual code-generation modules are located inside the main project.
+
+Environment
+-----------
+
+Currently the project is configured to require the following software:
+
+1) Java 8 JDK (Or newer): For running Maven in general as well as compiling the Java
+modules `JAVA_HOME` configured to point to that.
+
+
+Getting Started
+---------------
+
+Normally you wouldn't be required to build this module as the artifacts it produces
+will be made available via one of the maven repositories. However if you want to improve
+or fix the existing tools, you will have to build your version locally.
+
+You must have Java 8 installed on your system and connectivity to Maven Central
+(for downloading external third party dependencies). Maven will be automatically
+downloaded and installed by the maven wrapper `mvnw`.
+
+NOTE: When running from sources-zip, the `mvnw` might not be executable, this can easily
+be fixed by running the following command in the directory.
+
+$ chmod +x mvnw
+
+Build PLC4X Java jars and install them in your local maven repository
+
+$ ./mvnw install
+
+(Optionally you can use the normal Maven `mvn` command, if you have a reasonably fresh version of Maven installed)
+
+This should make the build-tools available to the main projects build.
+In order to use your locally built version of the build-tools you should
+update the property: `plc4x-code-generation.version` in the PLC4X main pom.xml.
+
+
+
+Licensing
+---------
+
+Apache PLC4X is released under the Apache License Version 2.0.

Added: dev/plc4x/build-tools/code-generation/1.6.0/rc1/RELEASE_NOTES
==============================================================================
--- dev/plc4x/build-tools/code-generation/1.6.0/rc1/RELEASE_NOTES (added)
+++ dev/plc4x/build-tools/code-generation/1.6.0/rc1/RELEASE_NOTES Thu Sep 22 12:13:27 2022
@@ -0,0 +1,133 @@
+==============================================================
+Apache PLC4X Build-Tools Code-Generation 1.6.0
+==============================================================
+
+New Features
+------------
+
+- Added the ability to provide protocol versions in the code
+  generation.
+- Fields now know the concept of attributes
+- New field types:
+  - Assert Field: Like Reserved or Const, but fires a special
+    type of exception which can be used by optional fields.
+  - Validation Field: Executes a validation and fires
+    special types of exceptions.
+  - Peek Field: Filed that doesn't consume bytes from the
+    read buffer.
+- Code generation now knows the concept of protocol versions.
+
+Incompatible changes
+--------------------
+
+Bug Fixes
+---------
+
+==============================================================
+Apache PLC4X Build-Tools Code-Generation 1.5.0
+==============================================================
+
+New Features
+
+- `string` fields allow variable length input
+- Added a new `byte` simple type for 8 bit values where the
+  language can decide on if it's signed or unsigned.
+- Added a new `unknown` field type that can be used in
+  early stages of a driver, it allows simply discarding data
+  when parsing, but throws an exception when used for
+  serialization
+- Added support to the maven plugin for custom generator
+  options (Such as a custom package name)
+
+Changes
+
+- `enum` fields should only be used if a field of the enum
+  is required for parsing and serializing. For all other
+  cases a `simple` field works just right.
+
+==============================================================
+Apache PLC4X Build-Tools Code-Generation 1.4.0
+==============================================================
+
+New Features
+
+- Added boolean-type
+- Moved the Default*TypeReference implementations from SPI in
+  the main repository to here
+
+------------
+
+Incompatible changes
+--------------------
+
+Bug Fixes
+---------
+
+==============================================================
+Apache PLC4X Build-Tools Code-Generation 1.3.0
+==============================================================
+
+Refactorings needed to make the expressions used in mspec
+strongly typed.
+
+New Features
+------------
+
+Incompatible changes
+--------------------
+
+Bug Fixes
+---------
+
+==============================================================
+Apache PLC4X Build-Tools Code-Generation 1.2.0
+==============================================================
+
+New Features
+------------
+- Added a new AbstractField type
+
+Incompatible changes
+--------------------
+
+Bug Fixes
+---------
+
+==============================================================
+Apache PLC4X Build-Tools Code-Generation 1.1.0
+==============================================================
+
+New Features
+------------
+- Added new Integer and Float type references
+- Added support for "dataIo" types in MSpec
+- Added support for temporal fields
+- Added support for string fields
+
+Incompatible changes
+--------------------
+
+Bug Fixes
+---------
+
+==============================================================
+Apache PLC4X Build-Tools Code-Generation 1.0.0
+==============================================================
+
+This is the first official release of Apache PLC4X
+Build-Tools Code-Generation.
+
+New Features
+------------
+
+- New `plc4x-maven-plugin`
+
+Incompatible changes
+--------------------
+
+- none
+
+Bug Fixes
+---------
+
+- none

Added: dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip
==============================================================================
Binary file - no diff available.

Propchange: dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip.asc
==============================================================================
--- dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip.asc (added)
+++ dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip.asc Thu Sep 22 12:13:27 2022
@@ -0,0 +1,16 @@
+-----BEGIN PGP SIGNATURE-----
+
+iQIzBAABCgAdFiEE8VaBP/MVAH42umwTCJEnwVxg1rkFAmMsT4gACgkQCJEnwVxg
+1rlsKQ//U7T3e4yZLCJ8pHwrFNZwg5hO9Lrsc+pnL2YMwfD2wPxCBze2Yr4qZVJz
+F5XuIMmWmk7i1cshwbA4xktLtQw9cj2S9v7m+I1OrZFIyuyIVmDCTRMQOk+Z7+xy
+Quqlre0Lr0R25/nO5fJag22r/6ohWAd+VW4xKUotK3LRyeDEAukLZEzFqFSpUAnc
+QdwPz0HU9qroCYVxsOZpHFph8rmhjhiF33chOyXTdJpZEgRcBMwirHcZ83kpgJpN
+tO8FsFVgwhT8hl4zQxFGnQnrLbQFVSt8LullUeWgpAX/XOihO0+qszO8b6pjR9vp
+GM5PXVGRs1TA3Cqf2dRI5sx1AtSjfSYugpj68pQA7ZzatwxsMijCMi65csqPMXCT
+GIJQhpBl/Q7zzmLwxi9fZ6QMLOzENdWlbPsOBvelnSLqyrUqQ/kfK2UIaT48GpzK
+2aTLdE3t0zb3vUff1W9nC5kuuIVKiaLkP6YDBbXBJFQXnDznrKWtcjFlrsTNub3B
+o2WO5zzFWmdRwGldG6GvAJBD1hqNJTvRKeBI2n9s9SfmD7KBxf9W33yygjpD0wRY
+GYxjgg9QWo05uVgwHdmQ5cRK8hkiuqY5YTtFifAIcVvLmikeN1sIQVQ8AvLxc6Ai
+Oebt+77PCmz+PgOzBPTDJzZXwwEXdWiZFeMJmRw/kRE1TKJGUw8=
+=R8r/
+-----END PGP SIGNATURE-----

Added: dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip.sha512
==============================================================================
--- dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip.sha512 (added)
+++ dev/plc4x/build-tools/code-generation/1.6.0/rc1/apache-plc4x-code-generation-1.6.0-source-release.zip.sha512 Thu Sep 22 12:13:27 2022
@@ -0,0 +1 @@
+b8309ad68c70b40e229f8deee105b27e31bb903bc011b7d065f4952dcd73a83a0daedee66b8e7c2e870e255646cc4906882141cabe4b63bf119fdbe3f744610e
\ No newline at end of file