From d59ee3d4b118747d6e149f39e2d17da8217b0303 Mon Sep 17 00:00:00 2001 From: Niels Weber Date: Fri, 8 Jun 2012 09:30:40 +0200 Subject: Bring documentation of Repositories tag in line with the code. Remove obsolete option, add missing options. Change-Id: I4d34c7dcbb222243b35bb5362db9222c96e30dcc Reviewed-by: Karsten Heimrich Reviewed-by: Tim Jenssen --- doc/installerfw.qdoc | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index f55aa2de5..00fa04c37 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -207,10 +207,7 @@ \o RemoteRepositories \o List of remote repositories. You can add several \c Repository sections that each specify the \c Url to access the repository. - Optionally, you can add a \c Required section to specify whether - the installer should go ahead even if it cannot access the - server. Acceptable values are \c true and \c false. For more - information, see \l{Configuring Repositories}. + For more information, see \l{Configuring Repositories}. \row \o UninstallerName \o Filename of the generated uninstaller. Defaults to @@ -757,9 +754,6 @@ \o URL, which points to a list of available components. - \o Required, which determines whether the repository must be available - during the installation. - \endlist The URL needs to point to the Updates.xml file that lists the available @@ -769,17 +763,22 @@ http://www.yourcompany.com/packages + 1 + user + password \endcode - The \a Required setting specifies whether the installer should go ahead even - if it cannot access the server. If you set \c Required to \c true, the - installer works only if it can access the repository. If the repository is + The installer works only if it can access the repository. If the repository is accessed after the installation, the maintenance tool rejects installation. - However, uninstallation is still possible. If you set it to \c false, the - installer continues to work, but excludes any configuration that should - be on the server. + However, uninstallation is still possible. + A repository can be enabled or disabled by default. + For repositories requiring authentication, the details can also be set here, + although entering a password here is usually not advisable as it is saved in plain + text. Authentication details not set here will be gotten at runtime using a dialog. + The user can work around these settings at runtime. + \section1 Creating Installer Binaries -- cgit v1.2.3