Document field types

This is not entirely clear for all fields from the documentation.

1 files changed, 75 insertions, 75 deletions

diff --git a/doc/xdg-app-builder.xml b/doc/xdg-app-builder.xml
index bf00e0d..520d689 100644
--- a/doc/xdg-app-builder.xml
+++ b/doc/xdg-app-builder.xml
@@ -107,119 +107,119 @@
             </para>
             <variablelist>
                 <varlistentry>
-                    <term><option>id</option></term>
+                    <term><option>id</option> (string)</term>
                     <listitem><para>A string defining the application id.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>branch</option></term>
+                    <term><option>branch</option> (string)</term>
                     <listitem><para>The branch of the application, defaults to master.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>runtime</option></term>
+                    <term><option>runtime</option> (string)</term>
                     <listitem><para>The name of the runtime that the application uses.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>runtime-version</option></term>
+                    <term><option>runtime-version</option> (string)</term>
                     <listitem><para>The version of the runtime that the application uses, defaults to master.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>sdk</option></term>
+                    <term><option>sdk</option> (string)</term>
                     <listitem><para>The name of the development runtime that the application builds with.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>metadata</option></term>
+                    <term><option>metadata</option> (string)</term>
                     <listitem><para>Use this file as the base metadata file when finishing.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>command</option></term>
+                    <term><option>command</option> (string)</term>
                     <listitem><para>The filename or path to the main binary of the application.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>build-runtime</option></term>
+                    <term><option>build-runtime</option> (boolean)</term>
                     <listitem><para>Build a new runtime instead of an application.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>separate-locales</option></term>
-                    <listitem><para>Separate out locale files and translations to an extention runtime. Defaults to true.</para></listitem>
+                    <term><option>separate-locales</option> (boolean)</term>
+                    <listitem><para>Separate out locale files and translations to an extension runtime. Defaults to true.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>id-platform</option></term>
+                    <term><option>id-platform</option> (string)</term>
                     <listitem><para>When building a runtime sdk, also create a platform based on it with this id.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>metadata-platform</option></term>
+                    <term><option>metadata-platform</option> (string)</term>
                     <listitem><para>The metadata file to use for the platform we create.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>writable-sdk</option></term>
+                    <term><option>writable-sdk</option> (boolean)</term>
                     <listitem><para>If true, use a writable copy of the sdk for /usr.
                     Defaults to true if --build-runtime is specified.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>appstream-compose</option></term>
+                    <term><option>appstream-compose</option> (boolean)</term>
                     <listitem><para>Run appstream-compose during cleanup phase. Defaults to true.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>sdk-extensions</option></term>
+                    <term><option>sdk-extensions</option> (array of strings)</term>
                     <listitem><para>Install these extra sdk extensions in /usr.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>platform-extensions</option></term>
+                    <term><option>platform-extensions</option> (array of strings)</term>
                     <listitem><para>Install these extra sdk extensions when creating the platform.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>tags</option></term>
+                    <term><option>tags</option> (array of strings)</term>
                     <listitem><para>Add these tags to the metadata file.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>build-options</option></term>
+                    <term><option>build-options</option> (object)</term>
                     <listitem><para>Object specifying the build environment. See below for details.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>modules</option></term>
+                    <term><option>modules</option> (array of objects)</term>
                     <listitem><para>An array of object specifying the modules to be built in order.
                     See below for details.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>cleanup</option></term>
+                    <term><option>cleanup</option> (array of strings)</term>
                     <listitem><para>An array of file patterns that should be removed at the end.
                     Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match
                     the basename.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>cleanup-commands</option></term>
+                    <term><option>cleanup-commands</option> (array of strings)</term>
                     <listitem><para>An array of commandlines that are run during the cleanup phase.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>cleanup-platform</option></term>
+                    <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>finish-args</option></term>
+                    <term><option>finish-args</option> (array of strings)</term>
                     <listitem><para>An array of arguments passed to the <command>xdg-app build-finish</command> command.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>rename-desktop-file</option></term>
+                    <term><option>rename-desktop-file</option> (string)</term>
                     <listitem><para>Any desktop file with this name will be renamed to a name based on id during the cleanup phase.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>rename-appdata-file</option></term>
+                    <term><option>rename-appdata-file</option> (string)</term>
                     <listitem><para>Any appdata file with this name will be renamed to a name based on id during the cleanup phase.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>rename-icon</option></term>
+                    <term><option>rename-icon</option> (string)</term>
                     <listitem><para>Any icon with this name will be renamed to a name based on id during the cleanup phase.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>copy-icon</option></term>
