summaryrefslogtreecommitdiffstats
path: root/doc/installerfw.qdoc
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@theqtcompany.com>2015-01-23 15:19:52 +0100
committerKai Koehne <kai.koehne@theqtcompany.com>2015-03-11 12:33:04 +0000
commit2eb21e190b6ff2813be1a0ae5eb1542699073304 (patch)
treeec66454bd24a768953c6888e101f1b1b897b0692 /doc/installerfw.qdoc
parent4aacfb8e11f5862797757d14f34964a05e2d9b1f (diff)
Update repogen documentation
Change-Id: I098b02f1fc0df4c3e2b09c5f97914be9c479d751 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Diffstat (limited to 'doc/installerfw.qdoc')
-rw-r--r--doc/installerfw.qdoc46
1 files changed, 25 insertions, 21 deletions
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index ec0fd005b..109d44dc4 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -872,38 +872,42 @@
\row
\li -p or --packages directory
\li Use \c directory as the \l{Package Directory Structure}
- {package directory}.
- Defaults to the current working directory.
+ {package directory}. This is mandatory.
\row
\li repository directory
- \li Target directory to generate the repository. Must not yet exist.
- \row
- \li components
- \li List of components to place into the repository. Includes
- dependencies.
+ \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
+ overwritten or removed. This is mandatory.
\row
\li -e or --exclude p1,...,pn
- \li Comma-separated list of packages to be retrieved from an online
- repository. The packages are not included in the installer
- binary.
+ \li Comma-separated list of packages to be ignored from the set of
+ all packages in the packages directory.
+ \row
+ \li -i or --include p1,...,pn
+ \li Comma-separated list of packages to be used from the set of
+ all packages in the packages directory.
\row
\li --update
- \li Place only the specified packages in the repository, without
- their dependencies. Make sure to also add the Updates.xml from
- the repository to update. This option adds the files that you list
- in the \c {--include} parameter to the end of the Updates.xml file.
+ \li Update all packages in the packages directory. The list can be further
+ filtered with the \c {-i}, \c {-e} parameters.
+ \row
+ \li --update-new-packages
+ \li Update only packages that are new or have a newer version. The
+ list can be further filtered with the \c {-i}, \c{-e}
+ parameters.
+ \row
+ \li -r or --remove
+ \li Force removal of existing target directory before generating it again.
\row
\li -v or --verbose
\li Display debug output.
\endtable
- \note We recommend that you use the \c {--update} parameter to update an
- existing repository, especially if you have a content delivery system.
- In combination with the \c {--include} parameter which gets only the components
- with incremented version numbers it generates an update which contains
- only new files.
- This helps you avoid updating components that have not changed and
+ \note We recommend that you use the \c {--update-new-packages} parameter
+ to update an existing repository, especially if you have a content delivery
+ system. This helps you avoid updating components that have not changed and
this makes it much easier for a content delivery system to distribute only
- new files, because only the updated components are assigned new SHA checksums.
+ new files, because only the updated components are assigned new SHA
+ checksums.
\section1 archivegen