Update docs

Since migration to CMake module, the doc needs to be be updated
to reflect the change and get rid of all git submodule occurrences.

Change-Id: If56c50a845d01dafd6b5dcd46cac7cfb2be76e85
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>

5 files changed, 166 insertions, 136 deletions

diff --git a/docs/README.md b/docs/README.md
deleted file mode 100644
index 39f9209..0000000
--- a/docs/README.md
+++ /dev/null
@@ -1,22 +0,0 @@
-# Introduction
-
-This document explain how to use the CMake templates files and associated
-files to ease developement of AGL application.
-
-<br>
-<br>
-<br>
-<br>
-<br>
-
-| *Meta* | *Data* |
-| -- | -- |
-| **Title** | {{ config.title }} |
-| **Author** | {{ config.author }} |
-| **Description** | {{ config.description }} |
-| **Keywords** | {{ config.keywords }} |
-| **Language** | English |
-| **Published** | Published {{ config.published }} as an electronic book |
-| **Updated** | {{ gitbook.time }} |
-| **Collection** | Open-source |
-| **Website** | [{{ config.website }}]({{ config.website }}) |
diff --git a/docs/dev_guide/0_Abstract.md b/docs/dev_guide/0_Abstract.md
index a04cc87..88e841b 100644
--- a/docs/dev_guide/0_Abstract.md
+++ b/docs/dev_guide/0_Abstract.md
@@ -1,21 +1,38 @@
-# Developper Guide: use AGL CMake Templates
+# Abstract
 
-## Abstract
+Files used to build an application, or a binding project with the AGL
+Application Framework.
 