+                    <term><option>copy-icon</option> (boolean)</term>
                     <listitem><para>If rename-icon is set, keep a copy of the old icon file.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>desktop-file-name-prefix</option></term>
+                    <term><option>desktop-file-name-prefix</option> (string)</term>
                     <listitem><para>This string will be prefixed to the Name key in the main application desktop file.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>desktop-file-name-suffixed</option></term>
+                    <term><option>desktop-file-name-suffixed</option> (string)</term>
                     <listitem><para>This string will be suffixed to the Name key in the main application desktop file.</para></listitem>
                 </varlistentry>
             </variablelist>
@@ -236,36 +236,36 @@
             </para>
             <variablelist>
                 <varlistentry>
-                    <term><option>cflags</option></term>
+                    <term><option>cflags</option> (string)</term>
                     <listitem><para>This is set in the environment variable CFLAGS during the build.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>cxxflags</option></term>
+                    <term><option>cxxflags</option> (string)</term>
                     <listitem><para>This is set in the environment variable CXXFLAGS during the build.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>prefix</option></term>
+                    <term><option>prefix</option> (string)</term>
                     <listitem><para>The build prefix for the modules (defaults to <filename>/app</filename> for
                     applications and <filename>/usr</filename> for runtimes).</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>env</option></term>
+                    <term><option>env</option> (object)</term>
                     <listitem><para>This is a dictionary defining environment variables to be set during the build.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>build-args</option></term>
+                    <term><option>build-args</option> (array of strings)</term>
                     <listitem><para>This is an array containing extra options to pass to xdg-app build.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>strip</option></term>
+                    <term><option>strip</option> (boolean)</term>
                     <listitem><para>If this is true (the default is false) then all ELF files will be stripped after install.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>no-debuginfo</option></term>
+                    <term><option>no-debuginfo</option> (boolean)</term>
                     <listitem><para>If this is true (the default is false) and strip is not set then all ELF files will have their debug info extracted to a separate file.</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>arch</option></term>
+                    <term><option>arch</option> (object)</term>
                     <listitem><para>This is a dictionary defining for each arch a separate build options object that override the main one.</para></listitem>
                 </varlistentry>
             </variablelist>
@@ -281,68 +281,68 @@
             </para>
             <variablelist>
                 <varlistentry>
-                    <term><option>name</option></term>
+                    <term><option>name</option> (string)</term>
                     <listitem><para>The name of the module, used in e.g. build logs</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>sources</option></term>
+                    <term><option>sources</option> (array of objects)</term>
                     <listitem><para>An array of objects defining sources that will be downloaded and extracted in order</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>config-opts</option></term>
+                    <term><option>config-opts</option> (array of strings)</term>
                     <listitem><para>An array of options that will be passed to configure</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>make-args</option></term>
+                    <term><option>make-args</option> (array of strings)</term>
                     <listitem><para>An array of arguments that will be passed to make</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>make-install-args</option></term>
+                    <term><option>make-install-args</option> (array of strings)</term>
                     <listitem><para>An array of arguments that will be passed to make install</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>rm-configure</option></term>
+                    <term><option>rm-configure</option> (boolean)</term>
                     <listitem><para>If true, remove the configure script before starting build</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>no-autogen</option></term>
+                    <term><option>no-autogen</option> (boolean)</term>
                     <listitem><para>Ignore the existance of an autogen script</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>no-parallel-make</option></term>
+                    <term><option>no-parallel-make</option> (boolean)</term>
                     <listitem><para>Don't call make with arguments to build in parallel</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>cmake</option></term>
+                    <term><option>cmake</option> (boolean)</term>
                     <listitem><para>Use cmake instead of configure</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>builddir</option></term>
+                    <term><option>builddir</option> (string)</term>
                     <listitem><para>Use a build directory that is separate from the source directory</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>subdir</option></term>
+                    <term><option>subdir</option> (string)</term>
                     <listitem><para>Build inside this subdirectory of the extracted sources</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>build-options</option></term>
+                    <term><option>build-options</option> (object)</term>
                     <listitem><para>A build options object that can override global options</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>post-install</option></term>
+                    <term><option>post-install</option> (array of strings)</term>
                     <listitem><para>An array of shell command that are run after the install phase. Can for example
                     clean up the install dir, or install extra files.
                     </para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>cleanup</option></term>
+                    <term><option>cleanup</option> (array of strings)</term>
                     <listitem><para>An array of file patterns that should be removed at the end.
                     Patterns starting with / are taken to be full pathnames (without the /app prefix), otherwise they just match
                     the basename. Note that any patterns will only match files installed by this module.
                     </para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option>cleanup-platform</option></term>
