From d87906a9406c9739f9fa217b6c1d3e76a4b51fa6 Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Thu, 27 Jun 2019 17:55:48 +0200 Subject: [PATCH] Update docs with deprecated message Change-Id: I1e72c255b7714a08a0ec92d504db5d6662f1ae64 Bug-AGL: SPEC-2027 Signed-off-by: Sebastien Douheret --- docs/0-Doc-Revisions.md | 6 - docs/README.md | 16 +- docs/SUMMARY.md | 10 - docs/dev_guide/0_Abstract.md | 21 -- docs/dev_guide/1_Quickstart.md | 97 --------- docs/dev_guide/2_project_architecture.md | 108 ---------- docs/dev_guide/3_advanced_usage.md | 278 -------------------------- docs/dev_guide/4_advanced_customization.md | 66 ------ docs/dev_guide/5_autobuild.md | 41 ---- docs/dev_guide/pictures/iotbzh_logo_small.png | Bin 6989 -> 0 bytes 10 files changed, 2 insertions(+), 641 deletions(-) delete mode 100644 docs/0-Doc-Revisions.md delete mode 100644 docs/SUMMARY.md delete mode 100644 docs/dev_guide/0_Abstract.md delete mode 100644 docs/dev_guide/1_Quickstart.md delete mode 100644 docs/dev_guide/2_project_architecture.md delete mode 100644 docs/dev_guide/3_advanced_usage.md delete mode 100644 docs/dev_guide/4_advanced_customization.md delete mode 100644 docs/dev_guide/5_autobuild.md delete mode 100644 docs/dev_guide/pictures/iotbzh_logo_small.png diff --git a/docs/0-Doc-Revisions.md b/docs/0-Doc-Revisions.md deleted file mode 100644 index 38b6e74..0000000 --- a/docs/0-Doc-Revisions.md +++ /dev/null @@ -1,6 +0,0 @@ -Document revisions -================== - -| Date | Version | Designation  | Author | -|-------------|---------|--------------------------------------|-------------------------| -| 4 Jul 2017 | 1.0 | Initial release | R. Forlot [ Iot.bzh ] | diff --git a/docs/README.md b/docs/README.md index b0b87bd..d17f8f5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,17 +1,5 @@ # Introduction -This document explains how to use the CMake template files and associated -files to ease developement of AGL application. +`app-templates` used as git submodule is now deprecated. - -| *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 }}) | +Please refer to [https://git.automotivelinux.org/src/cmake-apps-module/](https://git.automotivelinux.org/src/cmake-apps-module/) that holds app-templates code as CMake module. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md deleted file mode 100644 index f475678..0000000 --- a/docs/SUMMARY.md +++ /dev/null @@ -1,10 +0,0 @@ -# Summary - -* [Document revisions](0-Doc-Revisions.md) - -* [Developper guide](dev_guide/0_Abstract.md) - * [Quickstart](dev_guide/1_Quickstart.md) - * [Project architecture](dev_guide/2_project_architecture.md) - * [Advanced usage](dev_guide/3_advanced_usage.md) - * [Customization](dev_guide/4_advanced_customization.md) - * [Autobuild](dev_guide/5_autobuild.md) diff --git a/docs/dev_guide/0_Abstract.md b/docs/dev_guide/0_Abstract.md deleted file mode 100644 index a04cc87..0000000 --- a/docs/dev_guide/0_Abstract.md +++ /dev/null @@ -1,21 +0,0 @@ -# Developper Guide: use AGL CMake Templates - -## Abstract - -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 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. - -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) diff --git a/docs/dev_guide/1_Quickstart.md b/docs/dev_guide/1_Quickstart.md deleted file mode 100644 index e910178..0000000 --- a/docs/dev_guide/1_Quickstart.md +++ /dev/null @@ -1,97 +0,0 @@ -# Quickstart - -## 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 : - -```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 -``` - -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: - -```bash -cp conf.d/app-templates/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. - -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: - -```cmake -PROJECT_TARGET_ADD(SuperExampleName) --> Adding target to your project - -add_executable/add_library(${TARGET_NAME}.... --> defining your target sources - -SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES.... --> fit target properties -for macros usage - -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. - -Specify what is the type of your targets that you want to be included in the -widget package with the property **LABELS**: - -Choose between: - -- **BINDING**: Shared library that be loaded by the AGL Application Framework -- **BINDINGV2**: Shared library that be loaded by the AGL Application Framework - This has to be accompagnied with a JSON file named like the - *${OUTPUT_NAME}-apidef* of the target that describe the API with OpenAPI - syntax (e.g: *mybinding-apidef*). - Or Alternatively, you can choose the name, without the extension, using macro - **set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES** - with *CXX*. -- **BINDINGV3**: Shared library that be loaded by the AGL Application Framework - This has to be accompagnied with a JSON file named like the - *${OUTPUT_NAME}-apidef* of the target that describe the API with OpenAPI - syntax (e.g: *mybinding-apidef*). - Or Alternatively, you can choose the name, without the extension, using macro - **set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES** - with *CXX*. -- **PLUGIN**: Shared library meant to be used as a binding plugin. Binding - would load it as a plugin to extend its functionnalities. It should be named - with a special extension that you choose with SUFFIX cmake target property or - it'd be **.ctlso** by default. -- **HTDOCS**: Root directory of a web app. This target has to build its - directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} -- **DATA**: Resources used by your application. This target has to build its - directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} -- **EXECUTABLE**: Entry point of your application executed by the AGL - Application Framework -- **LIBRARY**: An external 3rd party library bundled with the binding for its - own purpose because platform doesn't provide it. -- **BINDING-CONFIG**: Any files used as configuration by your binding. - -> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which -> stand for **Application Framework Binding**. - -```cmake -SET_TARGET_PROPERTIES(${TARGET_NAME} - PREFIX "afb-" - LABELS "BINDINGV3" - OUTPUT_NAME "file_output_name") -``` - -> **NOTE**: 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 deleted file mode 100644 index 6365539..0000000 --- a/docs/dev_guide/2_project_architecture.md +++ /dev/null @@ -1,108 +0,0 @@ -# Project architecture - -A typical project architecture would be : - -```tree - -│ -├── 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 -│ ├── cmake -│ │ └── config.cmake -│ └── wgt -│ └── config.xml.in -├── -├── -│ └── -├── -│ └── -└── - └── -``` - -| # | Parent | Description | -| - | -------| ----------- | -| \ | - | Path to your project. Hold master CMakeLists.txt and general files of your projects. | -| conf.d | \ | 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. | -| \ | \ | 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. | -| \ | \ | 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 -git checkout --detach -git checkout --detach -# Then commit -cd ../.. -git commit -s conf.d/app-templates -``` diff --git a/docs/dev_guide/3_advanced_usage.md b/docs/dev_guide/3_advanced_usage.md deleted file mode 100644 index 3e0ace1..0000000 --- a/docs/dev_guide/3_advanced_usage.md +++ /dev/null @@ -1,278 +0,0 @@ -# Build a widget - -## config.xml.in file - -To build a widget you need a _config.xml_ file describing what is your apps and -how Application Framework would launch it. This repo provide a simple default -file _config.xml.in_ that should work for simple application without -interactions with others bindings. - -It is recommended that you use the sample one which is more complete. You can -find it at the same location under the name _config.xml.in.sample_ (stunning -isn't it). Just copy the sample file to your _conf.d/wgt_ directory and name it -_config.xml.in_, then edit it to fit your needs. - -> ***CAUTION*** : The default file is only meant to be use for a -> simple widget app, more complicated ones which needed to export -> their api, or ship several app in one widget need to use the provided -> _config.xml.in.sample_ which had all new Application Framework -> features explained and examples. - -## Using cmake template macros - -To leverage all cmake templates features, you have to specify ***properties*** -on your targets. Some macros will not works without specifying which is the -target type. - -As the type is not always specified for some custom targets, like an ***HTML5*** -application, macros make the difference using ***LABELS*** property. - -Choose between: - -- **BINDING**: Shared library that be loaded by the AGL Application Framework -- **BINDINGV2**: Shared library that be loaded by the AGL Application Framework - This has to be accompagnied with a JSON file named like the - *${OUTPUT_NAME}-apidef* of the target that describes the API with OpenAPI - syntax (e.g: *mybinding-apidef*). - Or Alternatively, you can choose the name, without the extension, using macro - **set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES** - to *CXX*. -- **BINDINGV3**: Shared library that be loaded by the AGL Application Framework - This has to be accompagnied with a JSON file named like the - *${OUTPUT_NAME}-apidef* of the target that describes the API with OpenAPI - syntax (e.g: *mybinding-apidef*). - Or Alternatively, you can choose the name, without the extension, using macro - **set_openapi_filename**. If you use C++, you have to set **PROJECT_LANGUAGES** - to *CXX*. -- **PLUGIN**: Shared library are meant to be used as a binding plugin. A binding - would load it as a plugin to extend its functionnalities. It should be named - with a special extension that you choose with SUFFIX cmake target property or - it'd be **.ctlso** by default. -- **HTDOCS**: Root directory of a web app. This target has to build its - directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} -- **DATA**: Resources used by your application. This target has to build its - directory and puts its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} -- **EXECUTABLE**: Entry point of your application executed by the AGL - Application Framework -- **LIBRARY**: An external 3rd party library bundled with the binding for its - own purpose because platform doesn't provide it. -- **BINDING-CONFIG**: Any files used as configuration by your binding. - -Optional **LABELS** are available to define which resources type your test -materials are: - -- **TEST-CONFIG**: JSON configuration files that will be used by the afb-test - binding to know how to execute tests. -- **TEST-DATA**: Resources used to test your binding. It is at least your test - plan and also could be fixtures and any needed files by your tests. These files - will appear in a separate test widget. -- **TEST-PLUGIN**: Shared library are meant to be used as a binding - plugin. A binding would load it as a plugin to extend its functionalities. It - should be named with a special extension that you choose with SUFFIX cmake - target property or it'd be **.ctlso** by default. -- **TEST-HTDOCS**: Root directory of a web app. This target has to build its - directory and put its files in the ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} -- **TEST-EXECUTABLE**: Entry point of your application executed by the AGL - Application Framework -- **TEST-LIBRARY**: An external 3rd party library bundled with the binding for its - own use in case of platform doesn't provide it. - -Here is a mapping between LABELS and directories where files will be placed in -the widget: - -- **EXECUTABLE** : \/bin -- **BINDING-CONFIG** : \/etc -- **BINDING** | **BINDINGV2** | **BINDINGV3** | **LIBRARY** : \/lib -- **PLUGIN** : \/lib/plugins -- **HTDOCS** : \/htdocs -- **BINDING-DATA** : \/var -- **DATA** : \/var - -And about test dedicated **LABELS**: - -- **TEST-EXECUTABLE** : \/bin -- **TEST-CONFIG** : \/etc -- **TEST-PLUGIN** : \/lib/plugins -- **TEST-HTDOCS** : \/htdocs -- **TEST-DATA** : \/var - -> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which -> stand for **Application Framework Binding**. - -Example: - -```cmake -SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES - LABELS "HTDOCS" - OUTPUT_NAME dist.prod - ) -``` - -> **NOTE**: 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}** - -> **NOTE**: if you want to set and use `rpath` with your target you should use -> and set the target property `INSTALL_RPATH`. - -## Add external 3rd party library - -### Build, link and ship external library with the project - -You could need to include an external library that isn't shipped in the -platform. Then you have to bundle the required library in the `lib` widget -directory. - -Templates includes some facilities to help you to do so. Classic way to do so -is to declare as many CMake ExternalProject as library you need. - -An ExternalProject is a special CMake module that let you define how to: -download, update, patch, configure, build and install an external project. It -doesn't have to be a CMake project and custom step could be added for special -needs using ExternalProject step. More informations on CMake [ExternalProject -documentation site](https://cmake.org/cmake/help/v3.5/module/ExternalProject.html?highlight=externalproject). - -Example to include `mxml` library for [unicens2-binding](https://github.com/iotbzh/unicens2-binding) -project: - -```cmake -set(MXML external-mxml) -set(MXML_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/mxml) -ExternalProject_Add(${MXML} - GIT_REPOSITORY https://github.com/michaelrsweet/mxml.git - GIT_TAG release-2.10 - SOURCE_DIR ${MXML_SOURCE_DIR} - CONFIGURE_COMMAND ./configure --build x86_64 --host aarch64 - BUILD_COMMAND make libmxml.so.1.5 - BUILD_IN_SOURCE 1 - INSTALL_COMMAND "" -) - -PROJECT_TARGET_ADD(mxml) - -add_library(${TARGET_NAME} SHARED IMPORTED GLOBAL) - -SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES - LABELS LIBRARY - IMPORTED_LOCATION ${MXML_SOURCE_DIR}/libmxml.so.1 - INTERFACE_INCLUDE_DIRECTORIES ${MXML_SOURCE_DIR} -) - -add_dependencies(${TARGET_NAME} ${MXML}) -``` - -Here we define an external project that drive the build of the library then we -define new CMake target of type **IMPORTED**. Meaning that this target hasn't -been built using CMake but is available at the location defined in the target -property *IMPORTED_LOCATION*. - -You could want to build the library as *SHARED* or *STATIC* depending on your needs -and goals. Then you only have to modify the external project configure step and change -filename used by **IMPORTED** library target defined after external project. - -Then target *LABELS* property is set to **LIBRARY** to ship it in the widget. - -Unicens project also need some header from this library, so we use the target -property *INTERFACE_INCLUDE_DIRECTORIES*. Setting that when another target link -to that imported target, it can access to the include directories. - -We bound the target to the external project using a CMake dependency at last. - -Then this target could be use like any other CMake target and be linked etc. - -### Only link and ship external library with the project - -If you already have a binary version of the library that you want to use and you -can't or don't want to build the library then you only have to add an **IMPORTED** -library target. - -So, taking the above example, `mxml` library inclusion would be: - -```cmake -PROJECT_TARGET_ADD(mxml) - -add_library(${TARGET_NAME} SHARED IMPORTED GLOBAL) - -SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES - LABELS LIBRARY - IMPORTED_LOCATION /path/to/library/libmxml.so.1 - INTERFACE_INCLUDE_DIRECTORIES /path/to/mxml/include/dir -) -``` - -Finally, you can link any other lib or executable target with this imported -library like any other target. - -## Macro reference - -### PROJECT_TARGET_ADD - -Typical usage would be to add the target to your project using macro -`PROJECT_TARGET_ADD` with the name of your target as parameter. - -Example: - -```cmake -PROJECT_TARGET_ADD(low-can-demo) -``` - -> ***NOTE***: This will make available the variable `${TARGET_NAME}` -> set with the specificied name. This variable will change at the next call -> to this macros. - -### project_subdirs_add - -This macro will search in all subfolder any `CMakeLists.txt` file. If found then -it will be added to your project. This could be use in an hybrid application by -example where the binding lay in a sub directory. - -Usage : - -```cmake -project_subdirs_add() -``` - -You also can specify a globbing pattern as argument to filter which folders -will be looked for. - -To filter all directories that begin with a number followed by a dash the -anything: - -```cmake -project_subdirs_add("[0-9]-*") -``` - -### set_openapi_filename - -Used with a target labelized **BINDINGV2** to define the file name, and -possibly a relative path with the current *CMakeLists.txt*. - -If you don't use that macro to specify the name of your definition file -then the default one will be used, *${OUTPUT_NAME}-apidef* with -**OUTPUT_NAME** as the [target property]. - -> **CAUTION** you must only specify the name **WITHOUT** the extension. - -```cmake -set_openapi_filename('binding/mybinding_definition') -``` - -[target property]: https://cmake.org/cmake/help/v3.6/prop_tgt/OUTPUT_NAME.html "OUTPUT_NAME property documentation" - -### add_input_files - -Create custom target dedicated for HTML5 and data resource files. This macro -provides syntax and schema verification for differents languages which are -about now: LUA, JSON and XML. - -You could change the tools used to check files with the following variables: - -- XML_CHECKER: set to use **xmllint** provided with major linux distribution. -- LUA_CHECKER: set to use **luac** provided with major linux distribution. -- JSON_CHECKER: no tools found at the moment. - -```cmake -add_input_file("${MY_FILES_LIST}") -``` - -> **NOTE**: an issue at the check step on a file will stop at the build step. diff --git a/docs/dev_guide/4_advanced_customization.md b/docs/dev_guide/4_advanced_customization.md deleted file mode 100644 index 30c704e..0000000 --- a/docs/dev_guide/4_advanced_customization.md +++ /dev/null @@ -1,66 +0,0 @@ -# Advanced build customization - -## Including additionnals cmake files - -### Machine and system custom cmake files - -Advanced tuning is possible using addionnals cmake files that are included -automatically from some specifics locations. They are included in that order: - -- Project CMake files normaly located in _/conf.d/app-templates/cmake/cmake.d_ -- Home CMake files located in _$HOME/.config/app-templates/cmake.d_ -- System CMake files located in _/etc/app-templates/cmake.d_ - -CMake files has to be named using the following convention: `XX-common*.cmake` -or `XX-${PROJECT_NAME}*.cmake`, where `XX` are numbers, `*` file name -(ie. `99-common-my_customs.cmake`). - -> **NOTE** You need to specify after numbers that indicate include order, to -which project that file applies, if it applies to all project then use keyword -`common`. - -So, saying that you should be aware that every normal cmake variables used at -project level could be overwrited by home or system located cmake files if -variables got the same name. Exceptions are cached variables set using -**CACHE** keyword: - -Example: - -```cmake -set(VARIABLE_NAME 'value string random' CACHE STRING 'docstring') -``` - -### OS custom cmake files - -This is meant to personalize the project depending on the OS your are using. -At the end of config.cmake, common.cmake will include lot of cmake file to -customize project build depending on your plateform. It will detect your OS -deducing it from file _/etc/os-release_ now as default in almost all Linux -distribution. - -So you can use the value of field **ID_LIKE** or **ID** if the -first one doesn't exists and add a cmake file for that distribution in your -_conf.d/cmake/_ directory or relatively to your _app-templates_ submodule path -_app-templates/../cmake/_ - -Those files has to be named use the following scheme _XX-${OSRELEASE}*.cmake_ -where _XX_ are numbers, ${OSRELEASE} the **ID_LIKE** or **ID** field from -_/etc/os-release_ file. You can also define default OS configuration file -to use as fallback is none specific OS configuration is available using the -scheme _XX-default*.cmake_. Then is you need by example a module that isn't -named the same in one distro only, you only has to define a specific file to -handle that case then for all the other case put the configuration in the -default file. - -## Include customs templated scripts - -As well as for additionnals cmake files you can include your own templated -scripts that will be passed to cmake command `configure_file`. - -Just create your own script to the following directories: - -- Home location in _$HOME/.config/app-templates/scripts_ -- System location in _/etc/app-templates/scripts_ - -Scripts only needs to use the extension `.in` to be parsed and configured by -CMake command. diff --git a/docs/dev_guide/5_autobuild.md b/docs/dev_guide/5_autobuild.md deleted file mode 100644 index fe1c63d..0000000 --- a/docs/dev_guide/5_autobuild.md +++ /dev/null @@ -1,41 +0,0 @@ -# Autobuild script usage - -## Generation - -To be integrated in the Yocto build workflow you have to generate `autobuild` -scripts using _autobuild_ target. - -To generate those scripts proceeds: - -```bash -mkdir -p build -cd build -cmake .. && make autobuild -``` - -You should see _conf.d/autobuild/agl/autobuild_ file now. - -## Available targets - -Here are the available targets available from _autobuild_ scripts: - -- **clean** : clean build directory from object file and targets results. -- **distclean** : delete build directory -- **configure** : generate project Makefile from CMakeLists.txt files. -- **build** : compile all project targets. -- **package** : build and output a wgt package. - -You can specify variables that modify the behavior of compilation using -the following variables: - -- **CONFIGURE_ARGS** : Variable used at **configure** time. -- **BUILD_ARGS** : Variable used at **build** time. -- **DEST** : Directory where to output ***wgt*** file. - -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 -``` diff --git a/docs/dev_guide/pictures/iotbzh_logo_small.png b/docs/dev_guide/pictures/iotbzh_logo_small.png deleted file mode 100644 index 6a98c609cc88f8be5f34a54e32937c492ccae33c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6989 zcmV-T8?xkyP)izlpPl-E9$)0w%Tg! z+H4bz1OUk{mwAlk1>~O&zC7bq{Pgu%hu_budvuC`HXcHZfkZ6?N&)yF5tDEl9ck~e zoz$*9oo{S>qv7#R09rr~i=^EpNl5a7k{6JFKDfGm>Bj*v55QyqwEzNwNa4VVO6lyC zaAE?&285*v&F4t#PmR%SKU=f=2fG3I066r@3rSu;j&GP>zZ6ft^J&blTQXA!?J)oo ziOB&7NZ8F$v*qzU?SEgfuXA0KBW)q!*qYF#PYXF=f0Z`5@}sAQeU)>hwBLIB(DTc- zw7k>>z|IRvUOu{(}^O>_sr32`vENdl|w3fzD*Z@*VB3y#DVa zKDkH}dLaN*hbCV!ru4Lz_O!3v3Lpj`LVuN2@v;zhjzC=u#yXAyKIIVc(O~i5pe)n? zP~aL*Bf`d9#O-aO1po>GglJriF+-BHYJ`{qImY$T7<^9R2-hoV4oMf%GoF3j^xxsJ z^%rA){n9H1#Bca_rW4<@wfPSZPpLfrMqTrj^6!#%bn7#lzxZjg9&NPFBohQLdMN=h zJl3maS%ZpiR1D*;vv|=cL^yThPz(@{35u)KdqK3@%eP3z-~dwAT()?bV(PFz$XARcwyZXb$nU1K@P0!`Dy?!g0k z;iS_>UH8$o`yTrp06&W@Y?ne19t=MXz#Y9P0fna|fOY@}0PFZH02cx{NC>{2{u>jKHk`iZe4-R($RL#jhl-h&8f!`kLy3N$1E+{u0B(^_K;WlGhVf zhs9zLE0@J$G`L`ZYdQd6Ju%sC#!O($bP9lT2MLEZ(QYlhkCXM717MQJ^*;l!i{_

