summaryrefslogtreecommitdiffstats
path: root/docs/dev_guide/5-advanced-customization.md
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-03-19 11:59:52 -0600
committerScott Rifenbark <srifenbark@gmail.com>2019-03-26 13:00:16 -0700
commit16829a33f77f9d9eda435f5f1c36f36bc33fb267 (patch)
treedd1f36dc54d7d4d18241f8cf051f7ac639b1f4f5 /docs/dev_guide/5-advanced-customization.md
parenta6daa45c47f553b9ff6a1120f48a322f4e834363 (diff)
cmake-apps-module: New file names.
Created some new file names based on some re-writing. Also, updated the devguides-book.yml file to reflect the state of things. Change-Id: I6a9a91fe9c2f271493404ab7d63b6d6a8faf586e Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'docs/dev_guide/5-advanced-customization.md')
-rwxr-xr-xdocs/dev_guide/5-advanced-customization.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/dev_guide/5-advanced-customization.md b/docs/dev_guide/5-advanced-customization.md
new file mode 100755
index 0000000..30c704e
--- /dev/null
+++ b/docs/dev_guide/5-advanced-customization.md
@@ -0,0 +1,66 @@
+# 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 _<project-root-path>/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.