diskimage-builder/doc/source/developer
Ian Wienand 37a53354ec Add IMAGE_ELEMENT_YAML and get_image_element_array
These new variables are a list of elements chosen for the build along
with their full paths.  For Python elements, IMAGE_ELEMENT_YAML is a
YAML formatted list that can be easily parsed.  For bash elements,
"get_image_element_array" will produce an associative-array of the
same (working around lack of array export in Bash).

This list is intended for consumption of elements who need to copy
files from other elements, such as pkg-map and svc-map.  As discussed
in I2a29861c67de2d25c595cb35d850e92807d26ac6, this list has already
been pruned and had overrides processed, so it is safe to simply walk
over this list with no further processing.

Since we're presenting the element list in a couple of different ways,
we combine it all into the element-info script.  It will output an
eval-able string that declares the appropriate variables.

I've added some inline documentation so they still appear in grep.
The documentation is updated with examples, and moved to a more
appropriate location as a sub-section of the element sytle guide.

To test this out, use the associative-array in generate_hooks, where
we can now find the element's directory without searching.

Change-Id: Ibbd07d082ec827441def2d3f6240df3efdc6eae3
2016-09-08 11:08:07 +10:00
..
caches.rst Prettify 'Caches and offline mode' documentation 2015-09-17 12:14:54 +02:00
components.rst doc: migrate from README.rst to Sphinx 2015-09-10 16:55:39 +10:00
design.rst Use fstrim to prep the block device 2016-03-13 16:24:59 +00:00
developing_elements.rst Add IMAGE_ELEMENT_YAML and get_image_element_array 2016-09-08 11:08:07 +10:00
dib_lint.rst Add documentation for dib-lint 2016-05-02 01:29:17 -05:00
index.rst Add documentation for dib-lint 2016-05-02 01:29:17 -05:00
invocation.rst Making element overriding explicit 2016-09-08 10:58:19 +10:00
stable_interfaces.rst Document what our stable interfaces are 2015-07-22 09:17:02 +00:00