Commit 328d205b authored by Eike Ziller's avatar Eike Ziller
Browse files

Device type + tool chain + other settings -> Kit



We called that "Target" before

Change-Id: Ie0d673c643947c26ac2706907f6250fc1739388a
Reviewed-by: default avatarLeena Miettinen <riitta-leena.miettinen@nokia.com>
parent fb59a39a
...@@ -39,7 +39,7 @@ ...@@ -39,7 +39,7 @@
your plugin with. your plugin with.
\list 1 \list 1
\o Select \gui{File > New File or Project > Other Qt Project > Qt Creator Plugin > Choose}. \o Select \gui{File > New File or Project > Libraries > Qt Creator Plugin > Choose}.
\image firstplugin-wizard.png "Choose the \QC Plugin Wizard" \image firstplugin-wizard.png "Choose the \QC Plugin Wizard"
...@@ -52,12 +52,12 @@ ...@@ -52,12 +52,12 @@
from the project name. You will choose that name later in the wizard. from the project name. You will choose that name later in the wizard.
Continue to the next page. Continue to the next page.
The \gui{Target Setup} dialog opens. The \gui{Kit Selection} dialog opens.
\image firstplugin-target.png "Choose the Desktop Target and Matching Qt" \image firstplugin-kitselection.png "Choose the kit to build and run your project with"
\o Select the target and Qt version to build your project with. \o Select the \l{glossary-buildandrun-kit}{kit} to build and run your project with.
For a \QC plugin this needs to be the \gui{Desktop} target, For a \QC plugin this needs to be a kit with \gui{Desktop} device type,
and a Qt version that is compatible with the Qt version that your and a Qt version that is compatible with the Qt version that your
\QC was built with (in the best case the exact same build). \QC was built with (in the best case the exact same build).
If you use an incompatible Qt version to build your plugin, you If you use an incompatible Qt version to build your plugin, you
......
...@@ -37,8 +37,8 @@ ...@@ -37,8 +37,8 @@
to use them from \QC. to use them from \QC.
To run the Valgrind tools on a remote host over SSH, select \gui {Analyze To run the Valgrind tools on a remote host over SSH, select \gui {Analyze
> Valgrind Analyze Memory (Remote)} or \gui {Valgrind Function Profile > Valgrind Analyze Memory (External)} or \gui {Valgrind Function Profile
(Remote)}. (External)}.
To stop the currently running analyzer, select \gui {Analyze To stop the currently running analyzer, select \gui {Analyze
> Stop}. > Stop}.
......
...@@ -252,15 +252,13 @@ ...@@ -252,15 +252,13 @@
\list 1 \list 1
\o Select \gui {Analyze > Valgrind Analyze Memory (Remote)} or \o Select \gui {Analyze > Valgrind Analyze Memory (External)} or
\gui {Valgrind Function Profile (Remote)}. \gui {Valgrind Function Profile (External)}.
\image qtcreator-valgrind-remote-settings.png "Start Debugger dialog" \image qtcreator-valgrind-remote-settings.png "Start Analyzer dialog"
\o In the \gui Remote group, specify the connection to the remote host. \o Specify the application to run and analyze, and the \l{glossary-buildandrun-kit}{kit}
to use.
\o In the \gui Target group, specify the application to run and analyze
on the remote host.
\endlist \endlist
......
...@@ -87,7 +87,7 @@ ...@@ -87,7 +87,7 @@
\section1 Attaching to Running Qt Quick Applications \section1 Attaching to Running Qt Quick Applications
To profile Qt Quick applications that are not launched by \QC, select To profile Qt Quick applications that are not launched by \QC, select
\gui {Analyze > QML Profiler (Remote)}. You must enable QML debugging for \gui {Analyze > QML Profiler (External)}. You must enable QML debugging for
the application in the project build settings. For more information, see the application in the project build settings. For more information, see
\l{Setting Up QML Debugging}. \l{Setting Up QML Debugging}.
......
...@@ -32,8 +32,10 @@ ...@@ -32,8 +32,10 @@
and analyze applications on them from \QC. and analyze applications on them from \QC.
If you have a tool chain for building applications for Android devices If you have a tool chain for building applications for Android devices
installed on the development PC, you can add it to \QC. You can then select installed on the development PC, you can add it to \QC. You can then add a
the \gui {Android} target to run applications on Android devices. \l{glossary-buildandrun-kit}{kit}
with the Android device type, the tool chain, and the Qt version for Android,
to build and run applications on Android devices.
\section1 Requirements \section1 Requirements
......
...@@ -32,10 +32,10 @@ ...@@ -32,10 +32,10 @@
\title Setting Up Debugger \title Setting Up Debugger
The main debugger settings are associated with the build The main debugger settings are associated with the
\l{glossary-development-target}{target} of your project. To specify the \l{glossary-buildandrun-kit}{kit} you build and run your project with. To specify the
debugger and compiler to use for each build target, select \gui Tools > debugger and compiler to use for each kit, select \gui Tools >
\gui Options > \gui {Build and Run} > \gui Targets. \gui Options > \gui {Build and Run} > \gui Kits.
You need to set up the debugger only if the automatic setup You need to set up the debugger only if the automatic setup
fails, because the native debugger is missing (as is usually the fails, because the native debugger is missing (as is usually the
...@@ -45,8 +45,9 @@ ...@@ -45,8 +45,9 @@
want to use a locally installed replacement instead). want to use a locally installed replacement instead).
\note If you need to change the debugger to use for an automatically \note If you need to change the debugger to use for an automatically
detected target, you can \gui{Clone} the target and change the parameters in detected \l{glossary-buildandrun-kit}{kit},
the clone. Make sure to select the cloned target for your project. you can \gui{Clone} the kit and change the parameters in
the clone. Make sure to select the cloned kit for your project.
\note To use the debugging tools for Windows, you must install them \note To use the debugging tools for Windows, you must install them
and add the Symbol Server provided by Microsoft to the symbol search and add the Symbol Server provided by Microsoft to the symbol search
...@@ -54,7 +55,7 @@ ...@@ -54,7 +55,7 @@
Server in Windows}. Server in Windows}.
\note To use the Free Software Foundation (FSF) version of GDB on \note To use the Free Software Foundation (FSF) version of GDB on
Mac OS, you must sign it and modify your target settings. Mac OS, you must sign it and modify your \l{glossary-buildandrun-kit}{kit} settings.
This section explains the options you have for debugging C++ code This section explains the options you have for debugging C++ code
and provides installation notes for the supported native debuggers. and provides installation notes for the supported native debuggers.
...@@ -185,8 +186,7 @@ ...@@ -185,8 +186,7 @@
\o On Linux and Windows, use the Python-enabled GDB versions that \o On Linux and Windows, use the Python-enabled GDB versions that
are installed when you install \QC and Qt SDK. On Mac OS X, are installed when you install \QC and Qt SDK. On Mac OS X,
use the GDB provided with Xcode. use the GDB provided with Xcode.
For a custom \l{glossary-development-target}{target}, you can You can also build your own Python-enabled GDB. Follow the instructions in
build your own Python-enabled GDB. Follow the instructions in
\l{http://developer.qt.nokia.com/wiki/QtCreatorBuildGdb} \l{http://developer.qt.nokia.com/wiki/QtCreatorBuildGdb}
{Building GDB}. {Building GDB}.
...@@ -234,7 +234,7 @@ ...@@ -234,7 +234,7 @@
supports Python from supports Python from
\l{ftp://ftp.qt.nokia.com/misc/gdb/7.2/gdb72_mac_platform.tar.bz2}. \l{ftp://ftp.qt.nokia.com/misc/gdb/7.2/gdb72_mac_platform.tar.bz2}.
To use FSF GDB on Mac OS, you must sign it and add it to the \QC To use FSF GDB on Mac OS, you must sign it and add it to the \QC
targets. For more information, see \l{glossary-buildandrun-kit}{kits}. For more information, see
\l{Setting up FSF GDB for Mac OS}. \l{Setting up FSF GDB for Mac OS}.
\note The Mac OS X Snow Leopard (10.6) has a bug that might cause the \note The Mac OS X Snow Leopard (10.6) has a bug that might cause the
...@@ -272,7 +272,8 @@ ...@@ -272,7 +272,8 @@
\section1 Setting up FSF GDB for Mac OS \section1 Setting up FSF GDB for Mac OS
To use FSF GDB on Mac OS, you must sign it and add it to the \QC targets. To use FSF GDB on Mac OS, you must sign it and add it to the \QC
\l{glossary-buildandrun-kit}{kits}.
\list 1 \list 1
...@@ -313,13 +314,13 @@ ...@@ -313,13 +314,13 @@
\endcode \endcode
\o In \QC, select \gui {Qt Creator > Preferences > Build & Run > \o In \QC, select \gui {Qt Creator > Preferences > Build & Run >
Targets} > \gui Add to create a build target that uses FSF GDB. Kits} > \gui Add to create a kit that uses FSF GDB.
\o In the \gui Debugger field, specify the path to FSF GDB \o In the \gui Debugger field, specify the path to FSF GDB
(\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for (\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for
\c $HOME). \c $HOME).
\o To use the debugger, add the target in the \gui {Build Settings} \o To use the debugger, add the kit in the \gui {Build Settings}
of the project. of the project.
\endlist \endlist
......
...@@ -252,9 +252,9 @@ ...@@ -252,9 +252,9 @@
While this setup might look daunting, it is mostly invisible to While this setup might look daunting, it is mostly invisible to
the user of \QC. To start debugging on a remote target with the the user of \QC. To start debugging on a remote target with the
necessary helper processes running, select the target in necessary helper processes running, select the corresponding
\gui{Projects > Build Settings} \l{glossary-buildandrun-kit}{kit} in
or in the \gui{Debug > Start Debugging} menu. \gui{Projects > Build & Run} or in the \gui{Debug > Start Debugging} menu.
Special use cases, such as attaching to a running process on the Special use cases, such as attaching to a running process on the
target, might still require manual setup. target, might still require manual setup.
...@@ -693,8 +693,7 @@ ...@@ -693,8 +693,7 @@
which may contain both release and debug versions of the library. When you run which may contain both release and debug versions of the library. When you run
applications on the Mac OS desktop, the release version of Frameworks is used applications on the Mac OS desktop, the release version of Frameworks is used
by default. To step into Frameworks, select the \gui {Use debug versions of by default. To step into Frameworks, select the \gui {Use debug versions of
Frameworks} option in the project run settings for \gui Desktop and Frameworks} option in the project run settings.
\gui {\QS} targets.
\section2 Viewing Threads \section2 Viewing Threads
...@@ -792,7 +791,7 @@ ...@@ -792,7 +791,7 @@
To give the user simple access also to these items, \QC employs To give the user simple access also to these items, \QC employs
so-called Debugging Helpers. Debugging Helpers come in two varieties, so-called Debugging Helpers. Debugging Helpers come in two varieties,
compiled, and Python based, depending on the selected compiled, and Python based, depending on the selected
\l{glossary-development-target}{target}. \l{glossary-buildandrun-kit}{kit}.
By default, Debugging Helpers are automatically and transparently used. By default, Debugging Helpers are automatically and transparently used.
To disable them, select \gui Tools > \gui Options > \gui Debugger > To disable them, select \gui Tools > \gui Options > \gui Debugger >
......
...@@ -89,7 +89,7 @@ ...@@ -89,7 +89,7 @@
\o To debug applications on devices, check that Qt 4.7.4, or later, \o To debug applications on devices, check that Qt 4.7.4, or later,
libraries are installed on the device and libraries are installed on the device and
\l{Running on Multiple Targets}{select the device as the target} \l{Running on Multiple Targets}{select the corresponding kit for the device}
before you start debugging. before you start debugging.
\endlist \endlist
......
...@@ -549,7 +549,7 @@ ...@@ -549,7 +549,7 @@
\o Open project \o Open project
\o Ctrl+Shift+O \o Ctrl+Shift+O
\row \row
\o Select build and run target \o Select the \l{glossary-buildandrun-kit}{kit} to build and run your project with
\o Ctrl+T \o Ctrl+T
\row \row
\o Run \o Run
......
...@@ -51,8 +51,8 @@ ...@@ -51,8 +51,8 @@
You can use the mode selector (1) to change to another \QC mode. You can use the mode selector (1) to change to another \QC mode.
You can use the target selector (2) to select the You can use the kit selector (2) to select the
\l{glossary-development-target}{target} for running (3), debugging (4), or \l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or
building (5) the application. Output from these actions is displayed in the building (5) the application. Output from these actions is displayed in the
output panes (7). output panes (7).
......
...@@ -54,8 +54,8 @@ ...@@ -54,8 +54,8 @@
\image qtcreator-embedded-linux-deployment.png "Deploy to embedded Linux" \image qtcreator-embedded-linux-deployment.png "Deploy to embedded Linux"
When you run the application on the \gui {Embedded Linux} target, \QC When you run the application on the \gui {Embedded Linux} device,
deploys the application as specified by the deploy steps. By default, \QC deploys the application as specified by the deploy steps. By default,
\QC copies the application files to the device by using the SSH file \QC copies the application files to the device by using the SSH file
transfer protocol (SFTP), as specified by the \gui {Upload files via SFTP} transfer protocol (SFTP), as specified by the \gui {Upload files via SFTP}
step. step.
...@@ -91,7 +91,7 @@ ...@@ -91,7 +91,7 @@
\section1 Creating Debian Installation Packages \section1 Creating Debian Installation Packages
When you run the application on the \gui{Maemo5} or \gui Harmattan target, When you run the application on the \gui{Maemo5} or \gui Harmattan device,
\QC generates a Debian installation package in the build directory by \QC generates a Debian installation package in the build directory by
default. You can deliver the installation package to users for installation default. You can deliver the installation package to users for installation
on devices that are of the same type and run the same firmware as the on devices that are of the same type and run the same firmware as the
...@@ -117,8 +117,9 @@ ...@@ -117,8 +117,9 @@
\note \QC automates this process for you. \note \QC automates this process for you.
\QC provides templates for a set of files that must be included in Debian \QC provides templates for a set of files that must be included in Debian
packages. When you create a \gui Maemo5 or \gui Harmattan target for a packages. When you start using a \l{glossary-buildandrun-kit}{kit} with
project, \QC asks whether packaging files are to be added to the project and \gui Maemo5 or \gui Harmattan device type
for a project, \QC asks whether packaging files are to be added to the project and
to version control. If you plan to edit the packaging files, add them to to version control. If you plan to edit the packaging files, add them to
version control. version control.
......
...@@ -57,9 +57,10 @@ ...@@ -57,9 +57,10 @@
\section1 Starting the Emulator \section1 Starting the Emulator
The \gui {Start MeeGo Emulator} button is visible if you have a project The \gui {Start MeeGo Emulator} button is visible if you have a project
open in \QC for which you have added the Maemo or MeeGo Harmattan open in \QC for which you have added a \l{glossary-buildandrun-kit}{kit}
build target. It starts the Maemo or MeeGo Harmattan emulator, depending with Maemo or MeeGo Harmattan device type.
on the selected target. It starts the Maemo or MeeGo Harmattan emulator, depending
on the selected kit.
To start the emulator, click To start the emulator, click
\inlineimage qtcreator-maemo-emulator-button.png "Start MeeGo Emulator button" \inlineimage qtcreator-maemo-emulator-button.png "Start MeeGo Emulator button"
......
\section2 Specifying Run Settings for Linux-Based Devices \section2 Specifying Run Settings for Linux-Based Devices
To run an application on a Linux-based device target (embedded Linux, MeeGo To run an application on a Linux-based device (embedded Linux, MeeGo
Harmattan, or Maemo), create and select a device configuration in the run Harmattan, or Maemo), create and select a device configuration in the
settings for the project. \l{glossary-buildandrun-kit}{kit} that is used for building and running the project and set its
device type correspondingly.
You can also pass command line arguments to your application. You can also pass command line arguments to your application.
\image qtcreator-screenshot-run-settings-maemo.png "Run settings for Linux-based devices" \image qtcreator-screenshot-run-settings-maemo.png "Run settings for Linux-based devices"
...@@ -16,7 +17,7 @@ ...@@ -16,7 +17,7 @@
When you run the application, \QC copies the files to the connected device. When you run the application, \QC copies the files to the connected device.
For MeeGo Harmattan and Maemo targets, \QC also generates an For MeeGo Harmattan and Maemo device types, \QC also generates an
installation package in the build directory by default. You can deliver the installation package in the build directory by default. You can deliver the
installation package to users for installation installation package to users for installation
on devices that are of the same type and run the same firmware as the on devices that are of the same type and run the same firmware as the
......
...@@ -61,7 +61,8 @@ ...@@ -61,7 +61,8 @@
\list 1 \list 1
\o Select the \gui {Maemo5} build target for your project. \o Select the \l{glossary-buildandrun-kit}{kit} with \gui {Maemo5} device type
for your project.
\o Choose \gui {Build > Publish Project}. \o Choose \gui {Build > Publish Project}.
......
...@@ -31,17 +31,17 @@ ...@@ -31,17 +31,17 @@
If you have a tool chain for building applications for embedded Linux If you have a tool chain for building applications for embedded Linux
devices (with no MADDE support) installed on the development PC, you can add devices (with no MADDE support) installed on the development PC, you can add
it to \QC. You can then select the \gui {Embedded Linux} target to it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit}
run applications on embedded Linux devices. with \gui {Embedded Linux} device type to
build and run applications on embedded Linux devices.
To be able to run and debug applications on embedded Linux devices, you must To be able to run and debug applications on embedded Linux devices, you must
create device configurations and select them in the \QC run create device configurations and select them in the \QC \l{glossary-buildandrun-kit}{kit}
settings.
You use a wizard to create the connections. You can edit the settings later You use a wizard to create the connections. You can edit the settings later
in \gui {Tools > Options > Linux Devices > Device Configurations}. in \gui {Tools > Options > Devices > Devices}.
\image qtcreator-linux-device-configurations.png "Device Configurations dialog" \image qtcreator-linux-device-configurations.png "Devices dialog"
You can protect the connections between \QC and a device by using You can protect the connections between \QC and a device by using
either a password or an SSH key. If you do not have an SSH key, you can either a password or an SSH key. If you do not have an SSH key, you can
...@@ -67,8 +67,8 @@ ...@@ -67,8 +67,8 @@
\list 1 \list 1
\o Select \gui {Tools > Options > Linux Devices > Device \o Select \gui {Tools > Options > Linux Devices > Devices > Add
Configurations > Add > Generic Linux Device > Start Wizard}. > Generic Linux Device > Start Wizard}.
\image qtcreator-screenshot-devconf-linux.png "Connection Data wizard" \image qtcreator-screenshot-devconf-linux.png "Connection Data wizard"
...@@ -91,9 +91,10 @@ ...@@ -91,9 +91,10 @@
\endlist \endlist
\o Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Targets \o Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits
> \gui Add to add a target for building for the device. Select the > \gui Add to add a kit for building for the device. Select the
Qt version, compiler, and device that you added above. Qt version, compiler, and device that you added above, and choose
\gui {Generic Linux Device} for the device type.
\o To specify build settings: \o To specify build settings:
...@@ -102,9 +103,9 @@ ...@@ -102,9 +103,9 @@
\o Open a project for an application you want to develop for the \o Open a project for an application you want to develop for the
device. device.
\o Select \gui {Projects > Targets > Add}. \o Select \gui {Projects > Build & Run Settings > Add Kit}.
\o Select the target that you added above. \o Select the kit that you added above.
\endlist \endlist
......
...@@ -40,7 +40,7 @@ ...@@ -40,7 +40,7 @@
\o \l{Deploying Applications to Linux-Based Devices} \o \l{Deploying Applications to Linux-Based Devices}
When you deploy the application on a Linux-based device target, such When you deploy the application on a Linux-based device, such
as \gui {Embedded Linux}, \gui Harmattan, or \gui{Maemo5}, \QC as \gui {Embedded Linux}, \gui Harmattan, or \gui{Maemo5}, \QC
copies the application files to the connected device. You copies the application files to the connected device. You
can test and debug the application on the device. can test and debug the application on the device.
...@@ -48,14 +48,14 @@ ...@@ -48,14 +48,14 @@
Maemo 5 devices. Maemo 5 devices.
\o \l{Deploying Applications to QNX Devices} \o \l{Deploying Applications to QNX Devices}
When you deploy the application on the \gui{QNX} target, depending When you deploy the application on a \gui{QNX} device, depending
on your target device, \QC either generates a BAR package in the on your target device, \QC either generates a BAR package in the
build directory and deploys it to the connected device, or copies build directory and deploys it to the connected device, or copies
the application files to the connected device. You can test and the application files to the connected device. You can test and
debug the application on the device. debug the application on the device.
\o \l{Deploying Applications to Android Devices} \o \l{Deploying Applications to Android Devices}
When you deploy the application on the Android target, \QC copies When you deploy the application on an Android device, \QC copies
the application files to the device. In addition, you can determine the application files to the device. In addition, you can determine
the Qt libraries to use. the Qt libraries to use.
\endlist \endlist
...@@ -68,7 +68,7 @@ ...@@ -68,7 +68,7 @@
When you are ready to publish the application on a publishing When you are ready to publish the application on a publishing
channel, you must make sure that the installation file meets the channel, you must make sure that the installation file meets the
requirements for publishing and installing applications to the requirements for publishing and installing applications to the
target devices. targeted devices.
\endlist \endlist
*/ */
...@@ -49,7 +49,7 @@ ...@@ -49,7 +49,7 @@
with the parts of the user interface, go to \l{User Interface}. with the parts of the user interface, go to \l{User Interface}.
\o \bold {\l{Building and Running an Example}} \o \bold {\l{Building and Running an Example}}
To check that \l{glossary-development-target}{targets} were To check that \l{glossary-buildandrun-kit}{kits} for building and running were
successfully installed as part of the \QSDK installation, open successfully installed as part of the \QSDK installation, open
an example application and run it. If you have not done so an example application and run it. If you have not done so
before, go to \l{Building and Running an Example}. before, go to \l{Building and Running an Example}.
......
...@@ -43,7 +43,8 @@ ...@@ -43,7 +43,8 @@
into binaries. Different build configurations allow you to into binaries. Different build configurations allow you to
quickly build the project for different purposes. quickly build the project for different purposes.
By default, \QC creates \e {debug build} and \e {release build} By default, \QC creates \e {debug build} and \e {release build}
configurations for each \e target. A debug build contains configurations for each \l{glossary-buildandrun-kit}{kit} defined for your project.
A debug build contains
additional debug symbols that you need for debugging the additional debug symbols that you need for debugging the
application but that you can leave out from the release version. application but that you can leave out from the release version.
Generally, you use the debug configuration for testing and the Generally, you use the debug configuration for testing and the
...@@ -79,6 +80,15 @@ ...@@ -79,6 +80,15 @@
copied to a location in the file system of the development PC or copied to a location in the file system of the development PC or
a mobile device. a mobile device.
\row
\o Kit
\target glossary-buildandrun-kit
\o \QC groups build and run specific settings as kits to make
cross-platform development easier. Each kit consists of a set
of values that define one environment, such as a device,
tool chain, Qt version, and debugger command to use. Configure kits at
\gui {Tools > Options > Build & Run > Kits}.
\row \row
\o Mode \o Mode
\target glossary-mode \target glossary-mode
...@@ -102,14 +112,15 @@ ...@@ -102,14 +112,15 @@
\target glossary-project-qt \target glossary-project-qt
\o \QC allows you to have multiple versions of Qt installed on your \o \QC allows you to have multiple versions of Qt installed on your
development PC and use different versions to build your projects development PC and use different versions to build your projects
for different \e targets.