Doc: Do not use the term "Output pane" in docs

When necessary, replace it with "view". When possible,
rephrase to omit the term. Link to descriptions of the
output views.

Update screenshots.

Change-Id: I80ccd12f5a10f221bbea6de994a15ddd07d20842
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2022-03-04 18:24:58 +01:00
parent bbb0270fb1
commit 09804a65e4
40 changed files with 151 additions and 158 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.8 KiB

After

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

@@ -504,6 +504,6 @@
the performance counters system. the performance counters system.
\endlist \endlist
Output from the helper program that processes the data is displayed in the Output from the helper program that processes the data is displayed in
\uicontrol {General Messages} output pane. \l{Viewing Output}{General Messages}.
*/ */

View File

@@ -295,8 +295,8 @@
the application for debugging. the application for debugging.
\note \QC cannot debug applications on Android devices if Android Studio is \note \QC cannot debug applications on Android devices if Android Studio is
running. If the following message is displayed in the \uicontrol Output running. If the following message is displayed in \l {Application Output},
pane, close Android Studio and try again: close Android Studio and try again:
\badcode \badcode
Ignoring second debugger -accepting and dropping. Ignoring second debugger -accepting and dropping.

View File

@@ -138,7 +138,7 @@
\l{androiddeployqt}. \l{androiddeployqt}.
You can view information about what the \c androiddeployqt tool is doing in You can view information about what the \c androiddeployqt tool is doing in
the \uicontrol {Compile Output} pane. To view additional information, select the \l {Compile Output}. To view additional information, select the
\uicontrol {Verbose output} check box. \uicontrol {Verbose output} check box.
Select \uicontrol {Add debug server} to include the debug server binary Select \uicontrol {Add debug server} to include the debug server binary

View File

@@ -237,6 +237,5 @@
\image qtcreator-cmake-clean-steps.png \image qtcreator-cmake-clean-steps.png
The build errors and warnings are parsed and displayed in the The build errors and warnings are parsed and displayed in \l Issues.
\l Issues output pane.
*/ */

View File

@@ -166,7 +166,7 @@
\endlist \endlist
Warnings and errors are displayed in the \l {Issues} output pane. Warnings and errors are displayed in \l {Issues}.
\section1 Adding External Libraries to CMake Projects \section1 Adding External Libraries to CMake Projects

View File

@@ -203,9 +203,9 @@
views, select the \uicontrol {Use Python dumper} check box. views, select the \uicontrol {Use Python dumper} check box.
For more information, see \l{Debugging Helper Implementation}. For more information, see \l{Debugging Helper Implementation}.
To add information about first-chance and second-chance exceptions To display information about first-chance and second-chance exceptions
to the \uicontrol Issues output pane, select the check boxes in \l Issues, select the check boxes
in the \uicontrol {Add Exceptions to the Issues View} group. in the \uicontrol {Add Exceptions to Issues View} group.
\section2 Setting CDB Paths on Windows \section2 Setting CDB Paths on Windows

View File

@@ -1497,7 +1497,7 @@
You might have created a release build that does not contain debug You might have created a release build that does not contain debug
information. A GNU Compiler Collection (GCC) debug build has the \c {-g} information. A GNU Compiler Collection (GCC) debug build has the \c {-g}
option on the compiler command line. Check that this option is present in option on the compiler command line. Check that this option is present in
the \uicontrol {Compile Output} pane. If it is not, adjust your build the \l {Compile Output}. If it is not, adjust your build
settings in the \uicontrol Projects mode. settings in the \uicontrol Projects mode.
\section1 Debugger Does Not Work \section1 Debugger Does Not Work

View File

@@ -104,7 +104,7 @@
\image qtquick-example-setting-breakpoint3.png \image qtquick-example-setting-breakpoint3.png
\li To execute JavaScript commands in the current context, open the \li To execute JavaScript commands in the current context, open the
\uicontrol {QML Debugger Console} output pane. \uicontrol {QML Debugger Console}.
\image qml-script-console.png \image qml-script-console.png

View File

@@ -253,8 +253,8 @@
When the application is interrupted by a breakpoint, you can use the When the application is interrupted by a breakpoint, you can use the
\uicontrol {QML Debugger Console} to execute JavaScript expressions in the \uicontrol {QML Debugger Console} to execute JavaScript expressions in the
current context. To open it, choose \uicontrol View > current context. To open it, choose \uicontrol View > \uicontrol Output >
\uicontrol {Output Panes} > \uicontrol {QML Debugger Console}. \uicontrol {QML Debugger Console}.
\image qml-script-console.png "QML Debugger Console" \image qml-script-console.png "QML Debugger Console"

View File

