aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2018-08-21 17:53:42 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2018-08-28 14:41:20 +0200
commit02f45f165b15cbd9e5c422a39e8a652a8c6e216b (patch)
treeaec92f2b7c601759edf2d037e83f898f42117feb /docs
parent52ae181d620faeec9829cc23c1c750ac99b33858 (diff)
Update Docs
Change-Id: If1c1e14233a765058a372fc25a88b21e8824f4d7 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs')
-rw-r--r--docs/dev_guide/3_advanced_usage.md31
1 files changed, 22 insertions, 9 deletions
diff --git a/docs/dev_guide/3_advanced_usage.md b/docs/dev_guide/3_advanced_usage.md
index 114230f..3e0ace1 100644
--- a/docs/dev_guide/3_advanced_usage.md
+++ b/docs/dev_guide/3_advanced_usage.md
@@ -7,7 +7,7 @@ how Application Framework would launch it. This repo provide a simple default
file _config.xml.in_ that should work for simple application without
interactions with others bindings.
-It is recommanded that you use the sample one which is more complete. You can
+It is recommended that you use the sample one which is more complete. You can
find it at the same location under the name _config.xml.in.sample_ (stunning
isn't it). Just copy the sample file to your _conf.d/wgt_ directory and name it
_config.xml.in_, then edit it to fit your needs.
@@ -32,19 +32,19 @@ Choose between:
- **BINDING**: Shared library that be loaded by the AGL Application Framework
- **BINDINGV2**: Shared library that be loaded by the AGL Application Framework
This has to be accompagnied with a JSON file named like the
- *${OUTPUT_NAME}-apidef* of the target that describe the API with OpenAPI
+ *${OUTPUT_NAME}-apidef* of the target that describes the API with OpenAPI
syntax (e.g: *mybinding-apidef*).
Or Alternatively, you can choose the name, without the extension, using macro
**set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES**
- with *CXX*.
+ to *CXX*.
- **BINDINGV3**: Shared library that be loaded by the AGL Application Framework
This has to be accompagnied with a JSON file named like the
- *${OUTPUT_NAME}-apidef* of the target that describe the API with OpenAPI
+ *${OUTPUT_NAME}-apidef* of the target that describes the API with OpenAPI
syntax (e.g: *mybinding-apidef*).
Or Alternatively, you can choose the name, without the extension, using macro
**set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES**
- with *CXX*.
-- **PLUGIN**: Shared library meant to be used as a binding plugin. Binding
+ to *CXX*.
+- **PLUGIN**: Shared library are meant to be used as a binding plugin. A binding
would load it as a plugin to extend its functionnalities. It should be named
with a special extension that you choose with SUFFIX cmake target property or
it'd be **.ctlso** by default.
@@ -58,16 +58,26 @@ Choose between:
own purpose because platform doesn't provide it.
- **BINDING-CONFIG**: Any files used as configuration by your binding.
-Two optionnals **LABELS** are available to define which resources are your tests
-materials:
+Optional **LABELS** are available to define which resources type your test
+materials are:
- **TEST-CONFIG**: JSON configuration files that will be used by the afb-test
binding to know how to execute tests.
- **TEST-DATA**: Resources used to test your binding. It is at least your test
plan and also could be fixtures and any needed files by your tests. These files
will appear in a separate test widget.
+- **TEST-PLUGIN**: Shared library are meant to be used as a binding
+ plugin. A binding would load it as a plugin to extend its functionalities. It
+ should be named with a special extension that you choose with SUFFIX cmake
+ target property or it'd be **.ctlso** by default.
+- **TEST-HTDOCS**: Root directory of a web app. This target has to build its
+ directory and put its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
+- **TEST-EXECUTABLE**: Entry point of your application executed by the AGL
+ Application Framework
+- **TEST-LIBRARY**: An external 3rd party library bundled with the binding for its
+ own use in case of platform doesn't provide it.
-Here is a mapping between LABELS and directories where files will be puted in
+Here is a mapping between LABELS and directories where files will be placed in
the widget:
- **EXECUTABLE** : \<wgtrootdir\>/bin
@@ -80,7 +90,10 @@ the widget:
And about test dedicated **LABELS**:
+- **TEST-EXECUTABLE** : \<wgtrootdir\>/bin
- **TEST-CONFIG** : \<TESTwgtrootdir\>/etc
+- **TEST-PLUGIN** : \<wgtrootdir\>/lib/plugins
+- **TEST-HTDOCS** : \<wgtrootdir\>/htdocs
- **TEST-DATA** : \<TESTwgtrootdir\>/var
> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which