Allows specific features for agl-devel

[AGL/meta-agl.git] / templates / feature / agl-devel / agl-devel.md

diff --git a/templates/feature/agl-devel/agl-devel.md b/templates/feature/agl-devel/agl-devel.md
new file mode 100644 (file)
index 0000000..85a2b91
--- /dev/null
+++ b/templates/feature/agl-devel/agl-devel.md
@@ -0,0 +1,40 @@
+The features of 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:
+
+       CPPFLAGS_append_agl-devel = " -DAGL_DEVEL"
+
+Using this, any code enclosed in
+
+       #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.
+