Skip to content

Commit

Permalink
Release v3.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
arobenko committed Aug 22, 2020
2 parents 4313068 + b3582a1 commit a704caa
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 13 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ if (NOT A2X_EXECUTABLE)
message(FATAL_ERROR "a2x is not found")
endif ()

set (VERSION "v3.1.1")
set (VERSION "v3.1.2")
set (MAIN_FILE "${PROJECT_SOURCE_DIR}/commsdsl_spec.txt")

add_custom_target("pdf" ALL
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Introduction
This document contains specification of **D**omain **S**pecific **L**anguage (DSL),
called **CommsDSL**, for [CommsChampion Ecosystem](https://arobenko.github.io/cc),
called **CommsDSL**, for [CommsChampion Ecosystem](https://commschamp.github.io),
used to define custom binary protocols. The defined schema files are intended
to be parsed and used by [commsdsl](https://github.com/arobenko/commsdsl) library and code
to be parsed and used by [commsdsl](https://github.com/commschamp/commsdsl) library and code
generation application(s).

The PDF can be downloaded from [release](https://github.com/arobenko/CommsDSL-Specification/releases)
The PDF can be downloaded from [release](https://github.com/commschamp/CommsDSL-Specification/releases)
artifacts of this project. The online HTML documentation is hosted on
[github pages](https://arobenko.github.io/commsdsl_spec).
[github pages](https://commschamp.github.io/commsdsl_spec).

The specification is written using [asciidoc](http://asciidoc.org/) and buildable
using [CMake](https://cmake.org/)
Expand Down
4 changes: 2 additions & 2 deletions commsdsl_spec.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
CommsDSL Specification v3.1.1
CommsDSL Specification v3.1.2
===========================
Alex Robenko
v3.1.1, 2020-06
v3.1.2, 2020-08
:doctype: article
:numbered!:
:sectnums!:
Expand Down
3 changes: 3 additions & 0 deletions frames/value.txt
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ names of the supported interfaces.
</frame>
</schema>
----
In case the whole protocol schema contains no more than one **&lt;interface&gt;**
definition, then the usage of the **interfaces** property is not necessary.

In addition to specifying the interfaces themselves, there is a need to
specify the field name in the interface(s), that will hold the processed value,
using **interfaceFieldName** <<intro-properties, property>>.
Expand Down
10 changes: 5 additions & 5 deletions intro/intro.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
== Introduction ==
This document contains specification of **D**omain **S**pecific **L**anguage (DSL),
called **CommsDSL**, for https://arobenko.github.io/cc[CommsChampion Ecosystem],
called **CommsDSL**, for https://commschamp.github.io[CommsChampion Ecosystem],
used to define custom binary protocols. The defined schema files are intended
to be parsed and used by https://github.com/arobenko/commsdsl[commsdsl] library and code
to be parsed and used by https://github.com/commschamp/commsdsl[commsdsl] library and code
generation application(s).

The PDF can be downloaded from https://github.com/arobenko/CommsDSL-Specification/releases[release]
artifacts of from https://github.com/arobenko/CommsDSL-Specification[CommsDSL-Specification] project.
The PDF can be downloaded from https://github.com/commschamp/CommsDSL-Specification/releases[release]
artifacts of from https://github.com/commschamp/CommsDSL-Specification[CommsDSL-Specification] project.
The online HTML documentation is hosted on
https://arobenko.github.io/commsdsl_spec[github pages].
https://commschamp.github.io/commsdsl_spec[github pages].

This specification document is licensed under
https://creativecommons.org/licenses/by-nd/4.0/[Creative Commons Attribution-NoDerivatives 4.0 International License].
Expand Down
2 changes: 1 addition & 1 deletion intro/schema_def.txt
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ There are protocols that put some information, common to all the messages, such
protocol version and/or extra flags, into the framing information instead of message payload.
This information needs to be accessible when message payload is being read or
message object is being handled by the application. The
https://github.com/arobenko/comms_champion#comms-library[COMMS Library]
https://github.com/commschamp/comms_champion#comms-library[COMMS Library]
handles these cases by having a common interface class for all the messages, which
contains this extra information. In order to support such cases, the **CommsDSL**
introduces optional node **&lt;interface&gt;** (described in detail in
Expand Down

0 comments on commit a704caa

Please sign in to comment.