-Files used to build an application, or binding, project with the
-AGL Application Framework.
+To build your AGL project using these templates, you have to installed them as
+a CMake module. The easy way is to install using your distro package manager
+following [this guide](http://docs.automotivelinux.org/docs/devguides/en/dev/reference/host-configuration/docs/1_Prerequisites.html).
 
-To build your AGL project using these templates, you have to install
-them within your project and adjust compilation option in `config.cmake`.
-For technical reasons, you also have to specify **cmake** target in
-sub CMakeLists.txt installed. Make a globbing search to find source files
-isn't recommended now to handle project build especially in a multiuser
-project because CMake will not be aware of new or removed source files.
+Then install it, depending of your distro:
+
+* **Debian/Ubuntu**
+
+```bash
+sudo apt-get install agl-cmake-apps-module-bin
+```
+
+* **openSUSE**
+
+```bash
+sudo zypper install agl-cmake-apps-module
+```
+
+* **Fedora**
+
+```bash
+sudo dnf install agl-cmake-apps-module
+```
+
+----
 
 You'll find usage samples here:
 
 - [helloworld-service](https://github.com/iotbzh/helloworld-service)
-- [low-level-can-service](https://gerrit.automotivelinux.org/gerrit/apps/low-level-can-service)
-- [high-level-viwi-service](https://github.com/iotbzh/high-level-viwi-service)
-- [audio-binding](https://github.com/iotbzh/audio-binding)
-- [unicens2-binding](https://github.com/iotbzh/unicens2-binding)
+- [agl-service-can-low-level](https://gerrit.automotivelinux.org/gerrit/apps/agl-service-can-low-level)
+- [agl-service-audio-4a](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/apps/agl-service-audio-4a)
+- [agl-service-unicens](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/apps/agl-service-unicens)
+- [4a-hal-unicens](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/4a-hal-unicens)
diff --git a/docs/dev_guide/1_Quickstart.md b/docs/dev_guide/1_Quickstart.md
index e910178..992f4ca 100644
--- a/docs/dev_guide/1_Quickstart.md
+++ b/docs/dev_guide/1_Quickstart.md
@@ -2,33 +2,37 @@
 
 ## Initialization
 
-To use these templates files on your project just install the reference files using
-**git submodule** then use `config.cmake` file to configure your project specificities :
+To use these templates files on your project just install the reference files
+using **cmake module** then use `config.cmake` file to configure your project specificities :
 
 ```bash
-git submodule add https://gerrit.automotivelinux.org/gerrit/p/apps/app-templates.git conf.d/app-templates
-mkdir conf.d/cmake
-cp conf.d/app-templates/samples.d/config.cmake.sample conf.d/cmake/config.cmake
+mkdir -p conf.d/cmake
+# RPM based distribution
+cp /usr/share/cmake/Modules/CMakeAfbTemplates/samples.d/config.cmake.sample conf.d/cmake/config.cmake
+# DEB based distribution with X.Y as cmake version
+cp /usr/share/cmake-X.Y/Modules/CMakeAfbTemplates/samples.d/config.cmake.sample conf.d/cmake/config.cmake
 ```
 
 Edit the copied config.cmake file to fit your needs.
 
 Now, create your top CMakeLists.txt file which include `config.cmake` file.
 
-An example is available in **app-templates** submodule that you can copy and
-use:
+An example is available in the **cmake module** that you can copy and use:
 
 ```bash
-cp conf.d/app-templates/samples.d/CMakeLists.txt.sample CMakeLists.txt
+# RPM based distribution
+cp /usr/share/cmake/Modules/CMakeAfbTemplates/samples.d/CMakeLists.txt.sample CMakeLists.txt
+# DEB based distribution with X.Y as cmake version
+cp /usr/share/cmake-X.Y/Modules/CMakeAfbTemplates/samples.d/CMakeLists.txt.sample CMakeLists.txt
 ```
 
 ## Create your CMake targets
 
-For each target part of your project, you need to use ***PROJECT_TARGET_ADD***
-to include this target to your project.
+For each target that is part of your project, you need to use
+***PROJECT_TARGET_ADD*** to include this target to your project.
 
-Using it, make available the cmake variable ***TARGET_NAME*** until the next
-***PROJECT_TARGET_ADD*** is invoked with a new target name.
+> **NOTE**: Using it, make available the cmake variable ***TARGET_NAME*** until
+> the next ***PROJECT_TARGET_ADD*** is invoked with a new target name.
 
 So, typical usage defining a target is:
 
@@ -45,8 +49,8 @@ INSTALL(TARGETS ${TARGET_NAME}....
 
 ## Targets PROPERTIES
 
-You should set properties on your targets that will be used to package your
-apps in a widget file that could be installed on an AGL system.
+Targets properties is used to determine nature of targets and where they will be
+stored in the package that will be build.
 
 Specify what is the type of your targets that you want to be included in the
 widget package with the property **LABELS**:
@@ -92,6 +96,6 @@ SET_TARGET_PROPERTIES(${TARGET_NAME}
 	OUTPUT_NAME "file_output_name")
 ```
 
-> **NOTE**: You doesn't need to specify an **INSTALL** command for these
+> **CAUTION**: You doesn't need to specify an **INSTALL** command for these
 > targets. This is already handle by template and will be installed in the
 > following path : **${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}**
diff --git a/docs/dev_guide/2_project_architecture.md b/docs/dev_guide/2_project_architecture.md
index 6365539..9e5503f 100644
--- a/docs/dev_guide/2_project_architecture.md
+++ b/docs/dev_guide/2_project_architecture.md
@@ -5,57 +5,32 @@ A typical project architecture would be :
 ```tree
 <project-root-path>
 │
+├── autobuild/
+│   ├── agl
+│   │   └── autobuild
+│   ├── linux
+│   │   └── autobuild
+│   └── windows
+│       └── autobuild
 ├── conf.d/
-│   ├── autobuild/
-│   │   ├── agl
-│   │   │   └── autobuild
-│   │   ├── linux
-│   │   │   └── autobuild
-│   │   └── windows
-│   │       └── autobuild
-│   ├── app-templates/
-│   │   ├── README.md
-│   │   ├── cmake/
-│   │   │   ├── export.map
-│   │   │   └── macros.cmake
-│   │   ├── samples.d/
-│   │   │   ├── CMakeLists.txt.sample
-│   │   │   ├── config.cmake.sample
-│   │   │   ├── config.xml.in.sample
-│   │   │   └── xds-config.env.sample
-│   │   ├── template.d/
-│   │   │   ├── autobuild/
-│   │   │   │   ├── agl
-│   │   │   │   │   └── autobuild.in
-│   │   │   │   ├── linux
-│   │   │   │   │   └── autobuild.in
-│   │   │   │   └── windows
-│   │   │   │       └── autobuild.in
-│   │   │   ├── config.xml.in
-│   │   │   ├── deb-config.dsc.in
-│   │   │   ├── deb-config.install.in
-│   │   │   ├── debian.changelog.in
-│   │   │   ├── debian.compat.in
-│   │   │   ├── debian.rules.in
-│   │   │   ├── gdb-on-target.ini.in
-│   │   │   ├── install-wgt-on-target.sh.in
-│   │   │   ├── start-on-target.sh.in
-│   │   │   ├── rpm-config.spec.in
-│   │   │   └── xds-project-target.conf.in
-│   │   └── wgt/
-│   │       ├── icon-default.png
-│   │       ├── icon-html5.png
-│   │       ├── icon-native.png
-│   │       ├── icon-qml.png
-│   │       └── icon-service.png
 │   ├── packaging/
-│   │   ├── config.spec
-│   │   └── config.deb
+│   │   ├── rpm
+│   │   │   └── package.spec
+│   │   └── deb
+│   │       ├── package.dsc
+│   │       ├── debian.package.install
+│   │       ├── debian.changelog
+│   │       ├── debian.compat
+│   │       ├── debian.control
+│   │       └── debian.rules
 │   ├── cmake
+│   │   ├── 00-debian-osconfig.cmake
+│   │   ├── 00-suse-osconfig.cmake
+│   │   ├── 01-default-osconfig.cmake
 │   │   └── config.cmake
 │   └── wgt
-│      └── config.xml.in
-├── <libs>
+│       ├── icon.png
+│       └── config.xml.in
 ├── <target>
 │   └── <files>
 ├── <target>
@@ -67,42 +42,9 @@ A typical project architecture would be :
 | # | Parent | Description |
 | - | -------| ----------- |
 | \<root-path\> | - | Path to your project. Hold master CMakeLists.txt and general files of your projects. |
+| autobuild | \<root-path\> | Scripts generated from app-templates to build packages the same way for differents platforms.|
 | conf.d | \<root-path\> | Holds needed files to build, install, debug, package an AGL app project |
-| app-templates | conf.d | Git submodule to app-templates AGL repository which provides CMake helpers macros library, and build scripts. config.cmake is a copy of config.cmake.sample configured for the projects. SHOULD NOT BE MODIFIED MANUALLY !|
-| autobuild | conf.d | Scripts generated from app-templates to build packages the same way for differents platforms.|
 | cmake | conf.d | Contains at least config.cmake file modified from the sample provided in app-templates submodule. |
-| wgt | conf.d | Contains at least config.xml.in template file modified from the sample provided in app-templates submodule for the needs of project (See config.xml.in.sample file for more details). |
 | packaging | conf.d | Contains output files used to build packages. |
-| \<libs\> | \<root-path\> | External dependencies libraries. This isn't to be used to include header file but build and link statically specifics libraries. | Library sources files. Can be a decompressed library archive file or project fork. |
+| wgt | conf.d | Contains config.xml.in, and optionnaly test-config.xml.in template files modified from the sample provided in cmake module for the needs of project (See config.xml.in.sample and test-config.xml.in.sample file for more details). |
 | \<target\> | \<root-path\> | A target to build, typically library, executable, etc. |
-
-## Manage app-templates submodule
-
-### Update
-
-You may have some news bug fixes or features available from app-templates
-repository that you want. To update your submodule proceed like the following:
-
-```bash
-git submodule update --remote
-git commit -s conf.d/app-templates
-```
-
-This will update the submodule to the HEAD of master branch repository. Save
-the modification by commiting it in your master git project.
-
-### Checkout submodule to a git tag
-
-You could just want to update at a specified repository tag or branch or commit
-, here are the method to do so:
-
-```bash
-cd conf.d/app-templates
-# Choose one of the following depending what you want
-git checkout <tag_name>
-git checkout --detach <branch_name>
-git checkout --detach <commit_id>
-# Then commit
-cd ../..
-git commit -s conf.d/app-templates
-```
diff --git a/docs/dev_guide/5_autobuild.md b/docs/dev_guide/5_autobuild.md
index fe1c63d..f6788fc 100644
--- a/docs/dev_guide/5_autobuild.md
+++ b/docs/dev_guide/5_autobuild.md
@@ -1,4 +1,87 @@
-# Autobuild script usage
+# Autobuild script
+
+The Applications based on AGL framework should have a full packaging solution,
+independently of yocto workflow.
+
+Unfortunately the build part of the Applications is only in documentation or in
+yocto recipes.
+
+The Applications build with AGL framework must be automated without any yocto
+recipes.
+
+A script named **autobuild** is used to control applications build operations.
+The bbclass aglwgt.bbclass will call the **autobuild** script for all operations
+and is located at the top level of the application repository.
+
+This script could be written in one of the following languages:
+
+* Makefile
+* Bash
+* Python
+
+The script will be executed directly after a chmod() on it (this implies that the caller should make the script executable before calling it: caller could be aglwgt.bbclass, a jenkins job, a 'real' developer ...)
+An appropriate shebang is required to make the script callable directly:
+
+* '#!/usr/bin/make -f' for Makefile format,
+* '#/usr/bin/bash' for Bash
+* etc.
+
+The calling convention is close to the one from make, in particular to pass arguments through env variables. This is also easy for bash, as a simple eval on arguments will set environment variables correctly.
+The generic call has the following format:
+
+```bash
+autobuild/agl/autobuild <command> [ARG1="value1" [ARG2="value2" ... ]]
+```
+
+autobuild can be invoked from any directory and all relative paths are
+considered to be relative to the location of autobuild.
+
+For makefile scripts, this is the usual behaviour.
+
+For bash scripts, running a 'cd $(dirname $0)' at the beginning is mandatory.
+
+At build time, the following calls must be made in the following order:
+
+```bash
+autobuild/agl/autobuild configure CONFIGURE_ARGS="..."
+```
+
+initializes the build environment (ex: if app uses cmake, the 'configure''
+step will run cmake)
+
+```bash
+autobuild/agl/autobuild build BUILD_ARGS="...."
+```
+
+builds the application (compile, link binaries, assembles javascript etc.)
+
+```bash
+autobuild/agl/autobuild package PACKAGE_ARGS="..." DEST=<path for resulting wgt
+file(s)>
+```
+
+creates the widget package(s) in the specified destination path prepared by the
+caller
+
+```bash
+autobuild/agl/autobuild package-test PACKAGE_ARGS="..." DEST=<path for resulting wgt
+file(s)>
+```
+
+creates the test widget package(s) in the specified destination path prepared by the
+caller
+
+```bash
+autobuild/agl/autobuild clean CLEAN_ARGS="..."
+```
+
+clean the built files (removes the result of autobuild build)
+
+```bash
+autobuild/agl/autobuild distclean DISTCLEAN_ARGS="..."
+```
+
+clean everything (removes the result of autobuild build + autobuild configure)
 
 ## Generation
 
@@ -13,7 +96,7 @@ cd build
 cmake .. && make autobuild
 ```
 
-You should see _conf.d/autobuild/agl/autobuild_ file now.
+You should see _autobuild/agl/autobuild_ file now.
 
 ## Available targets
 
@@ -24,18 +107,24 @@ Here are the available targets available from _autobuild_ scripts:
 - **configure** : generate project Makefile from CMakeLists.txt files.
 - **build** : compile all project targets.
 - **package** : build and output a wgt package.
+- **package-test** : build and output the test wgt as well as the normal wgt
+ package.
+- **install** : install the project in your filesystem
 
 You can specify variables that modify the behavior of compilation using
 the following variables:
 
+- **CLEAN_ARGS** : Variable used at **clean** time.
+- **DISTCLEAN_ARGS** : Variable used at **distclean** time.
 - **CONFIGURE_ARGS** : Variable used at **configure** time.
 - **BUILD_ARGS** : Variable used at **build** time.
-- **DEST** : Directory where to output ***wgt*** file.
+- **DEST** : Directory where to output ***wgt*** file (default at build root
+ directory).
 
 Variable as to be in CMake format. (ie: BUILD_ARGS="-DC_FLAGS='-g -O2'")
 
 Usage example:
 
 ```bash
-./conf.d/autobuild/wgt/autobuild package DEST=/tmp
+./autobuild/wgt/autobuild package DEST=/tmp
 ```