Add the note about ninja build tool to Qt build documentation

The note helps to pay attention to the requirement of use the ninja
build tool when building Qt.

Task-number: QTBUG-111163
Change-Id: I15b7e99b4033e7570583b2828a83811c224ea0cc
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
(cherry picked from commit 0a2662deb40130d1e3a9804b770ab5c7bc5af98c)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>

8 files changed, 23 insertions, 0 deletions

diff --git a/doc/src/platforms/android/android-building.qdoc b/doc/src/platforms/android/android-building.qdoc
index 2f16e382..7cb54454 100644
--- a/doc/src/platforms/android/android-building.qdoc
+++ b/doc/src/platforms/android/android-building.qdoc
@@ -71,6 +71,8 @@
     <path_to_qt_source>/configure -platform android-clang -prefix </path/to/install> -android-ndk $ANDROID_NDK_ROOT -android-sdk $ANDROID_SDK_ROOT -qt-host-path <path_to_host_qt_installation>
     \endcode
 
+    \include use-ninja-note.qdocinc ninja-note
+
     \section2 Architectures
 
     Qt for Android supports the following ABIs:
diff --git a/doc/src/platforms/configure-linux-device.qdoc b/doc/src/platforms/configure-linux-device.qdoc
index cc1068da..3be2a304 100644
--- a/doc/src/platforms/configure-linux-device.qdoc
+++ b/doc/src/platforms/configure-linux-device.qdoc
@@ -61,6 +61,8 @@
     ./configure -release -opengl es2 -device linux-rasp-pi2-g++ -device-option CROSS_COMPILE=$TOOLCHAIN/arm-bcm2708/gcc-linaro-arm-linux-gnueabihf-raspbian/bin/arm-linux-gnueabihf- -sysroot $ROOTFS -prefix /usr/local/qt5
     \endcode
 
+    \include use-ninja-note.qdocinc ninja-note
+
     With Qt 6 and CMake, this approach is \b{no longer sufficient} on its own. Rather, a
     \l{https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html}{CMake toolchain
     file} must be provided before configuring can happen. It is in this file where
diff --git a/doc/src/platforms/integrity-build-monolith-app-tutorial.qdoc b/doc/src/platforms/integrity-build-monolith-app-tutorial.qdoc
index bbf1d857..777e8aa0 100644
--- a/doc/src/platforms/integrity-build-monolith-app-tutorial.qdoc
+++ b/doc/src/platforms/integrity-build-monolith-app-tutorial.qdoc
@@ -151,6 +151,8 @@
         cmake --install .
     \endcode
 
+    \include use-ninja-note.qdocinc ninja-note
+
     \section1 Creating a toolchain file for INTEGRITY
 
     To cross-compile a project with CMake, one must specify a toolchain file.
diff --git a/doc/src/platforms/ios.qdoc b/doc/src/platforms/ios.qdoc
index f45263e5..e7d02d44 100644
--- a/doc/src/platforms/ios.qdoc
+++ b/doc/src/platforms/ios.qdoc
@@ -176,6 +176,8 @@
         > ./configure -platform macx-ios-clang -release -qt-host-path <path_to_host_qt_installation>
     \endcode
 
+    \include use-ninja-note.qdocinc ninja-note
+
     For other configure options, see \l{Qt Configure Options}.
 
     Then, simply run \c{cmake --build . --parallel}.
diff --git a/doc/src/platforms/linux.qdoc b/doc/src/platforms/linux.qdoc
index 8b8f4eaa..f62d1b3a 100644
--- a/doc/src/platforms/linux.qdoc
+++ b/doc/src/platforms/linux.qdoc
@@ -381,6 +381,8 @@
 
     \snippet snippets/code/doc_src_installation.qdoc 1
 
+    \include use-ninja-note.qdocinc ninja-note
+
         The \l{Qt Configure Options}{Configure Options} page contains more
         information about the configure options.
 
diff --git a/doc/src/platforms/macos.qdoc b/doc/src/platforms/macos.qdoc
index c4ba7fce..d975f11d 100644
--- a/doc/src/platforms/macos.qdoc
+++ b/doc/src/platforms/macos.qdoc
@@ -310,6 +310,8 @@
 
         \snippet snippets/code/doc_src_installation.qdoc 12
 
+        \include use-ninja-note.qdocinc ninja-note
+
         By default, Qt is configured for installation in the
         \c{/usr/local/Qt-%VERSION%} directory, but this can be
         changed by using the \c{-prefix} option.
diff --git a/doc/src/platforms/use-ninja-note.qdocinc b/doc/src/platforms/use-ninja-note.qdocinc
new file mode 100644
index 00000000..9cb80be7
--- /dev/null
+++ b/doc/src/platforms/use-ninja-note.qdocinc
@@ -0,0 +1,9 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+//! [ninja-note]
+\note configure always uses the \b Ninja generator and build tool if a \c ninja
+executable is available. Ninja is cross-platform, feature-rich, performant, and
+recommended on all platforms. The use of other generators might work but is not
+officially supported.
+//! [ninja-note]
diff --git a/doc/src/platforms/wasm.qdoc b/doc/src/platforms/wasm.qdoc
index fa67a4ac..74b85069 100644
--- a/doc/src/platforms/wasm.qdoc
+++ b/doc/src/platforms/wasm.qdoc
@@ -116,6 +116,8 @@ variable \e{CMAKE_TOOLCHAIN_FILE} or by passing
     ./configure -qt-host-path /path/to/Qt -platform wasm-emscripten -prefix $PWD/qtbase
 \endcode
 
+\include use-ninja-note.qdocinc ninja-note
+
 On Windows, make sure you have MinGW in your \c PATH
 and configure with the following: