forked from qt-creator/qt-creator
Doc: Issues pane filters
Rename Build Issues to Issues Change-Id: I6aa6116e8cdaf0f1d9f201335bfebedddca7c237 Reviewed-by: Christian Kamm <christian.d.kamm@nokia.com>
This commit is contained in:
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 11 KiB |
@@ -149,7 +149,7 @@
|
|||||||
\o Switch to \gui Help mode
|
\o Switch to \gui Help mode
|
||||||
\o Ctrl+6
|
\o Ctrl+6
|
||||||
\row
|
\row
|
||||||
\o Toggle \gui{Build Issues} pane
|
\o Toggle \gui{Issues} pane
|
||||||
\o Alt+1 (Cmd+1 on Mac OS X)
|
\o Alt+1 (Cmd+1 on Mac OS X)
|
||||||
\row
|
\row
|
||||||
\o Toggle \gui{Search Results} pane
|
\o Toggle \gui{Search Results} pane
|
||||||
|
|||||||
@@ -31,7 +31,7 @@
|
|||||||
\page creator-task-lists.html
|
\page creator-task-lists.html
|
||||||
\nextpage creator-cli.html
|
\nextpage creator-cli.html
|
||||||
|
|
||||||
\title Showing Task List Files in the Build Issues Pane
|
\title Showing Task List Files in Issues Pane
|
||||||
|
|
||||||
Code scanning and analysis tools create report files in ASCII format.
|
Code scanning and analysis tools create report files in ASCII format.
|
||||||
Usually, the report files consist of lines that contain a file name, a line
|
Usually, the report files consist of lines that contain a file name, a line
|
||||||
@@ -40,7 +40,7 @@
|
|||||||
manually navigating to them and correcting them, which is tedious.
|
manually navigating to them and correcting them, which is tedious.
|
||||||
|
|
||||||
\QC makes this very easy by providing a way to load these files into
|
\QC makes this very easy by providing a way to load these files into
|
||||||
the \gui{Build Issues} pane. You can navigate to the corresponding source
|
the \gui{Issues} pane. You can navigate to the corresponding source
|
||||||
code by clicking the error message. But first you must convert the files to
|
code by clicking the error message. But first you must convert the files to
|
||||||
the \l{Task List File Format} by using conversion scripts that based on
|
the \l{Task List File Format} by using conversion scripts that based on
|
||||||
standard text processing tools of the operating system.
|
standard text processing tools of the operating system.
|
||||||
|
|||||||
@@ -92,7 +92,7 @@
|
|||||||
|
|
||||||
\list
|
\list
|
||||||
|
|
||||||
\o \gui{Build Issues} pane Alt+1 (Cmd+1 on Mac OS X)
|
\o \gui{Issues} pane Alt+1 (Cmd+1 on Mac OS X)
|
||||||
|
|
||||||
\o \gui{Search Results} pane Alt+2 (Cmd+2 on Mac OS X)
|
\o \gui{Search Results} pane Alt+2 (Cmd+2 on Mac OS X)
|
||||||
|
|
||||||
|
|||||||
@@ -230,7 +230,7 @@
|
|||||||
|
|
||||||
\list
|
\list
|
||||||
|
|
||||||
\o \gui{Build Issues}
|
\o \gui{Issues}
|
||||||
|
|
||||||
\o \gui{Search Results}
|
\o \gui{Search Results}
|
||||||
|
|
||||||
@@ -256,26 +256,45 @@
|
|||||||
To open the \gui{General Messages} and \gui{Version Control} panes, select
|
To open the \gui{General Messages} and \gui{Version Control} panes, select
|
||||||
\gui {Window > Output Panes}.
|
\gui {Window > Output Panes}.
|
||||||
|
|
||||||
\section2 Build Issues
|
\section2 Issues
|
||||||
|
|
||||||
The \gui{Build Issues} pane provides a list of errors and warnings
|
The \gui{Issues} pane provides lists of following types of issues:
|
||||||
encountered during a build. The pane filters out irrelevant output from
|
|
||||||
the build tools and presents the issues in an organized way.
|
\list
|
||||||
|
|
||||||
|
\o \gui Analyzer - Errors encountered while running the
|
||||||
|
\l{Analyzing Code}{Valgrind code analysis tools}.
|
||||||
|
|
||||||
|
\o \gui {Build System} - Errors and warnings encountered during a
|
||||||
|
build.
|
||||||
|
|
||||||
|
\o \gui Compile - Selected output from the compiler. Open the
|
||||||
|
\gui {Compile Output} pane for more detailed information.
|
||||||
|
|
||||||
|
\o \gui {My Tasks} - Entries from a task list file (.tasks) generated
|
||||||
|
by \l{Showing Task List Files in Issues Pane}
|
||||||
|
{code scanning and analysis tools}.
|
||||||
|
|
||||||
|
\o \gui QML - Errors in QML syntax.
|
||||||
|
|
||||||
|
\o \gui {QML Analysis} - Results of the JavaScript
|
||||||
|
\l{Checking JavaScript Syntax}{code syntax and validation checks}
|
||||||
|
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
The pane 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 qtcreator-filter.png
|
||||||
|
and then select a filter.
|
||||||
|
|
||||||
|
\image qtcreator-build-issues.png
|
||||||
|
|
||||||
Right-clicking on a line brings up a context menu with options to copy
|
Right-clicking on a line brings up a context menu with options to copy
|
||||||
the contents and to show a version control annotation view of the line
|
the contents and to show a version control annotation view of the line
|
||||||
that causes the error message.
|
that causes the error message.
|
||||||
|
|
||||||
\image qtcreator-build-issues.png
|
To jump from one issue to the next or previous one, press \key F6 and
|
||||||
|
\key Shift+F6.
|
||||||
To view task lists in the \gui{Build Issues} pane, click
|
|
||||||
\inlineimage qtcreator-filter.png
|
|
||||||
and select \gui{My Tasks}. Entries from a task list file (.tasks) are
|
|
||||||
imported to the pane. Press \key F6 and \key Shift+F6 to jump from one issue
|
|
||||||
to the next.
|
|
||||||
|
|
||||||
For more information about creating task files, see
|
|
||||||
\l{Showing Task List Files in the Build Issues Pane}.
|
|
||||||
|
|
||||||
\section2 Search Results
|
\section2 Search Results
|
||||||
|
|
||||||
@@ -301,7 +320,7 @@
|
|||||||
|
|
||||||
The \gui{Compile Output} pane provides all output from the compiler.
|
The \gui{Compile Output} pane provides all output from the compiler.
|
||||||
The \gui{Compile Output} is a more detailed version of information
|
The \gui{Compile Output} is a more detailed version of information
|
||||||
displayed in the \gui{Build Issues} pane.
|
displayed in the \gui{Issues} pane.
|
||||||
|
|
||||||
\image qtcreator-compile-pane.png
|
\image qtcreator-compile-pane.png
|
||||||
|
|
||||||
|
|||||||
@@ -62,7 +62,7 @@
|
|||||||
\o \l{Using Maemo or MeeGo Harmattan Emulator}
|
\o \l{Using Maemo or MeeGo Harmattan Emulator}
|
||||||
\endif
|
\endif
|
||||||
\o \l{Editing MIME Types}
|
\o \l{Editing MIME Types}
|
||||||
\o \l{Showing Task List Files in the Build Issues Pane}
|
\o \l{Showing Task List Files in Issues Pane}
|
||||||
\o \l{Using Command Line Options}
|
\o \l{Using Command Line Options}
|
||||||
\o \l{Keyboard Shortcuts}
|
\o \l{Keyboard Shortcuts}
|
||||||
\o \l{Glossary}
|
\o \l{Glossary}
|
||||||
|
|||||||
@@ -40,7 +40,7 @@
|
|||||||
|
|
||||||
To check that the application code can be compiled and linked for a target,
|
To check that the application code can be compiled and linked for a target,
|
||||||
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 \gui {Build Issues} output pane. More detailed information is displayed
|
the \gui {Issues} output pane. More detailed information is displayed
|
||||||
in the \gui {Compile Output} pane.
|
in the \gui {Compile Output} pane.
|
||||||
|
|
||||||
To build an application:
|
To build an application:
|
||||||
|
|||||||
@@ -96,7 +96,7 @@
|
|||||||
|
|
||||||
\QC builds \c CMake projects by running \c make, \c mingw32-make, or
|
\QC builds \c CMake projects by running \c make, \c mingw32-make, or
|
||||||
\c nmake depending on your platform. The build errors and warnings are
|
\c nmake depending on your platform. The build errors and warnings are
|
||||||
parsed and displayed in the \gui{Build Issues} output pane.
|
parsed and displayed in the \gui{Issues} output pane.
|
||||||
|
|
||||||
By default, \QC builds the \bold{all} target. You can specify which
|
By default, \QC builds the \bold{all} target. You can specify which
|
||||||
targets to build in \gui{Project} mode, under \gui{Build Settings}.
|
targets to build in \gui{Project} mode, under \gui{Build Settings}.
|
||||||
|
|||||||
@@ -167,7 +167,7 @@
|
|||||||
\o \l{Using External Tools}
|
\o \l{Using External Tools}
|
||||||
\o \l{Using Maemo or MeeGo Harmattan Emulator}
|
\o \l{Using Maemo or MeeGo Harmattan Emulator}
|
||||||
\o \l{Editing MIME Types}
|
\o \l{Editing MIME Types}
|
||||||
\o \l{Showing Task List Files in the Build Issues Pane}
|
\o \l{Showing Task List Files in Issues Pane}
|
||||||
\o \l{Using Command Line Options}
|
\o \l{Using Command Line Options}
|
||||||
\o \l{Keyboard Shortcuts}
|
\o \l{Keyboard Shortcuts}
|
||||||
\endlist
|
\endlist
|
||||||
|
|||||||
Reference in New Issue
Block a user