summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Griebl <robert.griebl@qt.io>2022-09-27 14:33:52 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-09-27 17:53:25 +0000
commite9b2a9f42a1d40a84cd29d444d4f2608b618e7a7 (patch)
tree12917bd7283c6c647a709d426f1f61467f982cf0
parent97985f198d76aca6211fa8f257523e74d2b5037b (diff)
downloadqtapplicationmanager-e9b2a9f42a1d40a84cd29d444d4f2608b618e7a7.tar.gz
Fix a few documentation inconsistencies
Change-Id: I33b43f1af4f052ef70fdad80b6abf8cec91f5930 Reviewed-by: Dominik Holland <dominik.holland@qt.io> (cherry picked from commit 81b9b03ac7f302f87bbeea61c03678167e3f5ef3) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--doc/controller.qdoc2
-rw-r--r--doc/installer.qdoc7
-rw-r--r--doc/online/style/qt5-sidebar.html1
-rw-r--r--doc/packager.qdoc5
-rw-r--r--src/manager-lib/packagemanager.cpp3
5 files changed, 11 insertions, 7 deletions
diff --git a/doc/controller.qdoc b/doc/controller.qdoc
index 7986e1dc..6486effb 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 d228b696..a641e99b 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