diff options
| author | Joerg Bornemann <joerg.bornemann@qt.io> | 2024-01-31 08:50:58 +0100 |
|---|---|---|
| committer | Joerg Bornemann <joerg.bornemann@qt.io> | 2024-01-31 15:19:50 +0100 |
| commit | b8a78054cf540f082766b1a4d76e42426c1edff9 (patch) | |
| tree | 014dba4a31524efefe810f52dc82c7bafc9e2748 /src/corelib/doc | |
| parent | 1902f98a9d02d576d38059081a395d9cf6a342af (diff) | |
Doc: Address QT_DEPLOY_LIBEXEC_DIR issues from API review
Pick-to: 6.7
Task-number: QTBUG-121708
Change-Id: I25a05fc26e9950a8b84770347dbcea1912832990
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'src/corelib/doc')
| -rw-r--r-- | src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc | 13 | ||||
| -rw-r--r-- | src/corelib/doc/src/includes/cmake-deploy-modified-variable-values.qdocinc | 2 |
2 files changed, 8 insertions, 7 deletions
diff --git a/src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc b/src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc index 924e2b1a2e..ac5094e7cb 100644 --- a/src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc +++ b/src/corelib/doc/src/cmake/cmake-deploy-variables.qdoc @@ -104,15 +104,14 @@ should not be used for that scenario. \include cmake-deploy-var-usage.qdocinc -\cmakevariablesince 6.8 +\cmakevariablesince 6.7 -Projects should use \c QT_DEPLOY_LIBEXEC_DIR in their deploy scripts to avoid -hard-coding a particular directory in which to deploy the following types of -binaries: +On Unix derivatives, projects should use \c QT_DEPLOY_LIBEXEC_DIR in their +deploy scripts to avoid hard-coding a particular directory in which to deploy +helper executables that are local to the project. -\list -\li Helper executables that are local to the project on Unix derivatives. -\endlist +For example, projects using QtWebEngine would deploy the \c QtWebEngineProcess +executable to this directory. \c QT_DEPLOY_LIBEXEC_DIR defaults to the value of \c${CMAKE_INSTALL_LIBEXECDIR} (usually \c{libexec}), which is provided by CMake's \l{GNUInstallDirs} module. diff --git a/src/corelib/doc/src/includes/cmake-deploy-modified-variable-values.qdocinc b/src/corelib/doc/src/includes/cmake-deploy-modified-variable-values.qdocinc index 055aff968d..632ddf756f 100644 --- a/src/corelib/doc/src/includes/cmake-deploy-modified-variable-values.qdocinc +++ b/src/corelib/doc/src/includes/cmake-deploy-modified-variable-values.qdocinc @@ -2,6 +2,8 @@ cmake_minimum_required(VERSION 3.16...3.22) project(MyThings) +# The following CMAKE_INSTALL_*DIR variables are used to initialize their +# QT_DEPLOY_*_DIR counterparts. set(CMAKE_INSTALL_BINDIR "mybindir") set(CMAKE_INSTALL_LIBDIR "mylibdir") set(CMAKE_INSTALL_LIBEXECDIR "mylibexecdir") |