summaryrefslogtreecommitdiffstats
path: root/docs/dev_guide/5_autobuild.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-07-04 19:00:40 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2018-10-15 18:22:47 +0200
commit989eb4b774d941a0b6192917e76bd422bae968d2 (patch)
tree0a54be85b5095ce087e78144442c599f5707531f /docs/dev_guide/5_autobuild.md
parent9e01b88db70d572967b2122a0195f6d38121a49b (diff)
Update doc & use gitbook to enhance doc generation
Change-Id: If42c916f7664ea67b818a21b8f50c66c41e11f89 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/dev_guide/5_autobuild.md')
-rw-r--r--docs/dev_guide/5_autobuild.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/dev_guide/5_autobuild.md b/docs/dev_guide/5_autobuild.md
new file mode 100644
index 0000000..fe1c63d
--- /dev/null
+++ b/docs/dev_guide/5_autobuild.md
@@ -0,0 +1,41 @@
+# 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
+```