forked from qt-creator/qt-creator
Doc: Move output view docs to separate topics
- Move some information from "Viewing Output" to the "View output" how-to topic - Add the output view topics to \ingroup creator-reference-output-views and \ingroup studio-reference-output-views Task-number: QTCREATORBUG-29361 Change-Id: Ib91373015f416bf4eb6f5f5123a4ae6e5ebe8d8e Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
Binary file not shown.
|
Before Width: | Height: | Size: 3.3 KiB After Width: | Height: | Size: 9.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 4.8 KiB |
BIN
doc/qtcreator/images/qtcreator-preferences-compile-output.webp
Normal file
BIN
doc/qtcreator/images/qtcreator-preferences-compile-output.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.3 KiB |
@@ -500,9 +500,9 @@
|
|||||||
\endlist
|
\endlist
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
Output from the helper program that processes the data is displayed in
|
The \uicontrol {General Messages} view shows \l{View output}{output} from the
|
||||||
\l{Viewing Output}{General Messages}.
|
helper program that processes the data.
|
||||||
|
|
||||||
Some information is displayed in \l {Application Output} even if the
|
The \l {Application Output} view shows some information even if the
|
||||||
Performance Analyzer displays error messages.
|
Performance Analyzer displays error messages.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
\page creator-editor-functions.html
|
\page creator-editor-functions.html
|
||||||
\previouspage creator-coding.html
|
\previouspage creator-coding.html
|
||||||
\if defined(qtdesignstudio)
|
\if defined(qtdesignstudio)
|
||||||
\nextpage creator-output-panes.html
|
\nextpage creator-highlighting.html
|
||||||
\else
|
\else
|
||||||
\nextpage creator-coding-navigating.html
|
\nextpage creator-coding-navigating.html
|
||||||
\endif
|
\endif
|
||||||
|
|||||||
@@ -35,7 +35,7 @@
|
|||||||
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 General Messages after sending a post}
|
\li Select the \uicontrol {Display General Messages after sending a post}
|
||||||
check box to display the URL in \l{Viewing Output}{General Messages}
|
check box to display the URL in \l{View output}{General Messages}
|
||||||
when you paste a post.
|
when you paste a post.
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
|
|||||||
@@ -92,7 +92,7 @@
|
|||||||
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. \l{Viewing Output}
|
with a matching MIME type is opened. \l{View output}
|
||||||
{General Messages} displays information about the connection to the
|
{General Messages} displays information about the connection to the
|
||||||
language server.
|
language server.
|
||||||
\li In the \uicontrol {Initialization options} field, you can add
|
\li In the \uicontrol {Initialization options} field, you can add
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\page creator-highlighting.html
|
\page creator-highlighting.html
|
||||||
\if defined(qtdesignstudio)
|
\if defined(qtdesignstudio)
|
||||||
\previouspage creator-output-panes.html
|
\previouspage creator-editor-functions.html
|
||||||
\else
|
\else
|
||||||
\previouspage creator-coding-navigating.html
|
\previouspage creator-coding-navigating.html
|
||||||
\endif
|
\endif
|
||||||
@@ -55,8 +55,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 \l{Viewing Output}
|
To view information about the downloaded files, open the \l{View output}
|
||||||
{General Messages}.
|
{General Messages} view.
|
||||||
|
|
||||||
To suppress the message for a particular file pattern, select
|
To suppress the message for a particular file pattern, select
|
||||||
\uicontrol Edit > \uicontrol Preferences > \uicontrol {Text Editor}
|
\uicontrol Edit > \uicontrol Preferences > \uicontrol {Text Editor}
|
||||||
|
|||||||
@@ -113,7 +113,7 @@
|
|||||||
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 \l{Viewing Output}
|
tool. You can ignore the output, view it in \l{View output}
|
||||||
{General Messages}, 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.
|
||||||
|
|
||||||
|
|||||||
@@ -584,7 +584,7 @@
|
|||||||
|
|
||||||
\section1 Viewing Test Output
|
\section1 Viewing Test Output
|
||||||
|
|
||||||
The \l{Viewing Output}{Test Results} view shows Qt and Qt Quick test results
|
The \l{View output}{Test Results} view shows Qt and Qt Quick test results
|
||||||
in XML format and other test results in plain text format.
|
in XML format and other test results in plain text format.
|
||||||
|
|
||||||
\section2 Qt Test Output
|
\section2 Qt Test Output
|
||||||
|
|||||||
@@ -129,38 +129,6 @@
|
|||||||
\image qtcreator-preferences.webp {Filtering preferences}
|
\image qtcreator-preferences.webp {Filtering preferences}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
|
||||||
\page creator-how-to-view-output.html
|
|
||||||
\previouspage creator-how-tos.html
|
|
||||||
\nextpage creator-known-issues.html
|
|
||||||
\ingroup creator-how-to-ui
|
|
||||||
|
|
||||||
\title View output
|
|
||||||
|
|
||||||
The \l{Viewing Output}{taskbar} shows output from
|
|
||||||
several sources, such as a list of errors and warnings encountered during
|
|
||||||
a build, detailed output from the compiler, status of a program when it is
|
|
||||||
executed, debug output, or search results.
|
|
||||||
|
|
||||||
\image qtcreator-output-panes-taskbar.webp "Output on the taskbar"
|
|
||||||
|
|
||||||
To view different types of output, use the following shortcuts:
|
|
||||||
|
|
||||||
\list
|
|
||||||
|
|
||||||
\li \uicontrol{Issues} - \key Alt+1 (\key Cmd+1 on \macos)
|
|
||||||
|
|
||||||
\li \uicontrol{Search Results} - \key Alt+2 (\key Cmd+2 on \macos)
|
|
||||||
|
|
||||||
\li \uicontrol{Application Output} - \key Alt+3 (\key Cmd+3 on \macos)
|
|
||||||
|
|
||||||
\li \uicontrol{Compile Output} - \key Alt+4 (\key Cmd+4 on \macos)
|
|
||||||
|
|
||||||
\endlist
|
|
||||||
|
|
||||||
For additional ways to view other types of output, see \l{Viewing Output}.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\page creator-how-to-run-from-cli.html
|
\page creator-how-to-run-from-cli.html
|
||||||
\previouspage creator-how-tos.html
|
\previouspage creator-how-tos.html
|
||||||
|
|||||||
@@ -22,7 +22,7 @@
|
|||||||
\li Record test cases (in a very limited way compared to what you can do
|
\li Record test cases (in a very limited way compared to what you can do
|
||||||
inside the Squish IDE).
|
inside the Squish IDE).
|
||||||
\li Use Squish Runner and Server to run test suites or cases and view
|
\li Use Squish Runner and Server to run test suites or cases and view
|
||||||
the results in the \uicontrol Squish \l{Viewing Output}{output}.
|
the results in the \uicontrol Squish \l{View output}{output}.
|
||||||
\li Set breakpoints before running tests to stop at certain locations and
|
\li Set breakpoints before running tests to stop at certain locations and
|
||||||
inspect the local variables, similarly to when debugging a test.
|
inspect the local variables, similarly to when debugging a test.
|
||||||
\endlist
|
\endlist
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
// **********************************************************************
|
// **********************************************************************
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\previouspage creator-output-panes.html
|
\previouspage creator-quick-tour.html
|
||||||
\page creator-configuring.html
|
\page creator-configuring.html
|
||||||
\nextpage creator-build-example-application.html
|
\nextpage creator-build-example-application.html
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
// Copyright (C) 2023 The Qt Company Ltd.
|
// Copyright (C) 2023 The Qt Company Ltd.
|
||||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\page qtcreator-toc.html
|
\page qtcreator-toc.html
|
||||||
|
|
||||||
@@ -18,9 +17,6 @@
|
|||||||
\list
|
\list
|
||||||
\li \l{IDE Overview}
|
\li \l{IDE Overview}
|
||||||
\li \l{User Interface}
|
\li \l{User Interface}
|
||||||
\list
|
|
||||||
\li \l{Viewing Output}
|
|
||||||
\endlist
|
|
||||||
\li \l{Configuring Qt Creator}
|
\li \l{Configuring Qt Creator}
|
||||||
\li \l{Building and Running an Example}
|
\li \l{Building and Running an Example}
|
||||||
\li \l{Tutorials}
|
\li \l{Tutorials}
|
||||||
|
|||||||
@@ -8,7 +8,6 @@
|
|||||||
\nextpage creator-open-documents-view.html
|
\nextpage creator-open-documents-view.html
|
||||||
\else
|
\else
|
||||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||||
\nextpage creator-output-panes.html
|
|
||||||
\endif
|
\endif
|
||||||
|
|
||||||
\ingroup creator-reference-sidebar-views
|
\ingroup creator-reference-sidebar-views
|
||||||
|
|||||||
@@ -0,0 +1,85 @@
|
|||||||
|
// Copyright (C) 2023 The Qt Company Ltd.
|
||||||
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-how-to-view-output.html
|
||||||
|
\if defined(qtdesignstudio)
|
||||||
|
\previouspage creator-quick-tour.html
|
||||||
|
\else
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
\endif
|
||||||
|
|
||||||
|
\ingroup creator-how-to-ui
|
||||||
|
|
||||||
|
\title View output
|
||||||
|
|
||||||
|
The \e {output views} show output from several sources, such as a list of
|
||||||
|
errors and warnings encountered during a build, detailed output from the
|
||||||
|
compiler, status of a program when it is executed, debug output, or search
|
||||||
|
results.
|
||||||
|
|
||||||
|
\image qtcreator-output-panes-taskbar.webp {Output views}
|
||||||
|
|
||||||
|
You can open output views in all
|
||||||
|
\if defined (qtcreator)
|
||||||
|
\l{Switch between modes}{modes}
|
||||||
|
\else
|
||||||
|
modes
|
||||||
|
\endif in the following ways:
|
||||||
|
|
||||||
|
\list
|
||||||
|
\if defined(qtcreator)
|
||||||
|
\li Select the output view.
|
||||||
|
\endif
|
||||||
|
\li Select \uicontrol View > \uicontrol Output.
|
||||||
|
The menu items also display the \l{Keyboard Shortcuts}
|
||||||
|
{keyboard shortcuts} that you can use.
|
||||||
|
\li Select \key Alt (\key Cmd on \macos) and the number of the view.
|
||||||
|
\li Select \inlineimage icons/output-pane-menu.png
|
||||||
|
, and then select the view to open.
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
To maximize an open output view, select the \inlineimage icons/arrowup.png
|
||||||
|
(\uicontrol Maximize) button or press \key {Alt+Shift+9}.
|
||||||
|
|
||||||
|
To increase or decrease the output text size, select \inlineimage icons/plus.png
|
||||||
|
(\uicontrol {Zoom In}) or \inlineimage icons/minus.png
|
||||||
|
(\uicontrol {Zoom Out}), or press \key Ctrl++ or \key Ctrl+-. Zooming is
|
||||||
|
not supported in all output views.
|
||||||
|
|
||||||
|
\section1 Change text encoding
|
||||||
|
|
||||||
|
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
|
||||||
|
the output. To specify the codec to use, select \uicontrol Edit >
|
||||||
|
\uicontrol Preferences > \uicontrol Environment > \uicontrol Interface, and
|
||||||
|
then select the codec in the \uicontrol {Text codec for tools} field.
|
||||||
|
|
||||||
|
\image qtcreator-preferences-environment-interface.webp {Interface tab in Environment preferences}
|
||||||
|
|
||||||
|
\section1 Find and filter output
|
||||||
|
|
||||||
|
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
|
||||||
|
\l{Finding and Replacing}.
|
||||||
|
|
||||||
|
To filter output, enter a string in the \uicontrol Filter field.
|
||||||
|
|
||||||
|
To specify filtering options,
|
||||||
|
select the \inlineimage icons/magnifier.png {Filtering options menu}
|
||||||
|
button. You can filter output by using regular expressions or
|
||||||
|
case-sensitivity. Select \uicontrol {Show Non-matching Lines} to
|
||||||
|
hide the lines that match the filter.
|
||||||
|
|
||||||
|
Some output views do not support finding and filtering.
|
||||||
|
|
||||||
|
\section1 Output views
|
||||||
|
|
||||||
|
The following views show output:
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
|
\annotatedlist creator-reference-output-views
|
||||||
|
\else
|
||||||
|
\annotatedlist studio-reference-output-views
|
||||||
|
\endif
|
||||||
|
*/
|
||||||
@@ -4,7 +4,6 @@
|
|||||||
/*!
|
/*!
|
||||||
\page creator-outline-view.html
|
\page creator-outline-view.html
|
||||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||||
\nextpage creator-output-panes.html
|
|
||||||
\ingroup creator-reference-sidebar-views
|
\ingroup creator-reference-sidebar-views
|
||||||
|
|
||||||
\title Outline
|
\title Outline
|
||||||
@@ -33,7 +32,6 @@
|
|||||||
/*!
|
/*!
|
||||||
\page creator-class-view.html
|
\page creator-class-view.html
|
||||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||||
\nextpage creator-output-panes.html
|
|
||||||
\ingroup creator-reference-sidebar-views
|
\ingroup creator-reference-sidebar-views
|
||||||
|
|
||||||
\title Class View
|
\title Class View
|
||||||
@@ -54,7 +52,6 @@
|
|||||||
/*!
|
/*!
|
||||||
\page creator-call-hierarchy-view.html
|
\page creator-call-hierarchy-view.html
|
||||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||||
\nextpage creator-output-panes.html
|
|
||||||
\ingroup creator-reference-sidebar-views
|
\ingroup creator-reference-sidebar-views
|
||||||
|
|
||||||
\title Call Hierarchy
|
\title Call Hierarchy
|
||||||
@@ -77,7 +74,6 @@
|
|||||||
/*!
|
/*!
|
||||||
\page creator-type-hierarchy.html
|
\page creator-type-hierarchy.html
|
||||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||||
\nextpage creator-output-panes.html
|
|
||||||
\ingroup creator-reference-sidebar-views
|
\ingroup creator-reference-sidebar-views
|
||||||
|
|
||||||
\title Type Hierarchy
|
\title Type Hierarchy
|
||||||
@@ -110,7 +106,6 @@
|
|||||||
/*!
|
/*!
|
||||||
\page creator-include-hierarchy-view.html
|
\page creator-include-hierarchy-view.html
|
||||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||||
\nextpage creator-output-panes.html
|
|
||||||
\ingroup creator-reference-sidebar-views
|
\ingroup creator-reference-sidebar-views
|
||||||
|
|
||||||
\title Include Hierarchy
|
\title Include Hierarchy
|
||||||
|
|||||||
@@ -0,0 +1,111 @@
|
|||||||
|
// Copyright (C) 2023 The Qt Company Ltd.
|
||||||
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-reference-terminal-view.html
|
||||||
|
\previouspage creator-how-to-view-output.html
|
||||||
|
|
||||||
|
\ingroup creator-reference-output-views
|
||||||
|
|
||||||
|
\title Terminal
|
||||||
|
|
||||||
|
\brief Opens a terminal.
|
||||||
|
|
||||||
|
When you select the \uicontrol {Run in Terminal} check box and run an
|
||||||
|
application or the \uicontrol {Open Terminal} button to open a terminal,
|
||||||
|
it opens as an output view.
|
||||||
|
|
||||||
|
To open the terminal in a separate window, select \uicontrol Edit >
|
||||||
|
\uicontrol Preferences > \uicontrol Terminal, and deselet the
|
||||||
|
\uicontrol {Use internal terminal} check box.
|
||||||
|
|
||||||
|
On Linux and \macos, you can set the terminal to open by selecting
|
||||||
|
\uicontrol Edit > \uicontrol Preferences >
|
||||||
|
\uicontrol Environment > \uicontrol System.
|
||||||
|
|
||||||
|
\image qtcreator-output-terminal.webp {Terminal pane}
|
||||||
|
|
||||||
|
\list
|
||||||
|
\li To clear the terminal, select \inlineimage icons/clean_pane_small.png
|
||||||
|
(\uicontrol Clear).
|
||||||
|
|
||||||
|
\li To close the current terminal, select \inlineimage icons/terminal-close.png
|
||||||
|
.
|
||||||
|
|
||||||
|
\li To open new terminals as tabs, select \inlineimage icons/terminal-create.png
|
||||||
|
.
|
||||||
|
|
||||||
|
\li To move between terminals, select the tabs or \inlineimage icons/arrowup.png
|
||||||
|
and \inlineimage icons/arrowdown.png
|
||||||
|
.
|
||||||
|
|
||||||
|
\li To select a word in a terminal, double-click it. To select the whole line,
|
||||||
|
triple-click it.
|
||||||
|
|
||||||
|
\li To open links in a browser, files in the editor, or folders in the
|
||||||
|
\l Projects view, hover the mouse over them, and press \key Ctrl.
|
||||||
|
|
||||||
|
\li To \l{Finding and Replacing}{search} through the output, press \key {Ctrl+F}.
|
||||||
|
|
||||||
|
\li To make the font larger or smaller, select the \inlineimage icons/plus.png
|
||||||
|
and \inlineimage icons/minus.png
|
||||||
|
buttons. You can also change the font size in terminal preferences.
|
||||||
|
|
||||||
|
\li To open terminal preferences, select \inlineimage icons/settings.png
|
||||||
|
(\uicontrol Configure).
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
Most of the \QC keyboard shortcuts are disabled in the terminal, except the
|
||||||
|
ones for opening terminal preferences or the locator and quitting \QC. To
|
||||||
|
send the escape key to the terminal instead of closing the terminal, select
|
||||||
|
\uicontrol {Shift+Esc}. You can also specify that the escape key is sent to
|
||||||
|
the terminal in terminal preferences.
|
||||||
|
|
||||||
|
\section1 Terminal Preferences
|
||||||
|
|
||||||
|
To set preferences for the internal terminal, select \uicontrol Edit >
|
||||||
|
\uicontrol Preferences > \uicontrol Terminal, or select the
|
||||||
|
\uicontrol Configure button in the \uicontrol Terminal pane.
|
||||||
|
|
||||||
|
\image qtcreator-preferences-terminal.webp {Terminal tab in Preferences}
|
||||||
|
|
||||||
|
\table
|
||||||
|
\header
|
||||||
|
\li Option
|
||||||
|
\li Value
|
||||||
|
\row
|
||||||
|
\li \uicontrol {Use internal terminal}
|
||||||
|
\li Open the \uicontrol Terminal pane when you select
|
||||||
|
\uicontrol {Run in Terminal} or \uicontrol {Open Terminal}.
|
||||||
|
\row
|
||||||
|
\li \uicontrol {Send escape key to terminal}
|
||||||
|
\li Send the escape key to the terminal instead of closing the terminal.
|
||||||
|
\row
|
||||||
|
\li \uicontrol {Audible bell}
|
||||||
|
\li Play an audible bell when the a bell character is received.
|
||||||
|
\row
|
||||||
|
\li \uicontrol {Allow blinking cursor}
|
||||||
|
\li Allow the cursor to blink.
|
||||||
|
\row
|
||||||
|
\li \uicontrol {Font}
|
||||||
|
\li Select the \uicontrol {Font family} and \uicontrol Size for the text
|
||||||
|
in the terminal. You can also use the \inlineimage icons/plus.png
|
||||||
|
and \inlineimage icons/minus.png buttons in the \uicontrol Terminal
|
||||||
|
pane to change the font size.
|
||||||
|
\row
|
||||||
|
\li \uicontrol {Colors}
|
||||||
|
\li Set colors for the \uicontrol Terminal pane \uicontrol Foreground,
|
||||||
|
\uicontrol Background, \uicontrol Selection, and
|
||||||
|
\uicontrol {Find match}.
|
||||||
|
\row
|
||||||
|
\li \uicontrol {Default shell}
|
||||||
|
\li Set the full path to the default terminal executable in
|
||||||
|
\uicontrol {Shell path} and the arguments to pass to the shell
|
||||||
|
in \uicontrol {Shell arguments}.
|
||||||
|
\endtable
|
||||||
|
|
||||||
|
To use an existing color scheme, select \uicontrol {Load Theme}. To revert
|
||||||
|
color changes, select \uicontrol {Reset Theme}.
|
||||||
|
|
||||||
|
\sa {View output}
|
||||||
|
*/
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
// Copyright (C) 2023 The Qt Company Ltd.
|
||||||
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-reference-to-do-entries-view.html
|
||||||
|
\previouspage creator-how-to-view-output.html
|
||||||
|
|
||||||
|
\ingroup creator-reference-output-views
|
||||||
|
|
||||||
|
\title To-Do Entries
|
||||||
|
|
||||||
|
\brief Lists the BUG, FIXME, NOTE, TODO, and 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
|
||||||
|
keywords.
|
||||||
|
|
||||||
|
\image qtcreator-to-do-entries.webp {To-Do Entries}
|
||||||
|
|
||||||
|
You can also open task list files generated by code scanning and
|
||||||
|
analysis tools in \l Issues. For more information, see
|
||||||
|
\l{Showing Task List Files in Issues}.
|
||||||
|
|
||||||
|
\section1 Enabling the To-Do Plugin
|
||||||
|
|
||||||
|
The Todo plugin is disabled by default. To enable it:
|
||||||
|
|
||||||
|
\list 1
|
||||||
|
\li Select \uicontrol Help > \uicontrol {About Plugins} >
|
||||||
|
\uicontrol Utilities > \uicontrol Todo.
|
||||||
|
\li Select \uicontrol OK.
|
||||||
|
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
\section1 To-Do Preferences
|
||||||
|
|
||||||
|
To add keywords, select \uicontrol Edit > \uicontrol Preferences >
|
||||||
|
\uicontrol {To-Do} > \uicontrol Add. Set an icon and a line background color
|
||||||
|
for the keyword.
|
||||||
|
|
||||||
|
\image qtcreator-todo-options.png {To-Do preferences}
|
||||||
|
|
||||||
|
\list
|
||||||
|
|
||||||
|
\li To change the icon and line background color of the selected keyword,
|
||||||
|
select \uicontrol Edit.
|
||||||
|
|
||||||
|
\li To remove the selected keyword, select \uicontrol Remove.
|
||||||
|
|
||||||
|
\li To reset the list to predefined keywords, select \uicontrol Reset.
|
||||||
|
All your changes will be permanently lost.
|
||||||
|
|
||||||
|
\li To determine whether the keywords in the whole project, in the
|
||||||
|
current file, or in a subproject are displayed by default, select
|
||||||
|
the appropriate option in the \uicontrol {Scanning scope} group.
|
||||||
|
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
\section1 Excluding Files from Scanning
|
||||||
|
|
||||||
|
To exclude files from scanning, select \uicontrol {Project Settings} >
|
||||||
|
\uicontrol {To-Do} in the \uicontrol Projects mode.
|
||||||
|
|
||||||
|
\image qtcreator-todo-excluded-files.png {Excluded Files in To-Do preferences}
|
||||||
|
|
||||||
|
Select \uicontrol Add and double-click the placeholder text in
|
||||||
|
\uicontrol {Exclude Files} to enter a regular expression that
|
||||||
|
matches the path to files to exclude. Use a forward slash (/)
|
||||||
|
as a separator in the path also on Windows.
|
||||||
|
|
||||||
|
Select the link in \uicontrol {Use global settings} to open global
|
||||||
|
To-Do preferences.
|
||||||
|
|
||||||
|
\sa {Enable and disable plugins}
|
||||||
|
*/
|
||||||
@@ -9,7 +9,6 @@
|
|||||||
\nextpage studio-content-library.html
|
\nextpage studio-content-library.html
|
||||||
\else
|
\else
|
||||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||||
\nextpage creator-output-panes.html
|
|
||||||
\endif
|
\endif
|
||||||
|
|
||||||
\ingroup creator-reference-sidebar-views
|
\ingroup creator-reference-sidebar-views
|
||||||
|
|||||||
@@ -8,7 +8,6 @@
|
|||||||
\nextpage creator-file-system-view.html
|
\nextpage creator-file-system-view.html
|
||||||
\else
|
\else
|
||||||
\previouspage creator-how-to-show-and-hide-sidebars.html
|
\previouspage creator-how-to-show-and-hide-sidebars.html
|
||||||
\nextpage creator-output-panes.html
|
|
||||||
\endif
|
\endif
|
||||||
|
|
||||||
\ingroup creator-reference-sidebar-views
|
\ingroup creator-reference-sidebar-views
|
||||||
|
|||||||
@@ -0,0 +1,257 @@
|
|||||||
|
// Copyright (C) 2023 The Qt Company Ltd.
|
||||||
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
|
// **********************************************************************
|
||||||
|
// NOTE: the sections are not ordered by their logical order to avoid
|
||||||
|
// reshuffling the file each time the index order changes (i.e., often).
|
||||||
|
// Run the fixnavi.pl script to adjust the links to the index order.
|
||||||
|
// **********************************************************************
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-reference-issues-view.html
|
||||||
|
\previouspage creator-how-to-view-output.html
|
||||||
|
|
||||||
|
\ingroup creator-reference-output-views
|
||||||
|
\ingroup studio-reference-output-views
|
||||||
|
|
||||||
|
\title Issues
|
||||||
|
|
||||||
|
\brief Lists issues from different sources.
|
||||||
|
|
||||||
|
The \uicontrol Issues 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 \inlineimage icons/filtericon.png
|
||||||
|
(\uicontrol {Filter Tree}) and then select a filter:
|
||||||
|
|
||||||
|
\list
|
||||||
|
|
||||||
|
\if defined(qtdesignstudio)
|
||||||
|
\li \uicontrol {Asset Export} - Errors and warnings encountered
|
||||||
|
while exporting assets.
|
||||||
|
|
||||||
|
\li \uicontrol {Asset Importer Error} - Errors and warnings encountered
|
||||||
|
while importing assets from a design tool.
|
||||||
|
\else
|
||||||
|
\li \uicontrol Autotests - Errors and warnings encountered while running
|
||||||
|
tests.
|
||||||
|
\endif
|
||||||
|
|
||||||
|
\li \uicontrol {Build System} - Errors and warnings encountered when
|
||||||
|
opening and managing projects.
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
|
\li \uicontrol {Clang Code Model} -
|
||||||
|
\l {Parsing C++ Files with the Clang Code Model}
|
||||||
|
{Errors and warnings from the current editor}.
|
||||||
|
\li \uicontrol {Clang Tools} - Errors and warnings from
|
||||||
|
\l {Using Clang Tools}{Clang-Tidy and Clazy}
|
||||||
|
\endif
|
||||||
|
|
||||||
|
\li \uicontrol Compile - Selected output from the compiler. Open
|
||||||
|
\uicontrol {Compile Output} for more detailed information.
|
||||||
|
|
||||||
|
\li \uicontrol{Debug Information} - Lists debug information packages that might
|
||||||
|
be missing.
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
|
\li \uicontrol Debugger - Errors encountered while running the
|
||||||
|
\l{Analyzing Code}{Valgrind code analysis tools}.
|
||||||
|
\endif
|
||||||
|
|
||||||
|
\li \uicontrol{Debugger Runtime} - Errors encountered when starting \QC. For
|
||||||
|
example, information about missing DLLs.
|
||||||
|
|
||||||
|
\li \uicontrol Deployment - Errors encountered between building an application
|
||||||
|
successfully and starting it on a \l{glossary-device}{device}.
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
|
\li \uicontrol {My Tasks} - Entries from a task list file (.tasks) generated
|
||||||
|
by \l{Showing Task List Files in Issues}
|
||||||
|
{code scanning and analysis tools}.
|
||||||
|
|
||||||
|
\li \uicontrol Python - Runtime errors and exceptions of Python scripts.
|
||||||
|
\endif
|
||||||
|
|
||||||
|
\li \uicontrol QML and \uicontrol {QML Analysis} -
|
||||||
|
\l{JavaScript and QML Error Codes}
|
||||||
|
{QML and JavaScript syntax errors}.
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
|
\li \uicontrol Sanitizer - Tasks created when you run an application if
|
||||||
|
you used an \e {address sanitizer} to detect memory handling issues.
|
||||||
|
\endif
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
To find output in the view, enter search criteria in the \uicontrol Filter
|
||||||
|
field.
|
||||||
|
|
||||||
|
\image qtcreator-issues.webp {Issues}
|
||||||
|
|
||||||
|
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.
|
||||||
|
For single lines, you can search the Internet for a solution using the
|
||||||
|
contents of the line as search criteria or open a version control
|
||||||
|
annotation view of the line that causes the error message.
|
||||||
|
|
||||||
|
To view detailed information about the selected line (where available), press
|
||||||
|
\key Space.
|
||||||
|
|
||||||
|
To navigate to the corresponding source code, click an issue or
|
||||||
|
select \uicontrol {Show in Editor} in the context menu. The entry must contain the
|
||||||
|
name of the file where the issue was found.
|
||||||
|
|
||||||
|
To view more information about an issue in \l {Compile Output},
|
||||||
|
select \uicontrol {Show Compile Output} in the context menu.
|
||||||
|
|
||||||
|
To jump from one issue to the next or previous
|
||||||
|
one, select \inlineimage icons/arrowup.png
|
||||||
|
and \inlineimage icons/arrowdown.png
|
||||||
|
or press \key F6 and \key Shift+F6.
|
||||||
|
|
||||||
|
By default, a new build clears the \uicontrol Issues view. To keep
|
||||||
|
the issues from the previous build rounds, deselect \uicontrol Edit >
|
||||||
|
\uicontrol Preferences > \uicontrol {Build & Run} > \uicontrol General >
|
||||||
|
\uicontrol {Clear issues list on new build}.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-reference-search-results-view.html
|
||||||
|
\previouspage creator-how-to-view-output.html
|
||||||
|
|
||||||
|
\ingroup creator-reference-output-views
|
||||||
|
\ingroup studio-reference-output-views
|
||||||
|
|
||||||
|
\title Search Results
|
||||||
|
|
||||||
|
\brief Lets you search through projects, files on a file system or the
|
||||||
|
currently open files.
|
||||||
|
|
||||||
|
The search history (1) stores the search results. You can select earlier
|
||||||
|
searches from the history.
|
||||||
|
|
||||||
|
\image qtcreator-search-results.webp {Search Results - criteria}
|
||||||
|
|
||||||
|
The figure below shows an example search result for all
|
||||||
|
occurrences of the search string in the specified directory.
|
||||||
|
|
||||||
|
\image qtcreator-search-results-matches.webp {Search Results - matches found}
|
||||||
|
|
||||||
|
For more information about the different search options, see
|
||||||
|
\l {Finding and Replacing}.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-reference-application-output-view.html
|
||||||
|
\previouspage creator-how-to-view-output.html
|
||||||
|
|
||||||
|
\ingroup creator-reference-output-views
|
||||||
|
\ingroup studio-reference-output-views
|
||||||
|
|
||||||
|
\title Application Output
|
||||||
|
|
||||||
|
\brief Displays the status of a program when you execute it, and the debug
|
||||||
|
output.
|
||||||
|
|
||||||
|
\image qtcreator-application-output.webp {Application Output}
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
|
If you specify command line arguments in the run settings that are passed
|
||||||
|
to the application when running it, they are displayed as a part of the
|
||||||
|
application output. For more information, see
|
||||||
|
\l{Specifying Run Settings for Desktop Device Types}.
|
||||||
|
\endif
|
||||||
|
|
||||||
|
Select toolbar buttons to run applications, to attach the debugger to the
|
||||||
|
running application, and to stop running or debugging.
|
||||||
|
|
||||||
|
\section1 Application Output Preferences
|
||||||
|
|
||||||
|
To set preferences for displaying application output:
|
||||||
|
|
||||||
|
\list
|
||||||
|
\li Select \uicontrol Edit > \uicontrol Preferences >
|
||||||
|
\uicontrol {Build & Run} > \uicontrol {Application Output}.
|
||||||
|
\li Select the \inlineimage icons/settings.png
|
||||||
|
(\uicontrol {Open Settings Page}) button.
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
\image qtcreator-preferences-application-output.webp {Application Output tab in Preferences}
|
||||||
|
|
||||||
|
You can select whether to open \uicontrol{Application Output} on output when
|
||||||
|
running or debugging applications, to clear old output on a new run,
|
||||||
|
to word-wrap output, and to limit output to the specified number of lines.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-reference-compile-output-view.html
|
||||||
|
\previouspage creator-how-to-view-output.html
|
||||||
|
|
||||||
|
\ingroup creator-reference-output-views
|
||||||
|
\ingroup studio-reference-output-views
|
||||||
|
|
||||||
|
\title Compile Output
|
||||||
|
|
||||||
|
\brief Shows all output from the compiler.
|
||||||
|
|
||||||
|
\uicontrol{Compile Output} shows a more detailed version of information
|
||||||
|
displayed in \l Issues.
|
||||||
|
|
||||||
|
\image qtcreator-compile-output.webp {Compile Output}
|
||||||
|
|
||||||
|
Double-click a file name in an error message to open the file in the
|
||||||
|
code editor.
|
||||||
|
|
||||||
|
To cancel the build, select the \uicontrol {Cancel Build} button.
|
||||||
|
|
||||||
|
To copy the output to the clipboard, select \uicontrol {Select All} in the
|
||||||
|
context menu, and then select \uicontrol Copy. Save the output as a file if
|
||||||
|
you want to examine it later without having to build the project again.
|
||||||
|
This is useful for large projects that take a long time to build.
|
||||||
|
|
||||||
|
\section1 Compile Output Preferences
|
||||||
|
|
||||||
|
To specify whether to open the \uicontrol {Compile Output} view on output
|
||||||
|
when building applications:
|
||||||
|
|
||||||
|
\list 1
|
||||||
|
\li Open the preferences:
|
||||||
|
\list
|
||||||
|
\li In the \uicontrol {Compile Output} view,
|
||||||
|
select \inlineimage icons/settings.png
|
||||||
|
(\uicontrol {Open Settings Page}).
|
||||||
|
\li Select \uicontrol Edit > \uicontrol Preferences >
|
||||||
|
\uicontrol {Build & Run} > \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
|
||||||
|
maximum amount of build output lines to display.
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
\section1 Parsing Existing Compile Output
|
||||||
|
|
||||||
|
You can use \QC's output parsers to parse output from builds done outside
|
||||||
|
of \QC or stored from previous build runs. By default, the parsers from the
|
||||||
|
kit selected for the active project are used, but you can select another
|
||||||
|
kit.
|
||||||
|
|
||||||
|
To parse compile output:
|
||||||
|
|
||||||
|
\list 1
|
||||||
|
\li Select \uicontrol Tools > \uicontrol {Parse Build Output}.
|
||||||
|
\image qtcreator-parse-build-output.png
|
||||||
|
\li Paste the build output in the \uicontrol {Build Output} field, 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
|
||||||
|
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
|
||||||
|
the new output to the old output.
|
||||||
|
\li Select \uicontrol OK to start parsing.
|
||||||
|
\endlist
|
||||||
|
*/
|
||||||
@@ -1,12 +1,6 @@
|
|||||||
// Copyright (C) 2023 The Qt Company Ltd.
|
// Copyright (C) 2023 The Qt Company Ltd.
|
||||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
// **********************************************************************
|
|
||||||
// NOTE: the sections are not ordered by their logical order to avoid
|
|
||||||
// reshuffling the file each time the index order changes (i.e., often).
|
|
||||||
// Run the fixnavi.pl script to adjust the links to the index order.
|
|
||||||
// **********************************************************************
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\page creator-quick-tour.html
|
\page creator-quick-tour.html
|
||||||
\if defined(qtdesignstudio)
|
\if defined(qtdesignstudio)
|
||||||
@@ -14,7 +8,7 @@
|
|||||||
\nextpage creator-using-qt-quick-designer.html
|
\nextpage creator-using-qt-quick-designer.html
|
||||||
\else
|
\else
|
||||||
\previouspage creator-overview.html
|
\previouspage creator-overview.html
|
||||||
\nextpage creator-views.html
|
\nextpage creator-configuring.html
|
||||||
\endif
|
\endif
|
||||||
|
|
||||||
\title User Interface
|
\title User Interface
|
||||||
@@ -66,7 +60,7 @@
|
|||||||
\li \inlineimage numbers/07.png
|
\li \inlineimage numbers/07.png
|
||||||
\li Output
|
\li Output
|
||||||
\li View output from building, running, and other actions.
|
\li View output from building, running, and other actions.
|
||||||
\li \l{Viewing Output}
|
\li \l{View output}
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
To see where the above controls are in the UI, select
|
To see where the above controls are in the UI, select
|
||||||
@@ -127,6 +121,7 @@
|
|||||||
\li \l {Find menu items on \macos}
|
\li \l {Find menu items on \macos}
|
||||||
\li \l {Set high DPI scaling}
|
\li \l {Set high DPI scaling}
|
||||||
\li \l {Switch UI themes}
|
\li \l {Switch UI themes}
|
||||||
|
\li \l {View output}
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
\section1 Viewing Images
|
\section1 Viewing Images
|
||||||
@@ -140,465 +135,3 @@
|
|||||||
|
|
||||||
\endif
|
\endif
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
|
||||||
\page creator-output-panes.html
|
|
||||||
\if defined(qtdesignstudio)
|
|
||||||
\previouspage creator-editor-functions.html
|
|
||||||
\nextpage creator-highlighting.html
|
|
||||||
\else
|
|
||||||
\previouspage creator-open-documents-view.html
|
|
||||||
\nextpage creator-configuring.html
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\title Viewing Output
|
|
||||||
|
|
||||||
\image qtcreator-general-messages.webp {General Messages}
|
|
||||||
|
|
||||||
You can view the following types of output:
|
|
||||||
|
|
||||||
\list
|
|
||||||
|
|
||||||
\li \l {Issues}
|
|
||||||
|
|
||||||
\li \l {Search Results}
|
|
||||||
|
|
||||||
\li \l {Application Output}
|
|
||||||
|
|
||||||
\li \l {Compile Output}
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\li \l {Terminal}
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\li \uicontrol {QML Debugger Console}
|
|
||||||
|
|
||||||
\li \uicontrol{General Messages}
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\li \l {Static Code Analysis}{Axivion}
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\li \uicontrol{Version Control}
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\li \l{Running Autotests}{Test Results}
|
|
||||||
|
|
||||||
\li \l{Using Squish}{Squish} test results and Squish Server and
|
|
||||||
Runner logs
|
|
||||||
|
|
||||||
\li \l {To-Do Entries}
|
|
||||||
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\endlist
|
|
||||||
|
|
||||||
Output is available on the taskbar in all
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\l{Switch between modes}{modes}.
|
|
||||||
\else
|
|
||||||
\l{Mode}{modes}.
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\image qtcreator-output-panes-taskbar.webp "Output on the taskbar"
|
|
||||||
|
|
||||||
You can view output in the following ways:
|
|
||||||
|
|
||||||
\list
|
|
||||||
\li Select the output view on the taskbar.
|
|
||||||
\li Select \key Alt (\key Cmd on \macos) and the number of the view on
|
|
||||||
the taskbar.
|
|
||||||
\li Select \inlineimage icons/output-pane-menu.png
|
|
||||||
, and then select the view to open.
|
|
||||||
\li Select \uicontrol View > \uicontrol Output.
|
|
||||||
The menu items also display the \l{Keyboard Shortcuts}
|
|
||||||
{keyboard shortcuts} that you can use.
|
|
||||||
\endlist
|
|
||||||
|
|
||||||
To maximize an open output view, select the \inlineimage icons/arrowup.png
|
|
||||||
(\uicontrol Maximize) button or press \key {Alt+Shift+9}.
|
|
||||||
|
|
||||||
|
|
||||||
To increase or decrease the output text size, select \inlineimage icons/plus.png
|
|
||||||
(\uicontrol {Zoom In}) or \inlineimage icons/minus.png
|
|
||||||
(\uicontrol {Zoom Out}), or press \key Ctrl++ or \key Ctrl+-. Zooming is
|
|
||||||
not supported in all output views.
|
|
||||||
|
|
||||||
To open the \uicontrol{General Messages} and
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\l{Using Version Control Systems}{Version Control}
|
|
||||||
\else
|
|
||||||
\l{Using Git}{Version Control}
|
|
||||||
\endif
|
|
||||||
views, select \uicontrol View > \uicontrol Output.
|
|
||||||
\if defined(qtcreator)
|
|
||||||
To view \uicontrol {To-Do Entries}, enable the \uicontrol Todo plugin.
|
|
||||||
\endif
|
|
||||||
|
|
||||||
For more information about the \uicontrol {QML Debugger Console} view, see
|
|
||||||
\l{Executing JavaScript Expressions}.
|
|
||||||
|
|
||||||
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
|
|
||||||
the output. To specify the codec to use, select \uicontrol Edit >
|
|
||||||
\uicontrol Preferences > \uicontrol Environment > \uicontrol Interface, and
|
|
||||||
then select the codec in the \uicontrol {Text codec for tools} field.
|
|
||||||
|
|
||||||
\image qtcreator-preferences-environment-interface.webp {Interface tab in Environment preferences}
|
|
||||||
|
|
||||||
\section1 Finding and Filtering Output
|
|
||||||
|
|
||||||
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
|
|
||||||
\l{Finding and Replacing}.
|
|
||||||
|
|
||||||
Besides searching from the output, you can enter a string in the
|
|
||||||
\uicontrol Filter field to filter it. To specify filtering options,
|
|
||||||
select the \inlineimage icons/magnifier.png "Filtering options menu"
|
|
||||||
button. You can filter output by using regular expressions or
|
|
||||||
case-sensitivity. Select \uicontrol {Show Non-matching Lines} to
|
|
||||||
hide the lines that match the filter.
|
|
||||||
|
|
||||||
Finding and filtering are not supported in all output views.
|
|
||||||
|
|
||||||
\section1 Issues
|
|
||||||
|
|
||||||
\uicontrol{Issues} lists the following types of issues:
|
|
||||||
|
|
||||||
\list
|
|
||||||
|
|
||||||
\if defined(qtdesignstudio)
|
|
||||||
\li \uicontrol {Asset Export} - Errors and warnings encountered
|
|
||||||
while exporting assets.
|
|
||||||
|
|
||||||
\li \uicontrol {Asset Importer Error} - Errors and warnings encountered
|
|
||||||
while importing assets from a design tool.
|
|
||||||
\else
|
|
||||||
\li \uicontrol Autotests - Errors and warnings encountered while running
|
|
||||||
tests.
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\li \uicontrol {Build System} - Errors and warnings encountered during a
|
|
||||||
build.
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\li \uicontrol {Clang Code Model} -
|
|
||||||
\l {Parsing C++ Files with the Clang Code Model}
|
|
||||||
{Errors and warnings from the current editor}.
|
|
||||||
\li \uicontrol {Clang Tools} - Errors and warnings from
|
|
||||||
\l {Using Clang Tools}{Clang-Tidy and Clazy}
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\li \uicontrol Compile - Selected output from the compiler. Open
|
|
||||||
\uicontrol {Compile Output} for more detailed information.
|
|
||||||
|
|
||||||
\li \uicontrol{Debug Information} - Lists debug information packages that might
|
|
||||||
be missing.
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\li \uicontrol Debugger - Errors encountered while running the
|
|
||||||
\l{Analyzing Code}{Valgrind code analysis tools}.
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\li \uicontrol{Debugger Runtime} - Errors encountered when starting \QC. For
|
|
||||||
example, information about missing DLLs.
|
|
||||||
|
|
||||||
\li \uicontrol Deployment - Errors encountered between building an application
|
|
||||||
successfully and starting it on a \l{glossary-device}{device}.
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\li \uicontrol {My Tasks} - Entries from a task list file (.tasks) generated
|
|
||||||
by \l{Showing Task List Files in Issues}
|
|
||||||
{code scanning and analysis tools}.
|
|
||||||
|
|
||||||
\li \uicontrol Python - Runtime errors and exceptions of Python scripts.
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\li \uicontrol QML and \uicontrol {QML Analysis} -
|
|
||||||
\l{JavaScript and QML Error Codes}
|
|
||||||
{QML and JavaScript syntax errors}.
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\li \uicontrol Sanitizer - Tasks created when you run an application if
|
|
||||||
you used an \e {address sanitizer} to detect memory handling issues.
|
|
||||||
\endif
|
|
||||||
\endlist
|
|
||||||
|
|
||||||
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
|
|
||||||
\inlineimage icons/filtericon.png
|
|
||||||
(\uicontrol {Filter Tree}) and then select a filter. To find output in the
|
|
||||||
view, enter search criteria in the \uicontrol Filter field.
|
|
||||||
|
|
||||||
\image qtcreator-issues.webp {Issues}
|
|
||||||
|
|
||||||
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.
|
|
||||||
For single lines, you can search the Internet for a solution using the
|
|
||||||
contents of the line as search criteria or open a version control
|
|
||||||
annotation view of the line that causes the error message.
|
|
||||||
|
|
||||||
To view detailed information about the selected line (where available), press
|
|
||||||
\key Space.
|
|
||||||
|
|
||||||
To navigate to the corresponding source code, click an issue or
|
|
||||||
select \uicontrol {Show in Editor} in the context menu. The entry must contain the
|
|
||||||
name of the file where the issue was found.
|
|
||||||
|
|
||||||
To view more information about an issue in \l {Compile Output},
|
|
||||||
select \uicontrol {Show Compile Output} in the context menu.
|
|
||||||
|
|
||||||
To jump from one issue to the next or previous
|
|
||||||
one, select \inlineimage icons/arrowup.png
|
|
||||||
and \inlineimage icons/arrowdown.png
|
|
||||||
or press \key F6 and \key Shift+F6.
|
|
||||||
|
|
||||||
By default, a new build clears the \uicontrol Issues view. To keep
|
|
||||||
the issues from the previous build rounds, deselect \uicontrol Edit >
|
|
||||||
\uicontrol Preferences > \uicontrol {Build & Run} > \uicontrol General >
|
|
||||||
\uicontrol {Clear issues list on new build}.
|
|
||||||
|
|
||||||
\section1 Search Results
|
|
||||||
|
|
||||||
In \uicontrol{Search Results}, you can search through projects, files on
|
|
||||||
a file system or the currently open files:
|
|
||||||
|
|
||||||
\image qtcreator-search-results.webp {Search Results - criteria}
|
|
||||||
|
|
||||||
The search history (1) stores the search results. You can select earlier
|
|
||||||
searches from the history.
|
|
||||||
|
|
||||||
The figure below shows an example search result for all
|
|
||||||
occurrences of the search string in the specified directory.
|
|
||||||
|
|
||||||
\image qtcreator-search-results-matches.webp {Search Results - matches found}
|
|
||||||
|
|
||||||
For more information about the different search options, see
|
|
||||||
\l {Finding and Replacing}.
|
|
||||||
|
|
||||||
\section1 Application Output
|
|
||||||
|
|
||||||
\uicontrol{Application Output} displays the status of a program when
|
|
||||||
you execute it, and the debug output.
|
|
||||||
|
|
||||||
\image qtcreator-application-output.webp {Application Output}
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
If you specify command line arguments in the run settings that are passed
|
|
||||||
to the application when running it, they are displayed as a part of the
|
|
||||||
application output. For more information, see
|
|
||||||
\l{Specifying Run Settings for Desktop Device Types}.
|
|
||||||
\endif
|
|
||||||
|
|
||||||
Select toolbar buttons to run applications, to attach the debugger to the
|
|
||||||
running application, and to stop running or debugging.
|
|
||||||
|
|
||||||
To specify settings for displaying application output, select
|
|
||||||
\uicontrol Edit > \uicontrol Preferences > \uicontrol {Build & Run} >
|
|
||||||
\uicontrol {Application Output}, or click the \inlineimage icons/settings.png
|
|
||||||
(\uicontrol {Open Settings Page}) button. You can select whether to open
|
|
||||||
\uicontrol{Application Output} on output when running or debugging
|
|
||||||
applications, to clear old output on a new run,
|
|
||||||
to word-wrap output, and to limit output to the specified number of lines.
|
|
||||||
|
|
||||||
\section1 Compile Output
|
|
||||||
|
|
||||||
\uicontrol{Compile Output} shows all output from the compiler.
|
|
||||||
The \uicontrol{Compile Output} is a more detailed version of information
|
|
||||||
displayed in \l Issues.
|
|
||||||
|
|
||||||
\image qtcreator-compile-output.webp {Compile Output}
|
|
||||||
|
|
||||||
Double-click on a file name in an error message to open the file in the
|
|
||||||
code editor.
|
|
||||||
|
|
||||||
Select the \uicontrol {Cancel Build} button to cancel the build.
|
|
||||||
|
|
||||||
To specify whether to open the \uicontrol {Compile Output} view on output
|
|
||||||
when building applications, select \uicontrol Edit > \uicontrol Preferences >
|
|
||||||
\uicontrol {Build & Run} > \uicontrol {Compile Output}, and then select the
|
|
||||||
\uicontrol {Open Compile Output when building} check box.
|
|
||||||
In the \uicontrol {Limit output to} field, you can specify the maximum
|
|
||||||
amount of build output lines to display.
|
|
||||||
|
|
||||||
You can also open the preferences page by clicking \inlineimage icons/settings.png
|
|
||||||
(\uicontrol {Open Settings Page}).
|
|
||||||
|
|
||||||
To copy the output to the clipboard, select \uicontrol {Select All} in the
|
|
||||||
context menu, and then select \uicontrol Copy. Save the output as a file if
|
|
||||||
you want to examine it later without having to build the project again.
|
|
||||||
This is useful for large projects that take a long time to build.
|
|
||||||
|
|
||||||
\section2 Parsing Existing Compile Output
|
|
||||||
|
|
||||||
You can use \QC's output parsers to parse output from builds done outside
|
|
||||||
of \QC or stored from previous build runs. By default, the parsers from the
|
|
||||||
kit selected for the active project are used, but you can select another
|
|
||||||
kit.
|
|
||||||
|
|
||||||
To parse compile output:
|
|
||||||
|
|
||||||
\list 1
|
|
||||||
\li Select \uicontrol Tools > \uicontrol {Parse Build Output}.
|
|
||||||
\image qtcreator-parse-build-output.png
|
|
||||||
\li Paste the build output in the \uicontrol {Build Output} field, 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
|
|
||||||
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
|
|
||||||
the new output to the old output.
|
|
||||||
\li Select \uicontrol OK to start parsing.
|
|
||||||
\endlist
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
|
|
||||||
\section1 Terminal
|
|
||||||
|
|
||||||
When you select the \uicontrol {Run in Terminal} check box and run an
|
|
||||||
application or the \uicontrol {Open Terminal} button to open a terminal,
|
|
||||||
the default terminal opens. On Linux and \macos, you can set the default
|
|
||||||
terminal by selecting \uicontrol Edit > \uicontrol Preferences >
|
|
||||||
\uicontrol Environment > \uicontrol System.
|
|
||||||
|
|
||||||
To open the terminal on the taskbar instead of in a separate window, select
|
|
||||||
\uicontrol Edit > \uicontrol Preferences > \uicontrol Terminal >
|
|
||||||
\uicontrol {Use internal terminal}.
|
|
||||||
|
|
||||||
\image qtcreator-output-terminal.webp {Terminal pane}
|
|
||||||
|
|
||||||
To clear the terminal, select \inlineimage icons/clean_pane_small.png
|
|
||||||
(\uicontrol Clear).
|
|
||||||
|
|
||||||
To close the current terminal, select \inlineimage icons/terminal-close.png
|
|
||||||
.
|
|
||||||
|
|
||||||
To open new terminals as tabs, select \inlineimage icons/terminal-create.png
|
|
||||||
.
|
|
||||||
|
|
||||||
To move between terminals, select the tabs or \inlineimage icons/arrowup.png
|
|
||||||
and \inlineimage icons/arrowdown.png
|
|
||||||
.
|
|
||||||
|
|
||||||
To select a word in a terminal, double-click it. To select the whole line,
|
|
||||||
triple-click it.
|
|
||||||
|
|
||||||
To open links in a browser, files in the editor, or folders in the
|
|
||||||
\l Projects view, hover the mouse over them, and press \key Ctrl.
|
|
||||||
|
|
||||||
To \l{Finding and Replacing}{search} through the output, press \key {Ctrl+F}.
|
|
||||||
|
|
||||||
To make the font larger or smaller, select the \inlineimage icons/plus.png
|
|
||||||
and \inlineimage icons/minus.png
|
|
||||||
buttons. You can also change the font size in terminal preferences.
|
|
||||||
|
|
||||||
To open terminal preferences, select \inlineimage icons/settings.png
|
|
||||||
(\uicontrol Configure).
|
|
||||||
|
|
||||||
Most of the \QC keyboard shortcuts are disabled in the terminal, except the
|
|
||||||
ones for opening terminal preferences or the locator and quitting \QC. To
|
|
||||||
send the escape key to the terminal instead of closing the terminal, select
|
|
||||||
\uicontrol {Shift+Esc}. You can also specify that the escape key is sent to
|
|
||||||
the terminal in terminal preferences.
|
|
||||||
|
|
||||||
\section2 Setting Terminal Preferences
|
|
||||||
|
|
||||||
To set preferences for the internal terminal, select \uicontrol Edit >
|
|
||||||
\uicontrol Preferences > \uicontrol Terminal, or select the
|
|
||||||
\uicontrol Configure button in the \uicontrol Terminal pane.
|
|
||||||
|
|
||||||
\image qtcreator-preferences-terminal.webp {Terminal tab in Preferences}
|
|
||||||
|
|
||||||
\table
|
|
||||||
\header
|
|
||||||
\li Option
|
|
||||||
\li Value
|
|
||||||
\row
|
|
||||||
\li \uicontrol {Use internal terminal}
|
|
||||||
\li Open the \uicontrol Terminal pane when you select
|
|
||||||
\uicontrol {Run in Terminal} or \uicontrol {Open Terminal}.
|
|
||||||
\row
|
|
||||||
\li \uicontrol {Send escape key to terminal}
|
|
||||||
\li Send the escape key to the terminal instead of closing the terminal.
|
|
||||||
\row
|
|
||||||
\li \uicontrol {Audible bell}
|
|
||||||
\li Play an audible bell when the a bell character is received.
|
|
||||||
\row
|
|
||||||
\li \uicontrol {Allow blinking cursor}
|
|
||||||
\li Allow the cursor to blink.
|
|
||||||
\row
|
|
||||||
\li \uicontrol {Font}
|
|
||||||
\li Select the \uicontrol {Font family} and \uicontrol Size for the text
|
|
||||||
in the terminal. You can also use the \inlineimage icons/plus.png
|
|
||||||
and \inlineimage icons/minus.png buttons in the \uicontrol Terminal
|
|
||||||
pane to change the font size.
|
|
||||||
\row
|
|
||||||
\li \uicontrol {Colors}
|
|
||||||
\li Set colors for the \uicontrol Terminal pane \uicontrol Foreground,
|
|
||||||
\uicontrol Background, \uicontrol Selection, and
|
|
||||||
\uicontrol {Find match}.
|
|
||||||
\row
|
|
||||||
\li \uicontrol {Default shell}
|
|
||||||
\li Set the full path to the default terminal executable in
|
|
||||||
\uicontrol {Shell path} and the arguments to pass to the shell
|
|
||||||
in \uicontrol {Shell arguments}.
|
|
||||||
\endtable
|
|
||||||
|
|
||||||
To use an existing color scheme, select \uicontrol {Load Theme}. To revert
|
|
||||||
color changes, select \uicontrol {Reset Theme}.
|
|
||||||
|
|
||||||
\section1 To-Do Entries
|
|
||||||
|
|
||||||
\uicontrol {To-Do Entries} lists the BUG, FIXME, NOTE, TODO, and
|
|
||||||
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
|
|
||||||
keywords.
|
|
||||||
|
|
||||||
\image qtcreator-to-do-entries.webp {To-Do Entries}
|
|
||||||
|
|
||||||
To add keywords, select \uicontrol Edit > \uicontrol Preferences >
|
|
||||||
\uicontrol {To-Do} > \uicontrol Add. Set an icon and a line background color
|
|
||||||
for the keyword.
|
|
||||||
|
|
||||||
\image qtcreator-todo-options.png {To-Do preferences}
|
|
||||||
|
|
||||||
To change the icon and line background color of the selected keyword, select
|
|
||||||
\uicontrol Edit.
|
|
||||||
|
|
||||||
To remove the selected keyword, select \uicontrol Remove.
|
|
||||||
|
|
||||||
To reset the list to predefined keywords, select \uicontrol Reset. All your
|
|
||||||
changes will be permanently lost.
|
|
||||||
|
|
||||||
To determine whether the keywords in the whole project, in the current file,
|
|
||||||
or in a subproject are displayed by default, select the appropriate option
|
|
||||||
in the \uicontrol {Scanning scope} group.
|
|
||||||
|
|
||||||
To exclude files from scanning, select \uicontrol {Project Settings} >
|
|
||||||
\uicontrol {To-Do} in the \uicontrol Projects mode.
|
|
||||||
|
|
||||||
\image qtcreator-todo-excluded-files.png {Excluded Files in To-Do preferences}
|
|
||||||
|
|
||||||
Select \uicontrol Add and double-click the placeholder text in
|
|
||||||
\uicontrol {Exclude Files} to enter a regular expression that
|
|
||||||
matches the path to files to exclude. Use a forward slash (/)
|
|
||||||
as a separator in the path also on Windows.
|
|
||||||
|
|
||||||
Select the link in \uicontrol {Use global settings} to open global
|
|
||||||
To-Do preferences.
|
|
||||||
|
|
||||||
The Todo plugin is disabled by default. To enable the plugin, select
|
|
||||||
\uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities >
|
|
||||||
\uicontrol Todo. Then select \uicontrol {Restart Now} to restart \QC
|
|
||||||
and load the plugin.
|
|
||||||
|
|
||||||
In addition, you can open task list files generated by code scanning and
|
|
||||||
analysis tools in \l Issues. For more information, see
|
|
||||||
\l{Showing Task List Files in Issues}.
|
|
||||||
\endif
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@
|
|||||||
To use GitLab, you must create a connection to the GitLab server and clone
|
To use GitLab, you must create a connection to the GitLab server and clone
|
||||||
the projects you want to work on. You can also link previously cloned
|
the projects you want to work on. You can also link previously cloned
|
||||||
projects to GitLab in the project settings. This enables you to receive
|
projects to GitLab in the project settings. This enables you to receive
|
||||||
event notifications in the \l {Viewing Output}{Version Control} pane.
|
event notifications in the \l {View output}{Version Control} pane.
|
||||||
|
|
||||||
\section1 Connecting to GitLab Servers
|
\section1 Connecting to GitLab Servers
|
||||||
|
|
||||||
|
|||||||
@@ -200,7 +200,6 @@
|
|||||||
\list
|
\list
|
||||||
\li \l{Writing Code}
|
\li \l{Writing Code}
|
||||||
\list
|
\list
|
||||||
\li \l{Viewing Output}
|
|
||||||
\li \l{Semantic Highlighting}
|
\li \l{Semantic Highlighting}
|
||||||
\li \l{Checking Code Syntax}
|
\li \l{Checking Code Syntax}
|
||||||
\li \l{Completing Code}
|
\li \l{Completing Code}
|
||||||
|
|||||||
Reference in New Issue
Block a user