aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2020-09-21deal with extra quoteszhonglu1-1/+1
Bug-AGL：SPEC-2714 Signed-off-by: Zhong Lu <zhongl.fnst@cn.fujitsu.com> Change-Id: I1323e28a3b39ff1c22ac40bcc7fb4fa86cf6e23c
2020-02-28Rename source files and improve readabilityJosé Bollo1-1/+1
Also rename wgtpkg-installer tools as wgtpkg-install. Shorter and obvious. Bug-AGL: SPEC-2840 Change-Id: Ifed072bfef488700807613dd61875a30a4041d7a Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2019-06-14Introduce platform servicesJosé Bollo1-1/+7
The platform services are services that run at the global platform scope as opposite to services that run in the context of the user. Bug-AGL: SPEC-1015 Change-Id: I08c2d47715cbc7436e67781d5e638386be531520 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2019-05-14Fix outdated application path.Li Xiaoming1-3/+2
Bug-AGL: SPEC-2360 Change-Id: I7907f8433cfdaf269004d6bc667f082a009b5cbd Signed-off-by: Li Xiaoming <lixm.fnst@cn.fujitsu.com>
2019-04-17API Reference Overview: Removed old "kristi" file, updated bookScott Rifenbark2-57/+0
Removed the old 0-kristi* file and updated the app-services-book.yml file to remove the redundant file from the contents. Change-Id: If0c01d5c39ae9660909d531335158b54168bc47a Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-04-16API Overview: Changes to the file that introduces APIs.Scott Rifenbark1-1/+3
Updates to wording. Change-Id: If91bfd17f786f39a2feedb70919af959222b59ff Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-19Fixed book.yml fileSebastien Douheret1-10/+8
- remove useless %lang% prefix - remove unwanted (copy/paste error) "API Reference" chapter Change-Id: I2c46f93093eed6950cfbb7319e7cfd47fcd8b8b7 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2018-12-13book doc: add book yaml fileClément Bénier1-0/+37
SPEC-1988 Change-Id: Ie68d715f04338bf8917792f0f1ae6e36d1602553 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2018-11-28API Landing Page: Test landing page for all APIsScott Rifenbark1-0/+45
Change-Id: I5c8b843fc2c31d45cafbf25eef156a94e9fd0f1c Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-10-19Add the ability to access binding through tcpJosé Bollo1-47/+59
This commit introduce "tcp", a new type of provided/required api. It appears in the config.xml as below: <urn:AGL:widget:provided-api> <param "name"="HOST:PORT/API" "value"="tcp"> <urn:AGL:widget:required-api> <param "name"="HOST:PORT/API" "value"="tcp"> This implementation is a draft. The service exposed can not start automatically. Use it with the permission urn:AGL:permission::system:run-by-default. Change-Id: Ic593f0d891692ca0c777c49057ec54c37fc55cc0 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-10-10docs: Improve documentating 'required-binding'Jose Bollo1-4/+59
The documentation was not clear because the headers wasn't set correctly. Bug-AGL: SPEC-1800 Change-Id: Ibb5ecf3becdaad1b560e6718d41b81fdf55fe9df Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
2018-09-20doc: Changed doc to new formatguppy_6.90.0guppy/6.90.06.90.0Sebastien Douheret12-819/+46
- fixed image width setting - split book.json to match new format - changed description in README.md - remove useless files Change-Id: I9b0b863715585659f32a9f6c3005c1bbf15009f4 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2018-08-16Add the external binding featureflounder_5.99.3flounder/5.99.35.99.3José Bollo1-4/+23
This commit introduce two new features: <urn:AGL:widget:provided-binding> <param "name"="public-name" "value"="relative-path-to-the-binding"/> <urn:AGL:widget:required-binding> <param "name"="public-name" "value"="extern"> <param "name"="relative-path-to-the-binding" "value"="local"> TODO: manage security by setting correct Smack label to the exported files Bugs-AGL: SPEC-1439 Bugs-AGL: SPEC-1663 Change-Id: I70aad7d523ece7a2ae0058b79708a02ef81144e2 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2018-01-19Bump version to 5.99-FFRC0José Bollo1-0/+1
Change-Id: I255b669036672b3728f0e60a62eca90716367178
2017-12-14docs: Add an historyJosé Bollo2-0/+8
Change-Id: Ib7ea7aa11c63492fe874368e3a0d539ab613a2a0 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-12-14mkdocs: Restore mkdocs featureJosé Bollo1-0/+1
Change-Id: Iac70ac21a0d88e973aa5859a692515d4e683b2c9 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-12-08docs: identify revision fileJosé Bollo2-1/+1
Change-Id: Iae13361c16b056f8619a9a75a08ae63d66f85daf Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-10-10Added information to include external libraryRomain Forlot1-0/+10
Describe default directories used by application framework inside the apps. Bug-AGL: SPEC-883 Change-Id: Iea0280197db6091b4963134f8b20b5dc10b9767b Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2017-09-18Bump doc to 4.99-EERC1Sebastien Douheret3-9/+10
Change-Id: I9181f557addc212224cc1bfe2da9a61b2c0cfb01 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-08-07Handle file-properties for setting eXecutable flagJosé Bollo1-0/+22
This commits introduce the feature "urn:AGL:widget:file-properties". This feature actually only allows to set execution flag to files of the widget. Example: <feature name="urn:AGL:widget:file-properties"> <param name="flite" value="executable" /> <param name="jtalk" value="executable" /> </feature> Bug-AGL: SPEC-384 Change-Id: If13ca3b1015576317fd52cb9540b77d0e2675f67 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-07-28clean markdown documentationRonan Le Martret10-637/+695
Change-Id: I1b0a1628b42097c47a844aa0c8030d4534428421 Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh>
2017-06-20Merge "Auto generate cover from book.json fields."Stéphane Desneux1-1/+2
2017-06-20docs: add document revisionStephane Desneux3-244/+257
Change-Id: Ib98fae58d8a95dceea42347a5e46d6d39d565852 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
2017-06-20Auto generate cover from book.json fields.Sebastien Douheret1-1/+2
Change-Id: I8203040b759289b08d5311a74e6df557fe8250bd Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-19docs: remove incomplete docs from bookStephane Desneux1-3/+0
Change-Id: I1ed6c95a906c086a010b302eca6a48c2a3ac3eef Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
2017-06-19Fix pdf paging and make-units rendering (svg to png).Sebastien Douheret5-1653/+438
Change-Id: I60b5ab02602b993d8d92504b25f0a35d340d5444 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-19Fix spelling and images size.Sebastien Douheret7-85/+79
Change-Id: I01c6342fa9f6b16753ed5f48645538e48af09a5a Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-19Re-order doc chaptersSebastien Douheret10-23/+23
Change-Id: I44cf2054fa06816480e26fc19b45c6f8a464a708 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-19Remove proposal statement.Sebastien Douheret1-2/+2
Change-Id: I5d63279149c46e095afeec97bfad3c61e40fedee Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-19Add gitbook documentation (support PDF generation).Sebastien Douheret16-11790/+2420
To generate PDF doc: ./gendocs.sh pdf To generate HTML doc (local webserver): ./gendocs.sh serve Change-Id: Ib9b195814f4596a5cf5233d6a331d206e76c9bae Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-06-19docs: minor enhancements, typo fixesStephane Desneux3-5/+5
Change-Id: Ic2cb29cb96e6542405736628f2d0cce995cb21ce Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
2017-03-21Allows or in mustache instanciationJosé Bollo1-4/+8
This allows to simplify the configuration file afm-unit.conf. Restore the type application/vnd.agl.service Change-Id: Iaadde2c2d96155cea6d1b8bee4d3c78e885cf44a Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-03-20Provide unit in config.xml and documentationJosé Bollo7-364/+12179
This commit remove urn:AGL:widget:provided-application in favour of urn:AGL:widget:provided-unit. In the same time, the feature urn:AGL:widget:provided-api must be attached to a unit. This will enable to export more than one API for a unit if needed. Change-Id: I17ade3651db2cd61402875333d063ee05cf57a10 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-03-17wgtpkg-install: choose the portJosé Bollo1-14/+19
The installer now chooses a port for an installed application. This choose is made by consulting the previously installed applications and by getting the lowest port available in the range 1024..32767. Change-Id: Iab4238b4d52447a2d261d87d45bbb02f0b7a35e5 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-02-15Fix typos in docsSebastien Douheret3-38/+39
Change-Id: I901ff5bb6f22ba7076914c7cbe92f69b4b89cb0e Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2017-02-03Rename binding to api in config.xmljobol1-8/+8
Signed-off-by: jobol <jose.bollo@iot.bzh>
2017-01-31Improves namesJosé Bollo1-8/+8
The name binding is related to an internal concept of the binder. The term API is more generic. Dont forget that an API can be provided by more than one binding (but only one at a given time). Change-Id: I91b2f3d96de6aace5fcb434cf64df7e8ed61630f Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2017-01-26Prepare the Integration with systemdJosé Bollo3-236/+366
This is an intermediate commit providing basic functionnalities for setting up integration of the framework with systemd. - file afm-unit.conf is a mustache template - translation of config.xml to json object - mustache (extended) application of the json to the template - post processing of the result for extracting unit files This processing is currently available as a test (and a tool) and will be integrated after more developement, test and validation. Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2016-12-12fix html linkRonan1-4/+4
Change-Id: Ia1be9d8370620e4dcfd00130108928daef61a7ed Signed-off-by: Ronan <ronan.lemartret@iot.bzh>
2016-12-09fix svg path for gen htmlRonan2-3/+3
Change-Id: Ib91a405a5a7d49ad6f6c752aef6cb6cadee9ab9f Signed-off-by: Ronan <ronan.lemartret@iot.bzh>
2016-11-29Doc reworked, reliftedRomain Forlot11-972/+1553
Change-Id: If41313a44cb66c0aa0f315b264284d081ff87f8e Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
2016-11-17docs: fix smallest typo, everStephane Desneux1-0/+1
Change-Id: Ibe47587fc1971de44e46147b110f2605b262c639 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
2016-11-14afm-user-daemon: Adds method "once"José Bollo1-1/+25
Adds the method "once" that is intended to start an application in local mode if it doesn't already run. Returns the state of the running application. Change-Id: I4dfff06fa2d3e95f13a2436a2f1af9174799ddcf Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2016-11-08renaming of verbsJosé Bollo3-30/+47
The verbs 'stop' and 'continue' are now renamed as respectively 'pause' and 'resume'. Change-Id: I2f82105103884fc07f3c67e08c696e435aed28e1 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2016-11-08afm-user-daemon: returns the pids of the processesJosé Bollo1-1/+3
Asking for the state now returns the pids of the launched processes when this processes are still alive. Change-Id: I69348d8089581247465c3bd1ab83f86decad25ae Signed-off-by: José Bollo <jose.bollo@iot.bzh>
2016-10-28doc: switch to mkdocsJosé Bollo10-0/+2161
Signed-off-by: José Bollo <jose.bollo@iot.bzh>