Doc: Update CMake configuration info

- Initial variables are now listed in the Initial Configuration tab
  and current ones in the Current Configuration tab.
- CMake builds can be stopped.
- Variables are no longer grouped according to their prefix.
- Kit Configuration button enables setting CMake options for the
  current kit.

Fixes: QTCREATORBUG-26983
Change-Id: I0b8696adc9d442b4c33c6e3c34739e5583254cd9
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
This commit is contained in:
Leena Miettinen
2022-02-03 15:11:15 +01:00
parent e310ce43dc
commit ea7b370fe9
12 changed files with 71 additions and 40 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 7.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2021 The Qt Company Ltd. ** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -31,17 +31,31 @@
\title CMake Build Configuration \title CMake Build Configuration
Configuring medium-sized to large CMake projects in \QC can be a 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, CMake to configure the project correctly. To make this easier,
\QC creates an initial configuration for you based on the kit \QC creates an initial configuration for you based on the kit
settings and displays it in the \uicontrol {Initial CMake parameters} settings and displays it in \uicontrol {Initial Configuration} in
field and in a table that lists the parameter names and values. the \l{Specifying Build Settings}{Build Settings} of the project.
\image qtcreator-cmake-build-settings-initial.png "CMake build settings" \image qtcreator-cmake-build-settings-initial.png "CMake build settings"
Parameter names are listed in the \uicontrol Key column. Names with a You can view and edit the actual values of the variables that are passed
common prefix (up to the first underscore character) are grouped under to CMake. Variable names are listed in the \uicontrol Key column and their
the prefix. 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 \section1 Multi-Config Support
@@ -59,35 +73,36 @@
When developing with Qt 6 for iOS, only the Xcode generator is supported. 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 You can view and edit the actual values of the variables that
of the parameters that are passed to CMake. 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 To add variables, select \uicontrol Add, and then select the type of
the parameter that you are adding: \uicontrol Boolean, \uicontrol String, the variable that you are adding: \uicontrol Boolean, \uicontrol String,
\uicontrol Directory, or \uicontrol File. \uicontrol Directory, or \uicontrol File.
To change the type of the selected parameter, right-click the To change the type of the selected variable, right-click the
parameter name in the \uicontrol Key column, and then select variable name in the \uicontrol Key column, and then select
\uicontrol {Force to bool}, \uicontrol {Force to file}, \uicontrol {Force to bool}, \uicontrol {Force to file},
\uicontrol {Force to directory}, or \uicontrol {Force to string} \uicontrol {Force to directory}, or \uicontrol {Force to string}
in the context menu. 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. 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. 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}. 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. the removal, select \uicontrol Set.
To reset all the changes that you made, select \uicontrol Reset. 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, To modify the environment variable values for the CMake build environment,
select \uicontrol {Batch Edit}. For more information, see \l{Batch Editing}. select \uicontrol {Batch Edit}. For more information, see \l{Batch Editing}.
To save the changes, select \uicontrol {Apply Configuration Changes}. To build using the current configuration, select \uicontrol {Run CMake}.
Keep in mind that a configuration change might trigger a follow-up While building, the button text changes to \uicontrol {Stop CMake}. Select
configuration change. the button to cancel the current build.
The parameter values that you change are passed via \c -D<option>=<value> The variable values that you change are passed via \c -D<option>=<value>
to CMake, which stores the options in the CMakeCache.txt file. This means to CMake, which stores the options in the CMakeCache.txt file. This means
that if you remove the build directory, all the custom parameters that are that if you remove the build directory, all the custom variables that are
not part of the initial CMake parameters are also removed. not part of the initial CMake configuration are also removed.
To reconfigure a project using the modified parameters, To reconfigure a project using the modified variable values,
select \uicontrol Build > \uicontrol {Clear CMake Configuration}, which select \uicontrol Build > \uicontrol {Clear CMake Configuration}, which
removes the CMakeCache.txt file. This enables you to do a full rebuild. removes the CMakeCache.txt file. This enables you to do a full rebuild.
\section1 Re-configuring with Initial Parameters \section1 Re-configuring with Initial Variables
To reset CMake parameters to the initial ones, select To reset CMake variables to the initial ones, select
\uicontrol {Re-configure with Initial Parameters}. \uicontrol {Re-configure with Initial Variables} in
\uicontrol {Initial Configuration}. \QC deletes the current CMake
configuration and runs CMake. The initial configuration values are
stored in the CMakeLists.txt.user file, so deleting a build directory
does not delete the initial configuration.
To be asked before \QC resets the changes, select \uicontrol Tools > To be asked before \QC resets the changes, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol CMake > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol CMake >
@@ -167,14 +186,16 @@
\li Install Ninja. \li Install Ninja.
\li Add the path to the Ninja executable to the value of the PATH system \li Add the path to the Ninja executable to the value of the PATH system
variable. variable.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits, and \li In \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Build
then select the build and run kit for the project. > \uicontrol {Build Settings}, select \uicontrol {Kit Configuration}.
\image qtcreator-cmake-kit-configuration.png "Kit CMake Configuration dialog"
\li Select \uicontrol Change next to the \uicontrol {CMake generator} \li Select \uicontrol Change next to the \uicontrol {CMake generator}
field to open the \uicontrol {CMake Generator} dialog. field to open the \uicontrol {CMake Generator} dialog.
\image qtcreator-build-steps-cmake-ninja.png \image qtcreator-cmake-generator.png "CMake Generator dialog"
\li In the \uicontrol Generator field, select \uicontrol Ninja. \li In \uicontrol Generator, select \uicontrol Ninja.
\li Select \uicontrol OK to return to the \uicontrol Kits tab. \li Select \uicontrol OK to save your changes and close the dialog.
\li Select \uicontrol OK or \uicontrol Apply to save your changes. \li Close the \uicontrol {Kit CMake Configuration} dialog to return to
\uicontrol {Build Settings}.
\endlist \endlist
\note To make sure that old build artifacts don't get in the way \note To make sure that old build artifacts don't get in the way