~2Ezq89cr$55OaQ)BJMUU*%Tz~C zD-s?*rSjYv0E$Qhx^b3kZUbHOZ~*56cpd4&WdY&Rpl74MTDKRlXnj=xO6Yk86G}If z5+9W?8fzXx=LKbSZz*#Vwf?wlnbZvlwxk8FHMxR$PK{({QT z3Db4qD`P@$^ns{a4&`OBVBg9yMi{^{V%{QRD18w5ghLVW23IuM)>lCmvV?GM(6u~X z$#riHqnFWN0U63Vh@U1FCnk?D-~B59F3WOXGk`Y%>>&a10~kqu_E?YW%Kz|+mM+gl`E3)@M*E_GJ?5N7zbO2~f+FdefcdZT@ zC08ikm5}i3MYRDvT*9(>K9{zX{h&dTm_5pTaEoG&o46n|OEC?=4tkEd{t-$}lo9hQ zx7kbchXMRomie?(T$=2M`xqiViVna61ewd&Z})1bEr`b49fgQE1?Ab0_cUp7ouzf- zM5tB(-v_XWOs<jNOC~fidL>;o3hq9@f!(sZ z_0@Y{Z&(l--6xRQN|TEZb;d*e zWpKlFZ@*o|p>8#CrzFb&T$<(D4FDSGx;Sat4yOH7itZ;QC~g=<+OL_IDMI&k5^*|- zAyPR6gx6e@i<6-7ls~WTS2^~Kw4;PPXxZ@xp4$9{`$9(P_(>IWPZ?c2V@_Fc%xOM7 zSSn@u()#L4*Tl@0y(NJWJx~_*RhI$qmjp(Xb|f2`8G)SvBq3~?bA;7bEHC$v)q1$) z*I0U1xs@j2lUp_iz<*M@)oTt*NcowByDo-bqZc0H*3;|NmwN{UM^iw|96@;kz*ck@ zkvfUddBIH5e18q#R&qf&6i^!Y4Q6>_j3A21Od?LMpf(oJ3!_Op+Ca4_W7`{@~WUwGE)cvDJ2|fA4ZFz`KNTHn)XY`gn$TUT9IHu zabQI0hsWKxuqn3fp;z92a3vrNKq|LW^f9xfl#Rk?6EXd@WSQKMqLiwil!?Iv(`HuL zZ9NhIJ`3QwELM31fGte9bdZ(rqWJ}LFuI?)N@04I#*|j!Q1bCm3y8Zl;-oCsr2y<_ zu24I)d6NOwvAR!LygG-f3d$ZQzo%qj0bSK|7W0`uz@Um%433kqVh z@~!|7HCt^d?HVDpV2{Y!>P$F}O>F{NIOHq)@5`n7O?2KgOWDods+j8LchXuN0VHzw`7EBsY4M%3-~h@riVXu@uVNziJnEo!GQNjL1`=~ zPcR|mnLM7bC_=i@JBzntw7%o?! zU(ITklk6H%G;KQF>zPIQ)U>An09V&9y+%O%)>|wDgwPSU+TP#Sxo*YVhn`=yde=So zZftyZb9r#=4Vx_HYa`)kXW20a$2c5K7fX=aluc0mgh!xgx?e%TBF4|onFG?;d*ZFBQWPwi@Zb=QRQ zIg^{?I~rT#yPASVi6{<^m<$%52mo=jy&-Bg$EpiYoY-?>TA;e{#OsEIr*3WR+O&(s z1=$27N_CwibC*H@rX$^=zwJ$BJO*)mre zxsfG(psP5R1w==>BUgG%)S&pGr58=Fn0#uM?^P?jSKD;I;9zvq#$kmg&YLmf(-U5A zSo)qj?f@X?Oz>EQmCl-Y{>1No%clj4CzPMn^yfW4zB6jJ zwCTd<%WPK^=t%D0k+NgvhQ_D=P!*bZilK*UI68txas9ZGnX?+ZHnkJe$8)$^DFE+~ z;z_Z9csVim$2=6(OcJV2mlfvlWuyzSUS7b<6qxHYH!d71t=pf@fRzBY)AcErtE{qI z3y|&t&y__z=3Oiu>2BC;sk~8rFu4k$bFzHjzPA-`(U$t7}y8^pB?le&Oq8 z7@<`aoFFt!TaYF1kJiNQzpvi;{bgs=e&Nz-HJ2|iv_P?hL_jaBnmhKJcZ@3jx6+q( zd}l$_YVQy1| zWd;{9i_2j+#T13e>^IYxmARchcf*@V7kdp71fGrTWNur3+GbR|qk8i?S(>9D~ibS+SR z%JBJj&lvfs3s&#E`@YT1D{pO0?0%s=v2X3Z&UM>~84`_MoA+#JeEN3VG57QPLq_R@ z5k=F+v4Gu|E1W`iZK(z6?Ewws0`2p-z5wagoML1)Ogbbuk7RLiHv)K^u6GCJokXAh z3WuUcimYHO(tUOfGu$I3@)|&;p;!^8E*i06G&Cw~!Q5N->-Dc%Ny^Bi*a* z?Cx0mf|PbcS!ndVXOFw-Qb$^rCiDORX=tHa;cCbeLPJOLz~ChW5nX zzk1P1KrgH+nE1I1CVuykve1}`t9E{G$;usfJQPVa9$5 z9uR%BAS(UeMgnq>3CTfp@A5qEvsfWA&t6c7bbruDboU_{EYL1Px{5wF3lpp(Vptw| z{DEZD@Xn#;Ws&Mj8&OYIm`Hr;xCskiMRue{#s>H%z=0iKyMOV;Ge=(cG4*lKC?1LKv$V3gSU#k?7iyWm?g#Kuq}zVHpoOkg z46FmV8|?52k7rzt?qi7D7ToPp8I&2khb0ZPJ}4}HJ{a$h(}yx$d^CHpxF7g1G5tkZ ztlG8o>I*a=U9IJTTojqTQgVP+L;?`&8=tyvdd-!;GK7D6k-vIj$X9w^!fIb0O*JpE zrCF>AeUv7AHJh7Pyey^D0l*wtG%Y-??97=Jp>ZcR$F@E9^p=I6Id8(9HNWh~lMH6~xSmBh(ajX5$1xDHIbR6R^Cg$+xpkufncvP^S1Vp8^N5i{ofqMmG z`uU8_l$KQ~U!xDSfGf7NnRS%MtANNX=Dria4J1Gp9>MtAk#3PtU7}qyb{9)0$|IP& z4G8DGmQ{xeeHCAvSU&e*Lkpaw3*Y!cU)A*mhTZN+J7UXJBIU&6Q>)JZ@CSxna$!&} zuGEDusA)!6Ko1s_l%H1`s9p5??YG=tUv<&?6D!aAdcX*e=D~aJnMjlcYv&w_Zhd`h z>CD-X5(0-y@PoO7@)feg4s%oWAz;7&(i^Y>=15mU>4%$%^5a~+WHIv))9rBH3 zKgKl41$&Uj;qBbK7}ejiYh};B(gt9zKltly>kmHpS<{KFSKkYvm+G3o)~|;rhJ95h zl?BJlEcOpS*{>Il(lvjjpk_q@QCt!n`OV9x{QQZy)e(7m^A{HGYF2baNWtNhevVvJ2_9>DMSe38H(S z0`K#Qy0Rv2*aP4#`kv3Z2|X+MHUL{dU|Z{&-P>B%Tz%1`du}Q4Rh(xCUxn-k?gM(b z{$yW7CTs0Lj{guG`NTRx1kB)RYIuRtJsZ5}zI{FoZv#X@()C6o7Qv;_n}D;FxFBe(n}c z_yUKbTVGhU^R8vg8n@C|CFnlMBfyl5yWvyef^Wu3k`ht{zIMi->O_~}R0rXQE%bLI zlZqEr+O~zBt6Z-d;wN<&UKc5^19WYaxzCCR!!*AU>|S+tKoilk8QuGPoTFty!2DFD zw;P}Rzb(x#?ko?Edv;{eNp;oXsi%j16;u3r;c!hDD*J?_9c}7L9@^dz*|2VJ z=eivo$^9*kwA4=*sJV(r@?b2IJh-3M?RTZP1psGa`J7q--7g@}5ZSO6Jr9<1n9=~N zVYr($`Fpj#6mzX2$ZSVfW2jA2J{F&7{frA7hW99o75UCZwaH7JXrs13B;nmW$>$fP z`6=FtA4yDlqypl0nL6nIAiDQ1$FnTXLFS=oCR4VUM#FRk+q04mqq9gN^M7|?Y zDG!@vqyjGGaG1eMgS8_xp$p3~qwh8?e~T$0lchjSR;Lq+XzRnbf zV!8nxf`H7!x1-41^W)Ha!30qy47!lHe}oqu9j1(xo2a}GzJO~R~kyOJ|j0renbA`bVe(NoD%1?1g zxoQ}0>!7lQ0}&2)Hj~qkD@@ZBgW4_y;CPIcLib@1QI~7!zE>V?3j+4=q|5BeUIHcQ z%55vnuDe_e;o(a=u5tUCv2a)nque^-(r{ia_tNz&F4W5MDJ$alupY|t#gTbBip{JW zU$+K82%!l_S~Bdf`iLX#=-$qC&ok}LPhUwOvjtxCk$%#JTgSsCvzU`@A5_FphLBhjg*#oJW3|0){xXhlGg9y2_nPPT#ua3x~`HrMxSIsr$ktWSG zXX#;4l#nR@*N2{GIJqsK>9Ty%weG`fm(sB>nf#;EG+|6mSRIdUYFe?4ES6-J!*nrF ze}4iY7cRN*Xvn=~c_0c_dbq(>7Mk}qKaqw1fB{t82eVKp+2ZU06n5Oi5q&5U$w3fo zule?6Y+l9Xg2G)w%_Ga>wtP;OXL5@s3w-52k+65|=~(-SX-DH2R`+BkyVvp!y9 zV`zULL}nRZ_G2u2fNLC50U7Kn=h6CEvB3~BE^JmW!Y%t~`3`@6b=|Us0P4F^P1n46 z;8!~VQ3FVexufpBGaTbM8_Mwqb#D3JC>$CKiX5(CzX*7B{nEJrzLm5i*S_%H4KE6a zYO1v;w{D>OEb`C?(DEo4GC|1|^yY+lb&ml6=GQIx03hy3*pW{>v-wLa0hCBcb(B#Y znMa`J1!M>y|0ABqD9o>0GDZmP;h5R}jpw$0Wd|~k1C_`;p2y4!$k0IE#X1IIUfp6{ z2yw~A#@~MIou(C*fL0{osBQ(7t%_rSx&1uk;kbq~YZofl*AUPO(ETe*)yVv{B_r=9 z=UuFSRl2C6p{lNXwW}O)J9i%PF4pl3s$Qam#@&^Gyl~_#$iKQ3akq@{cq1