Merge pull request #120 from matthiasclasen/man-page-fix

doc: Make xdg-app-build-init man page match reality

2 files changed, 21 insertions, 17 deletions

diff --git a/doc/xdg-app-build-init.xml b/doc/xdg-app-build-init.xml
index f85cb87..63035e8 100644
--- a/doc/xdg-app-build-init.xml
+++ b/doc/xdg-app-build-init.xml
@@ -32,8 +32,8 @@
             <cmdsynopsis>
                 <command>xdg-app build-init</command>
                 <arg choice="opt" rep="repeat">OPTION</arg>
-                <arg choice="plain">APPNAME</arg>
                 <arg choice="plain">DIRECTORY</arg>
+                <arg choice="plain">APPNAME</arg>
                 <arg choice="plain">SDK</arg>
                 <arg choice="plain">RUNTIME</arg>
                 <arg choice="opt">BRANCH</arg>
diff --git a/doc/xdg-app-builder.xml b/doc/xdg-app-builder.xml
index f11c1e2..d3731b7 100644
--- a/doc/xdg-app-builder.xml
+++ b/doc/xdg-app-builder.xml
@@ -112,7 +112,7 @@
                 </varlistentry>
                 <varlistentry>
                     <term><option>runtime-version</option></term>
-                    <listitem><para>The version of theruntime that the application uses, defaults to master.</para></listitem>
+                    <listitem><para>The version of the runtime that the application uses, defaults to master.</para></listitem>
                 </varlistentry>
                 <varlistentry>
                     <term><option>sdk</option></term>
@@ -136,7 +136,7 @@
                 </varlistentry>
                 <varlistentry>
                     <term><option>id-platform</option></term>
-                    <listitem><para>When building a runtime sdk, also create a platform based on it wit this id.</para></listitem>
+                    <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>
@@ -145,7 +145,7 @@
                 <varlistentry>
                     <term><option>writable-sdk</option></term>
                     <listitem><para>If true, use a writable copy of the sdk for /usr.
-                    Defaults to true if --build-runtime is specified</para></listitem>
+                    Defaults to true if --build-runtime is specified.</para></listitem>
                 </varlistentry>
                 <varlistentry>
                     <term><option>appstream-compose</option></term>
@@ -153,19 +153,19 @@
                 </varlistentry>
                 <varlistentry>
                     <term><option>sdk-extensions</option></term>
-                    <listitem><para>Install these extra sdk extensions in /usr</para></listitem>
+                    <listitem><para>Install these extra sdk extensions in /usr.</para></listitem>
                 </varlistentry>
                 <varlistentry>
                     <term><option>platform-extensions</option></term>
-                    <listitem><para>Install these extra sdk extensions when creating the platform</para></listitem>
+                    <listitem><para>Install these extra sdk extensions when creating the platform.</para></listitem>
                 </varlistentry>
                 <varlistentry>
                     <term><option>tags</option></term>
-                    <listitem><para>Add these tags to the metadata file</para></listitem>
+                    <listitem><para>Add these tags to the metadata file.</para></listitem>
                 </varlistentry>
                 <varlistentry>
                     <term><option>build-options</option></term>
-                    <listitem><para>object specifying the build environment. See below for details.</para></listitem>
+                    <listitem><para>Object specifying the build environment. See below for details.</para></listitem>
                 </varlistentry>
                 <varlistentry>
                     <term><option>modules</option></term>
@@ -188,19 +188,19 @@
                 </varlistentry>
                 <varlistentry>
                     <term><option>finish-args</option></term>
-                    <listitem><para>An array of arguments passed to the <command>xdg-app build-finish</command> command</para></listitem>
+                    <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>
-                    <listitem><para>Any desktop file with this name will be renamed to a name based on app-id during the cleanup phase.</para></listitem>
+                    <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>
-                    <listitem><para>Any appdata file with this name will be renamed to a name based on app-id during the cleanup phase.</para></listitem>
+                    <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>
-                    <listitem><para>Any icon with this name will be renamed to a name based on app-id during the cleanup phase.</para></listitem>
+                    <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>
@@ -245,6 +245,10 @@
                     <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>
+                    <listitem><para>This is an array containing extra options to pass to xdg-app build.</para></listitem>
+                </varlistentry>
+                <varlistentry>
                     <term><option>strip</option></term>
                     <listitem><para>If this is true (the default is false) then all ELF files will be stripped after install.</para></listitem>
                 </varlistentry>
@@ -254,7 +258,7 @@
                 </varlistentry>
                 <varlistentry>
                     <term><option>arch</option></term>
-                    <listitem><para>This is a dictionary defining for each arch a separate build options object that override the main one</para></listitem>
+                    <listitem><para>This is a dictionary defining for each arch a separate build options object that override the main one.</para></listitem>
                 </varlistentry>
             </variablelist>
         </refsect2>
@@ -273,7 +277,7 @@
                     <listitem><para>The name of the module, used in e.g. build logs</para></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><option></option>sources</term>
+                    <term><option>sources</option></term>
                     <listitem><para>An array of objects defining sources that will be downloaded and extracted in order</para></listitem>
                 </varlistentry>
                 <varlistentry>
@@ -306,11 +310,11 @@
                 </varlistentry>
                 <varlistentry>
                     <term><option>builddir</option></term>
-                    <listitem><para>Force the use of a build dirrectory separated from the source directory.</para></listitem>
+                    <listitem><para>Use a build directory that is separate from the source directory</para></listitem>
                 </varlistentry>
                 <varlistentry>
                     <term><option>subdir</option></term>
-                    <listitem><para>Do building inside this subdirectory of the extracted sources.</para></listitem>
+                    <listitem><para>Build inside this subdirectory of the extracted sources</para></listitem>
                 </varlistentry>
                 <varlistentry>
                     <term><option>build-options</option></term>
@@ -679,7 +683,7 @@
         </para>
 <programlisting>
 {
-    "app-id": "org.test.TestApp",
+    "id": "org.test.TestApp",
     "runtime": "org.freedesktop.Platform",
     "runtime-version": "1.2",
     "sdk": "org.freedesktop.Sdk",