1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Add table for *_DIR parameters of qt_deploy_runtime_dependencies

Browse Source 
The tables allows us to show how the parameters correspond to variables,
and it gives us the ability to add notes.

Add the note that LIBEXEC_DIR is available since 6.7.

Task-number: QTBUG-121708
Change-Id: I9421bdc692b0df45dc356c17fb90da8799d18ef9
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
(cherry picked from commit 313b7c56bd4f2053483c1addea89d8e293bc433b)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Joerg Bornemann 2024-01-31 09:25:51 +01:00 committed by Qt Cherry-pick Bot
parent 01a0b81998
commit b09c637c49
1 changed files with 35 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
src/corelib/doc/src/cmake/qt_deploy_runtime_dependencies.qdoc
View File

@ -104,13 +104,41 @@ directory structure. If the \c{GENERATE_QT_CONF} option is given, an appropriate
\c{qt.conf} file will be written to the same directory as the \c{executable}.
The paths in that \c{qt.conf} file will be based on the \c{CMAKE_INSTALL_xxxDIR}
variables, whose defaults are provided by CMake's \l{GNUInstallDirs} module.
You can override some of those defaults with the \c{BIN_DIR}, \c{LIBEXEC_DIR},
\c{LIB_DIR}, \c{PLUGINS_DIR}, and \c{QML_DIR} options, all of which are expected
to be relative to the base install location. A \c{qt.conf} file is always
written if \c{executable} is a macOS app bundle, regardless of whether or not
\c{GENERATE_QT_CONF} is provided. The \c{..._DIR} options are also ignored in
that case, since the directory layout of an app bundle is dictated by Apple's
requirements.
You can override some of those defaults with the parameters in the following
table, all of which are expected to be relative to the base install location.
\table
\header
\li parameter
\li affected variable
\li notes
\row
\li \c BIN_DIR
\li \l QT_DEPLOY_BIN_DIR
\li
\row
\li \c LIBEXEC_DIR
\li \l QT_DEPLOY_LIBEXEC_DIR
\li since Qt 6.7
\row
\li \c LIB_DIR
\li \l QT_DEPLOY_LIB_DIR
\li
\row
\li \c PLUGINS_DIR
\li \l QT_DEPLOY_PLUGINS_DIR
\li
\row
\li \c QML_DIR
\li \l QT_DEPLOY_QML_DIR
\li
\endtable
A \c{qt.conf} file is always written if \c{executable} is a macOS app bundle,
regardless of whether or not \c{GENERATE_QT_CONF} is provided. The \c{..._DIR}
options are also ignored in that case, since the directory layout of an app
bundle is dictated by Apple's requirements.
More verbose output about the deployment steps can be enabled by providing the
\c{VERBOSE} option. Alternatively, the \l{QT_ENABLE_VERBOSE_DEPLOYMENT}