diff options
Diffstat (limited to 'src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc')
-rw-r--r-- | src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc | 63 |
1 files changed, 23 insertions, 40 deletions
diff --git a/src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc b/src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc index abd1991b13..45fd8f4c5f 100644 --- a/src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc +++ b/src/corelib/doc/src/cmake/qt_deploy_qt_conf.qdoc @@ -1,36 +1,12 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_deploy_qt_conf.html +\page qt-deploy-qt-conf.html \ingroup cmake-commands-qtcore \title qt_deploy_qt_conf -\target qt_deploy_qt_conf +\keyword qt6_deploy_qt_conf \summary {Write a qt.conf file at deployment time.} @@ -40,12 +16,15 @@ Unlike most other CMake commands provided by Qt, \c{qt_deploy_qt_conf()} can only be called from a deployment script. It cannot be called directly by the project. -\preliminarycmakecommand +\cmakecommandsince 6.3 +\note This command does not usually need to be called directly. It is used + internally by other higher level commands, but projects wishing to + implement more customized deployment logic may find it useful. \section1 Synopsis \badcode -qt_deploy_qt_conf(file_name +qt_deploy_qt_conf(file_path [PREFIX prefix] [DOC_DIR doc_dir] [HEADERS_DIR headers_dir] @@ -65,28 +44,32 @@ qt_deploy_qt_conf(file_name \section1 Description -Use this command when you need to generate a \c{Using qt.conf}{qt.conf} file +Use this command when you need to generate a \l{Using qt.conf}{qt.conf} file during deployment. The default value of any path supported by \c{qt.conf} can be overridden with the corresponding \c{..._DIR} option. The command will only write a path to the generated \c{qt.conf} file if it differs from the default value. +The default values can be found at \l{Overriding Paths}. -This command does not usually need to be called directly. It is used internally -by other higher level commands, but projects wishing to implement more -customized deployment logic may find it useful. +The \c file_path argument expects an absolute path to the location where the +\c qt.conf file should be written to. The \l{QT_DEPLOY_PREFIX} and \l{QT_DEPLOY_BIN_DIR} +variables can be used to dynamically specify a path relative to the deployment binary directory, +as shown in the example below. This helps avoid hard-coding an absolute path. \sa {qt6_generate_deploy_app_script}{qt_generate_deploy_app_script()}, - qt_deploy_runtime_dependencies() + {qt6_deploy_runtime_dependencies}{qt_deploy_runtime_dependencies()} \section1 Example \badcode # The following script must only be executed at install time -set(deploy_script "${CMAKE_CURRENT_BINARY_DIR}/deploy_custom.cmake") - -file(GENERATE OUTPUT ${deploy_script} CONTENTS " -include(\"${QT_DEPLOY_SUPPORT}\") -qt_deploy_qt_conf(\"\${QT_DEPLOY_BIN_DIR}/qt.conf\") +qt_generate_deploy_script( + OUTPUT_SCRIPT deploy_script + CONTENT " +qt_deploy_qt_conf(\"\${QT_DEPLOY_PREFIX}/\${QT_DEPLOY_BIN_DIR}/qt.conf\" + DATA_DIR \"./custom_data_dir\" + TRANSLATIONS_DIR \"./custom_translations_dir\" +) ") install(SCRIPT ${deploy_script}) |