Doc: Update info about Qbs options

Qbs profiles can be edited in the Kits tab in Options.
Qbs settings are now a tab in Build and Run options.

Change-Id: Ibb45ff4488cb061a50f48ec3237265ce5776fa24
Reviewed-by: Jake Petroules <jake.petroules@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2017-11-01 11:42:39 +01:00
parent af17830d79
commit d679c8db82
5 changed files with 52 additions and 42 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB

View File

@@ -57,10 +57,8 @@
To change the location of the project directory, and to specify settings
for building and running projects, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol General. The
\uicontrol CMake tab contains additional CMake settings.
To specify build profiles for Qbs, select \uicontrol Tools >
\uicontrol Options > \uicontrol Qbs.
\uicontrol CMake and \uicontrol Qbs tabs contain additional settings for
those build systems.
To specify build and run settings for different target platforms,
select \uicontrol Projects. For more information on the options you have,

View File

@@ -41,7 +41,7 @@
kit. You can edit the build profiles by adding new keys and values.
To check which Qbs version is being used, select \uicontrol Tools >
\uicontrol Options > \uicontrol Qbs > \uicontrol {Version Info}.
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Qbs.
\section1 Building Qbs
@@ -57,46 +57,24 @@
\endlist
\section1 Editing Build Profiles
\section1 Specifying Qbs Settings
To specify settings for Qbs, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Qbs.
\image qtcreator-options-qbs.png
You can modify a build profile that is associated with a build and run kit
by editing the values of the keys generated by \QC and by adding new values:
By default, Qbs profiles are stored in the \c qbs directory in the \QC
settings directory to ensure that different \QC instances do not overwrite
each other's profiles. If you only run one \QC instance, you can store the
profiles in the Qbs settings directory instead, by deselecting the
\uicontrol {Store profiles in Qt Creator settings directory} check box.
\list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Qbs.
\li By default, Qbs profiles are stored in the \c qbs directory in the
\QC settings directory to ensure that different \QC instances do not
overwrite each other's profiles. If you only run one \QC instance,
you can store the profiles in the Qbs settings directory instead,
by deselecting the \uicontrol {Store profiles in Qt Creator settings
directory} check box.
\li In the \uicontrol Kit field, select a build and run kit.
\li Select \uicontrol Edit to edit the profile associated with the kit.
\li Select \uicontrol Add to add keys and values to the profile or to
modify existing values.
\li In the \uicontrol Key column, spefify the key to add or modify as:
\c <module_name>.<property_name>.
\li In the \uicontrol Value column, specify a value as a JSON literal.
\li Click \uicontrol OK.
\endlist
The values that you have modified are displayed in red in the
\uicontrol {Profile properties} field.
For a list of available keys and values, see the
\l{http://doc.qt.io/qbs/list-of-modules.html}{List of Modules} in the
Qbs Manual.
In the \uicontrol Kit field, select a build and run kit to view the
properties of the associated Qbs profile. To modify the properties of the
Qbs profile associated with a kit, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. For more
information, see \l{Editing Qbs Profiles}.
\section1 Related Topics

View File

@@ -142,7 +142,7 @@
\li In the \uicontrol {Additional Qbs profile settings} field, select
\uicontrol Change to add settings to Qbs build profiles. For more
information, see \l {Editing Build Profiles}.
information, see \l {Editing Qbs Profiles}.
\endlist
@@ -150,4 +150,38 @@
choose the kit to use. To set the selected kit as the default kit,
select \uicontrol {Make Default}.
\section1 Editing Qbs Profiles
To view the Qbs profile associated with the kit, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Qbs.
You can add keys and values to the profile or remove them from it, as well
as modify existing values. For a list of available keys and values, see
\l{http://doc.qt.io/qbs/list-of-modules.html}{List of Modules} in the Qbs
Manual.
To edit the Qbs profile associated with the kit:
\list 1
\li Select \uicontrol Change next to the
\uicontrol {Additional Qbs Profile Settings} field.
\image qtcreator-qbs-profile-settings.
\li Select \uicontrol Add.
\li In the \uicontrol Key column, spefify the key to add or modify as:
\c <module_name>.<property_name>.
\li In the \uicontrol Value column, specify a value as a JSON literal.
\li Click \uicontrol OK.
\endlist
To modify an existing value, double-click it in the \uicontrol Value field.
To remove the selected property, select \uicontrol Remove.
*/