diff options
author | José Bollo <jose.bollo@iot.bzh> | 2016-06-24 16:07:04 +0200 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2016-06-24 16:15:23 +0200 |
commit | 81df68c04dc5e32d5d6d06bc20a7030afdf45f59 (patch) | |
tree | 9a7c8b6250d15c3a75704a856a49477e74928095 /doc | |
parent | bad30c92a1cbe0e411f52c277cef37b6570b623f (diff) |
upgrading documentation to new usage
Change-Id: I5fbee7ba7ec929f6bcc02ffac7202059df02aa29
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/afm-system-daemon.html | 6 | ||||
-rw-r--r-- | doc/afm-system-daemon.md | 7 | ||||
-rw-r--r-- | doc/afm-user-daemon.html | 14 | ||||
-rw-r--r-- | doc/afm-user-daemon.md | 16 | ||||
-rw-r--r-- | doc/application-framework.html | 6 | ||||
-rw-r--r-- | doc/application-framework.md | 6 | ||||
-rw-r--r-- | doc/doc.css | 2 | ||||
-rw-r--r-- | doc/overview.html | 14 | ||||
-rw-r--r-- | doc/overview.md | 14 | ||||
-rw-r--r-- | doc/quick-tutorial.html | 5 | ||||
-rw-r--r-- | doc/quick-tutorial.md | 2 | ||||
-rw-r--r-- | doc/security-framework.html | 14 | ||||
-rw-r--r-- | doc/security-framework.md | 11 | ||||
-rw-r--r-- | doc/widgets.html | 3 | ||||
-rw-r--r-- | doc/widgets.md | 5 |
15 files changed, 34 insertions, 91 deletions
diff --git a/doc/afm-system-daemon.html b/doc/afm-system-daemon.html index 436a985..6cd5ede 100644 --- a/doc/afm-system-daemon.html +++ b/doc/afm-system-daemon.html @@ -18,7 +18,7 @@ <h1 class="title">The afm-system-daemon</h1> <h2 class="author">José Bollo</h2> <h2 class="author">Fulup Ar Foll</h2> -<h3 class="date">30 mai 2016</h3> +<h3 class="date">24 juin 2016</h3> </header> <nav id="TOC"> <ul> @@ -34,10 +34,6 @@ </ul> </nav> <h1 id="the-afm-system-daemon">The afm-system-daemon</h1> -<pre><code>version: 1 -Date: 30 mai 2016 -Author: José Bollo</code></pre> -<p>TABLE-OF-CONTENT-HERE</p> <h2 id="foreword">Foreword</h2> <p>This document describes application framework system daemon fundamentals. FCF (Fully Conform to Specification) implementation is still under development. It may happen that current implementation somehow diverges with specifications.</p> <h2 id="introduction">Introduction</h2> diff --git a/doc/afm-system-daemon.md b/doc/afm-system-daemon.md index 2db11d8..f7f9b3d 100644 --- a/doc/afm-system-daemon.md +++ b/doc/afm-system-daemon.md @@ -2,13 +2,6 @@ The afm-system-daemon ===================== - version: 1 - Date: 30 mai 2016 - Author: José Bollo - -TABLE-OF-CONTENT-HERE - - Foreword -------- diff --git a/doc/afm-user-daemon.html b/doc/afm-user-daemon.html index a7fcd49..364218f 100644 --- a/doc/afm-user-daemon.html +++ b/doc/afm-user-daemon.html @@ -18,7 +18,7 @@ <h1 class="title">The afm-user-daemon</h1> <h2 class="author">José Bollo</h2> <h2 class="author">Fulup Ar Foll</h2> -<h3 class="date">30 mai 2016</h3> +<h3 class="date">24 juin 2016</h3> </header> <nav id="TOC"> <ul> @@ -46,10 +46,6 @@ </ul> </nav> <h1 id="the-afm-user-daemon">The afm-user-daemon</h1> -<pre><code>version: 1 -Date: 30 mai 2016 -Author: José Bollo</code></pre> -<p>TABLE-OF-CONTENT-HERE</p> <h2 id="foreword">Foreword</h2> <p>This document describes application framework user daemon fundamentals. FCF (Fully Conform to Specification) implementation is still under development. It may happen that current implementation somehow diverges with specifications.</p> <h2 id="introduction">Introduction</h2> @@ -227,6 +223,10 @@ text/html <p>Holds application Id of launched application.</p> <p>Defined by the attribute <strong>id</strong> of the element <strong><widget></strong> of <strong>config.xml</strong>.</p> <ul> +<li><strong><em>%b</em></strong>: bindings</li> +</ul> +<p>In the future should represent the list of bindings and bindings directory separated by ','. Warning: not supported in current version.</p> +<ul> <li><strong><em>%c</em></strong>: content</li> </ul> <p>The file within the widget directory that is the entry point.</p> @@ -261,10 +261,6 @@ text/html </ul> <p>Name of the application as defined by the content of the element <strong><name></strong> of <strong>config.xml</strong>.</p> <ul> -<li><strong><em>%p</em></strong>: plugins</li> -</ul> -<p>In the future should represent the list of plugins and plugins directory separated by ','. Warning: not supported in current version.</p> -<ul> <li><strong><em>%P</em></strong>: port</li> </ul> <p>A port to use. It is currently a kind of random port. The precise model is to be defined later.</p> diff --git a/doc/afm-user-daemon.md b/doc/afm-user-daemon.md index b21c1cd..f1ce7f8 100644 --- a/doc/afm-user-daemon.md +++ b/doc/afm-user-daemon.md @@ -2,12 +2,6 @@ The afm-user-daemon =================== - version: 1 - Date: 30 mai 2016 - Author: José Bollo - -TABLE-OF-CONTENT-HERE - Foreword -------- @@ -311,6 +305,11 @@ Here is the list of *%substitutions*: Defined by the attribute **id** of the element **<widget>** of **config.xml**. + - ***%b***: bindings + + In the future should represent the list of bindings and bindings directory separated by ','. + Warning: not supported in current version. + - ***%c***: content The file within the widget directory that is the entry point. @@ -356,11 +355,6 @@ Here is the list of *%substitutions*: Name of the application as defined by the content of the element **<name>** of **config.xml**. - - ***%p***: plugins - - In the future should represent the list of plugins and plugins directory separated by ','. - Warning: not supported in current version. - - ***%P***: port A port to use. It is currently a kind of random port. The precise diff --git a/doc/application-framework.html b/doc/application-framework.html index 9c51b8e..4a7e36a 100644 --- a/doc/application-framework.html +++ b/doc/application-framework.html @@ -18,7 +18,7 @@ <h1 class="title">Application framework</h1> <h2 class="author">José Bollo</h2> <h2 class="author">Fulup Ar Foll</h2> -<h3 class="date">30 mai 2016</h3> +<h3 class="date">24 juin 2016</h3> </header> <nav id="TOC"> <ul> @@ -41,10 +41,6 @@ </ul> </nav> <h1 id="application-framework">Application framework</h1> -<pre><code>version: 1 -Date: 30 mai 2016 -Author: José Bollo</code></pre> -<p>TABLE-OF-CONTENT-HERE</p> <h2 id="foreword">Foreword</h2> <p>This document describes application framework fundamentals. FCF (Fully Conform to Specification) implementation is still under development. It may happen that current implementation somehow diverges with specifications.</p> <h2 id="overview">Overview</h2> diff --git a/doc/application-framework.md b/doc/application-framework.md index a88dc5b..0ebcdb7 100644 --- a/doc/application-framework.md +++ b/doc/application-framework.md @@ -2,12 +2,6 @@ Application framework ===================== - version: 1 - Date: 30 mai 2016 - Author: José Bollo - -TABLE-OF-CONTENT-HERE - Foreword -------- diff --git a/doc/doc.css b/doc/doc.css index 27be9dc..8c327c0 100644 --- a/doc/doc.css +++ b/doc/doc.css @@ -19,8 +19,6 @@ pre { outline: #555; } -pre:first-of-type { width: 20em; } - blockquote { border-left: solid thick black; background-color: #ff8; diff --git a/doc/overview.html b/doc/overview.html index 884a53c..c5998a6 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -16,7 +16,7 @@ <header> <h1 class="title">AGL framework, overview of the proposal of IoT.bzh</h1> <h2 class="author">José Bollo</h2> -<h3 class="date">29 mai 2016</h3> +<h3 class="date">24 juin 2016</h3> </header> <nav id="TOC"> <ul> @@ -31,10 +31,6 @@ </ul> </nav> <h1 id="agl-framework-overview-of-the-proposal-of-iot.bzh">AGL framework, overview of the proposal of IoT.bzh</h1> -<pre><code>version: 1 -Date: 29 mai 2016 -Author: José Bollo</code></pre> -<p>TABLE-OF-CONTENT-HERE</p> <h2 id="foreword">Foreword</h2> <p>This document describes what we intend to do. It may happen that our current implementation and the content of this document differ.</p> <p>In case of differences, it is assumed that this document is right and the implementation is wrong.</p> @@ -91,7 +87,7 @@ Tizen OBS ----------+---------------------------> | : +-----------v-----------+ : +---------+---------------+ | | : | binder afb-daemon | : | | | | : +-----------------------+ : | afm-user-daemon | | -| : | afm-main-plugin | : | | | +| : | afm-main-binding | : | | | | : +-----+--------------+--+ : +------^-------+------+---+ | | :........|..............|......: | | : | | |(2) |(8) |(10) | : | @@ -122,7 +118,7 @@ Tizen OBS ----------+---------------------------> <p>Let follow the sequence of calls:</p> <ol type="1"> <li><p>APPLICATION calls its <strong>binder</strong> to install the OTHER application.</p></li> -<li><p>The plugin <strong>afm-main-plugin</strong> of the <strong>binder</strong> calls, through <strong>D-Bus</strong> system, the system daemon to install the OTHER application.</p></li> +<li><p>The binding <strong>afm-main-binding</strong> of the <strong>binder</strong> calls, through <strong>D-Bus</strong> system, the system daemon to install the OTHER application.</p></li> <li><p>The system <strong>D-Bus</strong> checks wether APPLICATION has the permission or not to install applications by calling <strong>CYNARA</strong>.</p></li> <li><p>The system <strong>D-Bus</strong> transmits the request to <strong>afm-system-daemon</strong>.</p></li> </ol> @@ -131,7 +127,7 @@ Tizen OBS ----------+---------------------------> <li><p><strong>afm-system-daemon</strong> calls <strong>SECURITY-MANAGER</strong> for fullfilling security context of the installed application.</p></li> <li><p><strong>SECURITY-MANAGER</strong> calls <strong>CYNARA</strong> to install initial permissions for the application.</p></li> <li><p>APPLICATION call its binder to start the nearly installed OTHER application.</p></li> -<li><p>The plugin <strong>afm-main-plugin</strong> of the <strong>binder</strong> calls, through <strong>D-Bus</strong> session, the user daemon to launch the OTHER application.</p></li> +<li><p>The binding <strong>afm-main-binding</strong> of the <strong>binder</strong> calls, through <strong>D-Bus</strong> session, the user daemon to launch the OTHER application.</p></li> <li><p>The session <strong>D-Bus</strong> checks wether APPLICATION has the permission or not to start an application by calling <strong>CYNARA</strong>.</p></li> <li><p>The session <strong>D-Bus</strong> transmits the request to <strong>afm-user-daemon</strong>.</p></li> <li><p><strong>afm-user-daemon</strong> checks wether APPLICATION has the permission or not to start the OTHER application <strong>CYNARA</strong>.</p></li> @@ -146,7 +142,7 @@ Tizen OBS ----------+---------------------------> <li><p><strong><em>afm-system-daemon</em></strong>: in charge of installing and uninstalling applications.</p></li> <li><p><strong><em>afm-user-daemon</em></strong>: in charge of listing applications, querying application details, starting, terminating, stopping, resuming applications and their instances for a given user context.</p></li> <li><p><strong><em>afb-binder</em></strong>: in charge of serving resources and features through an HTTP interface.</p></li> -<li><p><strong><em>afm-main-plugin</em></strong>: This plugin allows applications to use the API of the AGL framework.</p></li> +<li><p><strong><em>afm-main-binding</em></strong>: This binding allows applications to use the API of the AGL framework.</p></li> </ul> <h2 id="links-between-the-security-framework-and-the-application-framework">Links between the "Security framework" and the "Application framework"</h2> <p>The security framework refers to the security model used to ensure security and to the tools that are provided for implementing that model.</p> diff --git a/doc/overview.md b/doc/overview.md index 6dc65bb..d39e66e 100644 --- a/doc/overview.md +++ b/doc/overview.md @@ -2,12 +2,6 @@ AGL framework, overview of the proposal of IoT.bzh ================================================== - version: 1 - Date: 29 mai 2016 - Author: José Bollo - -TABLE-OF-CONTENT-HERE - Foreword -------- @@ -118,7 +112,7 @@ APPLICATION installs an other application and then launch it. | : +-----------v-----------+ : +---------+---------------+ | | : | binder afb-daemon | : | | | | : +-----------------------+ : | afm-user-daemon | | - | : | afm-main-plugin | : | | | + | : | afm-main-binding | : | | | | : +-----+--------------+--+ : +------^-------+------+---+ | | :........|..............|......: | | : | | |(2) |(8) |(10) | : | @@ -151,7 +145,7 @@ Let follow the sequence of calls: 1. APPLICATION calls its **binder** to install the OTHER application. -2. The plugin **afm-main-plugin** of the **binder** calls, through +2. The binding **afm-main-binding** of the **binder** calls, through **D-Bus** system, the system daemon to install the OTHER application. 3. The system **D-Bus** checks wether APPLICATION has the permission @@ -170,7 +164,7 @@ Let follow the sequence of calls: 7. APPLICATION call its binder to start the nearly installed OTHER application. -8. The plugin **afm-main-plugin** of the **binder** calls, through +8. The binding **afm-main-binding** of the **binder** calls, through **D-Bus** session, the user daemon to launch the OTHER application. 9. The session **D-Bus** checks wether APPLICATION has the permission @@ -209,7 +203,7 @@ the components are: * ***afb-binder***: in charge of serving resources and features through an HTTP interface. -* ***afm-main-plugin***: This plugin allows applications to use the API +* ***afm-main-binding***: This binding allows applications to use the API of the AGL framework. diff --git a/doc/quick-tutorial.html b/doc/quick-tutorial.html index f1f96ed..72bf123 100644 --- a/doc/quick-tutorial.html +++ b/doc/quick-tutorial.html @@ -5,6 +5,7 @@ <meta name="generator" content="pandoc"> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> <meta name="author" content="Stephane Desneux"> + <meta name="author" content="José Bollo"> <title>AGL Application Framework: A Quick Tutorial</title> <style type="text/css">code{white-space: pre;}</style> <!--[if lt IE 9]> @@ -16,7 +17,8 @@ <header> <h1 class="title">AGL Application Framework: A Quick Tutorial</h1> <h2 class="author">Stephane Desneux</h2> -<h3 class="date">09 juin 2016</h3> +<h2 class="author">José Bollo</h2> +<h3 class="date">24 juin 2016</h3> </header> <nav id="TOC"> <ul> @@ -45,7 +47,6 @@ </ul> </nav> <h1 id="agl-application-framework-a-quick-tutorial">AGL Application Framework: A Quick Tutorial</h1> -<p>[TOC]</p> <h2 id="introduction">Introduction</h2> <p>This document proposes a quick tutorial to demonstrate the major functionnalities of the AGL Application Framework. For more complete information, please refer to the inline documentation available in the main git repository: https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/app-framework-main https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/app-framework-binder</p> <p>For more information on AGL, please visit: https://www.automotivelinux.org/</p> diff --git a/doc/quick-tutorial.md b/doc/quick-tutorial.md index 9eeebdb..cd23c22 100644 --- a/doc/quick-tutorial.md +++ b/doc/quick-tutorial.md @@ -1,6 +1,6 @@ + AGL Application Framework: A Quick Tutorial =========================================== -[TOC] Introduction ------------ diff --git a/doc/security-framework.html b/doc/security-framework.html index 779d710..dd4e72a 100644 --- a/doc/security-framework.html +++ b/doc/security-framework.html @@ -16,21 +16,19 @@ <header> <h1 class="title">The security framework</h1> <h2 class="author">José Bollo</h2> -<h3 class="date">29 mai 2016</h3> +<h3 class="date">24 juin 2016</h3> </header> <nav id="TOC"> <ul> -<li><a href="#the-security-framework">The security framework</a></li> +<li><a href="#the-security-framework">The security framework</a><ul> <li><a href="#setting-smack-rules-for-the-application">Setting Smack rules for the application</a></li> <li><a href="#what-user-can-run-an-application">What user can run an application?</a></li> +</ul></li> </ul> </nav> <h1 id="the-security-framework">The security framework</h1> -<pre><code>version: 1 -Date: 29 mai 2016 -Author: José Bollo</code></pre> -<p>TABLE-OF-CONTENT-HERE</p> -<h1 id="setting-smack-rules-for-the-application">Setting Smack rules for the application</h1> +<p>NOT STARTED !!!!!!</p> +<h2 id="setting-smack-rules-for-the-application">Setting Smack rules for the application</h2> <p>For Tizen, the following rules are set by the security manager for each application.</p> <pre><code>System ~APP~ rwx System ~PKG~ rwxat @@ -49,7 +47,7 @@ User ~PKG~::RO rwxat ~APP~ ~PKG~ rwxat ~APP~ ~PKG~::RO rxl</code></pre> <p>Here, <sub>PKG</sub> is the identifier of the package and <sub>APP</sub> is the identifier of the application.</p> -<h1 id="what-user-can-run-an-application">What user can run an application?</h1> +<h2 id="what-user-can-run-an-application">What user can run an application?</h2> <p>Not all user are able to run all applications. How to manage that?</p> </body> </html> diff --git a/doc/security-framework.md b/doc/security-framework.md index ad20742..61b01bb 100644 --- a/doc/security-framework.md +++ b/doc/security-framework.md @@ -2,15 +2,10 @@ The security framework ====================== - version: 1 - Date: 29 mai 2016 - Author: José Bollo - - -TABLE-OF-CONTENT-HERE +NOT STARTED !!!!!! Setting Smack rules for the application -======================================= +--------------------------------------- For Tizen, the following rules are set by the security manager for each application. @@ -34,7 +29,7 @@ For Tizen, the following rules are set by the security manager for each applicat Here, ~PKG~ is the identifier of the package and ~APP~ is the identifier of the application. What user can run an application? -================================= +--------------------------------------- Not all user are able to run all applications. How to manage that? diff --git a/doc/widgets.html b/doc/widgets.html index 1ea0178..5a22e4b 100644 --- a/doc/widgets.html +++ b/doc/widgets.html @@ -62,9 +62,6 @@ code > span.er { color: #ff0000; font-weight: bold; } </ul> </nav> <h1 id="the-widgets">The widgets</h1> -<pre><code>version: 1 -Date: 30 mai 2016 -Author: José Bollo</code></pre> <h2 id="the-widgets-1">The widgets</h2> <p>The widgets are described by the technical recommendations <a href="http://www.w3.org/TR/widgets" title="Packaged Web Apps">widgets</a> and <a href="http://www.w3.org/TR/widgets-digsig" title="XML Digital Signatures for Widgets">widgets-digsig</a>.</p> <p>In summary, <strong>widgets are ZIP files that can be signed and whose content is described by the file <config.xml></strong>.</p> diff --git a/doc/widgets.md b/doc/widgets.md index 10f7f58..5637f2c 100644 --- a/doc/widgets.md +++ b/doc/widgets.md @@ -1,11 +1,6 @@ The widgets =========== - version: 1 - Date: 30 mai 2016 - Author: José Bollo - - The widgets ----------- |