From 4d8d5273a2434c60562cae13c0a08d4bc2fd642f Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Date: Wed, 27 May 2015 17:10:40 +0200
Subject: Doc: add docs for devtool

Change-Id: Iadb453a02b331bb2cf9f8f0a4e1fe66052abe264
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
---
 doc/installerfw.qdoc | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 37d01bec9..6d9052316 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -710,6 +710,8 @@
 
         \li \l archivegen
 
+        \li \l devtool
+
     \endlist
 
     \section1 installerbase
@@ -930,6 +932,53 @@
     Where \e <name.7z> is the path and file name of the archive to create and
     \e <data> contains the paths and names of the files or directories to
     package into the archive, separated by spaces.
+
+    \section1 devtool
+
+    You can use \c devtool to update an existing installer or maintenance tool
+    with a new installer base, to dump binary content from an installer or
+    maintenance tool to a target, and to execute operations. For a summary of
+    available operations, see \l {Operations}.
+
+    \c devtool expects the following parameters in the following order:
+
+    \code
+    devtool [options] binary
+    \endcode
+
+    Where \e binary is the path and name of an existing installer or maintenance
+    tool.
+
+    \section2 Summary of devtool Parameters
+
+    \table
+        \header
+            \li Parameter
+            \li Use
+        \row
+            \li -?, -h, --help
+            \li Display help.
+        \row
+            \li -v, --version
+            \li Display version information.
+        \row
+            \li --verbose
+            \li Display additional information.
+        \row
+            \li --update <file>
+            \li Update an existing installer or maintenance tool with a new
+                installer base.
+        \row
+            \li --dump <folder>
+            \li Dump the binary content that belongs to an installer or
+                maintenance tool into the target.
+        \row
+            \li --operation <mode,name,args,...>
+            \li Execute an operation with a list of arguments.
+
+                \c mode can be \c DO or \c UNDO, depending on whether the step
+                contains instructions for the installer or uninstaller.
+    \endtable
 */
 
 /*!
-- 
cgit v1.2.1