Release v8.0

Author: arobenko

aliases/aliases.adoc

@@ -18,11 +18,11 @@ For example let's assume there is some message definition like the one below:
         <int name="SomeField" type="uint32" />
         ...
     </message>
-</schema> 
+</schema>
 ----
 In case there is a need to rename the **SomeField** name to be **SomeOtherField**,
 then the message definition can add an **&lt;alias&gt;** with the old name to
-the renamed field in order to keep the old client code compiling. 
+the renamed field in order to keep the old client code compiling.
 [source,xml]
 ----
 <?xml version="1.0" encoding="UTF-8"?>
@@ -34,7 +34,7 @@ the renamed field in order to keep the old client code compiling.
         </fields>
         <alias name="SomeField" field="$SomeOtherField" />
     </message>
-</schema> 
+</schema>
 ----
 In such case the code generator must allow access of the renamed field by
 both old and new names.
@@ -63,7 +63,7 @@ there was an enum field with limited number of valid values:
         </enum>
         ...
     </message>
-</schema> 
+</schema>
 ----
 When need arises to introduce new value the developer may decide to save I/O
 traffic reuse the same byte occupied by the `SomeEnum` field, like below.
@@ -82,10 +82,10 @@ traffic reuse the same byte occupied by the `SomeEnum` field, like below.
         </bitfield>
         ...
     </message>
-</schema> 
+</schema>
 ----
 In order to keep old client code compiling it is possible to introduce
-alias to the `SomeEnum` member of the <<fields-bitfield, &lt;bitfield&gt; >> 
+alias to the `SomeEnum` member of the <<fields-bitfield, &lt;bitfield&gt; >>
 like this:
 [source,xml]
 ----
@@ -103,15 +103,15 @@ like this:
         </fields>
         <alias name="SomeEnum" field="$F1.SomeEnum" />
     </message>
-</schema> 
+</schema>
 ----
 There can be any number of different **&lt;alias&gt;** nodes. The elements
 that are allowed to have **&lt;alias&gt;**-es are <<messages-messages, &lt;message&gt; >>,
 <<interfaces-interfaces, &lt;interface&gt; >>, and <<fields-bundle, &lt;bundle&gt; >>.
 
 [[aliases-description]]
 === Description ===
-The **&lt;alias&gt;** node may also have **description** 
+The **&lt;alias&gt;** node may also have **description**
 <<intro-properties, property>> which is expected to find its way into
 the generated code as a comment for the relevant access functions.
 [source,xml]
@@ -160,7 +160,7 @@ When a new <<messages-messages, &lt;message&gt; >> or <<interfaces-interfaces, &
 copy all the fields from other already defined <<messages-messages, &lt;message&gt; >>, <<interfaces-interfaces, &lt;interface&gt; >>, or <<fields-bundle, &lt;bundle&gt; >>
 (using **copyFieldsFrom** <<intro-properties, property>>).
 By default all the <<aliases-aliases, &lt;alias&gt; >> definitions are also copied.
-It is possible to modify this default behavior by using **copyFieldsAliases** 
+It is possible to modify this default behavior by using **copyFieldsAliases**
 <<intro-properties, property>> with <<intro-boolean, boolean>> value.
 [source,xml]
 ----
@@ -173,10 +173,9 @@ It is possible to modify this default behavior by using **copyFieldsAliases**
     <message name="Msg2" id="2" copyFieldsAliases="false">
         ...
     </message>
-    
+
 </schema>
 ----
 
 Use <<appendix-alias, properties table>> for future references.
 
-

appendix/alias.adoc

@@ -1,7 +1,7 @@
 <<<
 [[appendix-alias]]
 === Properties of &lt;alias&gt; ===
-Refer to <<aliases-aliases, Aliases>> chapter for detailed description. 
+Refer to <<aliases-aliases, Aliases>> chapter for detailed description.
 Introduced in DSL version **3**.
 
 [cols="^.^28,^.^10,^.^8,^.^8,^.^10,36", options="header"]

appendix/appendix.adoc

@@ -28,5 +28,6 @@ include::alias.adoc[]
 include::frame.adoc[]
 include::layers.adoc[]
 include::checksum.adoc[]
+include::sync.adoc[]
 include::value.adoc[]
 include::custom.adoc[]

appendix/bitfield.adoc

@@ -3,7 +3,7 @@
 === Properties of <bitfield> Field ===
 The **&lt;bitfield&gt;** field has all the <<appendix-fields, common>> properties as
 well as ones listed below. Refer to <<fields-bitfield, &lt;bitfield&gt; Field>> chapter
-for detailed description. 
+for detailed description.
 
 [cols="^.^28,^.^10,^.^8,^.^8,^.^10,36", options="header"]
 |===

appendix/bundle.adoc

