aboutsummaryrefslogtreecommitdiffstats
path: root/docs/dev_guide
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-08-25 02:26:42 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2017-08-25 02:26:42 +0200
commit4a4b3ccac7c0d44b15cd3ccb35b39d6c6bf26607 (patch)
treed33116c8cab16a48a54a071ddb440d2fbf6c671a /docs/dev_guide
parent28dcbc3a2c7fef8988d71862653f95cf455c97c9 (diff)
Update doc and README with latest modifications
Change-Id: I7b42fe371b6912de9df42a76781a8886dd804b3d Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/dev_guide')
-rw-r--r--docs/dev_guide/1_Quickstart.md9
-rw-r--r--docs/dev_guide/3_advanced_usage.md13
-rw-r--r--docs/dev_guide/4_advanced_customization.md23
3 files changed, 33 insertions, 12 deletions
diff --git a/docs/dev_guide/1_Quickstart.md b/docs/dev_guide/1_Quickstart.md
index 9aad1ef..6db1ef2 100644
--- a/docs/dev_guide/1_Quickstart.md
+++ b/docs/dev_guide/1_Quickstart.md
@@ -1,4 +1,3 @@
-
# Quickstart
## Initialization
@@ -70,6 +69,9 @@ Choose between:
- **EXECUTABLE**: Entry point of your application executed by the AGL
Application Framework
+> **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-"
@@ -77,5 +79,6 @@ SET_TARGET_PROPERTIES(${TARGET_NAME}
OUTPUT_NAME "file_output_name")
```
-> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
-> stand for **Application Framework Binding**.
+> **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/3_advanced_usage.md b/docs/dev_guide/3_advanced_usage.md
index cf85986..f9d9e90 100644
--- a/docs/dev_guide/3_advanced_usage.md
+++ b/docs/dev_guide/3_advanced_usage.md
@@ -45,6 +45,9 @@ Choose between:
- **EXECUTABLE**: Entry point of your application executed by the AGL
Application Framework
+> **TIP** you should use the prefix _afb-_ with your **BINDING* targets which
+> stand for **Application Framework Binding**.
+
Example:
```cmake
@@ -54,13 +57,9 @@ SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
)
```
-If your target output is not named as the ***TARGET_NAME***, you need to specify
-***OUTPUT_NAME*** property that will be used by the ***populate_widget*** macro.
-
-Use the ***populate_widget*** macro as latest statement of your target
-definition. Then at the end of your project definition you should use the macro
-***build_widget*** that make an archive from the populated widget tree using the
-`wgtpkg-pack` Application Framework tools.
+> **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}**
## Macro reference
diff --git a/docs/dev_guide/4_advanced_customization.md b/docs/dev_guide/4_advanced_customization.md
index 0d8957e..a9974a8 100644
--- a/docs/dev_guide/4_advanced_customization.md
+++ b/docs/dev_guide/4_advanced_customization.md
@@ -2,6 +2,8 @@
## 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:
@@ -9,8 +11,8 @@ automatically from some specifics locations. They are included in that order:
- 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
+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
@@ -28,6 +30,23 @@ Example:
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.
+
## Include customs templated scripts
As well as for additionnals cmake files you can include your own templated