summaryrefslogtreecommitdiffstats
path: root/templates/feature/agl-devel/README_feature_agl-devel.md
diff options
context:
space:
mode:
authorStéphane Desneux <stephane.desneux@iot.bzh>2018-11-20 20:37:25 +0100
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2019-07-24 18:38:21 +0000
commitbf1fe809582f424c65e593ece030351aaf797065 (patch)
treea5c3ab96aa78711302b51ffedff97937b621b596 /templates/feature/agl-devel/README_feature_agl-devel.md
parentf5bad757c85b4937d27785ff4e9400ff0e171082 (diff)
add markdown documentation for all machines and features
THIS IS STILL WIP - not all features/machines are described Bug-AGL: SPEC-1902 Change-Id: I9bd5a3f57946199e1da90cfbed020742710218a1 Signed-off-by: Stéphane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'templates/feature/agl-devel/README_feature_agl-devel.md')
-rw-r--r--templates/feature/agl-devel/README_feature_agl-devel.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/templates/feature/agl-devel/README_feature_agl-devel.md b/templates/feature/agl-devel/README_feature_agl-devel.md
new file mode 100644
index 000000000..24483f95e
--- /dev/null
+++ b/templates/feature/agl-devel/README_feature_agl-devel.md
@@ -0,0 +1,42 @@
+---
+description: Feature agl-devel
+authors: José Bollo <jose.bollo@iot.bzh>, Ronan Le Martret <ronan.lemartret@iot.bzh>, Stephane Desneux <stephane.desneux@iot.bzh>, Yannick Gicquel <yannick.gicquel@iot.bzh>
+---
+
+### Feature agl-devel
+
+Activation of the agl-devel features turns on
+features needed for developping and debugging
+agl distribution.
+
+This includes:
+
+* adding to images some useful packages
+* adding to images the package group 'packagegroup-agl-devel'
+* definition of a contionnal the tag 'agl-devel'
+ for conditionnal building
+
+ * definition of the distro feature 'agl-devel'
+ * adds packages for development in SDK
+
+### How to use agl-devel in conditionnal builds
+
+The following example shows how to activate C/C++ code
+specific to agl-devel:
+
+```yocto
+CPPFLAGS_append_agl-devel = " -DAGL_DEVEL"
+```
+
+Using this, any code enclosed in
+
+```yocto
+#ifdef AGL_DEVEL
+...my code specific to agl-devel...
+#endif
+```
+
+will normaly be effective only if agl-devel is set on.
+
+At this time, it is recommended to use AGL_DEVEL as tag
+within C/C++ code.