From fb284a3c47c77cbb9669ac8b2558c39bc0db5b83 Mon Sep 17 00:00:00 2001 From: Alexandru Croitor Date: Thu, 18 Aug 2022 16:54:30 +0200 Subject: [PATCH] CMake: Tidy up documentation regarding android library collection MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pick-to: 6.3 6.4 Change-Id: I3167855ef3a390a51d7bb0c703f47392b07cb2ac Reviewed-by: Jörg Bornemann Reviewed-by: Paul Wicking --- src/corelib/Qt6AndroidMacros.cmake | 8 ++++---- .../doc/src/cmake/qt_finalize_project.qdoc | 16 ++++++++++------ 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/src/corelib/Qt6AndroidMacros.cmake b/src/corelib/Qt6AndroidMacros.cmake index 7e1579c7a13..c0a7ddcc481 100644 --- a/src/corelib/Qt6AndroidMacros.cmake +++ b/src/corelib/Qt6AndroidMacros.cmake @@ -587,8 +587,8 @@ function(_qt_internal_collect_apk_dependencies_defer) endif() endfunction() -# The function collects shared libraries from the build system tree, that might be dependencies for -# the main apk targets. +# The function collects project-built shared libraries that might be dependencies for +# the main apk targets. It stores their locations in a global custom target property. function(_qt_internal_collect_apk_dependencies) # User opted-out the functionality if(QT_NO_COLLECT_BUILD_TREE_APK_DEPS) @@ -631,8 +631,8 @@ function(_qt_internal_collect_apk_dependencies) ) endfunction() -# The function recursively goes through the project subfolders and collects targets that supposed to -# be shared libraries of any kind. +# This function recursively walks the current directory and its subdirectories to collect shared +# library targets built in those directories. function(_qt_internal_collect_buildsystem_shared_libraries out_var subdir) set(result "") get_directory_property(buildsystem_targets DIRECTORY ${subdir} BUILDSYSTEM_TARGETS) diff --git a/src/corelib/doc/src/cmake/qt_finalize_project.qdoc b/src/corelib/doc/src/cmake/qt_finalize_project.qdoc index 62af36c9175..5cd6a9fdaf0 100644 --- a/src/corelib/doc/src/cmake/qt_finalize_project.qdoc +++ b/src/corelib/doc/src/cmake/qt_finalize_project.qdoc @@ -8,7 +8,7 @@ \title qt_finalize_project \target qt6_finalize_project -\summary {Handles various common platform-specific tasks associated with Qt project.} +\summary {Handles various common platform-specific tasks associated with a Qt project.} \preliminarycmakecommand \include cmake-find-package-core.qdocinc @@ -26,13 +26,17 @@ qt_finalize_project() \section1 Description Some targets that are created using Qt commands require additional actions -at the end of CMake configuring phase. Depending on the platform the function -typically walks through the build tree, resolves dependencies between targets -created by the user, and applies extra deployment steps. +at the end of CMake configuring phase. +Depending on the platform, the function typically: +\list + \li Walks the build tree. + \li Resolves dependencies. + \li Applies any extra deployment steps. +\endlist -With CMake versions 3.19 and higher, you don't need to call this command since +With CMake version 3.19 or later, you don't need to call this command since it consists of sub-commands that are ordinarily invoked at the end of -\c CMAKE_SOURCE_DIR scope. +\c CMAKE_SOURCE_DIR directory scope processing. \include cmake-android-qt-finalize-project-warning.qdocinc