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

Doc: use \uicontrol command instead of \gui macro

Browse Source 
Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This commit is contained in:
Leena Miettinen
2014-12-11 15:43:19 +01:00
committed by Leena Miettinen
parent c9696aa6f4
commit e1fbeedcd4
97 changed files with 1955 additions and 1876 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
doc/src/howto/creator-external-tools.qdoc
View File

@@ -45,15 +45,15 @@
To synchronize translation source (TS) files from a translator with the
application code,
select \gui {Tools > External > Text > Linguist > Update Translations
select \uicontrol {Tools > External > Text > Linguist > Update Translations
(lupdate)}.
To generate from the TS files Qt message (QM) files that can be used by an
application, select \gui {Tools > External > Text > Linguist > Release
application, select \uicontrol {Tools > External > Text > Linguist > Release
Translations (lrelease)}.
By default, the project .pro file is passed to the tools as an argument. To
specify other command line arguments for the tools, select \gui {Tools >
specify other command line arguments for the tools, select \uicontrol {Tools >
External > Configure}.
For more information about Qt Linguist, see \l{Qt Linguist Manual}.
@@ -64,77 +64,78 @@
QML Scene (Qt Quick 2). The preview tools enable you to load QML documents
for viewing and testing while you are developing an application.
To preview the currently active QML file, select \gui Tools > \gui External
> \gui {Qt Quick} > \gui {Qt Quick 1 Preview (qmlviewer)} or
\gui {Qt Quick 2 Preview (qmlscene)}.
To preview the currently active QML file, select \uicontrol Tools >
\uicontrol External > \uicontrol {Qt Quick} > \uicontrol {Qt Quick 1 Preview
(qmlviewer)} or \uicontrol {Qt Quick 2 Preview (qmlscene)}.
\section1 Using External Text Editors
You can open files for editing in the default text editor for your system:
Notepad on Windows and vi on Linux and OS X.
To open the file you are currently viewing in an external editor, select
\gui Tools > \gui External > \gui Text > \gui {Edit with Notepad} or
\gui {Edit with vi}, depending on your system.
\uicontrol Tools > \uicontrol External > \uicontrol Text >
\uicontrol {Edit with Notepad} or \uicontrol {Edit with vi}, depending on
your system.
\QC looks for the editor path in the PATH environment variable
of your operating system.
\section1 Sorting Text Alphabetically
To sort selected text alphabetically, select \gui {Tools > External > Text
To sort selected text alphabetically, select \uicontrol {Tools > External > Text
> Sort Selection}. The \c sort tool takes the selected text as input and
returns it in alphabetic order. By default, the output replaces the
original selection in the code editor.
To change the default configuration, select \gui {Tools > External >
To change the default configuration, select \uicontrol {Tools > External >
Configure}.
\section1 Configuring External Tools
You can change the configuration of preconfigured tools and configure
additional tools in \QC \gui Options.
additional tools in \QC \uicontrol Options.
To configure external tools:
\list 1
\li Select \gui {Tools > External > Configure}.
\li Select \uicontrol {Tools > External > Configure}.
\li Select \gui {Add > Add Tool}
to add a new tool. You can also select \gui {Add Category} to add a
\li Select \uicontrol {Add > Add Tool}
to add a new tool. You can also select \uicontrol {Add Category} to add a
new category.
\li In the \gui Executable field, specify the executable to run. If the
\li In the \uicontrol Executable field, specify the executable to run. If the
executable is found in your system PATH variable, do not specify
the path to it.
\li In the \gui Arguments field, specify optional arguments for running
\li In the \uicontrol Arguments field, specify optional arguments for running
the executable.
\li In the \gui {Working directory} field, specify the path to the
\li In the \uicontrol {Working directory} field, specify the path to the
working directory.
\li In the \gui {Output pane}, select how to handle output from the
tool. You can ignore the output, view it in the \gui {General
\li In the \uicontrol {Output pane}, select how to handle output from the
tool. You can ignore the output, view it in the \uicontrol {General
Messages} output pane, or replace the selected text with the
output in the code editor.
\li In the \gui {Error output pane}, select how to handle error messages
\li In the \uicontrol {Error output pane}, select how to handle error messages
from the tool.
\li Select the \gui {Modifies current document} check box to make sure
\li Select the \uicontrol {Modifies current document} check box to make sure
that if the current document is modified by the tool, it is saved
before the tool is run and reloaded after the tool finishes.
\li In the \gui Input field, specify text that is passed as standard
\li In the \uicontrol Input field, specify text that is passed as standard
input to the tool.
\endlist
The category and tool are added to the \gui {Tools > External} menu.
The category and tool are added to the \uicontrol {Tools > External} menu.
If you change the configuration of preconfigured tools, you can later
revert the changes by selecting the \gui Revert button.
revert the changes by selecting the \uicontrol Revert button.
The tool configurations that you add and modify are stored in XML format in
the user configuration folder. For example,

94
doc/src/howto/creator-help.qdoc
View File

@@ -35,7 +35,7 @@
\list
\li To view documentation, switch to \gui Help mode.
\li To view documentation, switch to \uicontrol Help mode.
\li To view context sensitive help on a Qt class or function as a
tooltip, move the mouse cursor over the class or function. If help
@@ -45,58 +45,58 @@
\li To display the full help on a Qt class or function, press \key F1.
The documentation is displayed in a
pane next to the code editor, or, if there is not enough vertical
space, in the fullscreen \gui Help mode.
space, in the fullscreen \uicontrol Help mode.
\li To select and configure how the documentation is displayed in the
\gui Help mode, select \gui Tools > \gui Options > \gui Help.
\uicontrol Help mode, select \uicontrol Tools > \uicontrol Options > \uicontrol Help.
\endlist
The following image displays the context sensitive help in the \gui Edit
The following image displays the context sensitive help in the \uicontrol Edit
mode.
\image qtcreator-context-sensitive-help.png
\section1 Viewing Function Tooltips
To hide function tooltips by default, select \gui {Tools > Options >
To hide function tooltips by default, select \uicontrol {Tools > Options >
Text Editor > Behavior > Show help tooltips using the mouse >
On Shift+Mouseover}. You
can still view the tooltips by pressing and holding down the \key Shift
key.
To use a keyboard shortcut for viewing help tooltips, select
\gui {Show help tooltips using keyboard shortcut (Alt)}.
\uicontrol {Show help tooltips using keyboard shortcut (Alt)}.
\section1 Finding Information in Qt Documentation
\QC, \QSDK and other Qt deliverables contain documentation
as .qch files. All the documentation is accessible in the \gui Help mode.
as .qch files. All the documentation is accessible in the \uicontrol Help mode.
To find information in the documentation, select:
\list
\li \gui Bookmarks to view a list of pages on which you have added
\li \uicontrol Bookmarks to view a list of pages on which you have added
bookmarks.
\li \gui Contents to see all the documentation installed on the
\li \uicontrol Contents to see all the documentation installed on the
development PC and to browse the documentation contents.
\li \gui Index to find information based on a list of keywords in all
\li \uicontrol Index to find information based on a list of keywords in all
the installed documents.
\li \gui {Open Pages} to view a list of currently open documentation
\li \uicontrol {Open Pages} to view a list of currently open documentation
pages.
\li \gui Search to search from all the installed documents.
\li \uicontrol Search to search from all the installed documents.
\endlist
\section2 Adding Bookmarks to Help Pages
You can add bookmarks to useful help pages to easily find them later
in the \gui Bookmarks view. You can either use the page title as the
in the \uicontrol Bookmarks view. You can either use the page title as the
bookmark or change it to any text. You can organize the bookmarks in
folders in the view.
@@ -108,21 +108,21 @@
\li Click the
\inlineimage qtcreator-help-add-bookmark.png
(\gui {Add Bookmark}) button on the toolbar.
(\uicontrol {Add Bookmark}) button on the toolbar.
\li In the \gui {Add Bookmark} dialog, click \gui OK to save the
\li In the \uicontrol {Add Bookmark} dialog, click \uicontrol OK to save the
page title as a bookmark in the selected folder.
\endlist
To import and export bookmarks, select \gui {Tools > Options > Help >
General Settings > Import} or \gui Export.
To import and export bookmarks, select \uicontrol {Tools > Options > Help >
General Settings > Import} or \uicontrol Export.
\section2 Full-text Search
In the \gui Search pane, you can use full-text search for finding a
particular word in all the installed documents. In the \gui {Search for}
field, enter the term you are looking for, and select the \gui Search
In the \uicontrol Search pane, you can use full-text search for finding a
particular word in all the installed documents. In the \uicontrol {Search for}
field, enter the term you are looking for, and select the \uicontrol Search
button. All documents that contain the specified term are listed. The list
is sorted by the number of search hits that the documents contain. Select a
document in the list to open it.
@@ -147,20 +147,20 @@
\endlist
For more flexibility, use the \gui {Advanced search}. Specify words to
For more flexibility, use the \uicontrol {Advanced search}. Specify words to
exclude from the search hits, or search for an exact phrase or for similar
words. For example, searching for \c{QStin}, \c{QSting}, or \c{QStrin} lists
all the documents with titles that are similar, such as \c{QString}.
Combine options to improve the search results.
Full-text search is based on indexing all the installed documents the first
time when you open the \gui Search pane. If you add or remove documents,
time when you open the \uicontrol Search pane. If you add or remove documents,
\QC recreates the index.
If you cannot find words that you know are there, indexing might not have
been completed for some reason. To regenerate the index, click
\inlineimage qtcreator-regenerate-index.png
(\gui {Regenerate Index}).
(\uicontrol {Regenerate Index}).
Punctuation is not included in indexed terms. To find terms that contain
punctuation, such as domain names, use the asterisk as a wild card. For
@@ -168,7 +168,7 @@
\section1 Adding External Documentation
You can display external documentation in the \gui Help mode.
You can display external documentation in the \uicontrol Help mode.
To augment or replace the documentation that ships with \QC and Qt:
\list 1
@@ -178,8 +178,8 @@
For information on how to prepare your documentation and create a
.qch file, see \l{The Qt Help Framework}.
\li To add the .qch file to \QC, select \gui Tools > \gui Options >
\gui Help > \gui Documentation > \gui Add.
\li To add the .qch file to \QC, select \uicontrol Tools > \uicontrol Options >
\uicontrol Help > \uicontrol Documentation > \uicontrol Add.
\endlist
@@ -190,32 +190,32 @@
space, the help opens in the full-screen help mode.
You can specify that the help always opens in full-screen mode or
is detached to an external window. Select \gui {Tools > Options > Help >
is detached to an external window. Select \uicontrol {Tools > Options > Help >
General Settings} and specify settings for displaying context-sensitive help
in the \gui {On context help} field. To detach the help window, select
\gui {Always Show Help in External Window}.
in the \uicontrol {On context help} field. To detach the help window, select
\uicontrol {Always Show Help in External Window}.
\section1 Selecting the Start Page
You can select the page to display when you open the \gui Help mode in the
\gui {Tools > Options > Help > General Settings > On help start} field.
You can select the page to display when you open the \uicontrol Help mode in the
\uicontrol {Tools > Options > Help > General Settings > On help start} field.
To display the page and help panes that were open when you exited the mode,
select the \gui {Show My Tabs from Last Session} option. However, Web pages
are not opened, because loading them would slow down opening the \gui Help
select the \uicontrol {Show My Tabs from Last Session} option. However, Web pages
are not opened, because loading them would slow down opening the \uicontrol Help
mode.
To display a particular page, select \gui {Show My Home Page}, and specify
the page in the \gui {Home Page} field.
To display a particular page, select \uicontrol {Show My Home Page}, and specify
the page in the \uicontrol {Home Page} field.
To display a blank page, select the \gui {Show a Blank Page} option. You can
also select the \gui {Use Blank Page} button to set a blank page as your
To display a blank page, select the \uicontrol {Show a Blank Page} option. You can
also select the \uicontrol {Use Blank Page} button to set a blank page as your
home page.
\section1 Using Documentation Filters
You can filter the documents displayed in the \gui Help mode to find
You can filter the documents displayed in the \uicontrol Help mode to find
relevant information faster. Select from a list of filters in the
\gui {Filtered by} field (1). The contents of the \gui Index and \gui Contents
\uicontrol {Filtered by} field (1). The contents of the \uicontrol Index and \uicontrol Contents
pane in the sidebar change accordingly.
\image qtcreator-help-filters.png "Help filters"
@@ -231,25 +231,25 @@
\list 1
\li Select \gui {Tools > Options > Help > Filters > Add}.
\li Select \uicontrol {Tools > Options > Help > Filters > Add}.
\li Enter a name for the filter and press \gui {OK}.
\li Enter a name for the filter and press \uicontrol {OK}.
\li In \gui Attributes, select the documents that you want to include
\li In \uicontrol Attributes, select the documents that you want to include
in the filter.
\image qtcreator-help-filter-attributes.png "Help filter attributes"
\li Click \gui OK.
\li Click \uicontrol OK.
\li In the \gui Help mode, select the filter in the \gui {Filtered by}
\li In the \uicontrol Help mode, select the filter in the \uicontrol {Filtered by}
field to see the filtered documentation in the sidebar.
\endlist
To modify filters, select a filter in \gui Filters, select the attributes,
and then click \gui Apply.
To modify filters, select a filter in \uicontrol Filters, select the attributes,
and then click \uicontrol Apply.
To remove filters, select them in \gui Filters, and click \gui Remove.
To remove filters, select them in \uicontrol Filters, and click \uicontrol Remove.
*/

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

@@ -34,9 +34,9 @@
process.
To view all keyboard shortcuts defined in \QC, and to change them, select
\gui {Tools > Options > Environment > Keyboard}. The shortcuts are listed by
\uicontrol {Tools > Options > Environment > Keyboard}. The shortcuts are listed by
category. To find a keyboard
shortcut in the list, enter a function name or shortcut in the \gui Filter
shortcut in the list, enter a function name or shortcut in the \uicontrol Filter
field.
\image qtcreator-keyboard-shortcuts.png
@@ -59,14 +59,15 @@
\list 1
\li Select \gui Tools > \gui Options > \gui Environment > \gui Keyboard.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Environment
> \uicontrol Keyboard.
\li Select a command from the list.
\li In \gui{Key Sequence} enter the shortcut key you want to associate
\li In \uicontrol{Key Sequence} enter the shortcut key you want to associate
with the selected command.
\li To revert to the default shortcut, select \gui Reset.
\li To revert to the default shortcut, select \uicontrol Reset.
\endlist
@@ -74,12 +75,12 @@
\list
\li To import a keyboard shortcut mapping scheme, click \gui Import
\li To import a keyboard shortcut mapping scheme, click \uicontrol Import
and select the .kms file containing the keyboard shortcut mapping scheme
you want to import.
\li To export the current keyboard shortcut mapping scheme, click
\gui Export and select the location where you want to save the
\uicontrol Export and select the location where you want to save the
exported .kms file.
\endlist
@@ -159,40 +160,40 @@
\li Previous open document in history
\li Ctrl+Tab
\row
\li Activate \gui Locator
\li Activate \uicontrol Locator
\li Ctrl+K
\row
\li Switch to \gui Welcome mode
\li Switch to \uicontrol Welcome mode
\li Ctrl+1
\row
\li Switch to \gui Edit mode
\li Switch to \uicontrol Edit mode
\li Ctrl+2
\row
\li Switch to \gui Design mode
\li Switch to \uicontrol Design mode
\li Ctrl+3
\row
\li Switch to \gui Debug mode
\li Switch to \uicontrol Debug mode
\li Ctrl+4
\row
\li Switch to \gui Projects mode
\li Switch to \uicontrol Projects mode
\li Ctrl+5
\row
\li Switch to \gui Analyze mode
\li Switch to \uicontrol Analyze mode
\li Ctrl+6
\row
\li Switch to \gui Help mode
\li Switch to \uicontrol Help mode
\li Ctrl+7
\row
\li Toggle \gui{Issues} pane
\li Toggle \uicontrol{Issues} pane
\li Alt+1 (Cmd+1 on OS X)
\row
\li Toggle \gui{Search Results} pane
\li Toggle \uicontrol{Search Results} pane
\li Alt+2 (Cmd+2 on OS X)
\row
\li Toggle \gui{Application Output} pane
\li Toggle \uicontrol{Application Output} pane
\li Alt+3 (Cmd+3 on OS X)
\row
\li Toggle \gui{Compile Output} pane
\li Toggle \uicontrol{Compile Output} pane
\li Alt+4 (Cmd+4 on OS X)
\row
\li Toggle other output panes
@@ -200,13 +201,13 @@
Where the number is the number of the output pane.
\row
\li Activate \gui Bookmarks pane
\li Activate \uicontrol Bookmarks pane
\li Alt+M
\row
\li Activate \gui{File System} pane
\li Activate \uicontrol{File System} pane
\li Alt+Y
\row
\li Activate \gui{Open Documents} pane
\li Activate \uicontrol{Open Documents} pane
\li Alt+O
\row
\li Maximize output panes
@@ -218,7 +219,7 @@
\li Move to previous item in output panes
\li Shift+F6
\row
\li Activate \gui Projects pane
\li Activate \uicontrol Projects pane
\li Alt+X
\row
\li Full screen
@@ -230,9 +231,9 @@
\li Undo
\li Ctrl+Z
\row
\li Move to \gui Edit mode
\li Move to \uicontrol Edit mode
In \gui Edit mode:
In \uicontrol Edit mode:
\list
\li The first press moves focus to the editor
\li The second press closes secondary windows
@@ -570,19 +571,19 @@
\li View context-sensitive help
\li F1
\row
\li Activate contents in \gui Help mode
\li Activate contents in \uicontrol Help mode
\li Ctrl+T
\row
\li Add bookmark in \gui Help mode
\li Add bookmark in \uicontrol Help mode
\li Ctrl+M
\row
\li Activate index in \gui Help mode
\li Activate index in \uicontrol Help mode
\li Ctrl+I
\row
\li Reset font size
\li Ctrl+0
\row
\li Activate search in \gui Help mode
\li Activate search in \uicontrol Help mode
\li Ctrl+S
\endtable

10
doc/src/howto/creator-sessions.qdoc
View File

@@ -32,7 +32,7 @@
When you exit \QC, a snapshot of your current workspace is stored as a
\e session. To restore the session automatically when you start \QC,
select \gui {File > Session Manager > Restore last session on startup}.
select \uicontrol {File > Session Manager > Restore last session on startup}.
When you open or create any of the following items, they automatically
become a part of the session:
@@ -61,17 +61,17 @@
on the first project, open the saved session. \QC opens the projects and
files that belong to the session.
To create a new session or remove existing sessions, select \gui File >
\gui{Session Manager}.
To create a new session or remove existing sessions, select \uicontrol File >
\uicontrol{Session Manager}.
\image qtcreator-session-manager.png
To switch between sessions, choose \gui {File > Session Manager}. If you do
To switch between sessions, choose \uicontrol {File > Session Manager}. If you do
not create or select a session, \QC always uses the default session, which
was created the last time you exited \QC.
When you launch \QC, a list of existing sessions is displayed in the
\gui Welcome mode.
\uicontrol Welcome mode.
\image qtcreator-welcome-session.png

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

@@ -32,7 +32,7 @@
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
issues into the \gui Issues pane for easier navigation.
issues into the \uicontrol Issues pane for easier navigation.
\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
@@ -43,14 +43,14 @@
\section1 Managing Task List Entries
To open task list files in the \gui Issues pane, choose \gui File >
\gui Open. Right-click a task list entry to open a context menu that
To open task list files in the \uicontrol Issues pane, choose \uicontrol File >
\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
entries or navigate to the corresponding source code.
\QC monitors the loaded files and displays the changes in the \gui Issues
\QC monitors the loaded files and displays the changes in the \uicontrol Issues
pane. To keep the current entries in a task list, but stop checking for
changes, select \gui {Stop Monitoring}.
changes, select \uicontrol {Stop Monitoring}.
\section1 Task List File Format

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

@@ -37,13 +37,13 @@
\list
\li \gui Welcome mode \key Ctrl+1
\li \gui Edit mode \key Ctrl+2
\li \gui Design mode \key Ctrl+3
\li \gui Debug mode \key Ctrl+4
\li \gui Projects mode \key Ctrl+5
\li \gui Analyze mode \key Ctrl+6
\li \gui Help mode \key Ctrl+7
\li \uicontrol Welcome mode \key Ctrl+1
\li \uicontrol Edit mode \key Ctrl+2
\li \uicontrol Design mode \key Ctrl+3
\li \uicontrol Debug mode \key Ctrl+4
\li \uicontrol Projects mode \key Ctrl+5
\li \uicontrol Analyze mode \key Ctrl+6
\li \uicontrol Help mode \key Ctrl+7
\endlist
@@ -56,16 +56,16 @@
To move forward in the location history, press \key {Alt+Right}
(\key {Cmd+Opt+Right} on OS X). To move backward, press \key {Alt+Left}
(\key {Cmd+Opt+Left} on OS X). For example, if you use the \gui Locator
(\key {Cmd+Opt+Left} on OS X). For example, if you use the \uicontrol Locator
to jump to a symbol in the same file, you can jump back to your original
location in that file by pressing \key {Alt+Left}.
\section1 Moving To the Edit Mode
To move to the \gui Edit mode and currently active file, press
To move to the \uicontrol Edit mode and currently active file, press
\key Esc.
If you already are in the \gui Edit mode:
If you already are in the \uicontrol Edit mode:
\list
@@ -77,8 +77,8 @@
\section1 Using the Filter in Options Dialog
To find specific settings you require in \gui{Tools} > \gui{Options}
use the filter located at the top left of the \gui Options dialog box.
To find specific settings you require in \uicontrol{Tools} > \uicontrol{Options}
use the filter located at the top left of the \uicontrol Options dialog box.
\section1 Opening Output Panes
@@ -90,18 +90,18 @@
\list
\li \gui{Issues} pane Alt+1 (Cmd+1 on OS X)
\li \uicontrol{Issues} pane Alt+1 (Cmd+1 on OS X)
\li \gui{Search Results} pane Alt+2 (Cmd+2 on OS X)
\li \uicontrol{Search Results} pane Alt+2 (Cmd+2 on OS X)
\li \gui{Application Output} pane Alt+3 (Cmd+3 on OS X)
\li \uicontrol{Application Output} pane Alt+3 (Cmd+3 on OS X)
\li \gui{Compile Output} pane Alt+4 (Cmd+4 on OS X)
\li \uicontrol{Compile Output} pane Alt+4 (Cmd+4 on OS X)
\endlist
To open the other output panes, such as \gui{General Messages} and
\gui{Version Control}, select \gui Window > \gui {Output Panes}. The menu
To open the other output panes, such as \uicontrol{General Messages} and
\uicontrol{Version Control}, select \uicontrol Window > \uicontrol {Output Panes}. The menu
items also display the keyboard shortcuts that you can use.
For more information about output panes, see \l{Viewing Output}.
@@ -112,8 +112,8 @@
You can see the keyboard shortcut for a menu command in the menu
or the tooltip for a button.
To customize, import or export keyboard shortcuts, select \gui Tools >
\gui Options > \gui Environment > \gui Keyboard.
To customize, import or export keyboard shortcuts, select \uicontrol Tools >
\uicontrol Options > \uicontrol Environment > \uicontrol Keyboard.
\section1 Running \QC From Command Line
@@ -128,7 +128,7 @@
\section1 Showing and Hiding the Sidebar
To toggle the sidebar in the \gui Edit and \gui Debug modes, click
To toggle the sidebar in the \uicontrol Edit and \uicontrol Debug modes, click
\inlineimage qtcreator-togglebutton.png
or press \key Alt+0 (\key Cmd+0 on OS X).
@@ -138,11 +138,11 @@
\section1 Moving To Symbols
To move straight to a symbol used in a project, select the symbol in the
\gui Editor toolbar drop-down menu. For more information on the editor
\uicontrol Editor toolbar drop-down menu. For more information on the editor
toolbar, see \l {Using the Editor Toolbar}.
To jump to a symbol in the current file, press \key {Ctrl+K} to open the
\gui Locator, enter a period (.), and start typing the symbol name. Then
\uicontrol Locator, enter a period (.), and start typing the symbol name. Then
select the symbol in the list. For more information on using the locator,
see \l{Searching with the Locator}.
@@ -155,15 +155,15 @@
If an instance of a class is derived from QObject, and you would like to
find all other objects connected to one of your object's slots using
Qt's signals and slots mechanism, select \gui Tools > \gui Options
> \gui{Debugger} > \gui{Locals and Expressions} >
\gui{Use Debugging Helper}.
Qt's signals and slots mechanism, select \uicontrol Tools > \uicontrol Options
> \uicontrol{Debugger} > \uicontrol{Locals and Expressions} >
\uicontrol{Use Debugging Helper}.
In the \gui{Locals and Expressions} view, expand the object's entry and open
In the \uicontrol{Locals and Expressions} view, expand the object's entry and open
the slot in the \e slots subitem. The objects connected to this slot are
shown as children of the slot. This method works with signals too.
For more information about the \gui{Locals and Expressions} view, see
For more information about the \uicontrol{Locals and Expressions} view, see
\l{Locals and Expressions}.
\section1 Displaying Low Level Data
@@ -175,10 +175,10 @@
To switch off the debugging helpers:
\list 1
\li Select \gui Tools > \gui Options > \gui Debugger >
\gui{Locals and Expressions}.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger >
\uicontrol{Locals and Expressions}.
\li Uncheck the \gui{Use Debugging Helper} checkbox.
\li Uncheck the \uicontrol{Use Debugging Helper} checkbox.
\endlist
@@ -189,39 +189,40 @@
\list 1
\li Select \gui Tools > \gui Options > \gui Debugger > \gui General.
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol Debugger > \uicontrol General.
\li Select the \gui {Use tooltips in main editor while debugging} check
\li Select the \uicontrol {Use tooltips in main editor while debugging} check
box.
\endlist
When you hover over a variable in the code editor in \gui Debug mode, a
When you hover over a variable in the code editor in \uicontrol Debug mode, a
tooltip is displayed. To keep the tooltip visible, click the pin button.
You can expand pinned tooltips to view their full content.
\image qtcreator-pin-tooltip.png
Pinned tooltips are stored in the session. To close all pinned tooltips,
select \gui {Close Editor Tooltips} in the context menu in the \gui {Locals
select \uicontrol {Close Editor Tooltips} in the context menu in the \uicontrol {Locals
and Expressions} view.
\section1 Locating Files
The \gui Locator provides one of the easiest ways in \QC to browse
The \uicontrol Locator provides one of the easiest ways in \QC to browse
through projects, files, classes, functions, documentation and file systems.
To quickly access files not directly mentioned in your project, you can
create your own locator filters. That way you can locate files in a
directory structure you have defined.
To create locator filters, select \gui {Tools > Options > Locator > Add}.
To create locator filters, select \uicontrol {Tools > Options > Locator > Add}.
For more information, see \l{Creating Locator Filters}.
\section1 Adding a License Header Template for C++ Code
A file containing a license header for C++ can be specified under
\gui{Tools > Options > C++ > License Template}. It may contain special
\uicontrol{Tools > Options > C++ > License Template}. It may contain special
placeholders enclosed in \c{%%} that are replaced when generating a
new file:

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

@@ -30,7 +30,7 @@
\title User Interface
When you start \QC, it opens to the \gui Welcome mode, where you can:
When you start \QC, it opens to the \uicontrol Welcome mode, where you can:
\list
@@ -65,10 +65,10 @@
{corresponding keyboard shortcut}.
To hide the mode selector and to save space on the display, select
\gui Window > \gui {Show Mode Selector}.
\uicontrol Window > \uicontrol {Show Mode Selector}.
The following image displays an example application in \gui Edit mode (1)
and \gui Design mode (2).
The following image displays an example application in \uicontrol Edit mode (1)
and \uicontrol Design mode (2).
\image qtcreator-qt-quick-editors.png "Edit mode and Design mode"
@@ -76,37 +76,37 @@
\list
\li \gui Welcome mode for opening projects.
\li \uicontrol Welcome mode for opening projects.
\li \gui{\l{Coding}{Edit}} mode for editing project and source
\li \uicontrol{\l{Coding}{Edit}} mode for editing project and source
files.
\li \gui{\l{Designing User Interfaces}{Design}} mode for designing and
\li \uicontrol{\l{Designing User Interfaces}{Design}} mode for designing and
developing application user interfaces. This mode is available for
UI files.
\li \gui{\l{Debugging}{Debug}} mode for inspecting the state of your
\li \uicontrol{\l{Debugging}{Debug}} mode for inspecting the state of your
application while debugging.
\li \gui{\l{Specifying Build Settings}{Projects}} mode for configuring
\li \uicontrol{\l{Specifying Build Settings}{Projects}} mode for configuring
project building and execution. This mode is available when a
project is open.
\li \gui{\l{Analyzing Code}{Analyze}} mode for using code analysis tools
\li \uicontrol{\l{Analyzing Code}{Analyze}} mode for using code analysis tools
to detect memory leaks and profile C++ or QML code.
\li \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
\li \uicontrol{\l{Getting Help}{Help}} mode for viewing Qt documentation.
\endlist
Certain actions in \QC trigger a mode change. Clicking on \gui {Debug} >
\gui {Start Debugging} > \gui {Start Debugging} automatically switches to
\gui {Debug} mode.
Certain actions in \QC trigger a mode change. Clicking on \uicontrol {Debug} >
\uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to
\uicontrol {Debug} mode.
\section1 Browsing Project Contents
The sidebar is available in the \gui Edit and \gui Debug modes, and with a
different set of views in the \gui Design mode. Use the
The sidebar is available in the \uicontrol Edit and \uicontrol Debug modes, and with a
different set of views in the \uicontrol Design mode. Use the
sidebar to browse projects, files, and bookmarks, and to view the class
hierarchy.
@@ -116,25 +116,25 @@
\list
\li \gui Projects shows a list of projects open in the current
\li \uicontrol Projects shows a list of projects open in the current
session.
\li \gui{Open Documents} shows currently open files.
\li \uicontrol{Open Documents} shows currently open files.
\li \gui Bookmarks shows all bookmarks for the current session.
\li \uicontrol Bookmarks shows all bookmarks for the current session.
\li \gui{File System} shows all files in the currently selected
\li \uicontrol{File System} shows all files in the currently selected
directory.
\li \gui {Class View} shows the class hierarchy of the currently
\li \uicontrol {Class View} shows the class hierarchy of the currently
open projects.
\li \gui Outline shows the symbol hierarchy of a C++ file and the type
\li \uicontrol Outline shows the symbol hierarchy of a C++ file and the type
hierarchy of a QML file.
\li \gui {Type Hierarchy} shows the base classes of a class.
\li \uicontrol {Type Hierarchy} shows the base classes of a class.
\li \gui {Include Hierarchy} shows which files are included in the current file
\li \uicontrol {Include Hierarchy} shows which files are included in the current file
and which files include the current file.
\endlist
@@ -147,15 +147,15 @@
\list
\li To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
(\gui {Hide Sidebar/Show Sidebar}) or press \key Alt+0
(\uicontrol {Hide Sidebar/Show Sidebar}) or press \key Alt+0
(\key Cmd+0 on OS X).
\li To split the sidebar, click \inlineimage qtcreator-splitbar.png
(\gui {Split}). Select new content to view in the split view.
(\uicontrol {Split}). Select new content to view in the split view.
\li To close a sidebar view, click
\inlineimage qtcreator-closesidebar.png
(\gui {Close}).
(\uicontrol {Close}).
\endlist
@@ -188,15 +188,15 @@
\li To hide the categories and sort project files alphabetically, click
\inlineimage qtcreator-filter.png
(\gui {Filter Tree}) and select \gui{Simplify Tree}.
(\uicontrol {Filter Tree}) and select \uicontrol{Simplify Tree}.
\li To hide source files which are automatically generated by the build
system, select \gui {Filter Tree > Hide Generated Files}.
system, select \uicontrol {Filter Tree > Hide Generated Files}.
\li To keep the position in the project tree synchronized with the file
currently opened in the editor, click
\inlineimage qtcreator-synchronizefocus.png
(\gui {Synchronize with Editor}).
(\uicontrol {Synchronize with Editor}).
\li To see the absolute path of a file, move the mouse pointer over the
file name.
@@ -206,51 +206,51 @@
Files that are not sources or data can be still included into a project's
distribution tarball by adding their paths to the \c DISTFILES variable in
the .pro file. This way they also become known to \QC, so that they are
visible in the \gui Projects view and are known to the locator and search.
visible in the \uicontrol Projects view and are known to the locator and search.
\section2 Viewing the File System
If you cannot see a file in the \gui Projects view, switch to the
\gui {File System} view, which shows all the files in the file system.
If you cannot see a file in the \uicontrol Projects view, switch to the
\uicontrol {File System} view, which shows all the files in the file system.
To also show hidden files, select \gui {Filter Files} > \gui {Show Hidden Files}.
To also show hidden files, select \uicontrol {Filter Files} > \uicontrol {Show Hidden Files}.
To keep the position in the tree synchronized with the file
opened in the editor, select \gui {Synchronize with Editor}.
opened in the editor, select \uicontrol {Synchronize with Editor}.
\section2 Viewing the Class Hierarchy
The \gui {Class View} shows the class hierarchy of the currently
The \uicontrol {Class View} shows the class hierarchy of the currently
open projects. To organize the view by subprojects, click
\inlineimage qtcreator-show-subprojects.png
(\gui {Show Subprojects}).
(\uicontrol {Show Subprojects}).
To visit all parts of a namespace, double-click on the namespace item
multiple times.
\section2 Viewing QML Types
The \gui Outline view shows the type hierarchy in a QML file.
The \uicontrol Outline view shows the type hierarchy in a QML file.
\list
\li To see a complete list of all bindings, select \gui {Filter Tree >
\li To see a complete list of all bindings, select \uicontrol {Filter Tree >
Show All Bindings}.
\li To keep the position in the view synchronized with the QML type
selected in the editor, select \gui {Synchronize with Editor}.
selected in the editor, select \uicontrol {Synchronize with Editor}.
\endlist
\section2 Viewing Type Hierarchy
To view the base classes of a class, right-click the class and select
\gui {Open Type Hierarchy} or press \key {Ctrl+Shift+T}.
\uicontrol {Open Type Hierarchy} or press \key {Ctrl+Shift+T}.
\section2 Viewing Include Hierarchy
To view which files are included in the current file and which files include
the current file, right-click in the editor and select \gui {Open Include Hierarchy}
the current file, right-click in the editor and select \uicontrol {Open Include Hierarchy}
or press \key {Ctrl+Shift+I}.
\section1 Viewing Output
@@ -259,73 +259,73 @@
\list
\li \gui{Issues}
\li \uicontrol{Issues}
\li \gui{Search Results}
\li \uicontrol{Search Results}
\li \gui{Application Output}
\li \uicontrol{Application Output}
\li \gui{Compile Output}
\li \uicontrol{Compile Output}
\li \gui {QML/JS Console}
\li \uicontrol {QML/JS Console}
\li \gui {To-Do Entries}
\li \uicontrol {To-Do Entries}
\li \gui{Version Control}
\li \uicontrol{Version Control}
\li \gui{General Messages}
\li \uicontrol{General Messages}
\endlist
Output panes are available in all \l{Modes}{modes}. Click the name of an
output pane to open the pane. To maximize an open output pane, click the
\gui {Maximize Output Pane} button or press \key {Alt+9}.
\uicontrol {Maximize Output Pane} button or press \key {Alt+9}.
To search within the \gui{Application Output} and \gui{Compile Output}
To search within the \uicontrol{Application Output} and \uicontrol{Compile Output}
panes, press \key {Ctrl+F} when the pane is active. Enter search criteria in
the \gui Find field and click the left and right arrows to search down and
the \uicontrol Find field and click the left and right arrows to search down and
up in the pane.
To open the \gui{General Messages} and \l{Using Version Control Systems}
To open the \uicontrol{General Messages} and \l{Using Version Control Systems}
{Version Control} panes, select
\gui {Window > Output Panes}. To display the \gui {To-Do Entries} pane,
\uicontrol {Window > Output Panes}. To display the \uicontrol {To-Do Entries} pane,
enable the Todo plugin.
\section2 Issues
The \gui{Issues} pane provides lists of following types of issues:
The \uicontrol{Issues} pane provides lists of following types of issues:
\list
\li \gui Analyzer - Errors encountered while running the
\li \uicontrol Analyzer - Errors encountered while running the
\l{Analyzing Code}{Valgrind code analysis tools}.
\li \gui {Bar Descriptor} - Errors and warnings encountered when using
\li \uicontrol {Bar Descriptor} - Errors and warnings encountered when using
the BlackBerry 10 BAR descriptor editor to customize the appearance
and behavior of an application.
\li \gui {Build System} - Errors and warnings encountered during a
\li \uicontrol {Build System} - Errors and warnings encountered during a
build.
\li \gui Compile - Selected output from the compiler. Open the
\gui {Compile Output} pane for more detailed information.
\li \uicontrol Compile - Selected output from the compiler. Open the
\uicontrol {Compile Output} pane for more detailed information.
\li \gui{Debug Information} - Lists debug information packages that might
\li \uicontrol{Debug Information} - Lists debug information packages that might
be missing.
\li \gui{Debugger Runtime} - Errors encountered when starting \QC. For
\li \uicontrol{Debugger Runtime} - Errors encountered when starting \QC. For
example, information about missing DLLs.
\li \gui Deployment - Errors encountered between building an application
\li \uicontrol Deployment - Errors encountered between building an application
successfully and starting it on a device.
\li \gui {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}
{code scanning and analysis tools}.
\li \gui QML - Errors in QML syntax.
\li \uicontrol QML - Errors in QML syntax.
\li \gui {QML Analysis} - Results of the JavaScript
\li \uicontrol {QML Analysis} - Results of the JavaScript
\l{Checking JavaScript and QML Syntax}
{code syntax and validation checks}
@@ -333,7 +333,7 @@
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
\gui {Filter Tree}
\uicontrol {Filter Tree}
and then select a filter.
\image qtcreator-build-issues.png
@@ -345,18 +345,18 @@
annotation view of the line that causes the error message.
To navigate to the corresponding source code, click an issue or
select \gui {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.
To view more information about an issue in the \gui {Compile Output} pane,
select \gui {Show Output} in the context menu.
To view more information about an issue in the \uicontrol {Compile Output} pane,
select \uicontrol {Show Output} in the context menu.
To jump from one issue to the next or previous one, press \key F6 and
\key Shift+F6.
\section2 Search Results
In the \gui{Search Results} pane, you can search through projects, files on
In the \uicontrol{Search Results} pane, you can search through projects, files on
a file system or the currently open file:
\image qtcreator-search-results.png "Search Results output pane"
@@ -371,7 +371,7 @@
\section2 Application Output
The \gui{Application Output} pane displays the status of a program when
The \uicontrol{Application Output} pane displays the status of a program when
it is executed, and the debug output.
\image qtcreator-application-output.png
@@ -381,20 +381,20 @@
\section2 Compile Output
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{Issues} pane.
The \uicontrol{Compile Output} pane provides all output from the compiler.
The \uicontrol{Compile Output} is a more detailed version of information
displayed in the \uicontrol{Issues} pane.
\image qtcreator-compile-pane.png
Double-click on a file name in an error message to open the file in the
code editor.
Select the \gui {Cancel Build} button to cancel the build.
Select the \uicontrol {Cancel Build} button to cancel the build.
\section2 QML/JS Console
In the \gui {QML/JS Console}, you can type JavaScript expressions and use them to get
In the \uicontrol {QML/JS Console}, you can type JavaScript expressions and use them to get
information about the state of your application during debugging. You can change property
values temporarily, without editing the source, and view the results in the running
application.
@@ -405,33 +405,35 @@
\section2 To-Do List
The \gui {To-Do List Entries} pane lists the BUG, FIXME, NOTE, TODO, and
The \uicontrol {To-Do List Entries} pane lists the BUG, FIXME, NOTE, TODO, and
WARNING keywords from the current file or from all project files. The
keywords are organized into information, warning, and error categories.
\image qtcreator-todo-pane.png
To add keywords, select \gui Tools > \gui Options > \gui {To-Do} > \gui Add.
To add keywords, select \uicontrol Tools > \uicontrol Options >
\uicontrol {To-Do} > \uicontrol Add.
Set an icon and a line background color for the keyword. To change the icons
and colors set for an existing keyword, select \gui Edit.
and colors set for an existing keyword, select \uicontrol Edit.
To determine whether the keywords in the whole project or in the current
file are displayed by default, select \gui {Scanning scope}.
file are displayed by default, select \uicontrol {Scanning scope}.
The Todo plugin is disabled by default. To enable the plugin, select
\gui Help > \gui {About Plugins} > \gui Utilities > \gui Todo and restart
\uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities >
\uicontrol Todo and restart
\QC.
In addition, you can open task list files generated by code scanning and
analysis tools in the \gui Issues pane. For more information, see
analysis tools in the \uicontrol Issues pane. For more information, see
\l{Showing Task List Files in Issues Pane}.
\section1 Changing Languages
\QC has been localized into several languages. If the system language is one
of the supported languages, it is automatically selected. To change the
language, select \gui {Tools > Options > Environment} and select a language
in the \gui Language field. The change takes effect after you restart \QC.
language, select \uicontrol {Tools > Options > Environment} and select a language
in the \uicontrol Language field. The change takes effect after you restart \QC.
\section1 Viewing Images
@@ -482,15 +484,15 @@
\li For
\li Look In
\row
\li \gui Tools > \gui Options
\li \gui {Qt Creator} > \gui Preferences
\li \uicontrol Tools > \uicontrol Options
\li \uicontrol {Qt Creator} > \uicontrol Preferences
\row
\li \gui Help > \gui {About Plugins}
\li \gui {Qt Creator} > \gui {About Plugins}
\li \uicontrol Help > \uicontrol {About Plugins}
\li \uicontrol {Qt Creator} > \uicontrol {About Plugins}
\row
\li Keyboard shortcuts
\li \gui {Qt Creator} > \gui Preferences > \gui Environment >
\gui Keyboard
\li \uicontrol {Qt Creator} > \uicontrol Preferences > \uicontrol Environment >
\uicontrol Keyboard
\endtable
*/

309
doc/src/howto/creator-vcs.qdoc
View File

@@ -73,8 +73,8 @@
\QC uses the version control system's command line clients to access your
repositories. To allow access, make sure that the command line clients can
be located using the \c{PATH} environment variable or specify the path to
the command line client executables in \gui{Tools} > \gui{Options} >
\gui {Version Control}.
the command line client executables in \uicontrol{Tools} > \uicontrol{Options} >
\uicontrol {Version Control}.
After you set up the version control system, use the command line to check
that everything works (for example, use the status command). If no issues
@@ -90,26 +90,27 @@
you run Git from a Windows command prompt, it looks for the SSH keys in its
installation directory, and therefore, the authorization fails.
You can set the \c HOME environment variable from \QC. Select \gui {Tools >
Options > Version Control > Git}. Select the \gui {Environment Variables}
and the \gui {Set "HOME" environment variable} check boxes. \c HOME is set
You can set the \c HOME environment variable from \QC. Select \uicontrol {Tools >
Options > Version Control > Git}. Select the \uicontrol {Environment Variables}
and the \uicontrol {Set "HOME" environment variable} check boxes. \c HOME is set
to \c %HOMEDRIVE%%HOMEPATH% when the Git executable is run and authorization
works as it would with \c {git bash}.
\section1 Setting Up General Options
Select \gui{Tools} > \gui{Options} > \gui{Version Control} > \gui{General}
Select \uicontrol{Tools} > \uicontrol{Options} > \uicontrol{Version Control}
> \uicontrol{General}
to specify settings for submit messages:
\list
\li \gui{Submit message check script} is a script or program that
\li \uicontrol{Submit message check script} is a script or program that
can be used to perform checks on the submit message before
submitting. The submit message is passed in as the script's first
parameter. If there is an error, the script should output a
message on standard error and return a non-zero exit code.
\li \gui{User/alias configuration file} is a text file that lists
\li \uicontrol{User/alias configuration file} is a text file that lists
author names in mailmap format. For each author, you must specify a
real name and email address and optionally an alias and a second
email address. For example:
@@ -120,9 +121,9 @@
\endcode
After you specify a file in this field, you can select authors
as values of the submit message fields in the \gui Nicknames dialog.
as values of the submit message fields in the \uicontrol Nicknames dialog.
\li \gui{User fields configuration file} is a simple text file
\li \uicontrol{User fields configuration file} is a simple text file
consisting of lines specifying submit message fields that take
authors as values, for example:
@@ -137,17 +138,17 @@
After you specify a file in this field, you can add authors as
values of the submit message fields when submitting changes. If
you also specified a \gui{User/alias configuration file}, you can
select authors in the \gui Nicknames dialog.
you also specified a \uicontrol{User/alias configuration file}, you can
select authors in the \uicontrol Nicknames dialog.
\li \gui{SSH prompt command} specifies an ssh-askpass command that you
\li \uicontrol{SSH prompt command} specifies an ssh-askpass command that you
can use (on Linux) to prompt the user for a password when using SSH.
For example, \c ssh-askpass or \c x11-ssh-askpass, depending on the
ssh-askpass implementation that you use.
\li \gui {Patch command} specifies the path to the patch utility that is
\li \uicontrol {Patch command} specifies the path to the patch utility that is
used to apply changes in the format used to represent the diff
output. The \gui Revert command uses the patch utility to revert
output. The \uicontrol Revert command uses the patch utility to revert
partial changes.
\endlist
@@ -156,24 +157,24 @@
\QC allows you to create repositories for version control systems that
support local repository creation, such as Git, Mercurial, or Bazaar.
When creating a new project by selecting \gui File > \gui{New File or
When creating a new project by selecting \uicontrol File > \uicontrol{New File or
Project}, you can choose a version control system on the final wizard page.
You can also select \gui Tools and then select \gui {Create Repository}
You can also select \uicontrol Tools and then select \uicontrol {Create Repository}
in the submenu for the version control system.
To import a project that is under version control, choose \gui {File >
To import a project that is under version control, choose \uicontrol {File >
New File or Project > Project from Version Control} and select the
version control system that you use. Follow the instructions of the
wizard to import the project.
\section1 Using Version Control Systems
The \gui{Tools} menu contains a submenu for each supported version
The \uicontrol{Tools} menu contains a submenu for each supported version
control system.
The \gui{Version Control} output pane displays the commands that are
executed, a timestamp, and the relevant output. Select \gui {Window > Output
The \uicontrol{Version Control} output pane displays the commands that are
executed, a timestamp, and the relevant output. Select \uicontrol {Window > Output
Panes > Version Control} to open the pane.
\image qtcreator-vcs-pane.png
@@ -203,14 +204,14 @@
With Git, the diff is displayed side-by-side in a \l{Comparing Files}
{diff editor} by default. To use the inline diff view instead, select the
\gui {Switch to Text Diff Editor} option from the toolbar. In the inline
\uicontrol {Switch to Text Diff Editor} option from the toolbar. In the inline
diff view, you can use context menu commands to apply, revert, stage, and
unstage hunks, as well as send them to a code pasting service.
\section2 Viewing Versioning History and Change Details
Display the versioning history of a file by selecting \gui{Log}
or \gui{Filelog}. Typically, the log output contains the date, the commit
Display the versioning history of a file by selecting \uicontrol{Log}
or \uicontrol{Filelog}. Typically, the log output contains the date, the commit
message, and a change or revision identifier. Click on the identifier to
display a description of the change including the diff.
Right-clicking on an identifier brings up a context menu that lets you
@@ -221,8 +222,8 @@
\section2 Annotating Files
Annotation views are obtained by selecting \gui{Annotate} or \gui{Blame}.
Selecting \gui{Annotate} or \gui{Blame} displays the lines of the file
Annotation views are obtained by selecting \uicontrol{Annotate} or \uicontrol{Blame}.
Selecting \uicontrol{Annotate} or \uicontrol{Blame} displays the lines of the file
prepended by the change identifier they originate from. Clicking on the
change identifier shows a detailed description of the change.
@@ -238,19 +239,19 @@
\section2 Committing Changes
Once you have finished making changes, submit them to the version control
system by choosing \gui{Commit} or \gui{Submit}. \QC displays a
system by choosing \uicontrol{Commit} or \uicontrol{Submit}. \QC displays a
commit page containing a text editor where you can enter your commit
message and a checkable list of modified files to be included.
\image qtcreator-vcs-commit.png
When you have finished filling out the commit page information, click on
\gui{Commit} to start committing.
\uicontrol{Commit} to start committing.
The \gui{Diff Selected Files} button brings up a diff view of the
The \uicontrol{Diff Selected Files} button brings up a diff view of the
files selected in the file list. Since the commit page is just another
editor, you can go back to it by closing the diff view. You can also switch
to an open diff view by selecting it in the \gui{Open Documents} pane in the
to an open diff view by selecting it in the \uicontrol{Open Documents} pane in the
sidebar.
\section2 Reverting Changes
@@ -260,7 +261,7 @@
The changes discarded depend on the version control system.
A version control system can replace the \gui Revert menu option with other
A version control system can replace the \uicontrol Revert menu option with other
options.
\section3 Reverting Changes Using Git
@@ -272,21 +273,21 @@
\list
\li \gui Git > \gui {Current File} > \gui{Undo Unstaged Changes} reverts
\li \uicontrol Git > \uicontrol {Current File} > \uicontrol{Undo Unstaged Changes} reverts
all changes and resets the current file to the state of the
index.
\li \gui Git > \gui {Current File} > \gui {Undo Uncommitted Changes}
\li \uicontrol Git > \uicontrol {Current File} > \uicontrol {Undo Uncommitted Changes}
reverts all changes, discarding the
index. This returns the current file to the state it was in right
after the last commit.
\li \gui Git > \gui {Local Repository} > \gui Reset opens a dialog
\li \uicontrol Git > \uicontrol {Local Repository} > \uicontrol Reset opens a dialog
where you can select the SHA-1 to reset the working directory to.
This is useful after applying patches for review, for example. You
can choose between a \gui Soft reset that does not touch the index
file nor the working tree at all, a \gui Hard reset that discards
all changes to tracked files in working tree, and a \gui Mixed
can choose between a \uicontrol Soft reset that does not touch the index
file nor the working tree at all, a \uicontrol Hard reset that discards
all changes to tracked files in working tree, and a \uicontrol Mixed
reset that resets HEAD and the index (nothing remains staged)
without touching the working directory.
@@ -294,12 +295,12 @@
\section2 Viewing Status
You can select \gui{Status} to view the status of the project or
You can select \uicontrol{Status} to view the status of the project or
repository.
\section2 Updating the Working Tree
You can select \gui Update to update your working tree with the latest
You can select \uicontrol Update to update your working tree with the latest
changes from the branch. Some version control systems allow you to choose
between updating the current project and updating all projects.
@@ -308,7 +309,7 @@
\section2 Deleting Files
You can select \gui Delete to delete obsolete files from the repository.
You can select \uicontrol Delete to delete obsolete files from the repository.
With Git, you delete the files from the working tree and then stage the
deleted files for a commit.
@@ -317,20 +318,20 @@
Bazaar is a free version control system sponsored by Canonical.
The \gui Bazaar submenu contains the following additional items:
The \uicontrol Bazaar submenu contains the following additional items:
\table
\header
\li Menu Item
\li Description
\row
\li \gui Pull
\li \uicontrol Pull
\li Turn the branch into a mirror of another branch.
\row
\li \gui Push
\li \uicontrol Push
\li Update a mirror of the branch.
\row
\li \gui Uncommit
\li \uicontrol Uncommit
\li Remove the last committed revision.
\endtable
@@ -338,19 +339,19 @@
In Bazaar, committing changes to a branch creates a new revision that holds
a snapshot of the state of the working tree. To remove the last committed
revision, select \gui Tools > \gui Bazaar > \gui Uncommit.
revision, select \uicontrol Tools > \uicontrol Bazaar > \uicontrol Uncommit.
In the \gui Uncommit dialog, select options to keep tags that point to
In the \uicontrol Uncommit dialog, select options to keep tags that point to
removed revisions and to only remove the commits from the local branch when
in a checkout.
To remove all commits up to an entry in the revision log, specify the
revision in the \gui Revision field.
revision in the \uicontrol Revision field.
To test the outcome of the \gui Uncommit command without actually removing
anything, select \gui {Dry Run}.
To test the outcome of the \uicontrol Uncommit command without actually removing
anything, select \uicontrol {Dry Run}.
\gui Uncommit leaves the working tree ready for a new commit. The only
\uicontrol Uncommit leaves the working tree ready for a new commit. The only
change it might make is restoring pending merges that were present before
the commit.
@@ -361,30 +362,30 @@
ClearCase client plugin is available on Linux and Windows for accessing a
ClearCase server.
The \gui ClearCase submenu contains the following additional items:
The \uicontrol ClearCase submenu contains the following additional items:
\table
\header
\li Menu Item
\li Description
\row
\li \gui{Check In}
\li \uicontrol{Check In}
\li Create a permanent new version of the current file or all files
in the versioned object base (VOB).
\row
\li \gui{Check In Activity}
\li \uicontrol{Check In Activity}
\li Check in checked-out versions in the change set of the current
Unified Change Management (UCM) activity.
\row
\li \gui{Check Out}
\li \uicontrol{Check Out}
\li Create a writable copy of a branch. If you check out files in a
UCM view, they are added to the change set of the UCM activity.
\row
\li \gui{Undo Check Out}
\li \uicontrol{Undo Check Out}
\li Cancel the checkout for a file and delete the checked-out
version.
\row
\li \gui{Undo Hijack}
\li \uicontrol{Undo Hijack}
\li Resolve hijacked files. If you change the read-only attribute of
a file that is loaded into a snapshot view and modify the file
without checking it out, you \e hijack the file.
@@ -395,8 +396,8 @@
CVS is an open source version control system.
In addition to the standard version control system functions, you can
select \gui Tools > \gui CVS > \gui Edit to open a file for editing.
To discard the changes that you made in a file, select \gui Unedit.
select \uicontrol Tools > \uicontrol CVS > \uicontrol Edit to open a file for editing.
To discard the changes that you made in a file, select \uicontrol Unedit.
\section2 Using Additional Git Functions
@@ -409,36 +410,39 @@
\section3 Working with the Current File
In addition to the standard version control system functions, you can
select \gui Tools > \gui Git > \gui {Current File} > \gui {Stage File for
select \uicontrol Tools > \uicontrol Git > \uicontrol {Current File} >
\uicontrol {Stage File for
Commit} to mark a new or modified file for committing to the repository.
To undo this function, select \gui {Unstage File from Commit}.
To undo this function, select \uicontrol {Unstage File from Commit}.
\section3 Working with the Current Project
In addition to the standard version control system functions, you can
select \gui Tools > \gui Git > \gui {Current Project} > \gui {Clean Project}
select \uicontrol Tools > \uicontrol Git > \uicontrol {Current Project} >
\uicontrol {Clean Project}
to clean the working directory. All files that are not under version control
are displayed in the \gui {Clean Repository} dialog. Ignored files are
deselected by default. Select the files to delete and click \gui Delete.
are displayed in the \uicontrol {Clean Repository} dialog. Ignored files are
deselected by default. Select the files to delete and click \uicontrol Delete.
\section3 Working with Local Repositories
In addition to the standard version control system functions, you can
select \gui Tools > \gui Git > \gui {Local Repository} > \gui Clean to clean
select \uicontrol Tools > \uicontrol Git > \uicontrol {Local Repository} >
\uicontrol Clean to clean
the repository.
To apply latest changes to the last commit, select \gui Tools > \gui Git >
\gui {Local Repository} > \gui {Amend Last Commit}. You can also edit the
To apply latest changes to the last commit, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Local Repository} > \uicontrol {Amend Last Commit}. You can also edit the
commit message.
To amend an earlier comment in a series of related commits, select
\gui Tools > \gui Git > \gui {Local Repository} >
\gui {Fixup Previous Commit}. This operation is done using interactive
\uicontrol Tools > \uicontrol Git > \uicontrol {Local Repository} >
\uicontrol {Fixup Previous Commit}. This operation is done using interactive
rebase. In case of conflicts, a merge tool is suggested.
To change a series of commits in the local repository, select \gui Tools >
\gui Git > \gui {Local Repository} > \gui {Interactive Rebase}. You can
To change a series of commits in the local repository, select \uicontrol Tools >
\uicontrol Git > \uicontrol {Local Repository} > \uicontrol {Interactive Rebase}. You can
reorder or discard commits, squash them into a single commit, or edit the
commit messages.
@@ -447,7 +451,7 @@
\section4 Working with Branches
To work with Git branches, select \gui{Branches}. The checked out branch
To work with Git branches, select \uicontrol{Branches}. The checked out branch
is shown in bold and underlined in the list of branches. Double-click branch
names to edit them.
@@ -460,56 +464,56 @@
\li Menu Item
\li Description
\row
\li \gui{Refresh}
\li \uicontrol{Refresh}
\li Refresh the list of branches.
\row
\li \gui{Add}
\li \uicontrol{Add}
\li Create new tracking and non-tracking branches.
\row
\li \gui{Remove}
\li \uicontrol{Remove}
\li Remove a local branch. You cannot delete remote branches.
\row
\li \gui Rename
\li \uicontrol Rename
\li Rename a local branch.
\row
\li \gui{Checkout}
\li \uicontrol{Checkout}
\li Check out the selected branch and make it current. You can stash
changes you have made to tracked files.
\row
\li \gui{Diff}
\li \uicontrol{Diff}
\li Show the differences between the selected and the current
branch.
\row
\li \gui{Log}
\li \uicontrol{Log}
\li Show the changes in a branch.
\row
\li \gui Merge
\li \uicontrol Merge
\li Join the development histories in two branches together.
If the commit you are merging can be reached by following the
first commit's history, there is no divergent work to merge
together. To allow Git to move the branch pointer forward,
select \gui {Fast-Forward}. If you do not want to fast-forward
the branch, select \gui {No Fast-Forward}.
select \uicontrol {Fast-Forward}. If you do not want to fast-forward
the branch, select \uicontrol {No Fast-Forward}.
\row
\li \gui Rebase
\li \uicontrol Rebase
\li Copy local commits to the updated upstream head.
\row
\li \gui {Cherry Pick}
\li \uicontrol {Cherry Pick}
\li Cherry pick the top commit from the selected branch.
\row
\li \gui Track
\li \uicontrol Track
\li Set the current branch to track the selected one.
\endtable
\section4 Applying Patches
Patches are rewriting instructions that can be applied to a set of files.
To apply a patch file that is open in \QC, select \gui Tools > \gui Git >
\gui {Local Repository} > \gui {Apply from Editor}.
To apply a patch file that is open in \QC, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Local Repository} > \uicontrol {Apply from Editor}.
To select the patch file to apply from the file system, select
\gui {Apply from File}.
\uicontrol {Apply from File}.
\section4 Using Stashes
@@ -518,25 +522,25 @@
changes to work on higher priority tasks or to pull in new chages from
another repository.
To stash all local changes, select \gui Tools > \gui Git >
\gui {Local Repository} > \gui Stash > \gui Stash. The working copy is reset
To stash all local changes, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Local Repository} > \uicontrol Stash > \uicontrol Stash. The working copy is reset
to the state it had after the last commit.
To display a dialog that shows all known stashes with options to restore,
display or delete them, select \gui Stashes.
display or delete them, select \uicontrol Stashes.
To save a snapshot of your current work under a name for later reference,
select \gui {Take Snapshot}. The working copy is unchanged. For example, if
select \uicontrol {Take Snapshot}. The working copy is unchanged. For example, if
you want to try something and find out later that it does not work, you can
discard the changes and return to the state of the snapshot.
To remove a single stashed state from the stash list and apply it on top of
the current working tree state, select \gui {Stash Pop}.
the current working tree state, select \uicontrol {Stash Pop}.
\section3 Applying Actions to Commits
To browse a directory or the commit history and to apply actions on the
commits, select \gui Tools > \gui Git > \gui {Actions on Commits}. You can
commits, select \uicontrol Tools > \uicontrol Git > \uicontrol {Actions on Commits}. You can
checkout, revert, or cherry-pick commits or view them in the diff editor.
\image creator-git-commit-actions.png "Select a Git Commit dialog"
@@ -544,17 +548,17 @@
\section3 Working with Remote Repositories
In addition to the standard version control system functions, you can
select \gui Tools > \gui Git > \gui {Remote Repository} > \gui Pull to
select \uicontrol Tools > \uicontrol Git > \uicontrol {Remote Repository} > \uicontrol Pull to
pull changes from the remote repository. If there are locally modified
files, you are prompted to stash the changes. Select \gui Tools >
\gui Options > \gui {Version Control} > \gui Git and then select the
\gui {Pull with rebase} check box to perform a rebase operation while
files, you are prompted to stash the changes. Select \uicontrol Tools >
\uicontrol Options > \uicontrol {Version Control} > \uicontrol Git and then select the
\uicontrol {Pull with rebase} check box to perform a rebase operation while
pulling.
\section4 Managing Remote Repositories
To manage remote repositories available in Git, select \gui Tools > \gui Git
> \gui {Remote Repository} > \gui{Manage Remotes}. Double-click the names
To manage remote repositories available in Git, select \uicontrol Tools > \uicontrol Git
> \uicontrol {Remote Repository} > \uicontrol{Manage Remotes}. Double-click the names
and URLs of the remote repositories to edit them.
The following operations are supported:
@@ -564,20 +568,20 @@
\li Menu Item
\li Description
\row
\li \gui{Refresh}
\li \uicontrol{Refresh}
\li Refresh the list of remote repositories.
\row
\li \gui{Add}
\li \uicontrol{Add}
\li Add a new remote repository.
\row
\li \gui{Fetch}
\li \uicontrol{Fetch}
\li Fetch all the branches and change information from a remote
repository.
\row
\li \gui Push
\li \uicontrol Push
\li Push committed changes to the remote repository.
\row
\li \gui{Remove}
\li \uicontrol{Remove}
\li Remove a remote repository.
\endtable
@@ -585,93 +589,94 @@
\section4 Using Git with Subversion
You can use Git as a client for a Subversion server. To fetch changes from a
Subversion repository to a Git repository, select \gui Tools > \gui Git >
\gui {Remote Repository} > \gui Subversion > \gui Fetch.
Subversion repository to a Git repository, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Remote Repository} > \uicontrol Subversion > \uicontrol Fetch.
To view the Git Subversion log, select \gui Log.
To view the Git Subversion log, select \uicontrol Log.
\section4 Reviewing Code with Gerrit
If your Git project uses Gerrit for code reviews, you can view your changes
in \QC.
Select \gui Tools > \gui Options > \gui {Version Control} > \gui Gerrit to
Select \uicontrol Tools > \uicontrol Options > \uicontrol {Version Control}
> \uicontrol Gerrit to
specify the connection to the Gerrit server.
\image qtcreator-gerrit-options.png
To push committed changes to Gerrit, select \gui Tools > \gui Git >
\gui {Remote Repository} > \gui {Push to Gerrit}.
To push committed changes to Gerrit, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Remote Repository} > \uicontrol {Push to Gerrit}.
To view the same information about each change as in the Gerrit
web interface, select \gui Tools > \gui Git > \gui {Remote Repository} >
\gui Gerrit.
web interface, select \uicontrol Tools > \uicontrol Git > \uicontrol {Remote Repository} >
\uicontrol Gerrit.
\image qtcreator-gerrit.png
To view details of the selected change, select \gui Show.
To view details of the selected change, select \uicontrol Show.
To cherry-pick the selected change to the local repository, select
\gui {Cherry Pick}. To remove the change after testing it, select \gui Tools >
\gui Git > \gui {Local Repository} > \gui Reset. In the
\gui {Undo Changes to} dialog, select the
state to reset the working directory to, and then select \gui OK.
\uicontrol {Cherry Pick}. To remove the change after testing it, select \uicontrol Tools >
\uicontrol Git > \uicontrol {Local Repository} > \uicontrol Reset. In the
\uicontrol {Undo Changes to} dialog, select the
state to reset the working directory to, and then select \uicontrol OK.
To check out the change in a headless state, select \gui Checkout.
To check out the change in a headless state, select \uicontrol Checkout.
To refresh the list of changes, select \gui Refresh.
To refresh the list of changes, select \uicontrol Refresh.
\section3 Working with Git Tools
To start a graphical interface to Git, select \gui Tools > \gui Git >
\gui {Git Tools} > \gui {Git Gui}.
To start a graphical interface to Git, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Git Tools} > \uicontrol {Git Gui}.
\note On OS X, the default Git installation does not contain Git Gui. To
use Git Gui, install it separately. To start Git Gui from \QC, select
\gui Preferences > \gui {Version Control} > \gui Git, and set the path to
the environment that contains Git Gui in the \gui {Prepend to PATH} field.
\uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Git, and set the path to
the environment that contains Git Gui in the \uicontrol {Prepend to PATH} field.
To start the commit viewer for Git, select \gui Tools > \gui Git >
\gui {Git Tools} > \gui Gitk. You can also start the tool to view commits in
To start the commit viewer for Git, select \uicontrol Tools > \uicontrol Git >
\uicontrol {Git Tools} > \uicontrol Gitk. You can also start the tool to view commits in
the current document or in the folder that contains the current document.
To specify arguments for running Gitk, select \gui Tools > \gui Options >
\gui {Version Control} > \gui Git.
To specify arguments for running Gitk, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Version Control} > \uicontrol Git.
To use some other application for viewing Git history, such as GitX or
QGit viewer, select \gui Tools > \gui Options > \gui {Version Control} >
\gui Git and specify the path to the application executable in the
\gui {Command} field. To start the application, select \gui Tools > \gui Git
> \gui {Git Tools} > \gui {Repository Browser}.
QGit viewer, select \uicontrol Tools > \uicontrol Options > \uicontrol {Version Control} >
\uicontrol Git and specify the path to the application executable in the
\uicontrol {Command} field. To start the application, select \uicontrol Tools > \uicontrol Git
> \uicontrol {Git Tools} > \uicontrol {Repository Browser}.
To resolve merge conflicts, select \gui Tools > \gui Git > \gui {Git Tools}
> \gui {Merge Tool}.
To resolve merge conflicts, select \uicontrol Tools > \uicontrol Git > \uicontrol {Git Tools}
> \uicontrol {Merge Tool}.
\section2 Using Additional Mercurial Functionality
Mercurial is a free, distributed source control management tool.
The \gui Mercurial submenu contains the following additional items:
The \uicontrol Mercurial submenu contains the following additional items:
\table
\header
\li Menu Item
\li Description
\row
\li \gui{Import}
\li \uicontrol{Import}
\li Apply changes from a patch file.
\row
\li \gui{Incoming}
\li \uicontrol{Incoming}
\li Monitor the status of a remote repository by listing
the changes that will be pulled.
\row
\li \gui{Outgoing}
\li \uicontrol{Outgoing}
\li Monitor the status of a remote repository by listing
the changes that will be pushed.
\row
\li \gui{Pull}
\li \uicontrol{Pull}
\li Pull changes from the remote repository.
\row
\li \gui{Push}
\li \uicontrol{Push}
\li Push changes to the remote repository.
\endtable
@@ -681,36 +686,36 @@
Perforce Software.
When you start \QC, it looks for the executable specified
in the \gui{P4 command} field in \gui{Tools > Options > Version
in the \uicontrol{P4 command} field in \uicontrol{Tools > Options > Version
Control > Perforce}. If the file is not found, the following error
message is displayed in the \gui {Version Control} output pane:
\gui {Perforce: Unable to determine the repository: "p4.exe"
message is displayed in the \uicontrol {Version Control} output pane:
\uicontrol {Perforce: Unable to determine the repository: "p4.exe"
terminated with exit code 1}. If you use Perforce, check that the
path to the executable is specified correctly in the \gui{P4 command}
path to the executable is specified correctly in the \uicontrol{P4 command}
field.
If you do not use Perforce, you can disable the Perforce plugin to
get rid of the error message. Choose \gui {Help > About Plugins} and
deselect the \gui Load check box for the \gui Perforce plugin in the
\gui {Version Control} group.
get rid of the error message. Choose \uicontrol {Help > About Plugins} and
deselect the \uicontrol Load check box for the \uicontrol Perforce plugin in the
\uicontrol {Version Control} group.
The \gui Perforce submenu contains the following additional items:
The \uicontrol Perforce submenu contains the following additional items:
\table
\header
\li Menu Item
\li Description
\row
\li \gui{Describe}
\li \uicontrol{Describe}
\li View information about changelists and the files in them.
\row
\li \gui{Edit File}
\li \uicontrol{Edit File}
\li Open a file for editing.
\row
\li \gui{Opened}
\li \uicontrol{Opened}
\li List files that are open for editing.
\row
\li \gui{Pending Changes}
\li \uicontrol{Pending Changes}
\li Group files for commit.
\endtable
@@ -719,7 +724,7 @@
Subversion is an open source version control system.
In addition to the standard version control system functions, you can
select \gui Tools > \gui Subversion > \gui Describe to display commit log
select \uicontrol Tools > \uicontrol Subversion > \uicontrol Describe to display commit log
messages for a revision.
*/

32
doc/src/howto/qtcreator-faq.qdoc
View File

@@ -95,7 +95,7 @@
\li Launch \QC from command line, with
\c {-noload Welcome -noload QmlProfiler -noload QuickDesigner} arguments.
\li Disable the plugins permanently by selecting \gui Help > \gui{About Plugins}.
\li Disable the plugins permanently by selecting \uicontrol Help > \uicontrol{About Plugins}.
\endlist
@@ -143,7 +143,7 @@
compiler. What should I do?}
Make sure that the application is in your system PATH when starting \QC.
Also select \gui {Tools > Options} to check the settings specified
Also select \uicontrol {Tools > Options} to check the settings specified
for the application. Many plugins specify either the path to the tool they
need or the environment they run in.
@@ -154,8 +154,8 @@
\QC has been localized into several languages. If the system
language is one of the supported languages, it is automatically selected.
To change the language, select \gui {Tools > Options > Environment} and
select a language in the \gui Language field. The change takes effect after
To change the language, select \uicontrol {Tools > Options > Environment} and
select a language in the \uicontrol Language field. The change takes effect after
you restart \QC.
\b {Has a reported issue been addressed?}
@@ -174,10 +174,10 @@
the Qt Help plugin. The integrated Qt Reference Documentation is available
for Qt 4.4 and later. \QC and other Qt deliverables contain
documentation as .qch files. All the documentation is accessible in the
\gui Help mode.
\uicontrol Help mode.
To view the documentation that is available and to add documentation,
select \gui {Tools > Options > Help > Documentation}. For more
select \uicontrol {Tools > Options > Help > Documentation}. For more
information, see \l{Adding External Documentation}.
\section1 Debugger Questions
@@ -200,28 +200,28 @@
\b {How do I generate a core file in \QC?}
To trigger the GDB command that generates a core file while debugging,
select \gui {Window > Views > Debugger Log}. In the \gui Command field,
select \uicontrol {Window > Views > Debugger Log}. In the \uicontrol Command field,
type \c gcore and press \key Enter. The core file is created in the
current working directory. You can specify another location for the file,
including a relative or absolute path, as an argument of the command.
To generate a temporary core file, select \gui {Create Snapshot} in the
context menu in the \gui Snapshot view. The core file is deleted when you
To generate a temporary core file, select \uicontrol {Create Snapshot} in the
context menu in the \uicontrol Snapshot view. The core file is deleted when you
stop debugging.
\section1 Compiler Questions
\b {How can I make use of my multi-core CPU with \QC?}
On Linux and OS X, go to \gui Project mode, select your configuration
in the \gui {Build Settings}, locate the \gui {Build Steps}, and add the
On Linux and OS X, go to \uicontrol Project mode, select your configuration
in the \uicontrol {Build Settings}, locate the \uicontrol {Build Steps}, and add the
following value, where \c{<num>} is the amount of cores in your CPU:
\c{-j <num>}
On Windows, nmake does not support the \c{-j} parameter. Instead, we
provide a drop-in replacement called jom. You can download a precompiled
version of jom from \l{http://releases.qt-project.org/jom/}{Qt Project Release server}.
Put jom.exe in a location in the %PATH%. Go to the \gui {Build Settings}
Put jom.exe in a location in the %PATH%. Go to the \uicontrol {Build Settings}
and set jom.exe as the make command.
\note Unlike GNU make, jom automatically detects your cores and spawns as
@@ -256,9 +256,9 @@
\b {On Unix (Linux and OS X):} \c qDebug() and related functions use
the standard output and error output. When you run or debug the
application, you can view the output in the \gui{Application Output} pane.
application, you can view the output in the \uicontrol{Application Output} pane.
For console applications that require input, select \gui {Projects > Run
For console applications that require input, select \uicontrol {Projects > Run
Settings > Run in terminal}.
\b {On Windows:} Output is displayed differently for \e{console
@@ -273,12 +273,12 @@
type of application, \c qDebug() and related functions use standard output
and error output.
We recommend that you select \gui {Projects > Run Settings > Run in
We recommend that you select \uicontrol {Projects > Run Settings > Run in
terminal} for console applications.
For GUI applications, \c qDebug() and related functions use the Windows API
function \c OutputDebugString(). The output is displayed in the
\gui{Application Output} pane. However, only one output pane tab may be
\uicontrol{Application Output} pane. However, only one output pane tab may be
open at a time or the output is not displayed correctly. You can use an
external debug output viewer, such as the
\l{http://technet.microsoft.com/en-us/sysinternals/bb896647}{DebugView for Windows}