@@ -89,8 +89,8 @@
\endif \endif
\endlist \endlist
The \uicontrol {Search Results} pane shows the location \l{Search Results} shows the location and number of search hits in the
and number of search hits in the current project. current project.
\if defined(qtcreator) \if defined(qtcreator)
\image qtcreator-refactoring-find.png \image qtcreator-refactoring-find.png
@@ -101,12 +101,11 @@
You can browse the search results in the following ways: You can browse the search results in the following ways:
\list \list
\li To go directly to an instance, double-click the instance in the \li To go directly to an instance, double-click the instance in
\uicontrol {Search Results} pane. \uicontrol {Search Results}.
\li To move between instances, click the \inlineimage icons/next.png \li To move between instances, click the \inlineimage icons/next.png
(\uicontrol {Next Item}) button and \inlineimage icons/prev.png (\uicontrol {Next Item}) button and \inlineimage icons/prev.png
(\uicontrol {Previous Item}) button in the (\uicontrol {Previous Item}) button in \uicontrol {Search Results}.
\uicontrol {Search Results} pane.
\li To expand and collapse the list of all instances, click the \li To expand and collapse the list of all instances, click the
\inlineimage icons/qtcreator-expand.png \inlineimage icons/qtcreator-expand.png
(\uicontrol {Expand All}) button. (\uicontrol {Expand All}) button.
@@ -139,7 +138,7 @@
\uicontrol {QML/JS} > \uicontrol {Rename Symbol Under Cursor} \uicontrol {QML/JS} > \uicontrol {Rename Symbol Under Cursor}
or press \key {Ctrl+Shift+R}. or press \key {Ctrl+Shift+R}.
The \uicontrol {Search Results} pane shows the location \uicontrol {Search Results} shows the location
and number of instances of the symbol in the current project. and number of instances of the symbol in the current project.
\if defined(qtcreator) \if defined(qtcreator)
@@ -153,15 +152,15 @@
To omit an instance, deselect the check box next to the instance. To omit an instance, deselect the check box next to the instance.
\note This action replaces all selected instances of the symbol in \note This action replaces all selected instances of the symbol in
all files listed in the \uicontrol {Search Results} pane. You cannot all files listed in \uicontrol {Search Results}. You cannot
undo this action. undo this action.
\if defined(qtcreator) \if defined(qtcreator)
If the symbol is a class, select the \uicontrol {Rename files} check If the symbol is a class, select the \uicontrol {Rename files} check
box to also change the filenames that match the class name. box to also change the filenames that match the class name.
\note Renaming local symbols does not open the \uicontrol {Search Results} \note Renaming local symbols does not open \uicontrol {Search Results}.
pane. The instances of the symbol are highlighted in code and you can edit The instances of the symbol are highlighted in code and you can edit
the symbol. All instances of the local symbol are changed as you type. the symbol. All instances of the local symbol are changed as you type.
\endif \endif

View File

@@ -106,7 +106,7 @@
find common problems. To run the checks, select \uicontrol Tools > find common problems. To run the checks, select \uicontrol Tools >
\uicontrol {QML/JS} > \uicontrol {Run Checks} or press \key {Ctrl+Shift+C}. \uicontrol {QML/JS} > \uicontrol {Run Checks} or press \key {Ctrl+Shift+C}.
The results are shown in the \uicontrol QML and \uicontrol {QML Analysis} The results are shown in the \uicontrol QML and \uicontrol {QML Analysis}
filters of the \uicontrol Issues output pane. filters in \l Issues.
Many of the error messages are similar to the ones in Douglas Crockford's Many of the error messages are similar to the ones in Douglas Crockford's
\l{http://www.jslint.com}{JSLint} tool. For more information about JSLint \l{http://www.jslint.com}{JSLint} tool. For more information about JSLint

View File

@@ -56,9 +56,9 @@
\li Select the \uicontrol {Copy-paste URL to clipboard} check box to \li Select the \uicontrol {Copy-paste URL to clipboard} check box to
copy the URL of the post on the code pasting service to the copy the URL of the post on the code pasting service to the
clipboard when you paste a post. clipboard when you paste a post.
\li Select the \uicontrol {Display Output pane after sending a post} \li Select the \uicontrol {Display General Messages after sending a post}
check box to display the URL in the \uicontrol {General Messages} check box to display the URL in \l{Viewing Output}{General Messages}
output pane when you paste a post. when you paste a post.
\endlist \endlist
Select \uicontrol Fileshare to specify the path to a shared network drive. Select \uicontrol Fileshare to specify the path to a shared network drive.
@@ -70,8 +70,7 @@
To paste a snippet of code onto the server, select \uicontrol Tools > To paste a snippet of code onto the server, select \uicontrol Tools >
\uicontrol {Code Pasting} > \uicontrol {Paste Snippet} or press \uicontrol {Code Pasting} > \uicontrol {Paste Snippet} or press
\key {Alt+C,Alt+P}. By default, \QC copies the URL of the snippet to the \key {Alt+C,Alt+P}. By default, \QC copies the URL of the snippet to the
clipboard and displays the URL in the \uicontrol {General Messages} output clipboard and displays the URL in \uicontrol {General Messages}.
pane.
To paste any content that you copied to the clipboard, select To paste any content that you copied to the clipboard, select
\uicontrol Tools > \uicontrol {Code Pasting} > \uicontrol {Paste Snippet}. \uicontrol Tools > \uicontrol {Code Pasting} > \uicontrol {Paste Snippet}.

View File

@@ -116,9 +116,9 @@
patterns to extend the MIME types, separated by semicolons. patterns to extend the MIME types, separated by semicolons.
\li In the \uicontrol {Startup behavior} field, select whether the \li In the \uicontrol {Startup behavior} field, select whether the
language server is started when \QC starts or when a project or file language server is started when \QC starts or when a project or file
with a matching MIME type is opened. The with a matching MIME type is opened. \l{Viewing Output}
\uicontrol {General Messages} \l{Viewing Output}{output pane} {General Messages} displays information about the connection to the
displays information about the connection to the language server. language server.
\li In the \uicontrol Initialization field, you can add language server \li In the \uicontrol Initialization field, you can add language server
specific JSON attributes to pass to an \c initialize request. specific JSON attributes to pass to an \c initialize request.
\li In the \uicontrol Executable field, enter the path to the language \li In the \uicontrol Executable field, enter the path to the language

View File

@@ -90,7 +90,7 @@
chart, select \inlineimage icons/statistics.png chart, select \inlineimage icons/statistics.png
(\uicontrol {View Statistics}). (\uicontrol {View Statistics}).
To search from the state chart, use the \uicontrol Search pane. The search To search from the state chart, use \l {Search Results}. The search
checks the whole SCXML tree for attributes that match the search criteria. checks the whole SCXML tree for attributes that match the search criteria.
To save the currently visible part of the state chart as an image, select To save the currently visible part of the state chart as an image, select

View File

@@ -194,8 +194,8 @@
\image qtcreator-searchresults.png \image qtcreator-searchresults.png
A list of files containing the searched text is displayed in the A list of files containing the searched text is displayed in
\uicontrol {Search Results} pane. \l {Search Results}.
\list \list

View File

@@ -73,8 +73,8 @@
If the editor cannot find the highlight definition for a file that you open If the editor cannot find the highlight definition for a file that you open
for editing, it prompts you to download additional highlight definition for editing, it prompts you to download additional highlight definition
files. Select \uicontrol {Download Definitions} to download the files. files. Select \uicontrol {Download Definitions} to download the files.
Information about the downloaded files is displayed in the Information about the downloaded files is displayed in \l{Viewing Output}
\uicontrol {General Messages} \l{Viewing Output}{output pane}. {General Messages}.
To suppress the message for a particular file pattern, select To suppress the message for a particular file pattern, select
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor}

