Doc: Update info about Clang diagnostics

Task-number: QTCREATORBUG-25195
Change-Id: Idb8dee94fae29cb0f347decf50e686a3485d9139
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2021-01-06 17:05:56 +01:00
parent c81baf1a9c
commit 19970878b8
6 changed files with 14 additions and 19 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.7 KiB

After

Width:  |  Height:  |  Size: 7.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

@@ -166,7 +166,7 @@
system to the Clang code model for displaying annotations in the system to the Clang code model for displaying annotations in the
code editor. code editor.
\image qtcreator-diagnostics-configuration.png "Diagnostics Configuration dialog" \image qtcreator-clang-tools-diagnostics-configuration.png "Diagnostics Configuration dialog"
\li In the \uicontrol {Clang-Tidy Checks} tab, select \li In the \uicontrol {Clang-Tidy Checks} tab, select
\uicontrol {Select Checks} to select the checks to perform. \uicontrol {Select Checks} to select the checks to perform.

View File

@@ -138,7 +138,10 @@
edit the value for the \uicontrol {Do not index files greater than} edit the value for the \uicontrol {Do not index files greater than}
check box. To index all files, deselect the check box. check box. To index all files, deselect the check box.
\li Select \uicontrol Manage to specify the Clang checks to perform. \li The \uicontrol {Diagnostic Configuration} field shows the Clang
checks to perform. Click the value of the field to open the
\uicontrol {Diagnostic Configurations} dialog, where you can
select and edit the checks to perform.
\image qtcreator-diagnostics-configuration.png \image qtcreator-diagnostics-configuration.png
@@ -146,26 +149,18 @@
\section1 Clang Checks \section1 Clang Checks
The predefined configurations perform the following Clang checks: In addition to using the built-in checks, you can select \uicontrol Copy to
create copies of them and edit the copies to fit your needs.
\list \uicontrol {Build-system warnings} displays warnings as specified
by the build system.
\li \uicontrol {Clang-only pedantic checks} uses the \c -Wpendantic \uicontrol {Checks for questionable constructs} combines the \c -Wall and
option that performs checks as required by strict ISO C and ISO C++. \c -Wextra checks for easily avoidable questionable constructions and some
additional issues.
\li \uicontrol {Clang-only checks for questionable constructs} combines Clang checks begin with \c -W. Each check also has a negative version that
the \c -Wall and \c -Wextra checks for easily avoidable questionable begins with \c -Wno.
constructions and some additional issues.
\li \uicontrol {Clang-only checks for almost everything} uses the
\c -Weverything option with negative options to suppress some
warnings.
\endlist
You can edit the predefined configurations to perform particular checks
beginning with \c -W. Each of these checks also has a negative version
that begins with \c -Wno.
Keep in mind that some options turn on other options. For more information, Keep in mind that some options turn on other options. For more information,
see \l{https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html} see \l{https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html}