From a2deab607ca1217f12cc23e0039fa3ce3c63bb96 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Fri, 14 Oct 2011 12:29:53 +0200 Subject: Doc: Issues pane filters Rename Build Issues to Issues Change-Id: I6aa6116e8cdaf0f1d9f201335bfebedddca7c237 Reviewed-by: Christian Kamm --- doc/images/qtcreator-build-issues.png | Bin 21792 -> 10947 bytes doc/src/howto/creator-keyboard-shortcuts.qdoc | 2 +- doc/src/howto/creator-task-lists.qdoc | 4 +- doc/src/howto/creator-tips.qdoc | 2 +- doc/src/howto/creator-ui.qdoc | 51 ++++++++++++++++-------- doc/src/overview/creator-advanced.qdoc | 2 +- doc/src/projects/creator-projects-building.qdoc | 2 +- doc/src/projects/creator-projects-cmake.qdoc | 2 +- doc/src/qtcreator.qdoc | 2 +- 9 files changed, 43 insertions(+), 24 deletions(-) (limited to 'doc') diff --git a/doc/images/qtcreator-build-issues.png b/doc/images/qtcreator-build-issues.png index 3a59674695..0cc675769f 100644 Binary files a/doc/images/qtcreator-build-issues.png and b/doc/images/qtcreator-build-issues.png differ diff --git a/doc/src/howto/creator-keyboard-shortcuts.qdoc b/doc/src/howto/creator-keyboard-shortcuts.qdoc index 6282334d0d..2ce0c8c342 100644 --- a/doc/src/howto/creator-keyboard-shortcuts.qdoc +++ b/doc/src/howto/creator-keyboard-shortcuts.qdoc @@ -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 diff --git a/doc/src/howto/creator-task-lists.qdoc b/doc/src/howto/creator-task-lists.qdoc index 3c5aa474a8..d8819a6f94 100644 --- a/doc/src/howto/creator-task-lists.qdoc +++ b/doc/src/howto/creator-task-lists.qdoc @@ -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. diff --git a/doc/src/howto/creator-tips.qdoc b/doc/src/howto/creator-tips.qdoc index 88337d816f..c6a9bccf92 100644 --- a/doc/src/howto/creator-tips.qdoc +++ b/doc/src/howto/creator-tips.qdoc @@ -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) diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index 63b1fc15e4..262e3dc290 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -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: - 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. + \list - \image qtcreator-build-issues.png + \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. - To view task lists in the \gui{Build Issues} pane, click + \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 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. + 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. - 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 diff --git a/doc/src/overview/creator-advanced.qdoc b/doc/src/overview/creator-advanced.qdoc index ec49e7d28a..549c527cd8 100644 --- a/doc/src/overview/creator-advanced.qdoc +++ b/doc/src/overview/creator-advanced.qdoc @@ -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} diff --git a/doc/src/projects/creator-projects-building.qdoc b/doc/src/projects/creator-projects-building.qdoc index 88c3601c6f..dd29d8ec0f 100644 --- a/doc/src/projects/creator-projects-building.qdoc +++ b/doc/src/projects/creator-projects-building.qdoc @@ -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: diff --git a/doc/src/projects/creator-projects-cmake.qdoc b/doc/src/projects/creator-projects-cmake.qdoc index 11b766c12d..7c64c34594 100644 --- a/doc/src/projects/creator-projects-cmake.qdoc +++ b/doc/src/projects/creator-projects-cmake.qdoc @@ -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}. diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc index 9f39fbfa01..599b4e18d9 100644 --- a/doc/src/qtcreator.qdoc +++ b/doc/src/qtcreator.qdoc @@ -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 -- cgit v1.2.1