summaryrefslogtreecommitdiffstats
path: root/doc/installation.qdoc
diff options
context:
space:
mode:
authorRobert Griebl <robert.griebl@qt.io>2024-02-07 02:42:37 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2024-03-05 19:18:12 +0000
commit0cdaac7d353e938c5f0b1cc452e82e59dee0e438 (patch)
tree6a7f896d9dd283cf51274eb29d6a7434ffff2595 /doc/installation.qdoc
parent9e9c8ca9527a3a7ae3d96e94bf3bd2ce2f872727 (diff)
Add libdbus to 3rdparty for Windows/macOS
On startup, we check if a libdbus-1 is provided by the system. If not we try to load our build instead, which will then be picked up by QtDBus later on. This enables us to use appman-controller in the QtCreator integration even on Windows and macOS. Change-Id: Ib832198ffd9c9e08e14d3c35cdcb4dff17f3b656 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Dominik Holland <dominik.holland@qt.io> (cherry picked from commit ea49063b02733e3ec8caaf39a610fb70d24d5b0a) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'doc/installation.qdoc')
-rw-r--r--doc/installation.qdoc23
1 files changed, 21 insertions, 2 deletions
diff --git a/doc/installation.qdoc b/doc/installation.qdoc
index 7ec89861..2693a926 100644
--- a/doc/installation.qdoc
+++ b/doc/installation.qdoc
@@ -41,8 +41,6 @@ To build the application manager with all its features, the following components
\list
\li \b Qt 6.5.0 or higher.
- \li \b openssl \e{- Linux only and only if you need the installer functionality}.
- Qt needs to be built with openssl support. The required minimum version is defined by Qt.
\li \b libyaml 2.2 or higher.
\li \b libarchive 3.5 or higher \e{- if you need the installer functionality}.
\endlist
@@ -58,6 +56,20 @@ folder are automatically used instead. Make sure you are aware of the licensing
since these bundled 3rdparty libs will be linked in as static libraries.
This option is not meant for production, but for development and testing environments only.
+\section1 Runtime Requirements
+
+Some libraries used by the application manager are not directly linked in, but instead loaded
+dynamically at runtime:
+
+\list
+ \li \b openssl \e{- Linux only and only if you need the installer functionality}.
+ Qt needs to be built with openssl support. The required minimum version is defined by Qt.
+ \li \b libdbus 1.12 or higher \e{- if you need multi-process mode or appman-controller support}.
+ As libdbus is not readily available for Windows and macOS, the application manager provides
+ its own copy to support the \c appman-controller tool (which is also used by the Qt-Creator
+ integration).
+\endlist
+
\section1 Multi-process vs. Single-process
By default, the application manager always tries to build in multi-process mode, but falls back
@@ -169,6 +181,13 @@ modules:
This gives you readable backtraces for crashes on Windows, but also increases the binary size
slightly. For debug builds, this option is enabled by default.
Settings this to \c no disables building and linking against \c stackwalker.
+\row
+ \li \c{libdbus}
+ \li Windows and macOS only: If set to \c no, enables building \c libdbus-1 from the 3rdparty
+ folder.
+ This will allow you to use the \c appman-controller tool (which is also used by the Qt-Creator
+ integration) on Windows and macOS. This option is enabled by default.
+ Settings this to \c no disables building \c libdbus-1.
\endtable
\section2 The Hardware ID