From b34be3868bd0933813f02c6a0fcbb5afd18b4105 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kai=20K=C3=B6hne?= Date: Mon, 29 Nov 2021 16:41:58 +0100 Subject: Doc: Use find_package(Qt6 REQUIRED COMPONENTS ...) idiom Using REQUIRED as a prefix instead of suffix works better with OPTIONAL_COMPONENTS, and is also the order in the CMake manual. Task-number: QTBUG-98867 Pick-to: 6.2 Change-Id: I1ab68408b95d8edf06272a3b9fceccd8d8e597fc Reviewed-by: Alexey Edelev --- src/concurrent/doc/snippets/CMakeLists.txt | 2 +- src/corelib/doc/snippets/overview/using-qt-core.cmake | 2 +- src/corelib/doc/snippets/resource-system/CMakeLists.txt | 2 +- src/corelib/doc/src/cmake/cmake-commands.qdoc | 2 +- src/corelib/doc/src/cmake/cmake-configure-variables.qdoc | 2 +- src/dbus/doc/snippets/CMakeLists.txt | 2 +- src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc | 2 +- src/dbus/doc/src/qtdbus-cmake.qdoc | 2 +- src/gui/doc/snippets/overview/using-qt-gui.cmake | 2 +- src/network/doc/snippets/CMakeLists.txt | 2 +- src/opengl/doc/snippets/CMakeLists.txt | 2 +- src/printsupport/doc/snippets/CMakeLists.txt | 2 +- src/sql/doc/snippets/CMakeLists.txt | 2 +- src/testlib/doc/snippets/CMakeLists.txt | 2 +- src/testlib/doc/snippets/code/doc_src_cmakelists.txt | 2 +- src/widgets/doc/snippets/CMakeLists.txt | 2 +- src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc | 2 +- src/xml/doc/snippets/CMakeLists.txt | 2 +- 18 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/concurrent/doc/snippets/CMakeLists.txt b/src/concurrent/doc/snippets/CMakeLists.txt index ffbf3014c9..1b0879a79f 100644 --- a/src/concurrent/doc/snippets/CMakeLists.txt +++ b/src/concurrent/doc/snippets/CMakeLists.txt @@ -1,4 +1,4 @@ #! [cmake_use] -find_package(Qt6 COMPONENTS Concurrent REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Concurrent) target_link_libraries(mytarget PRIVATE Qt6::Concurrent) #! [cmake_use] diff --git a/src/corelib/doc/snippets/overview/using-qt-core.cmake b/src/corelib/doc/snippets/overview/using-qt-core.cmake index a2c2034b8b..6e4b8d8028 100644 --- a/src/corelib/doc/snippets/overview/using-qt-core.cmake +++ b/src/corelib/doc/snippets/overview/using-qt-core.cmake @@ -1,2 +1,2 @@ -find_package(Qt6 COMPONENTS Core REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Core) target_link_libraries(mytarget PRIVATE Qt6::Core) diff --git a/src/corelib/doc/snippets/resource-system/CMakeLists.txt b/src/corelib/doc/snippets/resource-system/CMakeLists.txt index a488d869e6..96bfe787dc 100644 --- a/src/corelib/doc/snippets/resource-system/CMakeLists.txt +++ b/src/corelib/doc/snippets/resource-system/CMakeLists.txt @@ -1,6 +1,6 @@ project(my_app) cmake_minimum_required(VERSION 3.16) -find_package(Qt6 COMPONENTS Widgets Qml REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Widgets Qml) #! [AUTORCC] set(CMAKE_AUTORCC ON) diff --git a/src/corelib/doc/src/cmake/cmake-commands.qdoc b/src/corelib/doc/src/cmake/cmake-commands.qdoc index 63edcbe10d..646f237590 100644 --- a/src/corelib/doc/src/cmake/cmake-commands.qdoc +++ b/src/corelib/doc/src/cmake/cmake-commands.qdoc @@ -33,7 +33,7 @@ The following CMake commands are defined when Qt6::Core is loaded, for instance with \code -find_package(Qt6 COMPONENTS Core REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Core) \endcode \sa{CMake Command Reference} diff --git a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc index dab62cbcba..52e2549725 100644 --- a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc +++ b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc @@ -39,7 +39,7 @@ The following CMake variables are defined when Qt6::Core is loaded, for instance with \badcode -find_package(Qt6 COMPONENTS Core REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Core) \endcode \sa{CMake Variable Reference} diff --git a/src/dbus/doc/snippets/CMakeLists.txt b/src/dbus/doc/snippets/CMakeLists.txt index 825a088019..516a3cd67c 100644 --- a/src/dbus/doc/snippets/CMakeLists.txt +++ b/src/dbus/doc/snippets/CMakeLists.txt @@ -1,4 +1,4 @@ #! [cmake_use] -find_package(Qt6 COMPONENTS DBus REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS DBus) target_link_libraries(mytarget PRIVATE Qt6::DBus) #! [cmake_use] diff --git a/src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc b/src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc index d72102831e..1ed1c6a8ec 100644 --- a/src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc +++ b/src/dbus/doc/src/includes/cmake-find-package-dbus.qdocinc @@ -1,5 +1,5 @@ The command is defined in the \c DBus component of the \c Qt6 package. Load the package with: \code -find_package(Qt6 COMPONENTS DBus REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS DBus) \endcode diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc index 92b0e700ff..c35543c113 100644 --- a/src/dbus/doc/src/qtdbus-cmake.qdoc +++ b/src/dbus/doc/src/qtdbus-cmake.qdoc @@ -33,7 +33,7 @@ The following CMake commands are defined when Qt6::DBus is loaded, for instance with \code -find_package(Qt6 COMPONENTS DBus REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS DBus) \endcode \sa{CMake Command Reference} diff --git a/src/gui/doc/snippets/overview/using-qt-gui.cmake b/src/gui/doc/snippets/overview/using-qt-gui.cmake index 65a3f9034a..4f774c43ff 100644 --- a/src/gui/doc/snippets/overview/using-qt-gui.cmake +++ b/src/gui/doc/snippets/overview/using-qt-gui.cmake @@ -1,2 +1,2 @@ -find_package(Qt6 COMPONENTS Gui REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) diff --git a/src/network/doc/snippets/CMakeLists.txt b/src/network/doc/snippets/CMakeLists.txt index 5128943331..203cadad26 100644 --- a/src/network/doc/snippets/CMakeLists.txt +++ b/src/network/doc/snippets/CMakeLists.txt @@ -7,6 +7,6 @@ add_executable(mytarget ) # ![0] -find_package(Qt6 COMPONENTS Network REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Network) target_link_libraries(mytarget PRIVATE Qt6::Network) # ![0] diff --git a/src/opengl/doc/snippets/CMakeLists.txt b/src/opengl/doc/snippets/CMakeLists.txt index 28b641adfd..aff5f13c15 100644 --- a/src/opengl/doc/snippets/CMakeLists.txt +++ b/src/opengl/doc/snippets/CMakeLists.txt @@ -1,4 +1,4 @@ #! [cmake_use] -find_package(Qt6 COMPONENTS OpenGL REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS OpenGL) target_link_libraries(mytarget PRIVATE Qt6::OpenGL) #! [cmake_use] diff --git a/src/printsupport/doc/snippets/CMakeLists.txt b/src/printsupport/doc/snippets/CMakeLists.txt index 0a7f3b86fd..355b244644 100644 --- a/src/printsupport/doc/snippets/CMakeLists.txt +++ b/src/printsupport/doc/snippets/CMakeLists.txt @@ -1,4 +1,4 @@ #! [cmake_use] -find_package(Qt6 COMPONENTS PrintSupport REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS PrintSupport) target_link_libraries(mytarget PRIVATE Qt6::PrintSupport) #! [cmake_use] diff --git a/src/sql/doc/snippets/CMakeLists.txt b/src/sql/doc/snippets/CMakeLists.txt index 2e74eed35a..f696eec076 100644 --- a/src/sql/doc/snippets/CMakeLists.txt +++ b/src/sql/doc/snippets/CMakeLists.txt @@ -1,4 +1,4 @@ #! [cmake_use] -find_package(Qt6 COMPONENTS Sql REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Sql) target_link_libraries(mytarget PRIVATE Qt6::Sql) #! [cmake_use] diff --git a/src/testlib/doc/snippets/CMakeLists.txt b/src/testlib/doc/snippets/CMakeLists.txt index 1dac3c91aa..09d54fd56e 100644 --- a/src/testlib/doc/snippets/CMakeLists.txt +++ b/src/testlib/doc/snippets/CMakeLists.txt @@ -1,4 +1,4 @@ #! [cmake_use] -find_package(Qt6 COMPONENTS Test REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Test) target_link_libraries(mytarget PRIVATE Qt6::Test) #! [cmake_use] diff --git a/src/testlib/doc/snippets/code/doc_src_cmakelists.txt b/src/testlib/doc/snippets/code/doc_src_cmakelists.txt index 5e292a6417..6e19597775 100644 --- a/src/testlib/doc/snippets/code/doc_src_cmakelists.txt +++ b/src/testlib/doc/snippets/code/doc_src_cmakelists.txt @@ -1,6 +1,6 @@ project(mytest LANGUAGES CXX) -find_package(Qt6 COMPONENTS Test REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Test) set(CMAKE_INCLUDE_CURRENT_DIR ON) diff --git a/src/widgets/doc/snippets/CMakeLists.txt b/src/widgets/doc/snippets/CMakeLists.txt index ebf9b38dc2..9bd47894c2 100644 --- a/src/widgets/doc/snippets/CMakeLists.txt +++ b/src/widgets/doc/snippets/CMakeLists.txt @@ -1,4 +1,4 @@ #! [cmake_use] -find_package(Qt6 COMPONENTS Widgets REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Widgets) target_link_libraries(mytarget PRIVATE Qt6::Widgets) #! [cmake_use] diff --git a/src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc b/src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc index 547e39c0cc..3911ee80b6 100644 --- a/src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc +++ b/src/widgets/doc/src/includes/cmake-find-package-widgets.qdocinc @@ -1,5 +1,5 @@ The command is defined in the \c Widgets component of the \c Qt6 package. Load the package with: \code -find_package(Qt6 COMPONENTS Widgets REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Widgets) \endcode diff --git a/src/xml/doc/snippets/CMakeLists.txt b/src/xml/doc/snippets/CMakeLists.txt index 134f6c2589..9a51f6fcb7 100644 --- a/src/xml/doc/snippets/CMakeLists.txt +++ b/src/xml/doc/snippets/CMakeLists.txt @@ -1,4 +1,4 @@ #! [cmake_use] -find_package(Qt6 COMPONENTS Xml REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Xml) target_link_libraries(mytarget PRIVATE Qt6::Xml) #! [cmake_use] -- cgit v1.2.3