[plc4x] branch develop updated: - Added a description of the connection string options part

[cd...@apache.org]

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 c683afa  - Added a description of the connection string options part
c683afa is described below

commit c683afadae2feb69e713295dc07b74f7e7014d37
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Thu Mar 5 12:57:12 2020 +0100

    - Added a description of the connection string options part
---
 src/site/asciidoc/users/plc4j/general-concepts.adoc | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/site/asciidoc/users/plc4j/general-concepts.adoc b/src/site/asciidoc/users/plc4j/general-concepts.adoc
index b356032..0a4106c 100644
--- a/src/site/asciidoc/users/plc4j/general-concepts.adoc
+++ b/src/site/asciidoc/users/plc4j/general-concepts.adoc
@@ -82,6 +82,14 @@ For a full description of all transports and their options, please consult the `
 
 The last segment - `options` - can be used to fine tune some protocol or transport options to non-default values. For details on these options, please have a look at the `Protocol Documentation` and the `Transport Documentation`.
 
+The general structure of this part is always the same:
+
+----
+?{option-1-name}={option-1-value}&{option-2-name}={option-2-value}&{option-3-name}={option-3-value}
+----
+
+So in general the options are stared with a `?` and then followed by `name-value` pairs, which are separated by ampersand characters `&`.
+
 A driver for a given protocol however usually has a `default transport`, so sometimes it is possible to omit the transport code.
 
 Then this shorter version can be used. Please inspect the `Protocol Documentation` on `default transports`: