Doc: Turn "Using Custom Output Parsers" into two how-to topics

Task-number: QTCREATORBUG-29361
Change-Id: I426f0fe545a485a1932d1e59fed99c07c71f4aff
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2023-12-07 14:27:40 +01:00
parent 7ea90a11e4
commit 52eff2c6a4
5 changed files with 36 additions and 26 deletions

View File

@@ -1,18 +1,19 @@
// Copyright (C) 2022 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-project-settings-environment.html
\page creator-custom-output-parsers.html
\nextpage creator-sharing-project-settings.html
\previouspage creator-how-tos.html
\title Using Custom Output Parsers
\ingroup creator-how-to-build
\title Add custom output parsers
Custom output parsers scan command-line output for error
and warning patterns that you specify and create entries
for found patterns in \l Issues.
To view or add custom output parsers, select \preferences >
To add or change custom output parsers, select \preferences >
\uicontrol {Build & Run} > \uicontrol {Custom Output Parsers}.
\image qtcreator-custom-parser-list.png
@@ -22,25 +23,18 @@
To remove the selected parser, select \uicontrol Remove.
You can activate custom output parsers in the
\uicontrol {Custom Output Parsers} section of
the \uicontrol Build and \uicontrol Run settings,
as well as in the \l{Add custom compilers}
{custom compiler settings}.
\section1 Set custom parser preferences
\section1 Specifying Settings for Custom Output Parsers
\image qtcreator-custom-parser-options.png "Custom Output Parsers preferences"
A custom output parser enables you to capture errors and
warnings separately, according to the settings you specify
in the \uicontrol Error and \uicontrol Warning tab.
You can capture errors and warnings separately, according to the settings
you specify in the \uicontrol Error and \uicontrol Warning tab.
To create a custom output parser:
\list 1
\li Select \preferences > \uicontrol {Build & Run} >
\uicontrol {Custom Output Parsers} > \uicontrol Add.
\image qtcreator-custom-parser-options.png "Custom Output Parsers preferences"
\li In the \uicontrol {Error message capture pattern} field, specify
a regular expression to define what is an error. The custom
parser matches the compile output line by line against the
@@ -62,9 +56,21 @@
descriptive than the default value.
\endlist
\section1 Activating Custom Output Parsers
\sa {Activate custom output parsers}
*/
\image qtcreator-custom-parser.png
/*!
\page creator-how-to-activate-custom-output-parsers.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-build
\title Activate custom output parsers
You can activate custom output parsers in the
\uicontrol {Custom Output Parsers} section of
the \uicontrol Build and \uicontrol Run settings,
as well as in the custom compiler settings.
To activate a custom output parser in the \uicontrol Build or
\uicontrol Run settings of a project:
@@ -72,10 +78,14 @@
\list 1
\li In the \uicontrol {Custom Output Parsers} section, select
\uicontrol Details.
\image qtcreator-custom-parser.png
\li Select custom parsers to activate them for building or running
the project.
\endlist
Select \uicontrol {Parse standard output during build} to make output
parsers look for diagnostics on \c stdout in addition to \c stderr.
\sa {Add custom compilers}, {Add custom output parsers},
{Configure projects for building}, {Configure projects for running}
*/

View File

@@ -319,9 +319,10 @@
to the Qt mkspecs directory.
\li In the \uicontrol {Error parser} field, select the error parser to use.
You can add custom output parsers to the list.
You can add custom output parsers to the list. Select
\uicontrol {Custom Parser Settings} to view and edit their preferences.
\endlist
\sa {Add compilers}, {Add Nim compilers}, {Compilers},
{Using Custom Output Parsers}
{Add custom output parsers}
*/

View File

@@ -83,7 +83,6 @@
\li \l{Using Clang Tools}{Clang Tools}
\li \l{Specify code style}{C++ Code Style}
\li \l{Set C++ file naming preferences}{C++ File Naming}
\li \l{Using Custom Output Parsers}{Custom Output Parsers}
\li \l{Specify dependencies}{Dependencies}
\li \l{Document code}{Documentation Comments}
\li \l{Specify editor settings}{Editor}
@@ -96,7 +95,8 @@
in \uicontrol {Active Project}.
\sa {Activate kits for a project}, {Configure projects for building},
{Configure projects for running}, {Open projects}
{Configure projects for running}, {Open projects},
{Activate custom output parsers}
*/
/*!

View File

@@ -26,7 +26,6 @@
\li \l{Creating Projects}
\li \l{Configuring Projects}
\list
\li \l{Using Custom Output Parsers}
\li \l{Sharing Project Settings}
\endlist
\endlist

View File

@@ -63,7 +63,7 @@
\sa {View output}
\if defined(qtcreator)
\sa {Show task list files in Issues}
\sa {Add custom output parsers}, {Show task list files in Issues}
\endif
*/
@@ -224,5 +224,5 @@
\li Select \uicontrol OK to start parsing.
\endlist
\sa {View output}
\sa {View output}, {Add custom output parsers}
*/