@@ -3,7 +3,7 @@
 === Properties of <bundle> Field ===
 The **&lt;bundle&gt;** field has all the <<appendix-fields, common>> properties as
 well as ones listed below. Refer to <<fields-bundle, &lt;bundle&gt; Field>> chapter
-for detailed description. 
+for detailed description.
 
 [cols="^.^28,^.^10,^.^8,^.^8,^.^10,36", options="header"]
 |===

appendix/checksum.adoc

@@ -3,7 +3,7 @@
 === Properties of <checksum> Frame Layer ===
 The **&lt;checksum&gt;** layer has all the <<appendix-layers, common>> properties as
 well as ones listed below. Refer to <<frames-checksum, &lt;checksum&gt; Layer>> chapter
-for detailed description. 
+for detailed description.
 
 [cols="^.^28,^.^10,^.^8,^.^8,^.^10,36", options="header"]
 |===

appendix/custom.adoc

@@ -3,14 +3,14 @@
 === Properties of <custom> Frame Layer ===
 The **&lt;custom&gt;** layer has all the <<appendix-layers, common>> properties as
 well as ones listed below. Refer to <<frames-custom, &lt;custom&gt; Layer>> chapter
-for detailed description. 
+for detailed description.
 
 [cols="^.^27,^.^11,^.^8,^.^10,^.^10,34", options="header"]
 |===
 |Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
 |**checksumFrom**|<<intro-names, name>> string|5|no (unless **semanticLayerType** is "checksum" and **checksumUntil** is empty)||Name of the frame layer, from which the checksum calculation starts. Applicable only when `semanticLayerType="checksum"`.
 |**checksumUntil**|<<intro-names, name>> string|5|no (unless **semanticLayerType** is "checksum" and **checksumFrom** is empty)||Name of the frame layer, until (and including) which the checksum calculation is executed. Applicable only when `semanticLayerType="checksum"`.
-|**[.line-through]#idReplacement#**|<<intro-boolean, bool>>|1|no|false|Mark the layer as one replacing <<frames-id, &lt;id&gt; >>. + 
+|**[.line-through]#idReplacement#**|<<intro-boolean, bool>>|1|no|false|Mark the layer as one replacing <<frames-id, &lt;id&gt; >>. +
 **Deprecated**, use `semanticLayerType="id"` instead.
 |**semanticLayerType**|"payload", "id", "size", "sync", "checksum", "value", "custom"|5|no|custom|Specify what other layer **&lt;custom&gt;** one is replacing.
 |===

appendix/data.adoc

@@ -3,7 +3,7 @@
 === Properties of <data> Field ===
 The **&lt;data&gt;** field has all the <<appendix-fields, common>> properties as
 well as ones listed below. Refer to <<fields-data, &lt;data&gt; Field>> chapter
-for detailed description. 
+for detailed description.
 
 [cols="^.^28,^.^10,^.^8,^.^8,^.^10,36", options="header"]
 |===
@@ -16,5 +16,3 @@ for detailed description.
 |**validValue**|string|7|no||Valid value. Case-insensitive hexadecimal string.
 |===
 
-
-

appendix/enum.adoc

@@ -3,7 +3,7 @@
 === Properties of <enum> Field ===
 The **&lt;enum&gt;** field has all the <<appendix-fields, common>> properties as
 well as ones listed below. Refer to <<fields-enum, &lt;enum&gt; Field>> chapter
-for detailed description. 
+for detailed description.
 
 [cols="^.^28,^.^10,^.^8,^.^8,^.^10,36", options="header"]
 |===

appendix/fields.adoc

@@ -2,7 +2,7 @@
 <<<
 [[appendix-fields]]
 === Common Properties of Fields ===
-Refer to <<fields-common, Common Properties of Fields>> chapter for detailed description. 
+Refer to <<fields-common, Common Properties of Fields>> chapter for detailed description.
 
 [cols="^.^27,^.^11,^.^8,^.^8,^.^10,36", options="header"]
 |===
@@ -29,7 +29,7 @@ Applicable only to members of the <<messages-messages, &lt;message&gt; >> or <<f
 |**reuse**|<<intro-references, reference>> string|1|no||Field, definition of which to copy.
 |**reuseCode**|<<intro-boolean, bool>>|5|no|false|In case of **reuse** apply **copyCodeFrom** with the same <<intro-references, reference>> string.
 |**semanticType**|"none", "messageId", "version", "length"|1|no|none|Specify semantic type of the field. It allows code generator to generate special code for special cases. Value "length" was introduced in **v2** of this specification.
-|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which field was introduced. + 
+|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which field was introduced. +
 Applicable only to members of the <<messages-messages, &lt;message&gt; >> or <<fields-bundle, &lt;bundle&gt; >>.
 |**validateMinLength**|<<intro-numeric, numeric>>|7|no||Specify expected minimal serialization length of the field.
 |**validOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **valid** retrieval.