X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2F2.2-config.xml.md;h=2be937135b054a61c34b8a0fd2a0c3c90f2e8679;hb=43bc2e5178749719ea35891df5ad6fdd22c5b365;hp=f6c88abdd9f9ae8a51898d6a369701dc351637b2;hpb=8c08f5f678660d27420d548cf8b3100bb24aebd9;p=src%2Fapp-framework-main.git
diff --git a/docs/2.2-config.xml.md b/docs/2.2-config.xml.md
index f6c88ab..2be9371 100644
--- a/docs/2.2-config.xml.md
+++ b/docs/2.2-config.xml.md
@@ -119,13 +119,13 @@ is called the "main" unit.
List of the api required by the widget.
-Each required api must be explicited using a `` entry.
+Each required api must be explicit using a `` entry.
Example:
```xml
- >
+
@@ -156,7 +156,8 @@ The name is the name of the required API.
The value describes how to connect to the required api.
It is either:
-- local:
+- local: OBSOLETE SINCE FF (AGL6), PROVIDED FOR COMPATIBILITY
+ Use the feature **urn:AGL:widget:required-binding** instead.
The binding is a local shared object.
In that case, the name is the relative path of the
shared object to be loaded.
@@ -171,19 +172,92 @@ It is either:
- dbus:
The framework connect using internal dbus
-- link:
- The framework connect in memory by dynamically linking
-
- cloud: [PROPOSAL - NOT IMPLEMENTED]
The framework connect externally using websock.
In that case, the name includes data to access the service.
Example: ``
+### required-binding: feature name="urn:AGL:widget:required-binding"
+
+List of the bindings required by the widget.
+
+Note: Since AGL 6 (FF - Funky Flounder),
+the binder implements bindings version 3 that allow the declaration
+of 0, 1 or more APIs by one binding. In other words, the equivalency
+one binding = one API is lost. At the same time the framework added
+the ability to use bindings exported by other widgets.
+
+Each required binding must be explicit using a `` entry.
+
+Example:
+
+```xml
+
+
+
+
+```
+
+This will be *virtually* translated for mustaches to the JSON
+
+```json
+"required-binding": [
+ { "name": "libexec/binding-gps.so", "value": "local" },
+ { "name": "extra", "value": "extern" }
+ ]
+```
+
+#### required-binding: param name=[name or path]
+
+The name or the path of the required BINDING.
+
+The value describes how to connect to the required binding.
+It is either:
+
+- local:
+ The binding is a local shared object.
+ In that case, the name is the relative path of the
+ shared object to be loaded.
+
+- extern:
+ The binding is external. The name is the exported binding name.
+ See provided-binding.
+
+### provided-binding: feature name="urn:AGL:widget:provided-binding"
+
+This feature allows to export a binding to other binders.
+The bindings whose relative name is given as value is exported to
+other binders under the given name.
+
+Each provided binding must be explicit using a `` entry.
+
+Example:
+
+```xml
+
+
+
+```
+
+This will be *virtually* translated for mustaches to the JSON
+
+```json
+"provided-binding": [
+ { "name": "extra", "value": "export/binding-gps.so" }
+ ]
+```
+
+#### provided-binding: param name=[exported name]
+
+Exports a local binding to other applications.
+
+The value must contain the path to the exported binding.
+
### required-permission: feature name="urn:AGL:widget:required-permission"
List of the permissions required by the unit.
-Each required permission must be explicited using a `` entry.
+Each required permission must be explicit using a `` entry.
Example:
@@ -348,6 +422,28 @@ The value is one of the following values:
- auto:
export the api using the default method(s).
+### file-properties: feature name="urn:AGL:widget:file-properties"
+
+Use this feature for setting properties to files of the widget.
+At this time, this feature only allows to set executable flag
+for making companion program executable explicitly.
+
+Example:
+
+```xml
+
+
+
+
+```
+
+#### file-properties: param name="path"
+
+The name is the relative path of the file whose property
+must be set.
+
+The value must be "executable" to make the file executable.
+
## Known content types
The configuration file ***/etc/afm/afm-unit.conf*** defines