From 5262c13a63c78107d6d7df05db31f54db8d47ac7 Mon Sep 17 00:00:00 2001 From: Fulup Ar Foll Date: Mon, 30 May 2016 16:07:31 +0200 Subject: Documentation Review Change-Id: I5574584b820f3b4537a9cef1f9f64d0517590883 --- doc/afm-system-daemon.html | 57 +++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 31 deletions(-) (limited to 'doc/afm-system-daemon.html') diff --git a/doc/afm-system-daemon.html b/doc/afm-system-daemon.html index 00cf81a..4569bc2 100644 --- a/doc/afm-system-daemon.html +++ b/doc/afm-system-daemon.html @@ -8,7 +8,7 @@

The afm-system-daemon

version: 1
-Date:    29 mai 2016
+Date:    30 mai 2016
 Author:  José Bollo
@@ -36,30 +36,27 @@ Author: José Bollo

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.

+

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

The daemon afm-system-daemon is in charge of installing -applications on the system. Its main tasks are:

+applications on AGL system. Its main tasks are:

-

The afm-system-daemon takes its orders from the system +

The afm-system-daemon takes its orders from system instance of D-Bus.

-

The figure below summarizes the situation of the -afm-system-daemon in the system.

+

The figure below summarizes the situation of afm-system-daemon in the system.

+------------------------------------------------------------+
 |                          User                              |
@@ -142,7 +139,7 @@ members install and uninstall
 
-
The client and the service are using JSON serialisation to
+
The client and the service are using JSON serialization to
 exchange data.

 
 
The D-Bus interface is defined by:

@@ -157,10 +154,10 @@ exchange data.

 
The signature of any member of the interface is string -> string
 for JSON -> JSON.

 
-
This is the normal case. In case of error, the current implmentation
+
This is the normal case. In case of error, the current implementation
 returns a dbus error that is a string.

 
-
Here is an example that use dbus-send to query data on
+
Here is an example using dbus-send to query data on
 installed applications.

 
 
dbus-send --session --print-reply \
@@ -177,24 +174,23 @@ org.AGL.afm.system.install 'string:"/tmp/appli.wgt"'
 
 
Method org.AGL.afm.system.install

 
-
Description: Install an application from its widget file.

+
Description: Install an application from a widget file.

 
-
If an application of the same id and version exists, it is not
-reinstalled except if force=true.

+
When an application with the same id and version already exists. Outside of
+using force=true the application is not reinstalled.

 
-
Applications are installed in the subdirectories of the common directory
-of applications.
+
Applications are installed the subdirectories of applications common directory.
 If root is specified, the application is installed under the
 sub-directories of the root defined.

 
-
Note that this methods is a simple accessor to the method
-org.AGL.afm.system.install of afm-system-daemon.

+
Note that this methods is a simple accessor method of
+org.AGL.afm.system.install from afm-system-daemon.

 
 
After the installation and before returning to the sender,
-afm-system-daemon sends the signal org.AGL.afm.system.changed.

+afm-system-daemon sends a signal org.AGL.afm.system.changed.

 
-
Input: The path of the widget file to install and, optionaly,
-a flag to force reinstallation, and, optionaly, a root directory.

+
Input: The path of the widget file to install and, optionally,
+a flag to force reinstallation, and, optionally, a root directory.

 
 
Either just a string being the absolute path of the widget file:

 
@@ -225,14 +221,13 @@ the id of the added application.

 
 
Description: Uninstall an application from its id.

 
-
Note that this methods is a simple accessor to the method
-org.AGL.afm.system.uninstall of afm-system-daemon.

+
Note that this methods is a simple method accessor of
+org.AGL.afm.system.uninstall from afm-system-daemon.

 
 
After the uninstallation and before returning to the sender,
-afm-system-daemon sends the signal org.AGL.afm.system.changed.

+afm-system-daemon sends a signal org.AGL.afm.system.changed.

 
-
Input: the id of the application and, otpionaly, the path to
-root of the application.

+
Input: the id of the application and optionally the application root path.

 
 
Either a string:

 
-- 
cgit