From: José Bollo Date: Fri, 24 Jun 2016 14:07:04 +0000 (+0200) Subject: upgrading documentation to new usage X-Git-Tag: 2.0.2~4 X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?p=src%2Fapp-framework-main.git;a=commitdiff_plain;h=81df68c04dc5e32d5d6d06bc20a7030afdf45f59 upgrading documentation to new usage Change-Id: I5fbee7ba7ec929f6bcc02ffac7202059df02aa29 Signed-off-by: José Bollo --- 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 @@

The afm-system-daemon

José Bollo

Fulup Ar Foll

-

30 mai 2016

+

24 juin 2016

The afm-system-daemon

-
version: 1
-Date:    30 mai 2016
-Author:  José Bollo
-

TABLE-OF-CONTENT-HERE

Foreword

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.

Introduction

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 @@

The afm-user-daemon

José Bollo

Fulup Ar Foll

-

30 mai 2016

+

24 juin 2016

The afm-user-daemon

-
version: 1
-Date:    30 mai 2016
-Author:  José Bollo
-

TABLE-OF-CONTENT-HERE

Foreword

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.

Introduction

@@ -227,6 +223,10 @@ text/html

Holds application Id of launched application.

Defined by the attribute id of the element of config.xml.

+

In the future should represent the list of bindings and bindings directory separated by ','. Warning: not supported in current version.

+

The file within the widget directory that is the entry point.

@@ -261,10 +261,6 @@ text/html

Name of the application as defined by the content of the element of config.xml.

-

In the future should represent the list of plugins and plugins directory separated by ','. Warning: not supported in current version.

-

A port to use. It is currently a kind of random port. The precise model is to be defined later.

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 **** 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 **** 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 @@

Application framework

José Bollo

Fulup Ar Foll

-

30 mai 2016

+

24 juin 2016

Application framework

-
version: 1
-Date:    30 mai 2016
-Author:  José Bollo
-

TABLE-OF-CONTENT-HERE

Foreword

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.

Overview

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 @@

AGL framework, overview of the proposal of IoT.bzh

José Bollo

-

29 mai 2016

+

24 juin 2016

AGL framework, overview of the proposal of IoT.bzh

-
version: 1
-Date:    29 mai 2016
-Author:  José Bollo
-

TABLE-OF-CONTENT-HERE

Foreword

This document describes what we intend to do. It may happen that our current implementation and the content of this document differ.

In case of differences, it is assumed that this document is right and the implementation is wrong.

@@ -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 ----------+--------------------------->

Let follow the sequence of calls:

  1. APPLICATION calls its binder to install the OTHER application.

    2. -

  2. The plugin afm-main-plugin of the binder calls, through D-Bus system, the system daemon to install the OTHER application.

    3. +

  3. The binding afm-main-binding of the binder calls, through D-Bus system, the system daemon to install the OTHER application.

  4. The system D-Bus checks wether APPLICATION has the permission or not to install applications by calling CYNARA.

  5. The system D-Bus transmits the request to afm-system-daemon.

@@ -131,7 +127,7 @@ Tizen OBS ----------+--------------------------->

  • afm-system-daemon calls SECURITY-MANAGER for fullfilling security context of the installed application.

  • SECURITY-MANAGER calls CYNARA to install initial permissions for the application.

  • APPLICATION call its binder to start the nearly installed OTHER application.

    • -

  • The plugin afm-main-plugin of the binder calls, through D-Bus session, the user daemon to launch the OTHER application.

    • +

  • The binding afm-main-binding of the binder calls, through D-Bus session, the user daemon to launch the OTHER application.

  • The session D-Bus checks wether APPLICATION has the permission or not to start an application by calling CYNARA.

  • The session D-Bus transmits the request to afm-user-daemon.

  • afm-user-daemon checks wether APPLICATION has the permission or not to start the OTHER application CYNARA.

    • @@ -146,7 +142,7 @@ Tizen OBS ----------+--------------------------->

  • afm-system-daemon: in charge of installing and uninstalling applications.

  • afm-user-daemon: in charge of listing applications, querying application details, starting, terminating, stopping, resuming applications and their instances for a given user context.

  • afb-binder: in charge of serving resources and features through an HTTP interface.

    • -

  • afm-main-plugin: This plugin allows applications to use the API of the AGL framework.

    • +

  • afm-main-binding: This binding allows applications to use the API of the AGL framework.

    • The security framework refers to the security model used to ensure security and to the tools that are provided for implementing that model.

    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 @@ + AGL Application Framework: A Quick Tutorial