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

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 @@
your plugin with.
\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"
......@@ -52,12 +52,12 @@
from the project name. You will choose that name later in the wizard.
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.
For a \QC plugin this needs to be the \gui{Desktop} target,
\o Select the \l{glossary-buildandrun-kit}{kit} to build and run your project with.
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
\QC was built with (in the best case the exact same build).
If you use an incompatible Qt version to build your plugin, you
......
......@@ -37,8 +37,8 @@
to use them from \QC.
To run the Valgrind tools on a remote host over SSH, select \gui {Analyze
> Valgrind Analyze Memory (Remote)} or \gui {Valgrind Function Profile
(Remote)}.
> Valgrind Analyze Memory (External)} or \gui {Valgrind Function Profile
(External)}.
To stop the currently running analyzer, select \gui {Analyze
> Stop}.
......
......@@ -252,15 +252,13 @@
\list 1
\o Select \gui {Analyze > Valgrind Analyze Memory (Remote)} or
\gui {Valgrind Function Profile (Remote)}.
\o Select \gui {Analyze > Valgrind Analyze Memory (External)} or
\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 In the \gui Target group, specify the application to run and analyze
on the remote host.
\o Specify the application to run and analyze, and the \l{glossary-buildandrun-kit}{kit}
to use.
\endlist
......
......@@ -87,7 +87,7 @@
\section1 Attaching to Running Qt Quick Applications
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
\l{Setting Up QML Debugging}.
......
......@@ -32,8 +32,10 @@
and analyze applications on them from \QC.
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
the \gui {Android} target to run applications on Android devices.
installed on the development PC, you can add it to \QC. You can then add a
\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
......
......@@ -32,10 +32,10 @@
\title Setting Up Debugger
The main debugger settings are associated with the build
\l{glossary-development-target}{target} of your project. To specify the
debugger and compiler to use for each build target, select \gui Tools >
\gui Options > \gui {Build and Run} > \gui Targets.
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.
You need to set up the debugger only if the automatic setup
fails, because the native debugger is missing (as is usually the
......@@ -45,8 +45,9 @@
want to use a locally installed replacement instead).
\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
the clone. Make sure to select the cloned target for your project.
detected \l{glossary-buildandrun-kit}{kit},
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
and add the Symbol Server provided by Microsoft to the symbol search
......@@ -54,7 +55,7 @@
Server in Windows}.
\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
and provides installation notes for the supported native debuggers.
......@@ -185,8 +186,7 @@
\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,
use the GDB provided with Xcode.
For a custom \l{glossary-development-target}{target}, you can
build your own Python-enabled GDB. Follow the instructions in
You can also build your own Python-enabled GDB. Follow the instructions in
\l{http://developer.qt.nokia.com/wiki/QtCreatorBuildGdb}
{Building GDB}.
......@@ -234,7 +234,7 @@
supports Python from
\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
targets. For more information, see
\l{glossary-buildandrun-kit}{kits}. For more information, see
\l{Setting up FSF GDB for Mac OS}.
\note The Mac OS X Snow Leopard (10.6) has a bug that might cause the
......@@ -272,7 +272,8 @@
\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
......@@ -313,13 +314,13 @@
\endcode
\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
(\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for
\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.
\endlist
......
......@@ -252,9 +252,9 @@
While this setup might look daunting, it is mostly invisible to
the user of \QC. To start debugging on a remote target with the
necessary helper processes running, select the target in
\gui{Projects > Build Settings}
or in the \gui{Debug > Start Debugging} menu.
necessary helper processes running, select the corresponding
\l{glossary-buildandrun-kit}{kit} in
\gui{Projects > Build & Run} or in the \gui{Debug > Start Debugging} menu.
Special use cases, such as attaching to a running process on the
target, might still require manual setup.
......@@ -693,8 +693,7 @@
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
by default. To step into Frameworks, select the \gui {Use debug versions of
Frameworks} option in the project run settings for \gui Desktop and
\gui {\QS} targets.
Frameworks} option in the project run settings.
\section2 Viewing Threads
......@@ -792,7 +791,7 @@
To give the user simple access also to these items, \QC employs
so-called Debugging Helpers. Debugging Helpers come in two varieties,
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.
To disable them, select \gui Tools > \gui Options > \gui Debugger >
......
......@@ -89,7 +89,7 @@
\o To debug applications on devices, check that Qt 4.7.4, or later,
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.
\endlist
......
......@@ -549,7 +549,7 @@
\o Open project
\o Ctrl+Shift+O
\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
\row
\o Run
......
......@@ -51,8 +51,8 @@
You can use the mode selector (1) to change to another \QC mode.
You can use the target selector (2) to select the
\l{glossary-development-target}{target} for running (3), debugging (4), or
You can use the kit selector (2) to select the
\l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or
building (5) the application. Output from these actions is displayed in the
output panes (7).
......
......@@ -54,8 +54,8 @@
\image qtcreator-embedded-linux-deployment.png "Deploy to embedded Linux"
When you run the application on the \gui {Embedded Linux} target, \QC
deploys the application as specified by the deploy steps. By default,
When you run the application on the \gui {Embedded Linux} device,
\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
transfer protocol (SFTP), as specified by the \gui {Upload files via SFTP}
step.
......@@ -91,7 +91,7 @@
\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
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
......@@ -117,8 +117,9 @@
\note \QC automates this process for you.
\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
project, \QC asks whether packaging files are to be added to the project and
packages. When you start using a \l{glossary-buildandrun-kit}{kit} with
\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
version control.
......
......@@ -57,9 +57,10 @@
\section1 Starting the Emulator
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
build target. It starts the Maemo or MeeGo Harmattan emulator, depending
on the selected target.
open in \QC for which you have added a \l{glossary-buildandrun-kit}{kit}
with Maemo or MeeGo Harmattan device type.
It starts the Maemo or MeeGo Harmattan emulator, depending
on the selected kit.
To start the emulator, click
\inlineimage qtcreator-maemo-emulator-button.png "Start MeeGo Emulator button"
......
\section2 Specifying Run Settings for Linux-Based Devices
To run an application on a Linux-based device target (embedded Linux, MeeGo
Harmattan, or Maemo), create and select a device configuration in the run
settings for the project.
To run an application on a Linux-based device (embedded Linux, MeeGo
Harmattan, or Maemo), create and select a device configuration in the
\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.
\image qtcreator-screenshot-run-settings-maemo.png "Run settings for Linux-based devices"
......@@ -16,7 +17,7 @@
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 to users for installation
on devices that are of the same type and run the same firmware as the
......
......@@ -61,7 +61,8 @@
\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}.
......
......@@ -31,17 +31,17 @@
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
it to \QC. You can then select the \gui {Embedded Linux} target to
run applications on embedded Linux devices.
it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit}
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
create device configurations and select them in the \QC run
settings.
create device configurations and select them in the \QC \l{glossary-buildandrun-kit}{kit}
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
either a password or an SSH key. If you do not have an SSH key, you can
......@@ -67,8 +67,8 @@
\list 1
\o Select \gui {Tools > Options > Linux Devices > Device
Configurations > Add > Generic Linux Device > Start Wizard}.
\o Select \gui {Tools > Options > Linux Devices > Devices > Add
> Generic Linux Device > Start Wizard}.
\image qtcreator-screenshot-devconf-linux.png "Connection Data wizard"
......@@ -91,9 +91,10 @@
\endlist
\o Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Targets
> \gui Add to add a target for building for the device. Select the
Qt version, compiler, and device that you added above.
\o Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits
> \gui Add to add a kit for building for the device. Select the
Qt version, compiler, and device that you added above, and choose
\gui {Generic Linux Device} for the device type.
\o To specify build settings:
......@@ -102,9 +103,9 @@
\o Open a project for an application you want to develop for the
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
......
......@@ -40,7 +40,7 @@
\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
copies the application files to the connected device. You
can test and debug the application on the device.
......@@ -48,14 +48,14 @@
Maemo 5 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
build directory and deploys it to the connected device, or copies
the application files to the connected device. You can test and
debug the application on the device.
\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 Qt libraries to use.
\endlist
......@@ -68,7 +68,7 @@
When you are ready to publish the application on a publishing
channel, you must make sure that the installation file meets the
requirements for publishing and installing applications to the
target devices.
targeted devices.
\endlist
*/
......@@ -49,7 +49,7 @@
with the parts of the user interface, go to \l{User Interface}.
\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
an example application and run it. If you have not done so
before, go to \l{Building and Running an Example}.
......
......@@ -43,7 +43,8 @@
into binaries. Different build configurations allow you to
quickly build the project for different purposes.
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
application but that you can leave out from the release version.
Generally, you use the debug configuration for testing and the
......@@ -79,6 +80,15 @@
copied to a location in the file system of the development PC or
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
\o Mode
\target glossary-mode
......@@ -102,14 +112,15 @@
\target glossary-project-qt
\o \QC allows you to have multiple versions of Qt installed on your
development PC and use different versions to build your projects
for different \e targets.
for different purposes.
\row
\o Run configuration
\target glossary-run-config
\o Starts the application in the location where it was copied by
the \e {deploy configuration}. By default, when you run a
project, \QC builds it, deploys it to the selected \e target,
project, \QC builds it, deploys it to the device specified in the selected
\l{glossary-buildandrun-kit}{kit},
and runs it there. However, if you have not made any changes to
the project since you last built and deployed it, \QC simply
runs it again.
......@@ -126,23 +137,6 @@
if you need many build configurations for a single set of
source files.
\row
\o Target
\target glossary-development-target
\o \QC groups platform specific settings as targets to make
cross-platform development easier. Each target consists of a set
of values that define one environment, such as a device,
tool chain, Qt version, and debugger command to use.
\row
\o Tool chain
\target glossary-tool-chain
\o Specifies a compiler and a debugger and other necessary
tools for building an application for a particular \e target.
\QC tries to detect the tool chains that are available on your
system. You can manually add tool chains that are not detected
automatically.
\endtable
*/
......@@ -107,7 +107,7 @@
\if defined(qcmanual)
\o On Windows, you must create projects for Maemo 5 and Harmattan
targets on the same partition where you installed \QSDK, \QC, and
device types on the same partition where you installed \QSDK, \QC, and
MADDE.
\endif
......
......@@ -32,7 +32,8 @@
\title Connecting Mobile Targets
You can connect mobile devices to the development PC to build, run, debug,
and analyze applications on them from \QC. When you install mobile targets
and analyze applications on them from \QC. When you install
\l{glossary-buildandrun-kit}{kits} for building and running on mobile targets
as part of the \QSDK, the build and run settings for the target devices are
set up automatically in \QC. However, \QSDK does not contain a tool chain
for building applications for embedded Linux devices.
......
......@@ -87,9 +87,10 @@
and commands used to build the project.
\QC provides support for building, running, and deploying Qt
applications for desktop environment and mobile devices. Build,
applications for desktop environment and mobile devices.
\l{glossary-buildandrun-kit}{Kits}, build,
run, and deployment settings allow you to quickly switch between
targets.
different setups and targets.
For more information, see \l{Building and Running}.
\o \bold {\l{Debugging and Analyzing}}
......
......@@ -50,22 +50,22 @@
\o Select \gui Projects to configure the project:
\image qtcreator-gs-build-example-targets.png "Selecting targets"
\image qtcreator-gs-build-example-targets.png "Selecting kit for building and running"
\list 1
\o Select at least \QS and one of the mobile
\l{glossary-development-target}{targets} (1), Maemo 5 or
\l{glossary-buildandrun-kit}{kits} (1), Maemo 5 or
MeeGo Harmattan, depending on the device you develop for.
\o Select \gui {Configure Project} (2).
\endlist
\o To test the application in \QS, click the \gui {Target
\o To test the application in \QS, click the \gui {Kit
Selector} and select \gui {\QS}.
\image qtcreator-gs-build-example-select-qs.png "Selecting Qt Simulator as target"
\image qtcreator-gs-build-example-select-qs.png "Selecting Qt Simulator as target device type"
\o Click
\inlineimage qtcreator-run.png
......
......@@ -34,20 +34,24 @@
\image creator_buildingrunning.png
\QC provides support for building, running, and deploying Qt applications
for different \l{glossary-development-target}{targets}.
for different targets, or using different compilers, debuggers or Qt versions.
\l{glossary-buildandrun-kit}{Kits} define the tools,
device type and other settings to use when building and running your project.
\list
\o \l{Building for Multiple Targets}
\e {Build configurations} contain everything you need to compile
the sources into binaries.
the sources into binaries. Build configurations use the tools and settings
defined in their corresponding \l{glossary-buildandrun-kit}{kit}.
\o \l{Running on Multiple Targets}
\e {Run configurations} start the application in the location
where it was copied by the \e{deploy configuration}. By default,
when you select the \gui Run function, \QC builds the project,
deploys it to the selected target, and runs it there. However,
deploys it to the target defined in the \l{glossary-buildandrun-kit}{kit},
and runs it there. However,
if you have not made any changes to the project since you last
built and deployed it, \QC simply runs it again.
......@@ -60,8 +64,8 @@
\o \l{Connecting Mobile Targets}
When you install tool chains for build targets as part of the \QSDK,
the build and run settings for mobile device targets are set up
When you install tool chains for device types as part of the \QSDK,
the build and run settings for mobile device types are set up
automatically. However, you might need to install and configure some
additional software on the devices to be able to connect to them
from the development PC.
......@@ -75,7 +79,7 @@
\o \l{Customizing the Build Process}
By default, running an application also builds it and deploys it to
a location from where it can be run on the target. You can change
a location from where it can be run on the target device. You can change
the relationship between the build, run, and deploy configurations.
\o \l{http://doc.qt.nokia.com/qtsimulator/index.html}
......@@ -89,7 +93,9 @@
Therefore, applications that run well on \QS also run on
any device that hosts the Qt and Qt Mobility libraries.
The \QS is installed as part of the \QSDK. After it is
installed, you can select it as a build target in \QC.
installed, you can create a \l{glossary-buildandrun-kit}{kit}
with \gui Desktop device type and the Qt Simulator Qt version for
building and running your projects.
\o \l{Using Maemo or MeeGo Harmattan Emulator}
......
......@@ -31,12 +31,15 @@
\title Building for Multiple Targets
You can build applications for multiple \l{glossary-development-target}
{targets}. By default, when you run the application on a target, you
automatically build it for the target and deploy it to the target first.
You can build applications for multiple targets, or using different compilers,
debuggers or Qt versions. \l{glossary-buildandrun-kit}{Kits} define the tools,
device type and other settings to use.
By default, when you run the application, you
automatically build and deploy it first.
However, you can also perform each operation separately.
To check that the application code can be compiled and linked for a target,
To check that the application code can be compiled and linked for a device,
you can build the project. The build errors and warnings are displayed in
the \gui {Issues} output pane. More detailed information is displayed
in the \gui {Compile Output} pane.
......@@ -45,9 +48,9 @@
\list 1
\o Select a target for the project.
\o Select a \l{glossary-buildandrun-kit}{kit} for the project.
\image qtcreator-target-selector.png "Target selector"
\image qtcreator-kit-selector.png "Kit selector"
\o Choose \gui {Build > Build Project} or press \key {Ctrl+B}.
......
......@@ -33,9 +33,9 @@
Qt is supported on a variety of 32-bit and 64-bit platforms, and can
usually be built on each platform with GCC, a vendor-supplied compiler, or
a third party compiler. In \QC, a \l{glossary-development-target}{target}
specifies the compiler and other necessary tools for building an
application for a particular platform.
a third party compiler. In \QC, a \l{glossary-buildandrun-kit}{kit}
specifies the compiler and other necessary tools for building and running an
application on a particular platform.
\QC automatically detects the compilers that are registered by your system
or by an SDK. You can add compilers to build applications by using other
......@@ -64,8 +64,8 @@
the application binary interface (ABI) version from the list of available
versions. You can also create a custom ABI definition.
You specify the compiler to use for each target in \gui Tools >
\gui Options > \gui {Build & Run} > \gui Targets.
You specify the compiler to use for each kit in \gui Tools >
\gui Options > \gui {Build & Run} > \gui Kits.