X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fdev_guide%2F4_advanced_customization.md;h=30c704e05fcf47bacd4a0713d45e5ff19ba8bbb8;hb=3965d37f1c51cd2e0f86b160f4145d235f88e55e;hp=796232f0f27ec6a6db242eaf25f79f4280490941;hpb=b1bb356be470cfc10a0d9457166ad21af0bd3f19;p=apps%2Fapp-templates.git diff --git a/docs/dev_guide/4_advanced_customization.md b/docs/dev_guide/4_advanced_customization.md index 796232f..30c704e 100644 --- a/docs/dev_guide/4_advanced_customization.md +++ b/docs/dev_guide/4_advanced_customization.md @@ -1,7 +1,9 @@ -# Advanced customization +# 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: @@ -9,8 +11,13 @@ 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-***.cmake`, -where `XX` are numbers, `***` file name (ie. `99-my_customs.cmake`). +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 @@ -23,6 +30,28 @@ 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. 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