summaryrefslogtreecommitdiffstats
path: root/docs/dev_guide/4_advanced_customization.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-08-25 02:26:42 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2018-10-15 18:22:47 +0200
commit44c82fa7586ac56f2547be006b9b0c2694c4d78d (patch)
treecfc0bf1fba83d3c6f8e814e202f8134207074fad /docs/dev_guide/4_advanced_customization.md
parent4a956003ffc9949e319056a64ad3ab3aeb154703 (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/4_advanced_customization.md')
-rw-r--r--docs/dev_guide/4_advanced_customization.md23
1 files changed, 21 insertions, 2 deletions
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