Doc: Describe the "Prefer .clang-tidy file, if present" option

...in Preferences > Analyzer > Clang Tools.

Task-number: QTCREATORBUG-29392
Change-Id: Ied7b2894cbe3c502db7d787532ecd1bf6822cea0
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2023-11-02 16:41:55 +01:00
parent 51673043cd
commit 65366d96c3
5 changed files with 6 additions and 2 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.8 KiB

View File

@@ -98,7 +98,7 @@
Select the \inlineimage icons/settings.png Select the \inlineimage icons/settings.png
button to customize Clang diagnostics for the current project. button to customize Clang diagnostics for the current project.
\image qtcreator-clang-tools-options-customized.png {Clang Tools customized settings} \image qtcreator-clang-tools-settings.webp {Clang Tools customized settings}
To restore the global settings, select \uicontrol {Restore Global Settings}. To restore the global settings, select \uicontrol {Restore Global Settings}.
To view and modify the global settings, select the link in To view and modify the global settings, select the link in
@@ -114,7 +114,7 @@
\li Select \preferences > \uicontrol Analyzer > \li Select \preferences > \uicontrol Analyzer >
\uicontrol {Clang Tools}. \uicontrol {Clang Tools}.
\image qtcreator-clang-tools-options.png {Clang Tools preferences} \image qtcreator-preferences-analyzer-clang-tools.webp {Clang Tools preferences}
\li In the \uicontrol Clang-Tidy and \uicontrol Clazy-Standalone fields, \li In the \uicontrol Clang-Tidy and \uicontrol Clazy-Standalone fields,
set the paths to the executables to use. set the paths to the executables to use.
@@ -140,6 +140,10 @@
\image qtcreator-clang-tools-diagnostics-configuration.png {Diagnostics Configuration dialog} \image qtcreator-clang-tools-diagnostics-configuration.png {Diagnostics Configuration dialog}
To perform checks from a Clang Tidy configuration file instead,
select \uicontrol {Prefer .clang-tidy file, if present} in the
\uicontrol {Clang Tools} tab.
\li Select \uicontrol Copy to copy the selected diagnostics for editing. \li Select \uicontrol Copy to copy the selected diagnostics for editing.
\image qtcreator-clang-copy-diagnostic-configuration.png {Copy Diagnostic Configuration dialog} \image qtcreator-clang-copy-diagnostic-configuration.png {Copy Diagnostic Configuration dialog}