diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/images/ifw-repository-categories.png | bin | 0 -> 58532 bytes | |||
| -rw-r--r-- | doc/includes/installerfw-examples-generating-online.qdocinc | 18 | ||||
| -rw-r--r-- | doc/installerfw.qdoc | 60 | ||||
| -rw-r--r-- | doc/scripting-api/qdesktopservices.qdoc | 8 |
4 files changed, 86 insertions, 0 deletions
diff --git a/doc/images/ifw-repository-categories.png b/doc/images/ifw-repository-categories.png Binary files differnew file mode 100644 index 000000000..afed7c1b9 --- /dev/null +++ b/doc/images/ifw-repository-categories.png diff --git a/doc/includes/installerfw-examples-generating-online.qdocinc b/doc/includes/installerfw-examples-generating-online.qdocinc new file mode 100644 index 000000000..f623b1d22 --- /dev/null +++ b/doc/includes/installerfw-examples-generating-online.qdocinc @@ -0,0 +1,18 @@ + \section1 Generating the Example Installer + + To create the example installer, switch to the example source directory on + the command line and enter the following command: + + \list + \li On Windows: + \code + ..\..\bin\binarycreator.exe --online-only -c config\config.xml -p packages installer.exe + \endcode + \li On Linux or macOS: + \code + ../../bin/binarycreator --online-only -c config/config.xml -p packages installer + \endcode + \endlist + + You should now be able to run the installer and install from the repository. + diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index 23d0c9e47..bdd99c089 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -266,6 +266,10 @@ elements that each contain the \c <Url> child element that specifies the URL to access the repository. For more information, see \l{Configuring Repositories}. \row + \li RepositoryCategories + \li Name of a category that can contain a list of \c <RemoteRepositories> child elements. + For more information, see \l{Configuring Repository Categories}. + \row \li MaintenanceToolName \li Filename of the generated maintenance tool. Defaults to \e maintenancetool. The platform-specific executable file extension is @@ -324,6 +328,11 @@ \row \li SupportsModify \li Set to \c false if the product does not support modifying an existing installation. + \row + \li SaveDefaultRepositories + \li Set to \c false if default repositories \c <RemoteRepositories> should not be saved to \e {MaintenanceToolName}.ini. + By default default repositories are saved. Not saving the repositories means than when you run \e maintenancetool + there are no default repositories in use. \endtable @@ -691,6 +700,9 @@ \li Checkable \li Set to \c false if you want to hide the checkbox for an item. This is useful when only a few subcomponents should be selected instead of all. Optional. + \row + \li ExpandedByDefault + \li Set to \c true if you want this item to be expanded by default. Optional. \endtable @@ -822,6 +834,11 @@ {package directory}. Defaults to the current working directory. \row + \li --repository directory + \li Use \c directory as the repository directory + with packages to repack. + This entry can be given multiple times. + \row \li -n or --online-only \li Compile without any component in the installer binary. \row @@ -853,6 +870,10 @@ \li Ignore component or package directories that do not have valid metadata information (package.xml) to make testing faster. \row + \li --ignore-invalid-repositories + \li Ignore repository directories that do not have valid + metadata information (Updates.xml) instead of aborting. + \row \li -v or --verbose \li Display debug output. @@ -906,6 +927,9 @@ specify the location in the installer configuration file when creating an installer for it. + You can use an existing repository to repack packages to another + repository or offline installer. + \section2 Summary of repogen Parameters \table @@ -917,6 +941,12 @@ \li Use \c directory as the \l{Package Directory Structure} {package directory}. This is mandatory. \row + \li --repository directory + \li Use \c directory as the repository directory + with packages to repack (not to confuse with the mandatory target + repository directory). + This entry can be given multiple times. + \row \li repository directory \li Target directory for the repository. During an initial installation, the directory must not yet exist. When updating, the directory may exist and its contents may be @@ -1088,6 +1118,36 @@ text. Authentication details not set here will be gotten at runtime using a dialog. The user can work around these settings at runtime. + \section1 Configuring Repository Categories + + The \c <RepositoryCategory> element in the installer configuration file + (config.xml) can contain a list of several \c <RemoteRepositories> elements. Each \c <RemoteRepositories> + element within the \c <RepositoryCagetory> element is considered a category, which has a \c <DisplayName> and can + contain several \c <Repository> elements. Repository categories are shown in the component selection page, + on the left side of the component selection widget: + + \image ifw-repository-categories.png "Component selection Page" + + By default, only repositories with no category are shown in the component selection widget. Checking one or + several repositories and pressing \uicontrol Fetch will update the widget to show content also + from the selected categorized repositories. + + Example of creating a repository category: + + \code + <RepositoryCategories> + <RemoteRepositories> + <Displayname>Category 1</Displayname> + <Repository> + <Url>http://www.example.com/packages</Url> + <Enabled>1</Enabled> + <Username>user</Username> + <Password>password</Password> + <DisplayName>Example repository</DisplayName> + </Repository> + </RemoteRepositories> + </RepositoryCategories> + \endcode \section1 Creating Installer Binaries diff --git a/doc/scripting-api/qdesktopservices.qdoc b/doc/scripting-api/qdesktopservices.qdoc index 037a0b6dd..7c2b31ea3 100644 --- a/doc/scripting-api/qdesktopservices.qdoc +++ b/doc/scripting-api/qdesktopservices.qdoc @@ -99,3 +99,11 @@ Returns the specified \a location. */ + +/*! + \qmlmethod array QDesktopServices::findFiles(string path, string pattern) + + Returns file names matching \a pattern. Searches the files recursively from \a path. + \a Pattern understands * and ? wildcards. +*/ + |
