path: root/doc
diff options
authorKai Koehne <>2013-02-19 14:34:49 +0100
committerKai Koehne <>2013-02-21 12:35:53 +0100
commit731b2dd006f5089f9bd22e90568a296984211bad (patch)
tree221030d7111946424622e466c9a0d0ac65086c63 /doc
parent5c2d700cb134b34dbfb5b92e33ab86d1f6b03125 (diff)
Update Installer File section
Change-Id: Id765ac4aa5cb99470ded495605c33059e913a42f Reviewed-by: Leena Miettinen <> Reviewed-by: Karsten Heimrich <> Reviewed-by: Niels Weber <>
Diffstat (limited to 'doc')
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 2c0836e59..ad139812e 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -138,17 +138,19 @@
\title Configuration File
- A configuration file called \c config.xml specifies how to build the
- installer binaries and online repositories. The file is located in the
+ The configuration file customizes the UI and behavior of an installer.
+ The file is typically called \c config.xml and located in the
\c config directory.
- \section1 Configuration File Syntax
+ A minimal configuration file consists of an \c <Installer> root element
+ with \c <Name> and \c <Version> elements as children. All other elements
+ are optional, and can appear in arbitrary order.
- The configuration file has the following syntax:
+ The following example shows a typical configuration file:
\quotefile examples/config.xml
- \section2 Summary of Configuration Settings
+ \section1 Supported Configuration Settings
The following table summarizes the settings in the configuration file.
@@ -172,7 +174,7 @@
\o Name of the installer as displayed on the title bar.
\o Publisher
- \o Publisher of the software.
+ \o Publisher of the software (as shown in the Windows Control Panel).
\o ProductUrl
\o URL to a page that contains product information on your web