diff options
author | Leena Miettinen <riitta-leena.miettinen@nokia.com> | 2012-08-13 15:58:25 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@nokia.com> | 2012-08-15 10:11:32 +0200 |
commit | a5b4effb3a36464817a3585d9fcb469b9c5779d6 (patch) | |
tree | a81276cafa8db182521a312d247d5ef2a945e926 | |
parent | fec5ef3df9f7e2828627c1ed9ef7fa986f0338db (diff) | |
download | qt-creator-a5b4effb3a36464817a3585d9fcb469b9c5779d6.tar.gz |
Doc: target options
Related changes to tool chains and Qt versions.
Change-Id: I3a1923f8dd84321dd78c969d14c15c52b17d5ae2
Reviewed-by: Tobias Hunger <tobias.hunger@nokia.com>
-rw-r--r-- | doc/images/qtcreator-qt4-qtversions-add.png | bin | 27949 -> 11952 bytes | |||
-rw-r--r-- | doc/images/qtcreator-targets.png | bin | 0 -> 14163 bytes | |||
-rw-r--r-- | doc/images/qtcreator-toolchains.png | bin | 16659 -> 12063 bytes | |||
-rw-r--r-- | doc/src/overview/creator-glossary.qdoc | 12 | ||||
-rw-r--r-- | doc/src/projects/creator-projects-qt-versions.qdoc | 19 | ||||
-rw-r--r-- | doc/src/projects/creator-projects-settings-build.qdoc | 3 | ||||
-rw-r--r-- | doc/src/projects/creator-projects-settings-overview.qdoc | 12 | ||||
-rw-r--r-- | doc/src/projects/creator-projects-targets.qdoc | 120 | ||||
-rw-r--r-- | doc/src/projects/creator-projects-tool-chains.qdoc | 10 | ||||
-rw-r--r-- | doc/src/qtcreator.qdoc | 1 | ||||
-rw-r--r-- | doc/src/qtquick/qtquick-app-tutorial.qdoc | 5 | ||||
-rw-r--r-- | doc/src/qtquick/qtquick-creating.qdoc | 7 | ||||
-rw-r--r-- | doc/src/widgets/qtdesigner-app-tutorial.qdoc | 5 |
13 files changed, 156 insertions, 38 deletions
diff --git a/doc/images/qtcreator-qt4-qtversions-add.png b/doc/images/qtcreator-qt4-qtversions-add.png Binary files differindex ef59a4185c..2857a28bd8 100644 --- a/doc/images/qtcreator-qt4-qtversions-add.png +++ b/doc/images/qtcreator-qt4-qtversions-add.png diff --git a/doc/images/qtcreator-targets.png b/doc/images/qtcreator-targets.png Binary files differnew file mode 100644 index 0000000000..d1e63ee8d2 --- /dev/null +++ b/doc/images/qtcreator-targets.png diff --git a/doc/images/qtcreator-toolchains.png b/doc/images/qtcreator-toolchains.png Binary files differindex eee50fb667..8f38f27369 100644 --- a/doc/images/qtcreator-toolchains.png +++ b/doc/images/qtcreator-toolchains.png diff --git a/doc/src/overview/creator-glossary.qdoc b/doc/src/overview/creator-glossary.qdoc index 6493486f9d..aa0558705d 100644 --- a/doc/src/overview/creator-glossary.qdoc +++ b/doc/src/overview/creator-glossary.qdoc @@ -102,8 +102,7 @@ \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. Select the Qt version in the \e {build - configuration} for the project. + for different \e targets. \row \o Run configuration @@ -130,11 +129,10 @@ \row \o Target \target glossary-development-target - \o The software platform for which you develop an - application. \QC groups platform specific settings (such as - \e {build configurations}, \e {deploy configurations}, - compatible \e {tool chains}, and supported \e {Qt versions}) as - targets to make cross-platform development easier. + \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 diff --git a/doc/src/projects/creator-projects-qt-versions.qdoc b/doc/src/projects/creator-projects-qt-versions.qdoc index 9fac13fe5e..89fff7b689 100644 --- a/doc/src/projects/creator-projects-qt-versions.qdoc +++ b/doc/src/projects/creator-projects-qt-versions.qdoc @@ -25,7 +25,7 @@ /*! \contentspage index.html - \previouspage creator-build-settings.html + \previouspage creator-targets.html \page creator-project-qmake.html \nextpage creator-tool-chains.html @@ -36,21 +36,14 @@ For example, \QSDK contains special Qt versions for developing applications for mobile devices. - \QC checks the directories listed in the \c{PATH} environment - variable for the qmake executable. If a qmake executable is found, it is - referred to as \bold{Qt in PATH} and selected as the Qt version to use - in the \gui Projects mode in the \gui {Build Settings}. If \QC - cannot find qmake, the value in the \gui {Qt version} field might be - invalid and you might need to change it. - \QC automatically detects the Qt versions that are registered by - your system or by \QSDK. To view the settings for each Qt version, move the - mouse pointer over it in the list. To add Qt versions, select + your system or by \QSDK. To view detailed information for each Qt + version, select it in the list and select \gui Details in the + \gui {Qt version for} section. To add Qt versions, select \gui {Tools > Options > Build & Run > Qt Versions}. - Typically, you select the Qt versions for a project when you use project - wizards to create the project. You can add Qt versions for a project in - \gui {Build Settings}. + You specify the Qt version to use for each \l{glossary-development-target} + {target} in \gui Tools > \gui Options > \gui {Build & Run} > \gui Targets. \section2 Setting Up New Qt Versions diff --git a/doc/src/projects/creator-projects-settings-build.qdoc b/doc/src/projects/creator-projects-settings-build.qdoc index 4813096d45..279f5f675d 100644 --- a/doc/src/projects/creator-projects-settings-build.qdoc +++ b/doc/src/projects/creator-projects-settings-build.qdoc @@ -27,7 +27,7 @@ \contentspage index.html \previouspage creator-configuring-projects.html \page creator-build-settings.html - \nextpage creator-project-qmake.html + \nextpage creator-targets.html \title Specifying Build Settings @@ -194,6 +194,7 @@ \list + \o \l{Adding Targets} \o \l{Adding Qt Versions} \o \l{Adding Tool Chains} diff --git a/doc/src/projects/creator-projects-settings-overview.qdoc b/doc/src/projects/creator-projects-settings-overview.qdoc index f83fd6fe42..c6671e60b3 100644 --- a/doc/src/projects/creator-projects-settings-overview.qdoc +++ b/doc/src/projects/creator-projects-settings-overview.qdoc @@ -31,8 +31,11 @@ \title Configuring Projects - When you install the \QSDK, the build and run settings for the tool chains + \omit + When you install the \QSDK, the build and run settings for the development + targets delivered with the \QSDK are set up automatically. + \endomit To view and modify the settings for currently open projects, switch to the \gui Projects mode by pressing \key Ctrl+5. @@ -40,7 +43,10 @@ \image qtcreator-project-targets.png You can add a target if the development environment for the target platform - is installed on the development PC and the Qt version is configured. Click + is installed on the development PC and the target is configured in + \gui Tools > \gui Options > \gui {Build & Run} > \gui Targets. + + Click \inlineimage qtcreator-qt4-addbutton.png "Add Target button" and select from a list of available targets. To remove a target, select it and click @@ -54,7 +60,7 @@ \list - \o \l{Running on Multiple Targets}{Targets} + \o \l{Adding Targets}{Targets} \list diff --git a/doc/src/projects/creator-projects-targets.qdoc b/doc/src/projects/creator-projects-targets.qdoc new file mode 100644 index 0000000000..6f6cfef6e6 --- /dev/null +++ b/doc/src/projects/creator-projects-targets.qdoc @@ -0,0 +1,120 @@ +/**************************************************************************** +** +** This file is part of Qt Creator +** +** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies). +** +** Contact: http://www.qt-project.org/ +** +** +** GNU Free Documentation License +** +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** +****************************************************************************/ + +// ********************************************************************** +// NOTE: the sections are not ordered by their logical order to avoid +// reshuffling the file each time the index order changes (i.e., often). +// Run the fixnavi.pl script to adjust the links to the index order. +// ********************************************************************** + +/*! + \contentspage index.html + \previouspage creator-build-settings.html + \page creator-targets.html + \nextpage creator-project-qmake.html + + \title Adding Targets + + \QC groups platform specific settings as \e 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, and some metadata, such as an icon and a name for the target. Once + you have defined targets, you can select them to build and run projects. + + \QC supports development for the desktop and for the following types of + devices: + + \list + + \o Android Device + + \o Generic Linux Device + + \o Maemo5/Fremantle Device + + \o MeeGo 1.2 Harmattan Device + + \o QNX Device + + \endlist + + To add targets: + + \list 1 + + \o Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Targets + > \gui Add. + + \image qtcreator-targets.png + + To clone the selected target, select \gui Clone. + + \o In the \gui Name column, double-click the target name to change it. + + + + \o In the \gui{Device type} field, select the type of the device to + target. + + Double-click the icon next to the field to select the image that is + displayed in the target selector for this target. You can use any + image in a supported file format (for example, PNG). The image is + scaled to the size 64x64 pixels. For example, using the compiler + logo as an icon allows you to easily see, which compiler is used to + build the project for the selected target. + + \o In the \gui Device field, select the device configuration to target. + + \o In the \gui Sysroot field, specify the directory where the device + image is located. If you are not cross-compiling, leave this field + empty. + + \o In the \gui {Tool chain} field, select the tool chain required + to build the project. You can add tool chains to the list + if they are installed on the development PC, but were not detected + automatically. For more information, see \l{Adding Tool Chains}. + + \note The \gui {Symbian Device} target uses the GCCE tool chain by + default. To use RVCT for building, install the RVCT tool chain, and + then select it in the \gui {Tool chain} field. RVCT 2.2 is supported + on Symbian^3 and earlier. RVCT 4.0 b902 or later is required for + Symbian Belle. + + \o In the \gui {Debugger command} field, specify the path to the + debugger command. On Windows, specify the path to the Windows + Console Debugger executable (32-bit version). + Select \gui {Auto detect} to automatically locate the debugger + command. + + \o In the \gui {Qt version} field, select the Qt version to use for + building the project. You can add Qt versions to the list if they + are installed on the development PC, but were not detected + automatically. For more information, see \l{Adding Qt Versions}. + + \QC checks the directories listed in the \c{PATH} environment + variable for the qmake executable. If a qmake executable is found, + it is referred to as \bold{Qt in PATH} and selected as the Qt + version to use for the \gui Desktop target. + + \o In the \gui {Qt mkspec} field, specify build instructions for qmake. + If you leave this field empty, the default value is used. + + \endlist + +*/ diff --git a/doc/src/projects/creator-projects-tool-chains.qdoc b/doc/src/projects/creator-projects-tool-chains.qdoc index 0366211955..b1d4bd3b24 100644 --- a/doc/src/projects/creator-projects-tool-chains.qdoc +++ b/doc/src/projects/creator-projects-tool-chains.qdoc @@ -31,7 +31,7 @@ \title Adding Tool Chains - A \e {tool chain} specifies a compiler and a debugger and other necessary + A \e {tool chain} specifies a compiler and other necessary tools for building an application that is \l{glossary-development-target} {targeted} for a particular platform. \QC automatically detects the tool chains that are registered by your system or by \QSDK. @@ -53,7 +53,7 @@ for Linux. \o Clang is a C, C++, Objective C, and Objective C++ front-end for the - LLVM compiler for Windows, Linux, Mac OS X, and Symbian. + LLVM compiler for Windows, Linux, and Mac OS X. \o GCCE (GNU Compiler Collection for Embedded) is an ARM-based compiler used in Symbian OS 9 and distributed together with \QSDK. @@ -70,12 +70,12 @@ \endlist To build an application using GCC, MinGW, GCCE, or Clang, specify the paths - to the directories where the compiler and debugger are located and select + to the directories where the compiler is located and select the application binary interface (ABI) version from the list of available versions. You can also create a custom ABI definition. - \QC allows you to select a tool chain that matches the Qt version - in the \gui Projects mode \gui {Build Settins}. + You specify the tool chain to use for each \l{glossary-development-target} + {target} in \gui Tools > \gui Options > \gui {Build & Run} > \gui Targets. To add tool chains: diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc index c0bb733d49..1271d9a80e 100644 --- a/doc/src/qtcreator.qdoc +++ b/doc/src/qtcreator.qdoc @@ -171,6 +171,7 @@ \list \o \l{Specifying Build Settings} \list + \o \l{Adding Targets} \o \l{Adding Qt Versions} \o \l{Adding Tool Chains} \endlist diff --git a/doc/src/qtquick/qtquick-app-tutorial.qdoc b/doc/src/qtquick/qtquick-app-tutorial.qdoc index 3b85eade64..2581ef7978 100644 --- a/doc/src/qtquick/qtquick-app-tutorial.qdoc +++ b/doc/src/qtquick/qtquick-app-tutorial.qdoc @@ -64,9 +64,8 @@ \o Select targets, and then click \gui{Next}. - \note Targets are listed if you installed the appropriate - development environment, for example, as part of the \QSDK. You can - add targets later in the \gui Projects mode. + \note Targets are listed if they have been specified in \gui Tools > + \gui Options > \gui {Build & Run} > \gui Targets. \o Select \gui Next in the following dialogs to use the default settings. diff --git a/doc/src/qtquick/qtquick-creating.qdoc b/doc/src/qtquick/qtquick-creating.qdoc index 707e0b87c2..f9d042e19f 100644 --- a/doc/src/qtquick/qtquick-creating.qdoc +++ b/doc/src/qtquick/qtquick-creating.qdoc @@ -160,12 +160,11 @@ \image qmldesigner-new-project-qt-versions.png "Target Setup dialog" - \o Select the Qt versions to use as build targets for your project, + \o Select build targets for your project, and then click \gui{Next}. - \note Qt Quick is supported since Qt 4.7, and therefore, only Qt 4.7 - and later versions are displayed. Further, if you have only one - supported Qt version installed, this dialog is skipped. + \note If only one target is specified in \gui Tools > \gui Options > + \gui {Build & Run} > \gui Targets, this dialog is skipped. The \gui {Mobile Options} dialog opens. diff --git a/doc/src/widgets/qtdesigner-app-tutorial.qdoc b/doc/src/widgets/qtdesigner-app-tutorial.qdoc index 57c769998b..410c3a0c5d 100644 --- a/doc/src/widgets/qtdesigner-app-tutorial.qdoc +++ b/doc/src/widgets/qtdesigner-app-tutorial.qdoc @@ -61,10 +61,11 @@ \image qtcreator-new-project-qt-versions-qt-gui.png "Target Setup dialog" - \o Select the Qt versions to use as build targets for your project, + \o Select build targets for your project, and click \gui{Next}. - \note If you have only one Qt version installed, this dialog is + \note If only one target is specified in \gui Tools > \gui Options > + \gui {Build & Run} > \gui Targets, this dialog is skipped. The \gui{Class Information} dialog opens. |