Doc: Describe overriding values from Preferences > CMake > General

Collect the settings to a table with links to where each setting
is documented.

Task-number: QTCREATORBUG-30604
Change-Id: Ia06076cdd7f51851f58307119716b4ed3cef630e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
This commit is contained in:
Leena Miettinen
2024-06-19 17:04:16 +02:00
parent 611f6bdbea
commit 113275118e
5 changed files with 75 additions and 3 deletions

View File

@@ -148,7 +148,7 @@ Projects
* Made CMake settings configurable per project * Made CMake settings configurable per project
* Implemented `Open Online Documentation` for CMake documentation * Implemented `Open Online Documentation` for CMake documentation
* Added `Clear CMake Configuration` to the context menu in the Projects view * Added `Clear CMake Configuration` to the context menu in the `Projects` view
([QTCREATORBUG-24658](https://bugreports.qt.io/browse/QTCREATORBUG-24658)) ([QTCREATORBUG-24658](https://bugreports.qt.io/browse/QTCREATORBUG-24658))
* Fixed that the package manager auto-setup files were not removed with * Fixed that the package manager auto-setup files were not removed with
`Clear CMake Configuration` `Clear CMake Configuration`

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

View File

@@ -65,8 +65,7 @@
a tree and lists all files that are part of the project. a tree and lists all files that are part of the project.
\QC automatically runs CMake to refresh project information in the \QC automatically runs CMake to refresh project information in the
view when you edit a \c CMakeLists.txt configuration file view when you edit a \c CMakeLists.txt configuration file
in a project. Project information is also automatically refreshed when in a project. Also, refreshes project information when you build the project.
you build the project.
\image qtcreator-projects-view-edit.png {CMake project in Projects view} \image qtcreator-projects-view-edit.png {CMake project in Projects view}

View File

@@ -0,0 +1,72 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-configure-cmake-for-project.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-projects-configure
\ingroup creator-how-to-build-with-cmake
\title Override CMake settings for a project
To override CMake settings for the current project:
\list 1
\li Go to \uicontrol Projects > \uicontrol {Project Settings} >
\uicontrol CMake.
\image qtcreator-project-settings-cmake.webp {CMake settings for a project}
\li Clear \uicontrol {Use global settings}.
\li Configure CMake for the project.
\endlist
Your choices override the values you set in \preferences > \uicontrol CMake >
\uicontrol General.
\table
\header
\li Setting
\li Value
\li Read More
\row
\li Autorun CMake
\li Runs CMake to refresh project information when you edit
a \c CMakeLists.txt configuration file in a project. Also,
refreshes project information when you build the project.
\li \l{View CMake project contents}
\row
\li Package manager auto setup
\li Sets up the \l {Conan Package Manager}{Conan} or
\l {vcpkg Package Manager}{vcpkg} package manager for use with CMake.
\li \l{Using CMake with Package Managers}
\row
\li Ask before re-configuring with initial parameters
\li Asks before acting when you select
\uicontrol {Re-configure with Initial Variables}.
\li \l{Re-configuring with Initial Variables}
\row
\li Ask before reloading CMake presets
\li Asks before acting when you select \uicontrol Build >
\uicontrol {Reload CMake Presets}.
\li \l{CMake Presets}
\row
\li Show subfolders inside source group folders
\li Hides subfolder names and arranges the files according to their
source group in the \uicontrol Projects view.
\li \l{Hide subfolder names in Projects view}
\row
\li Show advanced options by default
\li Shows all CMake variables by default in
\uicontrol {Initial Configuration} and
\uicontrol {Current Configuration}.
\li \l{Viewing Advanced Variables}
\row
\li Use junctions for CMake configuration and build operations
\li On Windows, uses junction points for CMake configure, build, and
install operations.
\li \l{Using Junction Points on Windows}
\endtable
\sa {Build with CMake}{How To: Build with CMake}, {CMake},
{Configuring Projects}
*/

View File

@@ -84,6 +84,7 @@
\li \l{Link projects to Axivion dashboards}{Axivion} \li \l{Link projects to Axivion dashboards}{Axivion}
\li \l{Specify clangd settings}{Clangd} \li \l{Specify clangd settings}{Clangd}
\li \l{Specify Clang tools settings}{Clang Tools} \li \l{Specify Clang tools settings}{Clang Tools}
\li \l{Override CMake settings for a project}{CMake}
\li \l{Set Copilot preferences}{Copilot} \li \l{Set Copilot preferences}{Copilot}
\li \l{Configure C++ code model}{C++ Code Model} \li \l{Configure C++ code model}{C++ Code Model}
\li \l{Specify code style}{C++ Code Style} \li \l{Specify code style}{C++ Code Style}