View File

@@ -135,8 +135,8 @@
working directory. working directory.
\li In the \uicontrol Output field, select how to handle output from the \li In the \uicontrol Output field, select how to handle output from the
tool. You can ignore the output, view it in the \uicontrol {General tool. You can ignore the output, view it in \l{Viewing Output}
Messages} output pane, or replace the selected text with the {General Messages}, or replace the selected text with the
output in the code editor. output in the code editor.
\li In the \uicontrol {Error output} field, select how to handle error \li In the \uicontrol {Error output} field, select how to handle error

View File

@@ -227,22 +227,22 @@
\li Switch to \uicontrol Help mode \li Switch to \uicontrol Help mode
\li Ctrl+6 \li Ctrl+6
\row \row
\li Toggle \uicontrol{Issues} pane \li Toggle \uicontrol{Issues}
\li Alt+1 (Cmd+1 on \macos) \li Alt+1 (Cmd+1 on \macos)
\row \row
\li Toggle \uicontrol{Search Results} pane \li Toggle \uicontrol{Search Results}
\li Alt+2 (Cmd+2 on \macos) \li Alt+2 (Cmd+2 on \macos)
\row \row
\li Toggle \uicontrol{Application Output} pane \li Toggle \uicontrol{Application Output}
\li Alt+3 (Cmd+3 on \macos) \li Alt+3 (Cmd+3 on \macos)
\row \row
\li Toggle \uicontrol{Compile Output} pane \li Toggle \uicontrol{Compile Output}
\li Alt+4 (Cmd+4 on \macos) \li Alt+4 (Cmd+4 on \macos)
\row \row
\li Toggle other output panes \li Toggle other output views
\li Alt+number (Cmd+number on \macos) \li Alt+number (Cmd+number on \macos)
Where the number is the number of the output pane. Where the number is the number of the view.
\if defined(qtcreator) \if defined(qtcreator)
\row \row
\li Activate \uicontrol Bookmarks view \li Activate \uicontrol Bookmarks view
@@ -255,13 +255,13 @@
\li Activate \uicontrol{Open Documents} view \li Activate \uicontrol{Open Documents} view
\li Alt+O \li Alt+O
\row \row
\li Maximize output panes \li Maximize output views
\li Alt+9 \li Alt+9
\row \row
\li Move to next item in output panes \li Move to next item in output
\li F6 \li F6
\row \row
\li Move to previous item in output panes \li Move to previous item in output
\li Shift+F6 \li Shift+F6
\row \row
\li Activate \uicontrol Projects view \li Activate \uicontrol Projects view

View File

@@ -332,7 +332,7 @@
\li In the \uicontrol Tests view, select the tests to run. \li In the \uicontrol Tests view, select the tests to run.
\li In the \uicontrol {Test Results} output pane, select: \li In the \uicontrol {Test Results}, select:
\list \list
\li \inlineimage icons/run_small.png \li \inlineimage icons/run_small.png
@@ -437,8 +437,8 @@
are omitted by default. To view them, deselect the \uicontrol {Omit internal are omitted by default. To view them, deselect the \uicontrol {Omit internal
messages} and \uicontrol {Omit run configuration warnings} check boxes. messages} and \uicontrol {Omit run configuration warnings} check boxes.
By default, test result output is limited to 100,000 characters. The output By default, test result output is limited to 100,000 characters. The view
pane is automatically scrolled down when new results are added. To display is automatically scrolled down when new results are added. To display
full results, deselect the \uicontrol {Limit result output} check box. full results, deselect the \uicontrol {Limit result output} check box.
To disable automatic scrolling, deselect the To disable automatic scrolling, deselect the
\uicontrol {Automatically scroll results} check box. \uicontrol {Automatically scroll results} check box.
@@ -598,7 +598,7 @@
\section1 Viewing Test Output \section1 Viewing Test Output
The test results are displayed in the \uicontrol {Test Results} output pane The test results are displayed in \l{Viewing Output}{Test Results}
in XML format. XML can be parsed more easily and reliably than plain text. in XML format. XML can be parsed more easily and reliably than plain text.
However, if a Qt test crashes, it might not produce complete XML code that However, if a Qt test crashes, it might not produce complete XML code that
@@ -608,11 +608,11 @@
\uicontrol Options > \uicontrol {Testing} > \uicontrol {Qt Test}, and \uicontrol Options > \uicontrol {Testing} > \uicontrol {Qt Test}, and
then deselect the \uicontrol {Use XML output} check box. Then select the then deselect the \uicontrol {Use XML output} check box. Then select the
\inlineimage icons/text.png \inlineimage icons/text.png
(\uicontrol {Switch Between Visual and Text Display}) button in the (\uicontrol {Switch Between Visual and Text Display}) button in
\uicontrol {Test Results} output pane to switch to the text display. \uicontrol {Test Results} to switch to the text display.
The following table lists the messages that the \uicontrol {Test Results} The following table lists the messages that \uicontrol {Test Results}
output pane displays: displays:
\table \table
\header \header

