Doc: Describe "Discard excessive output" option in Compile Output

- Add a description of the option
- Update screenshot
- Fix the capitalization of the checkbox label and the wording of
  the tooltip

Task-number: QTCREATORBUG-31510
Change-Id: I9028f800d640f9f88a51c9275c07b8e327602383
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2024-10-14 14:09:46 +02:00
parent 69d9c54df4
commit 41fc23ce51
3 changed files with 13 additions and 11 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

@@ -263,8 +263,10 @@
\uicontrol {Compile Output}.
\endlist
\image qtcreator-preferences-compile-output.webp {Compile Output tab in Preferences}
\li Select the \uicontrol {Open Compile Output when building} check box.
\li In the \uicontrol {Limit output to} field, you can specify the
\li Select \uicontrol {Open Compile Output when building}.
\li Select \uicontrol {Discard excessive output} to discard compile
output that continuously comes in faster than it can be handled.
\li In \uicontrol {Limit output to}, specify the
maximum amount of build output lines to display.
\endlist
@@ -278,18 +280,18 @@
To parse compile output:
\list 1
\li Select \uicontrol Tools > \uicontrol {Parse Build Output}.
\li Go to \uicontrol Tools > \uicontrol {Parse Build Output}.
\image qtcreator-parse-build-output.png
\li Paste the build output in the \uicontrol {Build Output} field, or
\li Paste the build output in \uicontrol {Build Output}, or
select \uicontrol {Load from File} to load it from a file.
\li Deselect the \uicontrol {Output went to stderr} check box if the
parser expects issues on \c stdout.
\li In the \uicontrol {Use parsers from kit} field, select the kit to
\li Clear \uicontrol {Output went to stderr} if the parser expects issues
on \c stdout.
\li In \uicontrol {Use parsers from kit}, select the kit to
use for parsing the output. Select \uicontrol Manage to view
and modify kit settings.
\li The parser displays the parsed output in \l Issues. By default, the
view is cleared before adding the new output.
Deselect the \uicontrol {Clear existing tasks} check box to append
Clear \uicontrol {Clear existing tasks} to append
the new output to the old output.
\li Select \uicontrol OK to start parsing.
\endlist

View File

@@ -266,11 +266,11 @@ CompileOutputSettings::CompileOutputSettings()
popUp.setLabelText(Tr::tr("Open Compile Output when building"));
discardOutput.setSettingsKey("ProjectExplorer/Settings/DiscardCompilerOutput");
discardOutput.setLabelText(Tr::tr("Discard Excessive Output"));
discardOutput.setLabelText(Tr::tr("Discard excessive output"));
discardOutput.setToolTip(
Tr::tr(
"If this option is enabled, compile output will be discarded if it continuously comes "
"in faster than it can be handled."));
"Discards compile output that continuously comes in faster than "
"it can be handled."));
maxCharCount.setSettingsKey("ProjectExplorer/Settings/MaxBuildOutputLines");
maxCharCount.setRange(1, Core::Constants::DEFAULT_MAX_CHAR_COUNT);