diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-11-01 11:42:39 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-11-03 09:03:45 +0000 |
commit | d679c8db821c325bade5652a069dd53b6a070fd7 (patch) | |
tree | d5f650c963762339a7b80e61e8fbe3222ad96b60 /doc | |
parent | af17830d7962b46a17421f00cf80aa3926e88a11 (diff) |
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>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/images/qtcreator-options-qbs.png | bin | 18180 -> 37688 bytes | |||
-rw-r--r-- | doc/images/qtcreator-qbs-profile-settings.png | bin | 0 -> 9918 bytes | |||
-rw-r--r-- | doc/src/projects/creator-projects-build-systems.qdocinc | 6 | ||||
-rw-r--r-- | doc/src/projects/creator-projects-qbs.qdoc | 54 | ||||
-rw-r--r-- | doc/src/projects/creator-projects-targets.qdoc | 36 |
5 files changed, 53 insertions, 43 deletions
diff --git a/doc/images/qtcreator-options-qbs.png b/doc/images/qtcreator-options-qbs.png Binary files differindex f46db113b0..40149a37e0 100644 --- a/doc/images/qtcreator-options-qbs.png +++ b/doc/images/qtcreator-options-qbs.png diff --git a/doc/images/qtcreator-qbs-profile-settings.png b/doc/images/qtcreator-qbs-profile-settings.png Binary files differnew file mode 100644 index 0000000000..e100701bd0 --- /dev/null +++ b/doc/images/qtcreator-qbs-profile-settings.png diff --git a/doc/src/projects/creator-projects-build-systems.qdocinc b/doc/src/projects/creator-projects-build-systems.qdocinc index 72e4e10970..8771fb693f 100644 --- a/doc/src/projects/creator-projects-build-systems.qdocinc +++ b/doc/src/projects/creator-projects-build-systems.qdocinc @@ -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, diff --git a/doc/src/projects/creator-projects-qbs.qdoc b/doc/src/projects/creator-projects-qbs.qdoc index 9ad54a7dae..2abe657f1f 100644 --- a/doc/src/projects/creator-projects-qbs.qdoc +++ b/doc/src/projects/creator-projects-qbs.qdoc @@ -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 - \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: - - \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. + To specify settings for Qbs, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run} > \uicontrol Qbs. - \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. + \image qtcreator-options-qbs.png - 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. + 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. + + 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 diff --git a/doc/src/projects/creator-projects-targets.qdoc b/doc/src/projects/creator-projects-targets.qdoc index b327354656..229bbc196e 100644 --- a/doc/src/projects/creator-projects-targets.qdoc +++ b/doc/src/projects/creator-projects-targets.qdoc @@ -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. + */ |