View File

@@ -43,7 +43,7 @@
\li \l {Move between open files} \li \l {Move between open files}
\li \l {Switch to Edit mode} \li \l {Switch to Edit mode}
\li \l {Find a specific setting} \li \l {Find a specific setting}
\li \l {Open output panes} \li \l {View output}
\li \l {Find keyboard shortcuts} \li \l {Find keyboard shortcuts}
\li \l {Run \QC from the command line} \li \l {Run \QC from the command line}
\li \l {Show and hide sidebars} \li \l {Show and hide sidebars}
@@ -114,13 +114,16 @@
To find specific settings in \uicontrol Tools > \uicontrol Options, To find specific settings in \uicontrol Tools > \uicontrol Options,
use the filter located at the top left of the \uicontrol Options dialog box. use the filter located at the top left of the \uicontrol Options dialog box.
\section1 Open output panes \section1 View output
The \l{Viewing Output}{output panes} provide a list of errors and warnings The \l{Viewing Output}{taskbar} provides different views to output from
encountered during a build, detailed output from the compiler, status of a several sources, such as a list of errors and warnings encountered during
program when it is executed, debug output, and search results. a build, detailed output from the compiler, status of a program when it is
executed, debug output, or search results.
To open output panes, use the following shortcuts: \image qtcreator-output-panes-taskbar.png "Output on the taskbar"
To view different types of output, use the following shortcuts:
\list \list
@@ -134,7 +137,7 @@
\endlist \endlist
For additional ways to open all output panes, see \l{Viewing Output}. For additional ways to view other types of output, see \l{Viewing Output}.
\section1 Find keyboard shortcuts \section1 Find keyboard shortcuts

View File

@@ -34,11 +34,11 @@
\page creator-task-lists.html \page creator-task-lists.html
\nextpage creator-logging-viewer.html \nextpage creator-logging-viewer.html
\title Showing Task List Files in Issues Pane \title Showing Task List Files in Issues
You can use code scanning and analysis tools to examine source code. These You can use code scanning and analysis tools to examine source code. These
tools report issues for you to fix. \QC enables you to load lists of tools report issues for you to fix. \QC enables you to load lists of
issues into the \uicontrol Issues pane for easier navigation. issues into \l Issues for easier navigation.
\QC expects tasks to be defined in a simple line-based file format that is \QC expects tasks to be defined in a simple line-based file format that is
easy to generate using scripts. The scripts can either convert reports from easy to generate using scripts. The scripts can either convert reports from
@@ -49,13 +49,13 @@
\section1 Managing Task List Entries \section1 Managing Task List Entries
To open task list files in the \uicontrol Issues pane, choose \uicontrol File > To open task list files in \uicontrol Issues, choose \uicontrol File >
\uicontrol Open. Right-click a task list entry to open a context menu that \uicontrol Open. Right-click a task list entry to open a context menu that
contains commands for managing the entry. You can copy or remove task list contains commands for managing the entry. You can copy or remove task list
entries or navigate to the corresponding source code. entries or navigate to the corresponding source code.
\QC monitors the loaded files and displays the changes in the \uicontrol Issues \QC monitors the loaded files and displays the changes in \uicontrol Issues.
pane. To keep the current entries in a task list, but stop checking for To keep the current entries in a task list, but stop checking for
changes, select \uicontrol {Stop Monitoring}. changes, select \uicontrol {Stop Monitoring}.
\section1 Task List File Format \section1 Task List File Format

View File

