diff options
author | Robert Griebl <robert.griebl@qt.io> | 2022-09-27 14:33:52 +0200 |
---|---|---|
committer | Robert Griebl <robert.griebl@qt.io> | 2022-09-27 12:50:36 +0000 |
commit | 81b9b03ac7f302f87bbeea61c03678167e3f5ef3 (patch) | |
tree | fc3713c1be5ceeb4de4d948e2cb64b58e634891d | |
parent | b14487e23dead810f3cec41e552946992d5f4c4e (diff) | |
download | qtapplicationmanager-81b9b03ac7f302f87bbeea61c03678167e3f5ef3.tar.gz |
Fix a few documentation inconsistencies
Change-Id: I33b43f1af4f052ef70fdad80b6abf8cec91f5930
Pick-to: 6.4 6.3 6.2
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
-rw-r--r-- | doc/controller.qdoc | 2 | ||||
-rw-r--r-- | doc/installer.qdoc | 7 | ||||
-rw-r--r-- | doc/online/style/qt5-sidebar.html | 1 | ||||
-rw-r--r-- | doc/packager.qdoc | 5 | ||||
-rw-r--r-- | src/manager-lib/packagemanager.cpp | 3 |
5 files changed, 11 insertions, 7 deletions
diff --git a/doc/controller.qdoc b/doc/controller.qdoc index 68280efa..cb34f67f 100644 --- a/doc/controller.qdoc +++ b/doc/controller.qdoc @@ -6,7 +6,7 @@ /*! \page appman-controller.html \title Controller -\brief A command-line utility to trigger the installation of a specified package on a target device. +\brief A command-line utility to remote control the application manager on a target device. \ingroup qtappman-tools The \c{appman-controller} is a command-line utility that can be used by the developer, or diff --git a/doc/installer.qdoc b/doc/installer.qdoc index c294f2b9..af68574b 100644 --- a/doc/installer.qdoc +++ b/doc/installer.qdoc @@ -8,9 +8,8 @@ \page installer.html \ingroup qtappman \ingroup qtappman-highlights -\ingroup qtappman-tools -\title Package Installer -\brief Discusses the installer tool which dynamically installs, updates and removes packages. +\title Package Installation +\brief Discusses the package installation infrastructure. \keyword Installer \section1 Dynamically Installing, Updating, and Removing Packages @@ -80,7 +79,7 @@ For the device, you need to install one or both of these CA certificates, includ intermediary ones. But, this depends on the type of package you want the user to be able to install. Which CA certificates to load is specified via \l {ca certificates} {the config file}. -The application manager sources has a script, +The application manager sources have a script, \c tests/data/certificates/create-test-certificates.sh, that sets up such a PKI for the internal unit tests. This script is \b not for use in production, but only for use in developing with signed packages. diff --git a/doc/online/style/qt5-sidebar.html b/doc/online/style/qt5-sidebar.html index d7f9f3d5..33679de9 100644 --- a/doc/online/style/qt5-sidebar.html +++ b/doc/online/style/qt5-sidebar.html @@ -25,7 +25,6 @@ </div> <ul> <li><a href="appman-controller.html">Controller</a></li> - <li><a href="installer.html">Package Installer</a></li> <li><a href="appman-packager.html">Packager</a></li> </ul> </div> diff --git a/doc/packager.qdoc b/doc/packager.qdoc index db49d7a3..ecdcac76 100644 --- a/doc/packager.qdoc +++ b/doc/packager.qdoc @@ -7,7 +7,7 @@ \page appman-packager.html \title Packager -\brief A command-line utility to manage the installation of packages. +\brief A command-line utility to create and sign application packages. \ingroup qtappman-tools The \c{appman-packager} is a command-line utility that can be used by the developer to manage @@ -19,6 +19,9 @@ Currently, the application manager supports unsigned packages, packages that are developer only (development mode), and packages that are signed by a trusted app-store. The \c{appman-packager} can create all these variations with the following commands: +Please also see the \l{Package Installation} documentation for more in-depth information about +package installations. + \table \header \li Command diff --git a/src/manager-lib/packagemanager.cpp b/src/manager-lib/packagemanager.cpp index ef08dcfd..4d5f05a3 100644 --- a/src/manager-lib/packagemanager.cpp +++ b/src/manager-lib/packagemanager.cpp @@ -43,6 +43,9 @@ part of the application manager. It provides both a DBus and QML APIs for all of its functionality. + Please also see the \l{Package Installation} documentation for more in-depth information about + package installations. + \note Unlike the deprecated ApplicationInstaller class, the PackageManager singleton and its corresponding DBus API are always available. Disabling the installer functionality via the application manager's \l{Configuration} will just lead to package (de-) installations |