Commit e1fbeedc authored by Leena Miettinen's avatar Leena Miettinen Committed by Leena Miettinen

Doc: use \uicontrol command instead of \gui macro

Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: default avatarTopi Reiniö <topi.reinio@digia.com>
parent c9696aa6
......@@ -30,20 +30,20 @@
\title Analyzing Code
You can use the code analysis tools in the \gui Analyze mode. To switch to
\gui Analyze mode, select \gui Analyze in the mode selector, or select the
\gui {Analyze} menu and then select a tool. When you are in the
\gui Analyze mode, you can switch between tools by selecting them in the
You can use the code analysis tools in the \uicontrol Analyze mode. To switch to
\uicontrol Analyze mode, select \uicontrol Analyze in the mode selector, or
select the \uicontrol {Analyze} menu and then select a tool. When you are in the
\uicontrol Analyze mode, you can switch between tools by selecting them in the
menu on the toolbar.
\image qtcreator-analyze-menu.png "Analyze mode menu"
You can drag and drop the views in the \gui Analyze mode to new positions
You can drag and drop the views in the \uicontrol Analyze mode to new positions
on the screen. The size and position of views are saved for future
sessions. Select \gui {Window > Views > Reset to Default Layout} to reset
sessions. Select \uicontrol {Window > Views > Reset to Default Layout} to reset
the views to their original sizes and positions.
You can use the following code analysis tools in the \gui Analyze mode:
You can use the following code analysis tools in the \uicontrol Analyze mode:
\list
......
......@@ -48,14 +48,15 @@
\list 1
\li Select \gui Help > \gui {About Plugins} > \gui {Code Analyzer} >
\gui {Clang Static Analyzer} to enable the experimental plugin.
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Code Analyzer} > \uicontrol {Clang Static Analyzer} to
enable the experimental plugin.
\li Restart \QC to be able to use the plugin.
\li Select \gui Tools > \gui Options > \gui Analyzer >
\gui {Clang Static Analyzer} to check that the path to the Clang
executable is set correctly in the \gui {Clang executable} field.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Analyzer >
\uicontrol {Clang Static Analyzer} to check that the path to the Clang
executable is set correctly in the \uicontrol {Clang executable} field.
\image qtcreator-clang-static-analyzer-options.png
......@@ -65,11 +66,11 @@
\list 1
\li Select \gui Analyze > \gui {Clang Static Analyzer}.
\li Select \uicontrol Analyze > \uicontrol {Clang Static Analyzer}.
\li Select the
\inlineimage qtcreator-analyze-start-button.png
(\gui Start) button to run the Clang Static Analyzer on the
(\uicontrol Start) button to run the Clang Static Analyzer on the
application.
\endlist
......
......@@ -52,12 +52,12 @@
For more information about analyzing applications for which you do not have
a project, see \l{Running Valgrind Tools on External Applications}.
To stop the currently running analyzer, select \gui {Analyze
To stop the currently running analyzer, select \uicontrol {Analyze
> Stop}.
To select options for the Valgrind tools, select \gui {Tools > Options >
To select options for the Valgrind tools, select \uicontrol {Tools > Options >
Analyzer}. You can override the general settings for each project in the
\gui {Run Settings} for the project.
\uicontrol {Run Settings} for the project.
The following sections describe how to use the Valgrind tools:
......
......@@ -44,9 +44,9 @@
\list 1
\li In the \gui Projects mode, select a debug build configuration.
\li In the \uicontrol Projects mode, select a debug build configuration.
\li Select \gui Analyze > \gui {Valgrind Memory Analyzer}.
\li Select \uicontrol Analyze > \uicontrol {Valgrind Memory Analyzer}.
\li Select the
\inlineimage qtcreator-analyze-start-button.png "Start button"
......@@ -57,14 +57,14 @@
\li Select the
\inlineimage qtcreator-debug-button-stop.png "Stop button"
button to view the results of the analysis in the
\gui {Analysis} view.
\uicontrol {Analysis} view.
\endlist
While the application is running, Memcheck checks all reads and writes of
memory and intercepts calls that allocate or free memory or create or
delete memory blocks. When you stop Memcheck, it displays the results in
the \gui Analysis view. Click a line to view where a memory leak
the \uicontrol Analysis view. Click a line to view where a memory leak
occurred and a stack trace that shows what caused it.
\image analyzer-issues.png "Analysis view"
......@@ -83,22 +83,22 @@
Stack traces can get quite large and confusing, and therefore, reading them
from the bottom up can help. If the stack trace is not big enough or it is
too big, select \gui {Tools > Options > Analyzer}.
Define the length of the stack trace in the \gui {Backtrace frame count}
too big, select \uicontrol {Tools > Options > Analyzer}.
Define the length of the stack trace in the \uicontrol {Backtrace frame count}
field.
\image qtcreator-valgrind-memcheck-options.png "Memory Analysis options"
Memcheck also reports uses of uninitialised values, most commonly with the
message \gui {Conditional jump or move depends on uninitialised value(s).}
To determine the root cause of these errors, the \gui {Track origins of
message \uicontrol {Conditional jump or move depends on uninitialised value(s).}
To determine the root cause of these errors, the \uicontrol {Track origins of
uninitialized memory} check box is selected by default. You can deselect it
to make Memcheck run faster.
Memcheck searches for memory leaks when the client application finishes. To
view the amount of leaks that occurred, select \gui {Summary Only} in the
\gui {Check for leaks on finish} field. To also view details of each leak,
select \gui Full.
view the amount of leaks that occurred, select \uicontrol {Summary Only} in the
\uicontrol {Check for leaks on finish} field. To also view details of each leak,
select \uicontrol Full.
\section2 Showing Reachable and Indirectly Lost Blocks
......@@ -109,7 +109,7 @@
root node are indirectly lost.
By default, Memcheck does not report reachable and indirectly lost blocks.
To have them reported, select the \gui {Show reachable and indirectly lost
To have them reported, select the \uicontrol {Show reachable and indirectly lost
blocks}.
\section2 Suppressing Errors
......@@ -122,7 +122,7 @@
You can write your own suppression files if parts of your project contain
errors you cannot fix and you do not want to be reminded of them. Click
\gui Add in the \gui {Memory Analysis} dialog to add the suppression files.
\uicontrol Add in the \uicontrol {Memory Analysis} dialog to add the suppression files.
For more information about writing suppression files, see
\l{http://valgrind.org/docs/manual/manual-core.html#manual-core.suppress}
{Suppressing Errors} in the Valgrind documentation.
......@@ -152,9 +152,9 @@
\list 1
\li In the \gui Projects mode, select a release build configuration.
\li In the \uicontrol Projects mode, select a release build configuration.
\li Select \gui Analyze > \gui {Valgrind Function Profiler}.
\li Select \uicontrol Analyze > \uicontrol {Valgrind Function Profiler}.
\li Select the
\inlineimage qtcreator-analyze-start-button.png "Start button"
......@@ -164,7 +164,7 @@
\li Select the
\inlineimage qtcreator-debug-button-stop.png "Stop button"
button to view the results of the analysis in the \gui Profile
button to view the results of the analysis in the \uicontrol Profile
view.
\endlist
......@@ -177,7 +177,7 @@
the runtime behavior of an application.
Double-click a function to view information about the calling functions in
the \gui Callers view and about the called functions in the \gui Callees
the \uicontrol Callers view and about the called functions in the \uicontrol Callees
view.
Since the run-time characteristics of debug and release
......@@ -204,12 +204,12 @@
separately for each project in the \l{Specifying Run Settings}{run settings}
of the project.
To specify settings for Valgrind, select \gui {Tools > Options >
Analyzer}. The \gui {Profiling Options} group contains Callgrind options.
To specify settings for Valgrind, select \uicontrol {Tools > Options >
Analyzer}. The \uicontrol {Profiling Options} group contains Callgrind options.
\image qtcreator-valgrind-callgrind-options.png "Valgrind options"
In the \gui {Result view: Minimum event cost}
In the \uicontrol {Result view: Minimum event cost}
field, limit the amount of results the profiler gives you to increase
profiler performance.
......@@ -219,7 +219,7 @@
\section2 Enabling Full Cache Simulation
By default, only instruction read accesses (Ir) are counted. To fully
simulate the cache, select the \gui {Enable cache simulation} check box.
simulate the cache, select the \uicontrol {Enable cache simulation} check box.
This enables the following additional event counters:
\list
......@@ -235,7 +235,7 @@
\section2 Enabling Branch Prediction Simulation
To enable the following additional event counters, select the
\gui {Enable branch prediction simulation} check box:
\uicontrol {Enable branch prediction simulation} check box:
\list
......@@ -266,9 +266,9 @@
\list 1
\li Select \gui Analyze > \gui {Valgrind Memory Analyzer (External
\li Select \uicontrol Analyze > \uicontrol {Valgrind Memory Analyzer (External
Remote Application)} or
\gui {Valgrind Function Profiler (External Remote Application)}.
\uicontrol {Valgrind Function Profiler (External Remote Application)}.
\image qtcreator-valgrind-remote-settings.png "Start Analyzer dialog"
......
This diff is collapsed.
......@@ -128,17 +128,17 @@
\list 1
\li Select \gui Tools > \gui Options > \gui Android to add paths to the
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Android to add paths to the
Android NDK and SDK.
You can use the
\inlineimage qtcreator-options-android-download-button.png
(\gui Download) buttons to go to the sites where you can download
(\uicontrol Download) buttons to go to the sites where you can download
the Android NDK and SDK.
\image qtcreator-options-android1.png "Android options"
\li Select the \gui {Automatically create kits for Android tool chains}
\li Select the \uicontrol {Automatically create kits for Android tool chains}
check box to allow \QC to create the kits for you. \QC displays a
warning if it cannot find a suitable Qt version.
......@@ -146,54 +146,54 @@
\list
\li To use Gradle, select the \gui {Use Gradle instead of Ant}
\li To use Gradle, select the \uicontrol {Use Gradle instead of Ant}
check box.
\li To use Ant, add the path to the Ant executable in the
\gui {Ant executable} field.
\uicontrol {Ant executable} field.
\endlist
\li Select \gui File > \gui {New File or Project} > \gui Application >
\gui {Qt Quick Application} > \gui Choose, and
\li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application >
\uicontrol {Qt Quick Application} > \uicontrol Choose, and
follow the instructions of the wizard. For more information, see
\l{Creating Qt Quick Projects}.
\li To specify settings for deploying applications to Android, select
\gui Projects > \gui Run for the \gui Android kit, and then select
\gui Details to view the \gui {Deploy configurations}. For more
\uicontrol Projects > \uicontrol Run for the \uicontrol Android kit, and then select
\uicontrol Details to view the \uicontrol {Deploy configurations}. For more
information about the options you have, see
\l{Deploying Applications to Android Devices}.
\li Enable debugging on your Android device.
Debugging is enabled in different ways on different Android devices.
Look for \gui {USB Debugging} under \gui {Developer Options}. On
some devices \gui {Developer Options} is hidden and becomes visible
when you tap the \gui {Build number} field in \gui Settings >
\gui About several times.
Look for \uicontrol {USB Debugging} under \uicontrol {Developer Options}. On
some devices \uicontrol {Developer Options} is hidden and becomes visible
when you tap the \uicontrol {Build number} field in \uicontrol Settings >
\uicontrol About several times.
\li Connect the Android device to the development PC with a USB cable.
You might be asked to select a device in the
\gui {Select Android Devices} dialog.
\uicontrol {Select Android Devices} dialog.
\endlist
\section1 Selecting Android Devices
When you deploy an application to an Android device with Android
version 4.2 or later, the \gui {Select Android Devices} dialog opens. It
version 4.2 or later, the \uicontrol {Select Android Devices} dialog opens. It
lists the devices that are connected to the development PC. and their
status. You can select devices from the \gui {Compatible Devices} list for
status. You can select devices from the \uicontrol {Compatible Devices} list for
deployment.
If \QC determines that a device is not ready for deployment, it places the
device in the \gui {Incompatible Devices} list, with information about the
device in the \uicontrol {Incompatible Devices} list, with information about the
issue. For example, you might need to authorize the connection on the
device. After you authorize the connection on the device, select
\gui {Refresh Device List}. The device is moved to the
\gui {Compatible Devices} list and you can select it for deployment.
\uicontrol {Refresh Device List}. The device is moved to the
\uicontrol {Compatible Devices} list and you can select it for deployment.
Other reasons for placing a device on the \gui {Incompatible Devices} are
Other reasons for placing a device on the \uicontrol {Incompatible Devices} are
that the Android version on the device is too old or that the tool chain
used for building does not match the Android architecture on the device
(for example, you cannot deploy an ARM build on an x86 device).
......@@ -201,21 +201,21 @@
\image qtcreator-android-select-devices.png "Select Android Devices dialog"
Android Virtual Devices (AVD) are also listed. To create new AVDs, select
\gui {Create Android Virtual Device}.
\uicontrol {Create Android Virtual Device}.
To set a device as the default device for a particular Android architecture,
select the \gui {Always use this device for architecture} check box. The
\gui {Select Android Devices} dialog will not appear until you switch to
select the \uicontrol {Always use this device for architecture} check box. The
\uicontrol {Select Android Devices} dialog will not appear until you switch to
another project or restart \QC.
\section1 Using the Android Emulator
To run your application on the Android Emulator, you must create Android
virtual devices (AVD). Select \gui Tools > \gui Options > \gui Android >
\gui Add. If you run an application without a device connected to the
virtual devices (AVD). Select \uicontrol Tools > \uicontrol Options > \uicontrol Android >
\uicontrol Add. If you run an application without a device connected to the
development PC and without an AVD specified, \QC asks you to add an AVD.
To manage AVDs, select \gui {Start AVD Manager}.
To manage AVDs, select \uicontrol {Start AVD Manager}.
\note The Android Emulator has a bug that prevents it from starting on some
systems. If the Android Emulator does not start, you can try starting it
......@@ -228,7 +228,7 @@
information, see the Android documentation.
In addition, debugging is supported at android-10 API level, or higher. In
the run settings for the project, in the \gui {Android build SDK} field,
the run settings for the project, in the \uicontrol {Android build SDK} field,
select android-10, or higher. For more information about Android API levels,
see \l{http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels}
{What is API Level?}.
......
This diff is collapsed.
......@@ -40,18 +40,18 @@
\list 1
\li Select \gui Help > \gui {About Plugins} > \gui {Device Support} >
\gui {Bare Metal} to enable the Bare Metal Device plugin.
\li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {Device Support} >
\uicontrol {Bare Metal} to enable the Bare Metal Device plugin.
\li Restart \QC to be able to use the plugin.
\li Select \gui Tools > \gui Options > \gui Devices > \gui Add >
\gui {Bare Metal Device} > \gui {Start Wizard}.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices > \uicontrol Add >
\uicontrol {Bare Metal Device} > \uicontrol {Start Wizard}.
\li In the \gui {GDB host} and \gui {GDB port} fields, specify the host
\li In the \uicontrol {GDB host} and \uicontrol {GDB port} fields, specify the host
name and port number to access the GDB server or hardware debugger.
\li In the \gui {GDB commands} fields, specify custom commands for the
\li In the \uicontrol {GDB commands} fields, specify custom commands for the
GDB server or hardware debugger.
\li To specify build settings:
......@@ -61,7 +61,7 @@
\li Open a project for an application you want to develop for the
device.
\li Select \gui Projects > \gui {Build & Run} > \gui {Add Kit} to
\li Select \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol {Add Kit} to
add a kit for building and running applications on bare metal
devices.
......@@ -69,7 +69,7 @@
\endlist
\li Select \gui Run to specify run settings.
\li Select \uicontrol Run to specify run settings.
Usually, you can use the default settings.
......
......@@ -31,7 +31,7 @@
\title Debugging a C++ Example Application
This section uses the \l{Creating a Qt Widget Based Application}{TextFinder}
example to illustrate how to debug Qt C++ applications in the \gui Debug
example to illustrate how to debug Qt C++ applications in the \uicontrol Debug
mode.
TextFinder reads a text file into QString and then displays it with
......@@ -45,19 +45,19 @@
\image qtcreator-setting-breakpoint1.png
\li Select \gui{Debug > Start Debugging > Start Debugging} or press
\li Select \uicontrol{Debug > Start Debugging > Start Debugging} or press
\key{F5}.
\li To view the breakpoint, click the \gui{Breakpoints} tab.
\li To view the breakpoint, click the \uicontrol{Breakpoints} tab.
\image qtcreator-setting-breakpoint2.png
\li To remove a breakpoint, right-click it and select
\gui{Delete Breakpoint}.
\uicontrol{Delete Breakpoint}.
\li To view the base classes and data members of the TextFinder class,
go to the \gui{Locals and Expressions} view.
go to the \uicontrol{Locals and Expressions} view.
\image qtcreator-watcher.png
......@@ -101,12 +101,12 @@
work correctly due to a logic error. To locate this logic error, step
through the code using the following buttons:
\inlineimage qtcreator-debug-button-stop.png
(\gui Stop),
(\uicontrol Stop),
\inlineimage qtcreator-debug-button-step-over.png
(\gui {Step Over}),
(\uicontrol {Step Over}),
\inlineimage qtcreator-debug-button-step-into.png
(\gui {Step Into}), and
(\uicontrol {Step Into}), and
\inlineimage qtcreator-debug-button-step-out.png
(\gui {Step Out}).
(\uicontrol {Step Out}).
*/
......@@ -33,8 +33,8 @@
The main debugger settings are associated with the
\l{glossary-buildandrun-kit}{kit} you build and run your project with. To specify the
debugger and compiler to use for each kit, select \gui Tools >
\gui Options > \gui {Build and Run} > \gui Kits.
debugger and compiler to use for each kit, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build and Run} > \uicontrol Kits.
You need to set up the debugger only if the automatic setup
fails, because the native debugger is missing (as is usually the
......@@ -45,11 +45,12 @@
\note If you need to change the debugger to use for an automatically
detected \l{glossary-buildandrun-kit}{kit},
you can \gui{Clone} the kit and change the parameters in
you can \uicontrol{Clone} the kit and change the parameters in
the clone. Make sure to select the cloned kit for your project.
If the debugger you want to use is not automatically detected, select
\gui Tools > \gui Options > \gui {Build & Run} > \gui Debuggers > \gui Add
\uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
\uicontrol Debuggers > \uicontrol Add
to add it.
\note To use the debugging tools for Windows, you must install them
......@@ -218,8 +219,8 @@
If you use a qmake based project in \QC, you can set a
flag in your \l{glossary-run-config}{run configuration}, in
\gui Projects mode. In the run configuration, select
\gui{Use debug version of frameworks}.
\uicontrol Projects mode. In the run configuration, select
\uicontrol{Use debug version of frameworks}.
For more detailed information about debugging on OS X,
see: \l{http://developer.apple.com/library/mac/#technotes/tn2124/_index.html#//apple_ref/doc/uid/DTS10003391}
......@@ -238,13 +239,13 @@
\list 1
\li Select \gui Tools > \gui Options > \gui Debugger > \gui General >
\gui Add.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger
> \uicontrol General > \uicontrol Add.
\li In the \gui {Source path} field, specify the source path in the
\li In the \uicontrol {Source path} field, specify the source path in the
debug information of the executable as reported by the debugger.
\li In the \gui {Target path} field, specify the actual location of the
\li In the \uicontrol {Target path} field, specify the actual location of the
source tree on the local machine.
\endlist
......@@ -257,13 +258,14 @@
\list 1
\li Select \gui Tools > \gui Options > \gui Debugger > \gui CDB.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger >
\uicontrol CDB.
\li In the \gui {Symbol paths} field, open the \gui Insert menu
and select \gui{Symbol Server}.
\li In the \uicontrol {Symbol paths} field, open the \uicontrol Insert
menu and select \uicontrol{Symbol Server}.
\li Select a directory where you want to store the cached information
and click \gui OK.
and click \uicontrol OK.
Use a subfolder in a temporary directory, such as
\c {C:\temp\symbolcache}.
......@@ -283,32 +285,32 @@
\list 1
\li To create a key for signing FSF GDB, select \gui {Keychain Access >
\li To create a key for signing FSF GDB, select \uicontrol {Keychain Access >
Certificate Assistant > Create a Certificate}:
\list 1
\li In the \gui {Name} field, input \gui {fsfgdb} to replace
\li In the \uicontrol {Name} field, input \uicontrol {fsfgdb} to replace
the existing content.
\li In the \gui {Certificate Type} field, select
\gui {Code Signing}.
\li In the \uicontrol {Certificate Type} field, select
\uicontrol {Code Signing}.
\li Select the \gui {Let me override defaults} check box.
\li Select the \uicontrol {Let me override defaults} check box.
\li Select \gui Continue, and follow the instructions of the
wizard (use the default settings), until the \gui {Specify a
\li Select \uicontrol Continue, and follow the instructions of the
wizard (use the default settings), until the \uicontrol {Specify a
Location For The Certificate} dialog opens.
\li In the \gui Keychain field, select \gui System.
\li In the \uicontrol Keychain field, select \uicontrol System.
\li Select \gui {Keychain Access > System}, and locate the
\li Select \uicontrol {Keychain Access > System}, and locate the
certificate.
\li Double click the certificate to view certificate information.
\li In the \gui Trust section, select \gui {Always Trust} in the
\gui {When using this certificate} field, and then close
\li In the \uicontrol Trust section, select \uicontrol {Always Trust} in the
\uicontrol {When using this certificate} field, and then close
the dialog.
\endlist
......@@ -319,14 +321,14 @@
codesign -f -s "fsfgdb" $INSTALL_LOCATION/fsfgdb
\endcode
\li In \QC, select \gui {Qt Creator > Preferences > Build & Run >
Kits} > \gui Add to create a kit that uses FSF GDB.
\li In \QC, select \uicontrol {Qt Creator > Preferences > Build & Run >
Kits} > \uicontrol Add to create a kit that uses FSF GDB.
\li In the \gui Debugger field, specify the path to FSF GDB
\li In the \uicontrol Debugger field, specify the path to FSF GDB
(\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for
\c $HOME).
\li To use the debugger, add the kit in the \gui {Build Settings}
\li To use the debugger, add the kit in the \uicontrol {Build Settings}
of the project.
\endlist
......@@ -338,17 +340,18 @@
\list 1
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits.
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Kits.
\li Select an automatically created kit in the list, and then select
\gui Clone to create a copy of the kit.
\uicontrol Clone to create a copy of the kit.
\li In the \gui Debugger field, select an LLDB Engine. If an LLDB Engine
is not listed, select \gui Manage to add it in \gui Tools >
\gui Options > \gui {Build & Run} > \gui Debuggers. For more
\li In the \uicontrol Debugger field, select an LLDB Engine. If an LLDB Engine
is not listed, select \uicontrol Manage to add it in \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Debuggers. For more
information, see \l {Adding Debuggers}.
\li To use the debugger, add the kit in the \gui {Build Settings}
\li To use the debugger, add the kit in the \uicontrol {Build Settings}
of the project.
\endlist
......
This diff is collapsed.
......@@ -33,7 +33,7 @@
This section uses the
\l{QML Advanced Tutorial}{Same Game}
example application to illustrate how to debug Qt Quick applications in the
\gui Debug mode.
\uicontrol Debug mode.
For more information about all the options you have, see
\l{Debugging Qt Quick Projects}.
......@@ -53,10 +53,10 @@
The red circle indicates that a breakpoint is now set on that line
number.