@@ -256,7 +256,7 @@
\b {On Unix (Linux and \macos):} \c qDebug() and related functions use \b {On Unix (Linux and \macos):} \c qDebug() and related functions use
the standard output and error output. When you run or debug the the standard output and error output. When you run or debug the
application, you can view the output in the \uicontrol{Application Output} pane. application, you can view the output in \l{Application Output}.
For console applications that require input, select \uicontrol Projects > For console applications that require input, select \uicontrol Projects >
\uicontrol {Run Settings} > \uicontrol {Run in terminal}. To specify the \uicontrol {Run Settings} > \uicontrol {Run in terminal}. To specify the
@@ -287,9 +287,9 @@
\uicontrol {Run in terminal} for console applications. \uicontrol {Run in terminal} for console applications.
For GUI applications, \c qDebug() and related functions use the Windows API For GUI applications, \c qDebug() and related functions use the Windows API
function \c OutputDebugString(). The output is displayed in the function \c OutputDebugString(). The output is displayed in
\uicontrol{Application Output} pane. However, only one output pane tab may be \uicontrol{Application Output}. However, \QC can show output from only one
open at a time or the output is not displayed correctly. You can use an source at the time for it to be displayed correctly. You can use an
external debug output viewer, such as the external debug output viewer, such as the
\l{https://technet.microsoft.com/en-us/sysinternals/bb896647} \l{https://technet.microsoft.com/en-us/sysinternals/bb896647}
{DebugView for Windows} to display output from GUI applications. {DebugView for Windows} to display output from GUI applications.

View File

@@ -51,8 +51,7 @@
In the \uicontrol {Target and configuration} group, specify the command In the \uicontrol {Target and configuration} group, specify the command
helper and arguments that will be used to construct the build command. helper and arguments that will be used to construct the build command.
The build errors and warnings are parsed and displayed in the The build errors and warnings are parsed and displayed in \l Issues.
\uicontrol Issues output pane.
Select the \uicontrol {Keep original jobs number} check box to stop Select the \uicontrol {Keep original jobs number} check box to stop
IncrediBuild from overriding the \c {-j} command line switch, which IncrediBuild from overriding the \c {-j} command line switch, which
@@ -142,6 +141,5 @@
For more information about the settings, see \l{IncrediBuild Build Steps}. For more information about the settings, see \l{IncrediBuild Build Steps}.
The build errors and warnings are parsed and displayed in the The build errors and warnings are parsed and displayed in \l Issues.
\uicontrol Issues output pane.
*/ */

View File

@@ -66,7 +66,6 @@
\image qtcreator-meson-clean-steps.png "Meson clean steps" \image qtcreator-meson-clean-steps.png "Meson clean steps"
The build errors and warnings are parsed and displayed in the The build errors and warnings are parsed and displayed in \uicontrol Issues.
\uicontrol Issues output pane.
*/ */

View File

@@ -88,12 +88,11 @@
\list \list
\li \l{Showing Task List Files in Issues Pane} \li \l{Showing Task List Files in Issues}
You can load report files created by code scanning and analysis You can load report files created by code scanning and analysis
tools to the \uicontrol Issues output pane. You can navigate to the tools to \l Issues. You can navigate to the corresponding source
corresponding source code by clicking the error message or by using code by clicking the error message or by using keyboard shortcuts.
keyboard shortcuts.
\li \l{Inspecting Internal Logs} \li \l{Inspecting Internal Logs}

View File

@@ -104,7 +104,7 @@
items with names consisting of plain characters, numbers, items with names consisting of plain characters, numbers,
underscores, and hyphens. underscores, and hyphens.
\li If error messages displayed in the \uicontrol {Compile Output} pane contain \li If error messages displayed in \l {Compile Output} contain
paths where slashes are missing (for example, C:QtSDK), paths where slashes are missing (for example, C:QtSDK),
check your PATH variable. For more information, see check your PATH variable. For more information, see
\l{Troubleshooting MinGW Compilation Errors}. \l{Troubleshooting MinGW Compilation Errors}.

View File

@@ -32,7 +32,7 @@
Custom output parsers scan command line output for error Custom output parsers scan command line output for error
and warning patterns that you specify and create entries and warning patterns that you specify and create entries
for found patterns in the \uicontrol Issues output pane. for found patterns in \l Issues.
To view or add custom output parsers, select To view or add custom output parsers, select
\uicontrol Tools > \uicontrol Options > \uicontrol Tools > \uicontrol Options >
@@ -68,9 +68,9 @@
\li In the \uicontrol {Error message capture pattern} field, specify \li In the \uicontrol {Error message capture pattern} field, specify
a regular expression to define what is an error. The custom a regular expression to define what is an error. The custom
parser matches the compile output line by line against the parser matches the compile output line by line against the
regular expression and displays errors in the \uicontrol Issues regular expression and displays errors in \l Issues. Create
output pane. Create regular expression groups that contain regular expression groups that contain the file name, line number
the file name, line number and error message. and error message.
\li In the \uicontrol {Capture Positions} field, map the regular \li In the \uicontrol {Capture Positions} field, map the regular
expression groups to \uicontrol {File name}, \uicontrol {Line number}, expression groups to \uicontrol {File name}, \uicontrol {Line number},
and \uicontrol Message. and \uicontrol Message.

View File

@@ -85,8 +85,8 @@
\li Click \inlineimage icons/run_small.png \li Click \inlineimage icons/run_small.png
(\uicontrol Run) to build and run the application. (\uicontrol Run) to build and run the application.
\li To see the compilation progress, press \key{Alt+4} to open the \li To see the compilation progress, press \key{Alt+4} to open
\uicontrol {Compile Output} pane. \l {Compile Output}.
If build errors occur, check that a Qt version and If build errors occur, check that a Qt version and
\l{Adding Compilers}{compiler} are installed and \l{Adding Compilers}{compiler} are installed and

View File

@@ -46,8 +46,7 @@
To check that the application code can be compiled and linked for a device, To check that the application code can be compiled and linked for a device,
you can build the project. The build errors and warnings are displayed in you can build the project. The build errors and warnings are displayed in
the \uicontrol {Issues} output pane. More detailed information is displayed the \l Issues. More detailed information is displayed in \l {Compile Output}.
in the \uicontrol {Compile Output} pane.
To build an application: To build an application:

View File

@@ -245,7 +245,7 @@
\section1 Troubleshooting \MinGW Compilation Errors \section1 Troubleshooting \MinGW Compilation Errors
If error messages displayed in the \uicontrol {Compile Output} pane contain If error messages displayed in \l {Compile Output} contain
paths where slashes are missing (for example, \c {C:QtSDK}), paths where slashes are missing (for example, \c {C:QtSDK}),
check your PATH variable. At the command line, enter the following commands: check your PATH variable. At the command line, enter the following commands:

View File

@@ -86,7 +86,7 @@
errors occur, if possible. errors occur, if possible.
\li Select \uicontrol {Show command lines} to print actual \li Select \uicontrol {Show command lines} to print actual
command lines to the compile output pane instead of command lines to \l{Compile Output} instead of
high-level descriptions. high-level descriptions.
\li Select \uicontrol {Force probes} to force re-execution of \li Select \uicontrol {Force probes} to force re-execution of

View File

@@ -77,9 +77,9 @@
Select \uicontrol Manage to manage device settings. For example, you can add Select \uicontrol Manage to manage device settings. For example, you can add
AVDs or manually start disconnected AVDs. AVDs or manually start disconnected AVDs.
The \uicontrol {Application Output} pane displays the status of the \l {Application Output} displays the status of the
application while it is running. You can select the \uicontrol Run button application while it is running. You can select the \uicontrol Run button
in the pane to re-run applications without building them first. This is to re-run applications without building them first. This is
useful when developing Qt Quick applications, because the QML files are useful when developing Qt Quick applications, because the QML files are
interpreted at runtime. Therefore, the application does not need to be interpreted at runtime. Therefore, the application does not need to be
built again if you edited only QML files. This saves time especially if built again if you edited only QML files. This saves time especially if

View File

@@ -228,7 +228,7 @@
\li \l{Using Command Line Options} \li \l{Using Command Line Options}
\li \l{Keyboard Shortcuts} \li \l{Keyboard Shortcuts}
\li \l{Using External Tools} \li \l{Using External Tools}
\li \l{Showing Task List Files in Issues Pane} \li \l{Showing Task List Files in Issues}
\li \l{Inspecting Internal Logs} \li \l{Inspecting Internal Logs}
\li \l{Managing Data Collection} \li \l{Managing Data Collection}
\list \list

View File

@@ -77,8 +77,8 @@
You can use the kit selector (2) to select the You can use the kit selector (2) to select the
\l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or \l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or
building (5) the application. Output from these actions is displayed in the building (5) the application. Output from these actions is displayed on
output panes (7). the task bar (7).
You can use the \l{Searching with the Locator}{locator} (6) to browse You can use the \l{Searching with the Locator}{locator} (6) to browse
through projects, files, classes, functions, documentation, and file through projects, files, classes, functions, documentation, and file
@@ -93,7 +93,7 @@
\li \l{Selecting Modes}{Mode selector} \li \l{Selecting Modes}{Mode selector}
\li \l{Working with Sidebars}{Sidebars} \li \l{Working with Sidebars}{Sidebars}
\li \l{Browsing Project Contents}{Views} \li \l{Browsing Project Contents}{Views}
\li \l{Viewing Output}{Output panes} \li \l{Viewing Output}{Output}
\endlist \endlist
\else \else
@@ -377,9 +377,9 @@
\title Viewing Output \title Viewing Output
\image qtcreator-general-messages.png "General Messages output pane" \image qtcreator-general-messages.png "General Messages"
The task pane in \QC can display one of the following panes: The taskbar in \QC can display following types of output:
\list \list
@@ -405,30 +405,30 @@
\endlist \endlist
Output panes are available on the taskbar in all \l{Selecting Modes}{modes}. Output is available on the taskbar in all \l{Selecting Modes}{modes}.
\image qtcreator-output-panes-taskbar.png "Output panes on the taskbar" \image qtcreator-output-panes-taskbar.png "Output on the taskbar"
You can open output panes in the following ways: You can view output in the following ways:
\list \list
\li Select the output pane on the taskbar. \li Select the output view on the taskbar.
\li Select \key Alt (\key Cmd on \macos) and the number of the pane on \li Select \key Alt (\key Cmd on \macos) and the number of the view on
the taskbar. the taskbar.
\li Select \inlineimage icons/output-pane-menu.png \li Select \inlineimage icons/output-pane-menu.png
, and then select the pane to open. , and then select the view to open.
\li Select \uicontrol View > \uicontrol {Output Panes}. \li Select \uicontrol View > \uicontrol Output.
The menu items also display the keyboard shortcuts that you can use. The menu items also display the keyboard shortcuts that you can use.
\endlist \endlist
To maximize an open output pane, select the \inlineimage icons/arrowup.png To maximize an open output view, select the \inlineimage icons/arrowup.png
(\uicontrol {Maximize Output Pane}) button or press \key {Alt+Shift+9}. (\uicontrol Maximize) button or press \key {Alt+Shift+9}.
To increase or decrease the output text size, select \inlineimage icons/plus.png To increase or decrease the output text size, select \inlineimage icons/plus.png
(\uicontrol {Zoom In}) or \inlineimage icons/minus.png (\uicontrol {Zoom In}) or \inlineimage icons/minus.png
(\uicontrol {Zoom Out}), or press \key Ctrl++ or \key Ctrl+-. Zooming is (\uicontrol {Zoom Out}), or press \key Ctrl++ or \key Ctrl+-. Zooming is
not supported in all output panes. not supported in all output views.
To open the \uicontrol{General Messages} and To open the \uicontrol{General Messages} and
\if defined(qtcreator) \if defined(qtcreator)
@@ -436,16 +436,15 @@
\else \else
\l{Using Git}{Version Control} \l{Using Git}{Version Control}
\endif \endif
panes, select \uicontrol View > \uicontrol {Output Panes}. views, select \uicontrol View > \uicontrol Output.
\if defined(qtcreator) \if defined(qtcreator)
To display the \uicontrol {To-Do Entries} pane, enable the \uicontrol Todo To view \uicontrol {To-Do Entries}, enable the \uicontrol Todo plugin.
plugin.
\endif \endif
For more information about the \uicontrol {QML Debugger Console} view, see For more information about the \uicontrol {QML Debugger Console} view, see
\l{Executing JavaScript Expressions}. \l{Executing JavaScript Expressions}.
If the text in the output panes is not displayed correctly, \QC might If the text in the output is not displayed correctly, \QC might
be using a different codec from the one used by the tools that generate be using a different codec from the one used by the tools that generate
the output. To specify the codec to use, select \uicontrol Tools > the output. To specify the codec to use, select \uicontrol Tools >
\uicontrol Options > \uicontrol Environment > \uicontrol Interface, and \uicontrol Options > \uicontrol Environment > \uicontrol Interface, and
@@ -455,7 +454,7 @@
\section1 Finding and Filtering Output \section1 Finding and Filtering Output
To search from output, press \key {Ctrl+F} when the pane is active. Enter To search from output, press \key {Ctrl+F} when the view is active. Enter
search criteria in the \uicontrol Find field. For more information, see search criteria in the \uicontrol Find field. For more information, see
\l{Finding and Replacing}. \l{Finding and Replacing}.
@@ -466,11 +465,11 @@
case-sensitivity. Select \uicontrol {Show Non-matching Lines} to case-sensitivity. Select \uicontrol {Show Non-matching Lines} to
hide the lines that match the filter. hide the lines that match the filter.
Finding and filtering are not supported in all output panes. Finding and filtering are not supported in all output views.
\section1 Issues \section1 Issues
The \uicontrol{Issues} pane provides lists of following types of issues: \uicontrol{Issues} provides lists of following types of issues:
\list \list
@@ -491,8 +490,8 @@
{Errors and warnings from the current editor}. {Errors and warnings from the current editor}.
\endif \endif
\li \uicontrol Compile - Selected output from the compiler. Open the \li \uicontrol Compile - Selected output from the compiler. Open
\uicontrol {Compile Output} pane for more detailed information. \uicontrol {Compile Output} for more detailed information.
\li \uicontrol{Debug Information} - Lists debug information packages that might \li \uicontrol{Debug Information} - Lists debug information packages that might
be missing. be missing.
@@ -510,7 +509,7 @@
\if defined(qtcreator) \if defined(qtcreator)
\li \uicontrol {My Tasks} - Entries from a task list file (.tasks) generated \li \uicontrol {My Tasks} - Entries from a task list file (.tasks) generated
by \l{Showing Task List Files in Issues Pane} by \l{Showing Task List Files in Issues}
{code scanning and analysis tools}. {code scanning and analysis tools}.
\li \uicontrol Python - Runtime errors and exceptions of Python scripts. \li \uicontrol Python - Runtime errors and exceptions of Python scripts.
@@ -522,12 +521,12 @@
\endlist \endlist
The pane filters out irrelevant output from the build tools and presents the The view filters out irrelevant output from the build tools and presents the
issues in an organized way. To further filter the output by type, select issues in an organized way. To further filter the output by type, select
\inlineimage icons/filtericon.png \inlineimage icons/filtericon.png
(\uicontrol {Filter Tree}) and then select a filter. (\uicontrol {Filter Tree}) and then select a filter.
\image qtcreator-issues.png "Issues output pane" \image qtcreator-issues.png "Issues"
Select one or several lines to apply context-menu actions to their contents. Select one or several lines to apply context-menu actions to their contents.
You can remove the selected lines or copy their contents to the clipboard. You can remove the selected lines or copy their contents to the clipboard.
@@ -539,23 +538,23 @@
select \uicontrol {Show in Editor} in the context menu. The entry must contain the select \uicontrol {Show in Editor} in the context menu. The entry must contain the
name of the file where the issue was found. name of the file where the issue was found.
To view more information about an issue in the \uicontrol {Compile Output} pane, To view more information about an issue in \l {Compile Output},
select \uicontrol {Show Output} in the context menu. select \uicontrol {Show Output} in the context menu.
To jump from one issue to the next or previous one, press \key F6 and To jump from one issue to the next or previous one, press \key F6 and
\key Shift+F6. \key Shift+F6.
By default, the \uicontrol Issues pane is cleared on a new build. To keep By default, the \uicontrol Issues view is cleared on a new build. To keep
the issues from the previous build rounds, deselect \uicontrol Tools > the issues from the previous build rounds, deselect \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol General > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol General >
\uicontrol {Clear issues list on new build}. \uicontrol {Clear issues list on new build}.
\section1 Search Results \section1 Search Results
In the \uicontrol{Search Results} pane, you can search through projects, files on In \uicontrol{Search Results}, you can search through projects, files on
a file system or the currently open files: a file system or the currently open files:
\image qtcreator-search-results.png "Search Results output pane" \image qtcreator-search-results.png "Search Results"
The search results are stored in the search history (1) from which you can The search results are stored in the search history (1) from which you can
select earlier searches. select earlier searches.
@@ -570,7 +569,7 @@
\section1 Application Output \section1 Application Output
The \uicontrol{Application Output} pane displays the status of a program when \uicontrol{Application Output} displays the status of a program when
it is executed, and the debug output. it is executed, and the debug output.
\image qtcreator-application-output.png \image qtcreator-application-output.png
@@ -589,37 +588,36 @@
\uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
\uicontrol {Application Output}, or click the \inlineimage icons/settings.png \uicontrol {Application Output}, or click the \inlineimage icons/settings.png
(\uicontrol {Open Settings Page}) button. You can select whether to open (\uicontrol {Open Settings Page}) button. You can select whether to open
the \uicontrol{Application Output} pane on output when running or debugging \uicontrol{Application Output} on output when running or debugging
applications, to clear old output on a new run, applications, to clear old output on a new run,
to word-wrap output, and to limit output to the specified number of lines. to word-wrap output, and to limit output to the specified number of lines.
\section1 Compile Output \section1 Compile Output
The \uicontrol{Compile Output} pane provides all output from the compiler. \uicontrol{Compile Output} provides all output from the compiler.
The \uicontrol{Compile Output} is a more detailed version of information The \uicontrol{Compile Output} is a more detailed version of information
displayed in the \uicontrol{Issues} pane. displayed in \l Issues.
\image qtcreator-compile-output.png "Compile Output pane" \image qtcreator-compile-output.png "Compile Output"
Double-click on a file name in an error message to open the file in the Double-click on a file name in an error message to open the file in the
code editor. code editor.
Select the \uicontrol {Cancel Build} button to cancel the build. Select the \uicontrol {Cancel Build} button to cancel the build.
To specify whether to open the \uicontrol {Compile Output} pane on output To specify whether to open the \uicontrol {Compile Output} view on output
when building applications, select \uicontrol Tools > \uicontrol Options > when building applications, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol {Compile Output}, and then select the \uicontrol {Build & Run} > \uicontrol {Compile Output}, and then select the
\uicontrol {Open pane when building} check box. \uicontrol {Open view when building} check box.
In the \uicontrol {Limit output to} field, you can specify the maximum In the \uicontrol {Limit output to} field, you can specify the maximum
amount of build output lines to display in the pane. amount of build output lines to display.
You can also reach the options page by clicking \inlineimage icons/settings.png You can also reach the options page by clicking \inlineimage icons/settings.png
(\uicontrol {Open Settings Page}). (\uicontrol {Open Settings Page}).
To copy the output from the pane to the clipboard, select To copy the output to the clipboard, select \uicontrol {Select All} in the
\uicontrol {Select All} in the context menu, and then select context menu, and then select \uicontrol Copy. Save the output as a file if
\uicontrol Copy. Save the output as a file if you want to you want to examine it later without having to build the project again.
examine it later without having to build the project again.
This is useful for large projects that take a long time to build. This is useful for large projects that take a long time to build.
\section2 Parsing Existing Compile Output \section2 Parsing Existing Compile Output
@@ -641,8 +639,8 @@
\li In the \uicontrol {Use parsers from kit} field, select the kit to \li In the \uicontrol {Use parsers from kit} field, select the kit to
use for parsing the output. Select \uicontrol Manage to view use for parsing the output. Select \uicontrol Manage to view
and modify kit settings. and modify kit settings.
\li The parser displays the parsed output in the \uicontrol Issues \li The parser displays the parsed output in \l Issues. By default, the
pane. By default, the pane is cleared before adding the new output. view is cleared before adding the new output.
Deselect the \uicontrol {Clear existing tasks} check box to append Deselect the \uicontrol {Clear existing tasks} check box to append
the new output to the old output. the new output to the old output.
\li Select \uicontrol OK to start parsing. \li Select \uicontrol OK to start parsing.
@@ -651,7 +649,7 @@
\if defined(qtcreator) \if defined(qtcreator)
\section1 To-Do Entries \section1 To-Do Entries
The \uicontrol {To-Do Entries} pane lists the BUG, FIXME, NOTE, TODO, and \uicontrol {To-Do Entries} lists the BUG, FIXME, NOTE, TODO, and
WARNING keywords from the current file, from all project files, or from a WARNING keywords from the current file, from all project files, or from a
subproject. Click the icons on the toolbar to show only the selected subproject. Click the icons on the toolbar to show only the selected
keywords. keywords.
@@ -688,8 +686,8 @@
and load the plugin. and load the plugin.
In addition, you can open task list files generated by code scanning and In addition, you can open task list files generated by code scanning and
analysis tools in the \uicontrol Issues pane. For more information, see analysis tools in \l Issues. For more information, see
\l{Showing Task List Files in Issues Pane}. \l{Showing Task List Files in Issues}.
\endif \endif
*/ */

View File

@@ -129,9 +129,9 @@
\li \l{Using Subversion} \li \l{Using Subversion}
\endlist \endlist
The \uicontrol{Version Control} output pane displays the commands that are \uicontrol{Version Control} displays the commands that are
executed, a timestamp, and the relevant output. Select \uicontrol View > executed, a timestamp, and the relevant output. Select \uicontrol View >
\uicontrol {Output Panes} > \uicontrol {Version Control} to open the pane. \uicontrol Output > \uicontrol {Version Control} to open the view.
\image qtcreator-vcs-pane.png \image qtcreator-vcs-pane.png

View File

@@ -198,9 +198,9 @@
\section2 Viewing Git Status \section2 Viewing Git Status
To view the status of the repository in the \uicontrol {Version Control} To view the status of the repository in \uicontrol {Version Control},
output pane, select \uicontrol Status. The context menu contains additional select \uicontrol Status. The context menu contains additional
actions, such as selecting and clearing all entries in the pane, copying actions, such as selecting and clearing all entries, copying
text, and opening files. text, and opening files.
\section2 Committing Changes to Git \section2 Committing Changes to Git

View File

@@ -224,11 +224,11 @@
One way to handle that would be to let the tool create an output file, which One way to handle that would be to let the tool create an output file, which
is then opened within \QC. You provide an editor (probably read-only) for is then opened within \QC. You provide an editor (probably read-only) for
handling this file. For lists of issues, consider creating task list files handling this file. For lists of issues, consider creating task list files
which are shown in the \uicontrol Issues output pane. which are shown in \l Issues.
\list \list
\li \l{https://doc.qt.io/qtcreator/creator-task-lists.html} \li \l{https://doc.qt.io/qtcreator/creator-task-lists.html}
{Showing Task List Files in the Issues Pane} {Showing Task List Files in Issues}
\li \l{Creating Plugins} \li \l{Creating Plugins}
\li \l{Qt Creator Coding Rules} \li \l{Qt Creator Coding Rules}
\omit \omit

View File

@@ -404,7 +404,7 @@
\li Dialog that provides feedback to users, in the form of status \li Dialog that provides feedback to users, in the form of status
information, a warning, or an error message. information, a warning, or an error message.
\image qtcreator-error-message.png "Message box" \image qtcreator-error-message.png "Message box"
Output from Qt Creator should be displayed in output panes, Output from Qt Creator should be displayed in output views,
instead. instead.
\li Use the event as the title and provide a solution in the \li Use the event as the title and provide a solution in the
message box. message box.
@@ -417,10 +417,10 @@
Use descriptive, but short mode names. They have to fit in the Use descriptive, but short mode names. They have to fit in the
\uicontrol {Mode selector}. \uicontrol {Mode selector}.
\row \row
\li Output pane \li Output
\li A pane displayed in the task pane that displays output from Qt Creator. \li Views to display output from Qt Creator.
\image qtcreator-output-pane.png "Output pane" \image qtcreator-output-pane.png "Output"
\li Use descriptive names for output panes. \li Use descriptive names for output views.
\row \row
\li Sidebar \li Sidebar
\li A view available in the \uicontrol Edit and \uicontrol Debug modes that \li A view available in the \uicontrol Edit and \uicontrol Debug modes that