summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2019-04-16afb-migration-to-binding-v3: fix broken linksClément Bénier1-3/+3
- fix broken link to the same section Change-Id: I5e104c5527fae29ff51b6208f43ed0eb3c5f8c04 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2018-12-19Remove useless %lang% prefix in yaml book fileguppy_6.99.3guppy/6.99.36.99.3Sebastien Douheret1-20/+20
Change-Id: I25c5efebc281f774324851372d2d074e31988847 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2018-12-13docs: add yaml bookClément Bénier1-0/+55
SPEC-1988 Change-Id: Ida94e5cf39b8c23efca9620d62ec2db55746d2b3 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2018-10-23Added an option to color out the ouputLoïc Collignon1-1/+6
Enhance the readability using basic colorization to the logging system. As the '--call' option is almost unused, it doesn't require to have a shortname. So we use the '-c' and '--color' for the new colorization option, and keep only the longname for the 'call' option. Change-Id: I095fc9f38133fb742e0f0003540cd120feec8f5e Signed-off-by: Loïc Collignon <loic.collignon@iot.bzh>
2018-08-31app-framework-binder doc: Changed doc to fit new format.flounder_5.99.5flounder/5.99.55.99.5CorentinLGS11-795/+22
-Split book.json in 2. -Deleted unwanted files. -Changed all links to .html files to .md files in the SUMMARY.md, it is used by gitbook to build the pdf and as gitbook doesn't handle .html files I had to change it. Change-Id: I15705ef0f0d9143971c046ccb72a4eee04b98890 Signed-off-by: CorentinLGS <corentinlgs@gmail.com>
2018-08-20Provide functions afb_service_call[_sync]_legacyJose Bollo3-24/+140
These functions was missing and the documentation was erronous. This fixes that issue by providing the missing functions and updating the documentation. Bug-AGL: SPEC-1669 Change-Id: I543b0fbe29370be6f35f15ca3bfa48fef9ab4055 Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
2018-08-02Add ability to provide binding settingsJosé Bollo2-3/+120
Change-Id: Iab93a26340fa9743a58ca43cd903bbf31c783e5b Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
2018-07-27coverage: Improve coverage testJosé Bollo1-1/+1
The test now raise an overall coverage rate: lines......: 75.4% (8356 of 11080 lines) functions..: 80.4% (1094 of 1360 functions) Also Improve the documentation and improve parts of code. Change-Id: Ic2b8bc2f85d4181aa0b358a953f95cb105a0eed9 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-07-25Fix tiny documentation bugJose Bollo1-2/+2
Change-Id: Ib11160a8137480af92c450b65039b1272084f2d6 Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
2018-07-24Tiny documentation fixesJosé Bollo12-34/+33
Some english improvement of the documentation. Change-Id: I066c41d657a1921ed7dcc46dafcc7c65d122239c Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-07-19Fix errors in migration to V3José Bollo2-7/+14
Fix a tiny error in the migration script and improve it. Fix declaration of afb_daemon_get... without args for binding V3 compatibility. Fix declaration of afb_api_event_handler_... Fix the correct URL to the sed script: valid: https://git.automotivelinux.org/src/app-framework-binder/plain/docs/migration-to-binding-v3.sed invalid: https://git.automotivelinux.org/src/app-framework-binder/tree/docs/migration-to-binding-v3.sed Bug-AGL: SPEC-1595 Change-Id: I245b20a9c14634a94c69420312afbd97628bc750 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-07-09docs: Fix internal links by referencing html filesJosé Bollo6-58/+58
What to reference? Markdown files or HTML files? I dont like this solution but it is the least effort. Bug-AGL: SPEC-1544 Change-Id: I0d2e2c7fe1cfe769149bee3af611b04d2fe1aead Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-07-03doc: Tiny improvementJose Bollo3-3/+3
Change-Id: I3e8b0cbbe925d9536722962ed1ddc8a63cdbc08a Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
2018-06-22Improve documentation of api v3José Bollo16-1164/+3806
The documentation is improved to reflect the new version. Tune the options Change-Id: I894c3db3bc0c10e89db66a9a51a9ad049bb8c0c4 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-06-19Fix warnings due to json-c evolutionJosé Bollo1-0/+0
The library json-c now returns size_t instead of int when querying length of arrays. Change-Id: Id52bb8e77da12cb01e61e1a7c7f4ae2fcbe4634e Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-06-15api-v3: First draftJosé Bollo12-220/+502
This commit introduces the bindings v3 API for bindings. The documentation has still to be improved and will come very soon. Change-Id: I8f9007370e29f671fdfd1da87fff7372a17db7af Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-10-11Update documentation for afb_req_get_uidJosé Bollo1-1/+8
Change-Id: I984824b8ffc22783c1e6b63ee03ba23d5b7e2954 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-10-09Add documentation on debugging featuresJosé Bollo2-0/+37
Change-Id: I8c524bb290097524f5ad9d70fe93f19824f1faa7 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-10-09Add function 'afb_req_get_application_id'José Bollo1-3/+15
This function is intended to return an identifier of the calling application. At this time, the identifier is just derived from the application id but it can be changed in the future. Change-Id: Idacde8979ac5bb525352de9cab19e3fc1ed48627 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-09-18Bump doc to 4.99-EERC1Sebastien Douheret3-9/+10
Change-Id: I8804b16c7355081740ef338f2d0acb3ff1e7000c Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-09-07Allow renaming of APIJosé Bollo1-0/+12
The function afb_daemon_rename_api allows to rename an API during the preinit phase. Change-Id: I35477ba99d35b1dc51a7cacf8e55c3f02d86d7b4 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-09-07afb-ditf: track daemon stateJosé Bollo1-0/+5
Change-Id: Ic21c79dcd9908919a1a8d13e8747ef0bd2490477 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-09-07Implement afb_req_has_permissionJosé Bollo1-0/+14
This new verb is available in bindings to check whether the client identified by a request has a given permission or not. Change-Id: I5eaa0892d8260d26bd76f37123251c103c981e10 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-08-03subcall_req: introduce afb_req_subcall_reqJosé Bollo1-0/+31
The function 'afb_req_subcall_req' can be used to make asynchronous subcalls. It improves the function 'afb_req_subcall' by automatically keeping the request opened for the callback and by passing it, the request, as an extra argument of the callback. Change-Id: I2dc79c01fc25c7a65b9c8cc9e001a5b85fba99df Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-07-27update markdown documentationRonan Le Martret11-656/+741
Change-Id: I4f466ff4b965022998d2418a9c1310d4f5e0188e Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh>
2017-07-17Missing member on new binding v2 struct.Romain Forlot1-0/+2
Change-Id: I5fc248d0fcbf3fb8d8cb25138778b11da7cd039a Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2017-07-13Fix const issue in afb-auth.hJosé Bollo1-0/+3
The fields type and loa were declared as const. This worked well for C compilers that are allowing to initialize constant fixed structures. But when compiling with C++, it is no more easy to create initialized structure explicitely. In C++, the solution is to use C++14 constexpr functions. But for using these function, const must be removed. Bug-AGL: SPEC-741 Change-Id: I8096db6e4eba020f96fbf25789b2990d2a8cbabf Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-07-03Make status commonJosé Bollo1-6/+6
Make all error status for bindings use a common convention: a negative value means an error. Change-Id: Id09610051295810f04f00477d7ec1d9771bf7975 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-06-20Merge "Auto generate cover from book.json fields."Stéphane Desneux1-1/+2
2017-06-20docs: add document revisionStephane Desneux3-3/+16
Change-Id: Ie941042d71ed8de25e0ea9fa9bdbb0990e64d5f2 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
2017-06-20Auto generate cover from book.json fields.Sebastien Douheret1-1/+2
Change-Id: I678df3c78ac04fb2f7a8b3f843103d933c95d73c Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-19Add page-break for pdf and fix spellingSebastien Douheret9-101/+94
Change-Id: I3225f27a4e45792aeeb418eac5430c93c9d70061 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-19Add gitbook documentation (support PDF generation).Sebastien Douheret13-0/+789
To generate PDF doc: ./gendocs.sh pdf To generate HTML doc (local webserver): ./gendocs.sh serve Change-Id: I77156a45e86f3bcab045cee05694f93b7a50e4ba Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-13Refactor of the documentationJosé Bollo19-0/+4854