+                    <term><option>cleanup-platform</option> (array of strings)</term>
                     <listitem><para>Extra files to clean up in the platform.</para></listitem>
                 </varlistentry>
             </variablelist>
@@ -361,23 +361,23 @@
                         <listitem><para>"archive"</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>path</option></term>
+                        <term><option>path</option> (string)</term>
                         <listitem><para>The path of the archive</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>url</option></term>
+                        <term><option>url</option> (string)</term>
                         <listitem><para>The url of a remote archive that will be downloaded. This overrides path if both are specified.</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>sha256</option></term>
+                        <term><option>sha256</option> (string)</term>
                         <listitem><para>The sha256 checksum of the file, verified after download</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>strip-components</option></term>
+                        <term><option>strip-components</option> (integer)</term>
                         <listitem><para>The number of initial pathname components to strip during extraction. Defaults to 1.</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>dest</option></term>
+                        <term><option>dest</option> (string)</term>
                         <listitem><para>Directory inside the source dir where the archive will be extracted.</para></listitem>
                     </varlistentry>
                 </variablelist>
@@ -390,15 +390,15 @@
                         <listitem><para>"git"</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>url</option></term>
+                        <term><option>url</option> (string)</term>
                         <listitem><para>URL of the git repostiory</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>branch</option></term>
+                        <term><option>branch</option> (string)</term>
                         <listitem><para>The branch/tag/commit to use from the git repostiory</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>dest</option></term>
+                        <term><option>dest</option> (string)</term>
                         <listitem><para>Directory inside the source dir where the repository will be checked out.</para></listitem>
                     </varlistentry>
                 </variablelist>
@@ -411,15 +411,15 @@
                         <listitem><para>"bzr"</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>url</option></term>
+                        <term><option>url</option> (string)</term>
                         <listitem><para>URL of the bzr repostiory</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>revision</option></term>
+                        <term><option>revision</option> (string)</term>
                         <listitem><para>A specific revision to use in the branch</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>dest</option></term>
+                        <term><option>dest</option> (string)</term>
                         <listitem><para>Directory inside the source dir where the repository will be checked out.</para></listitem>
                     </varlistentry>
                 </variablelist>
@@ -432,23 +432,23 @@
                         <listitem><para>"file"</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>path</option></term>
+                        <term><option>path</option> (string)</term>
                         <listitem><para>The path of a local file that will be copied into the source dir</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>url</option></term>
+                        <term><option>url</option> (string)</term>
                         <listitem><para>The url of a remote file that will be downloaded and copied into the source dir. This overrides path if both are specified.</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>sha256</option></term>
+                        <term><option>sha256</option> (string)</term>
                         <listitem><para>The sha256 checksum of the file, verified after download. This is optional for local files.</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>dest-filename</option></term>
+                        <term><option>dest-filename</option> (string)</term>
                         <listitem><para>Filename to use inside the source dir, default to the basename of path.</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>dest</option></term>
+                        <term><option>dest</option> (string)</term>
                         <listitem><para>Directory inside the source dir where the file will be copied.</para></listitem>
                     </varlistentry>
                 </variablelist>
@@ -464,15 +464,15 @@
                         <listitem><para>"script"</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>commands</option></term>
+                        <term><option>commands</option> (array of strings)</term>
                         <listitem><para>An array of shell commands that will be put in a shellscript file</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>dest-filename</option></term>
+                        <term><option>dest-filename</option> (string)</term>
                         <listitem><para>Filename to use inside the source dir, default to the basename of path.</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>dest</option></term>
+                        <term><option>dest</option> (string)</term>
                         <listitem><para>Directory inside the source dir where the file will be copied.</para></listitem>
                     </varlistentry>
                 </variablelist>
@@ -488,7 +488,7 @@
                         <listitem><para>"shell"</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>commands</option></term>
+                        <term><option>commands</option> (array of strings)</term>
                         <listitem><para>An array of shell commands that will be run during source extraction</para></listitem>
                     </varlistentry>
                 </variablelist>
@@ -501,15 +501,15 @@
                         <listitem><para>"patch"</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>path</option></term>
+                        <term><option>path</option> (string)</term>
                         <listitem><para>The path of a patch file that will be applied in the source dir</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>strip-components</option></term>
+                        <term><option>strip-components</option> (integer)</term>
                         <listitem><para>The value of the -p argument to patch, defaults to 1.</para></listitem>
                     </varlistentry>
                     <varlistentry>
-                        <term><option>dest</option></term>
+                        <term><option>dest</option> (string)</term>
                         <listitem><para>Directory inside the source dir where the patch will be applied.</para></listitem>
                     </varlistentry>
                 </variablelist>