diff --git a/doc/qtcreator/images/icons/message.png b/doc/qtcreator/images/icons/message.png new file mode 100644 index 00000000000..4cf36b6092c Binary files /dev/null and b/doc/qtcreator/images/icons/message.png differ diff --git a/src/plugins/coreplugin/images/logo/16/Qt_logo_green.png b/doc/qtcreator/images/icons/qtlogo-16.png similarity index 100% rename from src/plugins/coreplugin/images/logo/16/Qt_logo_green.png rename to doc/qtcreator/images/icons/qtlogo-16.png diff --git a/doc/qtcreator/images/icons/savefile.png b/doc/qtcreator/images/icons/savefile.png new file mode 100644 index 00000000000..d23d62adc42 Binary files /dev/null and b/doc/qtcreator/images/icons/savefile.png differ diff --git a/doc/qtcreator/images/icons/stopwatch.png b/doc/qtcreator/images/icons/stopwatch.png new file mode 100644 index 00000000000..5363b789e80 Binary files /dev/null and b/doc/qtcreator/images/icons/stopwatch.png differ diff --git a/doc/qtcreator/images/qtcreator-build-cmake-output.png b/doc/qtcreator/images/qtcreator-build-cmake-output.png index 4311c61249a..80040e8bfe6 100644 Binary files a/doc/qtcreator/images/qtcreator-build-cmake-output.png and b/doc/qtcreator/images/qtcreator-build-cmake-output.png differ diff --git a/doc/qtcreator/images/qtcreator-build-configurations.png b/doc/qtcreator/images/qtcreator-build-configurations.png index a1c2d7de82c..8ca5f7054df 100644 Binary files a/doc/qtcreator/images/qtcreator-build-configurations.png and b/doc/qtcreator/images/qtcreator-build-configurations.png differ diff --git a/doc/qtcreator/images/qtcreator-build-steps-cmake-ninja.png b/doc/qtcreator/images/qtcreator-build-steps-cmake-ninja.png deleted file mode 100644 index 0f1ba4fa745..00000000000 Binary files a/doc/qtcreator/images/qtcreator-build-steps-cmake-ninja.png and /dev/null differ diff --git a/doc/qtcreator/images/qtcreator-cmake-build-settings-initial.png b/doc/qtcreator/images/qtcreator-cmake-build-settings-initial.png index ce7f75f881f..90c632411b3 100644 Binary files a/doc/qtcreator/images/qtcreator-cmake-build-settings-initial.png and b/doc/qtcreator/images/qtcreator-cmake-build-settings-initial.png differ diff --git a/doc/qtcreator/images/qtcreator-cmake-build-settings.png b/doc/qtcreator/images/qtcreator-cmake-build-settings.png index 5d6968b2cf5..30491794188 100644 Binary files a/doc/qtcreator/images/qtcreator-cmake-build-settings.png and b/doc/qtcreator/images/qtcreator-cmake-build-settings.png differ diff --git a/doc/qtcreator/images/qtcreator-cmake-generator.png b/doc/qtcreator/images/qtcreator-cmake-generator.png new file mode 100644 index 00000000000..19c883bcb5b Binary files /dev/null and b/doc/qtcreator/images/qtcreator-cmake-generator.png differ diff --git a/doc/qtcreator/images/qtcreator-cmake-kit-configuration.png b/doc/qtcreator/images/qtcreator-cmake-kit-configuration.png new file mode 100644 index 00000000000..6a305822caf Binary files /dev/null and b/doc/qtcreator/images/qtcreator-cmake-kit-configuration.png differ diff --git a/doc/qtcreator/images/qtcreator-find-incremental.png b/doc/qtcreator/images/qtcreator-find-incremental.png new file mode 100644 index 00000000000..3bb17a1a41f Binary files /dev/null and b/doc/qtcreator/images/qtcreator-find-incremental.png differ diff --git a/doc/qtcreator/images/qtcreator-git-log.png b/doc/qtcreator/images/qtcreator-git-log.png index d58051cc34d..d628639b7c1 100644 Binary files a/doc/qtcreator/images/qtcreator-git-log.png and b/doc/qtcreator/images/qtcreator-git-log.png differ diff --git a/doc/qtcreator/images/qtcreator-logging-category-viewer.png b/doc/qtcreator/images/qtcreator-logging-category-viewer.png new file mode 100644 index 00000000000..4a88efd9b57 Binary files /dev/null and b/doc/qtcreator/images/qtcreator-logging-category-viewer.png differ diff --git a/doc/qtcreator/images/qtcreator-project-kits.png b/doc/qtcreator/images/qtcreator-project-kits.png index 569425e742b..e6c1434c9cc 100644 Binary files a/doc/qtcreator/images/qtcreator-project-kits.png and b/doc/qtcreator/images/qtcreator-project-kits.png differ diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc index 31e4780e608..8b72312a817 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2021 The Qt Company Ltd. +** Copyright (C) 2022 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -31,17 +31,31 @@ \title CMake Build Configuration Configuring medium-sized to large CMake projects in \QC can be a - challenge due to the number of options that you need to pass to + challenge due to the number of variables that you need to pass to CMake to configure the project correctly. To make this easier, \QC creates an initial configuration for you based on the kit - settings and displays it in the \uicontrol {Initial CMake parameters} - field and in a table that lists the parameter names and values. + settings and displays it in \uicontrol {Initial Configuration} in + the \l{Specifying Build Settings}{Build Settings} of the project. \image qtcreator-cmake-build-settings-initial.png "CMake build settings" - Parameter names are listed in the \uicontrol Key column. Names with a - common prefix (up to the first underscore character) are grouped under - the prefix. + You can view and edit the actual values of the variables that are passed + to CMake. Variable names are listed in the \uicontrol Key column and their + current values in the \uicontrol Value column. For more information + about the available variables, see \l{CMake: cmake-variables(7)}. + For more information about Qt-specific variables, see + \l{CMake Variable Reference}. + + You can specify additional CMake options, such as \c {--find-debug}, + \c {--preset}, \c {--trace-expand}, or \c {--warn-uninitialized}, in + \uicontrol {Additional CMake options}. For more information about + the available options, see \l{CMake: cmake(1)}. + + After successfully running CMake, you can view and modify the current + configuration in \uicontrol {Current Configuration}. + + Select \uicontrol {Kit Configuration} to edit the CMake settings for the + build and run kit selected for the project. \section1 Multi-Config Support @@ -59,35 +73,36 @@ When developing with Qt 6 for iOS, only the Xcode generator is supported. - \section1 Modifying Initial Parameters + \section1 Modifying Variable Values - In the \uicontrol Value column, you can view and edit the actual values - of the parameters that are passed to CMake. + You can view and edit the actual values of the variables that + are passed to CMake in \uicontrol {Initial Configuration} or + \uicontrol {Current Configuration}. - \image qtcreator-cmake-build-settings.png "CMake parameters" + \image qtcreator-cmake-build-settings.png "CMake variables" - To view all parameters, select the \uicontrol Advanced check box. + To view all variables, select the \uicontrol Advanced check box. - To add parameters, select \uicontrol Add, and then select the type of - the parameter that you are adding: \uicontrol Boolean, \uicontrol String, + To add variables, select \uicontrol Add, and then select the type of + the variable that you are adding: \uicontrol Boolean, \uicontrol String, \uicontrol Directory, or \uicontrol File. - To change the type of the selected parameter, right-click the - parameter name in the \uicontrol Key column, and then select + To change the type of the selected variable, right-click the + variable name in the \uicontrol Key column, and then select \uicontrol {Force to bool}, \uicontrol {Force to file}, \uicontrol {Force to directory}, or \uicontrol {Force to string} in the context menu. - To copy the name or value of the selected parameter to the clipboard, + To copy the name or value of the selected variable to the clipboard, select \uicontrol Copy in the context menu. - To modify the value of a parameter, double-click it, or select it, + To modify the value of a variable, double-click it, or select it, and then select \uicontrol Edit. - You can apply actions to multiple parameters at a time. To clear + You can apply actions to multiple variables at a time. To clear the selection, select \uicontrol {Clear Selection}. - To remove the selected parameters, select \uicontrol Unset. To undo + To remove the selected variables, select \uicontrol Unset. To undo the removal, select \uicontrol Set. To reset all the changes that you made, select \uicontrol Reset. @@ -95,23 +110,27 @@ To modify the environment variable values for the CMake build environment, select \uicontrol {Batch Edit}. For more information, see \l{Batch Editing}. - To save the changes, select \uicontrol {Apply Configuration Changes}. - Keep in mind that a configuration change might trigger a follow-up - configuration change. + To build using the current configuration, select \uicontrol {Run CMake}. + While building, the button text changes to \uicontrol {Stop CMake}. Select + the button to cancel the current build. - The parameter values that you change are passed via \c -D