feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Issues pane filters

Browse Source 
Rename Build Issues to Issues

Change-Id: I6aa6116e8cdaf0f1d9f201335bfebedddca7c237
Reviewed-by: Christian Kamm <christian.d.kamm@nokia.com>
This commit is contained in:
Leena Miettinen
2011-10-14 12:29:53 +02:00
parent eabd58139d
commit a2deab607c
9 changed files with 43 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/src/howto/creator-keyboard-shortcuts.qdoc
View File

@@ -149,7 +149,7 @@
\o Switch to \gui Help mode
\o Ctrl+6
\row
\o Toggle \gui{Build Issues} pane
\o Toggle \gui{Issues} pane
\o Alt+1 (Cmd+1 on Mac OS X)
\row
\o Toggle \gui{Search Results} pane

4
doc/src/howto/creator-task-lists.qdoc
View File

@@ -31,7 +31,7 @@
\page creator-task-lists.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.
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.
\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
the \l{Task List File Format} by using conversion scripts that based on
standard text processing tools of the operating system.

2
doc/src/howto/creator-tips.qdoc
View File

@@ -92,7 +92,7 @@
\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)

51
doc/src/howto/creator-ui.qdoc
View File

@@ -230,7 +230,7 @@
\list
\o \gui{Build Issues}
\o \gui{Issues}
\o \gui{Search Results}
@@ -256,26 +256,45 @@
To open the \gui{General Messages} and \gui{Version Control} panes, select
\gui {Window > Output Panes}.
\section2 Build Issues
\section2 Issues
The \gui{Build Issues} pane provides a list of errors and warnings
encountered during a build. The pane filters out irrelevant output from
the build tools and presents the issues in an organized way.
The \gui{Issues} pane provides lists of following types of issues:
\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
the contents and to show a version control annotation view of the line
that causes the error message.
\image qtcreator-build-issues.png
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}.
To jump from one issue to the next or previous one, press \key F6 and
\key Shift+F6.
\section2 Search Results
@@ -301,7 +320,7 @@
The \gui{Compile Output} pane provides all output from the compiler.
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

2
doc/src/overview/creator-advanced.qdoc
View File

@@ -62,7 +62,7 @@
\o \l{Using Maemo or MeeGo Harmattan Emulator}
\endif
\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{Keyboard Shortcuts}
\o \l{Glossary}

2
doc/src/projects/creator-projects-building.qdoc
View File

@@ -40,7 +40,7 @@
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
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.
To build an application:

2
doc/src/projects/creator-projects-cmake.qdoc
View File

@@ -96,7 +96,7 @@
\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
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
targets to build in \gui{Project} mode, under \gui{Build Settings}.

2
doc/src/qtcreator.qdoc
View File

@@ -167,7 +167,7 @@
\o \l{Using External Tools}
\o \l{Using Maemo or MeeGo Harmattan Emulator}
\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{Keyboard Shortcuts}
\endlist