Merge pull request #102 from matthiasclasen/recursive-docs

Document recursive modules and includes
tingping/wmclass
Alexander Larsson 2016-06-09 12:32:04 +02:00
commit 3fdfeacd5d
1 changed files with 10 additions and 1 deletions

View File

@ -176,8 +176,9 @@
<listitem><para>Object specifying the build environment. See below for details.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>modules</option> (array of objects)</term>
<term><option>modules</option> (array of objects or string)</term>
<listitem><para>An array of object specifying the modules to be built in order.
String members in the array are interpreted as the name of a separate json file that contains a module.
See below for details.</para></listitem>
</varlistentry>
<varlistentry>
@ -276,6 +277,9 @@
Each module specifies a source that has to be separately built and installed. It contains
the build options and a list of sources to download and extract before building.
</para>
<para>
Modules can be nested, in order to turn related modules on and off with a single key.
</para>
<para>
These are the properties that are accepted:
</para>
@ -353,6 +357,11 @@
<term><option>cleanup-platform</option> (array of strings)</term>
<listitem><para>Extra files to clean up in the platform.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>modules</option> (array of objects or strings)</term>
<listitem><para>An array of object specifying nested modules to be built before this one.
String members in the array are interpreted as names of a separate json file that contains a module.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>