View File

@@ -113,6 +113,14 @@
\externalpage https://doc.qt.io/QtApplicationManager/ \externalpage https://doc.qt.io/QtApplicationManager/
\title Qt Application Manager \title Qt Application Manager
*/ */
/*!
\externalpage https://cmake.org/cmake/help/latest/manual/cmake.1.html
\title CMake: cmake(1)
*/
/*!
\externalpage https://cmake.org/cmake/help/latest/manual/cmake-variables.7.html
\title CMake: cmake-variables(7)
*/
/*! /*!
\externalpage https://cmake.org/cmake/help/latest/command/install.html \externalpage https://cmake.org/cmake/help/latest/command/install.html
\title CMake: install command \title CMake: install command

View File

@@ -57,7 +57,7 @@
The process to add files to deploy depends on the build system you use. The process to add files to deploy depends on the build system you use.
\section2 CMake \section2 CMake Builds
When using CMake as the build system, use the \l{CMake: install command} When using CMake as the build system, use the \l{CMake: install command}
{install} command in the CMakeLists.txt file to add the missing files. {install} command in the CMakeLists.txt file to add the missing files.
@@ -75,7 +75,7 @@
) )
\endcode \endcode
\section2 qmake \section2 qmake Builds
When using qmake, edit the \l{Variables#installs}{INSTALLS variable} in When using qmake, edit the \l{Variables#installs}{INSTALLS variable} in
the project \c .pro file. the project \c .pro file.

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2021 The Qt Company Ltd. ** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -57,9 +57,11 @@
\section1 Managing Build Configurations \section1 Managing Build Configurations
Specify build settings in \uicontrol Projects > \uicontrol {Build & Run}
> \uicontrol Build > \uicontrol {Build Settings}.
\image qtcreator-build-configurations.png "Build Settings" \image qtcreator-build-configurations.png "Build Settings"
You specify build settings in the \uicontrol Projects mode.
To add a new build configuration, click \uicontrol Add and select the type of To add a new build configuration, click \uicontrol Add and select the type of
configuration you would like to add. The options you have depend on the configuration you would like to add. The options you have depend on the
build system that you selected for the project. You can add as many build build system that you selected for the project. You can add as many build