summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/config/qtcreator-project.qdocconf3
-rw-r--r--doc/images/qtcreator-clang-tools-options.pngbin5355 -> 8210 bytes
-rw-r--r--doc/images/qtcreator-clang-tools.pngbin16541 -> 9933 bytes
-rw-r--r--doc/images/qtcreator-cmake-build-settings.pngbin41710 -> 11650 bytes
-rw-r--r--doc/images/qtcreator-cmake-build-steps.pngbin7998 -> 5838 bytes
-rw-r--r--doc/images/qtcreator-cmake-clean-steps.pngbin8315 -> 6320 bytes
-rw-r--r--doc/images/qtcreator-cmakeexecutable.pngbin11541 -> 13050 bytes
-rw-r--r--doc/images/qtcreator-files-to-analyze.pngbin9716 -> 5402 bytes
-rw-r--r--doc/images/qtcreator-kits.pngbin28799 -> 27172 bytes
-rw-r--r--doc/src/analyze/creator-clang-static-analyzer.qdoc37
-rw-r--r--doc/src/cmake/creator-projects-cmake-building.qdocinc6
-rw-r--r--doc/src/cmake/creator-projects-cmake.qdoc11
-rw-r--r--doc/src/editors/creator-locator.qdoc5
-rw-r--r--doc/src/projects/creator-only/creator-projects-building.qdoc31
14 files changed, 57 insertions, 36 deletions
diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf
index 82daf9faad..b6710edb43 100644
--- a/doc/config/qtcreator-project.qdocconf
+++ b/doc/config/qtcreator-project.qdocconf
@@ -23,7 +23,8 @@ imagedirs = ../images \
../../src/plugins/qmldesigner/qmlpreviewplugin/images \
../../src/plugins/scxmleditor/common/images \
../../src/plugins/texteditor/images \
- ../../src/plugins/valgrind/images
+ ../../src/plugins/valgrind/images \
+ ../../src/plugins/welcome/images
exampledirs = ../examples
examples.fileextensions += *.qml *.svg
diff --git a/doc/images/qtcreator-clang-tools-options.png b/doc/images/qtcreator-clang-tools-options.png
index 6cf866f13f..3fce1e2dff 100644
--- a/doc/images/qtcreator-clang-tools-options.png
+++ b/doc/images/qtcreator-clang-tools-options.png
Binary files differ
diff --git a/doc/images/qtcreator-clang-tools.png b/doc/images/qtcreator-clang-tools.png
index 0ae985591c..cd80438a8a 100644
--- a/doc/images/qtcreator-clang-tools.png
+++ b/doc/images/qtcreator-clang-tools.png
Binary files differ
diff --git a/doc/images/qtcreator-cmake-build-settings.png b/doc/images/qtcreator-cmake-build-settings.png
index 35b4401820..534ddf6be1 100644
--- a/doc/images/qtcreator-cmake-build-settings.png
+++ b/doc/images/qtcreator-cmake-build-settings.png
Binary files differ
diff --git a/doc/images/qtcreator-cmake-build-steps.png b/doc/images/qtcreator-cmake-build-steps.png
index 1679217c51..5809136a85 100644
--- a/doc/images/qtcreator-cmake-build-steps.png
+++ b/doc/images/qtcreator-cmake-build-steps.png
Binary files differ
diff --git a/doc/images/qtcreator-cmake-clean-steps.png b/doc/images/qtcreator-cmake-clean-steps.png
index 9ecfbc74f1..88be99d715 100644
--- a/doc/images/qtcreator-cmake-clean-steps.png
+++ b/doc/images/qtcreator-cmake-clean-steps.png
Binary files differ
diff --git a/doc/images/qtcreator-cmakeexecutable.png b/doc/images/qtcreator-cmakeexecutable.png
index a0475e0c04..b98085b4e0 100644
--- a/doc/images/qtcreator-cmakeexecutable.png
+++ b/doc/images/qtcreator-cmakeexecutable.png
Binary files differ
diff --git a/doc/images/qtcreator-files-to-analyze.png b/doc/images/qtcreator-files-to-analyze.png
index fcdf05c0db..add972f337 100644
--- a/doc/images/qtcreator-files-to-analyze.png
+++ b/doc/images/qtcreator-files-to-analyze.png
Binary files differ
diff --git a/doc/images/qtcreator-kits.png b/doc/images/qtcreator-kits.png
index 05e8cc0df3..4dfaa560f3 100644
--- a/doc/images/qtcreator-kits.png
+++ b/doc/images/qtcreator-kits.png
Binary files differ
diff --git a/doc/src/analyze/creator-clang-static-analyzer.qdoc b/doc/src/analyze/creator-clang-static-analyzer.qdoc
index c4468ef038..b378553495 100644
--- a/doc/src/analyze/creator-clang-static-analyzer.qdoc
+++ b/doc/src/analyze/creator-clang-static-analyzer.qdoc
@@ -60,6 +60,11 @@
Clang tools are delivered and installed with \QC, and therefore you do not
need to set them up separately.
+ In addition to running the tools to collect diagnostics, you can select
+ \inlineimage open.png
+ to load diagnostics from \l{https://yaml.org/}{YAML} files that you exported
+ using the \c {-export fixes} option.
+
\section1 Running Clang Tools
To run the Clang tools to analyze an open project:
@@ -68,41 +73,25 @@
\li Select \uicontrol Analyze > \uicontrol {Clang-Tidy and Clazy}.
- \image qtcreator-files-to-analyze.png "Analyzer Configuration dialog"
-
- \li In the \uicontrol General group, select \uicontrol {Custom Settings}
- to modify the analyzer configuration.
-
- \li To build the project before running the Clang tools, select the
- \uicontrol {Build the project before analysis} check box. The Clang
- tools do not require the project to be built before analysis, but
- they might display misleading warnings about files missing that are
- generated during the build. For big projects, not building the
- project might save some time.
-
- \li In the \uicontrol {Diagnostic configuration} field, select a Clang
- configuration in the list of pre-defined configurations (1). For
- more information about creating a custom configuration, see
- \l {Configuring Clang Tools}.
+ \image qtcreator-files-to-analyze.png "Files to Analyze dialog"
- \li In the \uicontrol {Files to Analyze} group, select the files to
- apply the checks to.
+ \li Select the files to apply the checks to.
\li Select \uicontrol Analyze to start the checks.
\endlist
- If you select \uicontrol Debug in the mode selector to open the
- \uicontrol Debug mode and then select \uicontrol {Clang-Tidy and Clazy},
- you must select the \inlineimage qtcreator-analyze-start-button.png
- (\uicontrol Start) button to open the \uicontrol {Analyzer Configuration}
- dialog.
-
The found issues are displayed in the \uicontrol {Clang-Tidy and Clazy}
view:
\image qtcreator-clang-tools.png "Clang-Tidy and Clazy view"
+ \note If you select \uicontrol Debug in the mode selector to open the
+ \uicontrol Debug mode and then select \uicontrol {Clang-Tidy and Clazy},
+ you must select the \inlineimage qtcreator-analyze-start-button.png
+ (\uicontrol Start) button to open the \uicontrol {Files to Analyze}
+ dialog.
+
Double-click an issue to move to the location where the issue appears in
the code editor.
diff --git a/doc/src/cmake/creator-projects-cmake-building.qdocinc b/doc/src/cmake/creator-projects-cmake-building.qdocinc
index bca11658e4..a31449984c 100644
--- a/doc/src/cmake/creator-projects-cmake-building.qdocinc
+++ b/doc/src/cmake/creator-projects-cmake-building.qdocinc
@@ -57,6 +57,10 @@
To reset the changes that you made, select \uicontrol Reset.
+ To reconfigure CMake, select \uicontrol Build >
+ \uicontrol {Clear CMake Configuration}, and then
+ select \uicontrol Build > \uicontrol {Rescan Project}.
+
//! [cmake build configuration]
@@ -65,7 +69,7 @@
\section2 CMake Build Steps
\QC builds CMake projects by running \c {cmake . --build}, which then runs
- run whatever is needed based on how the project was configured: \c make,
+ whatever is needed based on how the project was configured: \c make,
\c mingw32-make, \c nmake, or \c ninja, for example.
You can add arguments and targets for the build command in
diff --git a/doc/src/cmake/creator-projects-cmake.qdoc b/doc/src/cmake/creator-projects-cmake.qdoc
index 585031ded7..a6d0ad6671 100644
--- a/doc/src/cmake/creator-projects-cmake.qdoc
+++ b/doc/src/cmake/creator-projects-cmake.qdoc
@@ -61,6 +61,10 @@
provide less information to the code model, which will then fail to resolve
includes and defines.
+ For CMake version 3.14, or later, \QC supports the
+ \l {https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html}
+ {file-based API}.
+
To specify paths to CMake executables:
\list 1
@@ -99,9 +103,14 @@
\section1 Editing CMake Configuration Files
To open a CMakeLists.txt file for editing, right-click it in the
- \uicontrol Projects view and select \uicontrol {Open with} >
+ \uicontrol Projects view and select \uicontrol {Open With} >
\uicontrol {CMake Editor}.
+ You can also use the \c cmo filter in the \l {Searching with the Locator}
+ {locator} to open the CMakeLists.txt file for the current run configuration
+ in the editor. This is the same build target as when you select
+ \uicontrol Build > \uicontrol {Build for Run Configuration}.
+
The following features are supported:
\list
diff --git a/doc/src/editors/creator-locator.qdoc b/doc/src/editors/creator-locator.qdoc
index e7c048f6d2..cd99ab139b 100644
--- a/doc/src/editors/creator-locator.qdoc
+++ b/doc/src/editors/creator-locator.qdoc
@@ -150,6 +150,11 @@
\if defined(qtcreator)
\li Running external tools (\c x)
+ \li Using CMake to build the project for the current run configuration
+ (\c {cm}). For more information, see \l {Setting up CMake}.
+ \li Opening the CMakeLists.txt file for the current run configuration in
+ the editor (\c {cmo}). This is the same build target as when you
+ select \uicontrol Build > \uicontrol {Build for Run Configuration}.
\endif
\endlist
diff --git a/doc/src/projects/creator-only/creator-projects-building.qdoc b/doc/src/projects/creator-only/creator-projects-building.qdoc
index c87557dc69..86b8b61748 100644
--- a/doc/src/projects/creator-only/creator-projects-building.qdoc
+++ b/doc/src/projects/creator-only/creator-projects-building.qdoc
@@ -84,16 +84,18 @@
To quickly check the compile output for changes that you made in one file or
subproject, you can use the \uicontrol Build menu commands to build a file or
- subproject.
+ subproject. The available build menu commands depend on the build system
+ you selected for the project: CMake, qmake, or Qbs.
- To build the executable that corresponds to the selected run configuration,
- select \uicontrol Build > \uicontrol {Build for Run Configuration}.
+ Select \uicontrol Build > \uicontrol {Build for Run Configuration} to
+ build the executable that corresponds to the selected run configuration.
+ You can also use the \c cm filter in the \l {Searching with the Locator}
+ {locator}.
To remove all build artifacts, select \uicontrol Build > \uicontrol {Clean All} or
\uicontrol {Clean Project}. To clean the build directory and then build
the project, select \uicontrol Build > \uicontrol {Rebuild All} or
- \uicontrol {Rebuild Project}. If you use qmake, rebuilding also runs qmake
- to generate new Makefiles between cleaning and building.
+ \uicontrol {Rebuild Project}.
To build and clean projects without dependencies, select the
\uicontrol {Build Without Dependencies},
@@ -101,11 +103,22 @@
\uicontrol {Clean Without Dependencies} options in the context menu in the
\uicontrol Projects view.
- \section1 Additional qmake Commands
+ To run qmake or CMake to regenerate build system files, select
+ \uicontrol Build > \uicontrol {Run qmake} or \uicontrol {Run CMake}.
- To run qmake to generate new Makefiles, select \uicontrol Build >
- \uicontrol qmake. To prevent failures on incremental builds, it might make
- sense to always run qmake before building, even though it means that
+ \section2 Building with CMake
+
+ \QC automatically runs CMake when you make changes to \c {CMakeLists.txt}
+ files. To disable this feature, select \uicontrol Tools >
+ \uicontrol Options > \uicontrol Kits > \uicontrol CMake >
+ \uicontrol {Autorun CMake}.
+
+ For more information, see \l {Setting Up CMake}.
+
+ \section2 Building with qmake
+
+ To prevent failures on incremental builds, it might make sense
+ to always run qmake before building, even though it means that
building will take more time. To enable this option, select \uicontrol Tools
> \uicontrol Options > \uicontrol {Build & Run} > \uicontrol qmake >
\uicontrol {Run qmake on every build}.