From ef91b41663fbfe1b50dc7f3541620d7a8b3e53d6 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Thu, 14 Dec 2023 16:12:51 +0100 Subject: [PATCH] Doc: Remove "Setting Up" from build system reference topic titles - And split some of them into several topics. - Combine almost identical topics. - Put settings values into tables to make them easier to browse. Task-number: QTCREATORBUG-29361 Change-Id: I2ee5a65848ab3a4643cf5fafe5a654730166aab1 Reviewed-by: Christian Kandeler --- .../creator-projects-cmake-building.qdoc | 4 +- .../creator-projects-conan-building.qdoc | 17 ++-- .../src/conan/creator-projects-conan.qdoc | 8 +- .../creator-only/creator-preferences-nim.qdoc | 2 +- .../src/howto/creator-only/creator-vcpkg.qdoc | 2 +- ...reator-projects-incredibuild-building.qdoc | 93 ++++++++++++------- .../creator-projects-incredibuild.qdoc | 7 +- .../creator-projects-meson-building.qdoc | 5 +- .../src/meson/creator-projects-meson.qdoc | 2 +- .../creator-how-to-add-wizards.qdoc | 3 +- .../creator-how-to-select-build-systems.qdoc | 6 +- .../creator-projects-autotools.qdoc | 17 ++-- .../creator-projects-compilers.qdoc | 17 +--- .../creator-projects-creating.qdoc | 7 +- .../creator-only/creator-projects-nimble.qdoc | 47 +++++++--- .../creator-only/creator-projects-qbs.qdoc | 28 ++++-- .../creator-projects-settings-build-qbs.qdoc | 6 +- .../creator-projects-settings-build.qdoc | 2 +- .../creator-projects-settings-run.qdoc | 2 +- .../creator-only/qtquick-creating.qdoc | 2 +- 20 files changed, 167 insertions(+), 110 deletions(-) diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc index e5fedd06d60..6cc19684276 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc @@ -240,8 +240,8 @@ \section1 Using CMake with Conan - \QC can automatically set up the \l {Setting Up Conan} - {Conan package manager} for use with CMake. + \QC can automatically set up the \l {Conan Package Manager} for use with + CMake. Select \preferences > \uicontrol CMake \uicontrol General > \uicontrol {Package manager auto setup} to set the diff --git a/doc/qtcreator/src/conan/creator-projects-conan-building.qdoc b/doc/qtcreator/src/conan/creator-projects-conan-building.qdoc index a82f1d14be2..55f71c40d05 100644 --- a/doc/qtcreator/src/conan/creator-projects-conan-building.qdoc +++ b/doc/qtcreator/src/conan/creator-projects-conan-building.qdoc @@ -2,22 +2,23 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! - \previouspage creator-build-settings-incredibuild.html \page creator-build-settings-conan.html - \nextpage creator-run-settings.html + \previouspage creator-reference.html + + \ingroup creator-reference-build-configurations \title Conan Build Configuration - You can specify build steps for Conan. + \brief Settings for building applications with the Conan package manager. - For more information about configuring Conan, see \l{Setting Up Conan}. - - \section1 Conan Build Steps + Specify build settings for the selected \l{glossary-buildandrun-kit}{kit} in + \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Build > + \uicontrol {Build Settings}. To configure a project to be built using the Conan package manager, select \uicontrol {Add Build Step} > \uicontrol {Run Conan Install}. - \image qtcreator-build-steps-conan-install.png "Conan Install build step" + \image qtcreator-build-steps-conan-install.png {Conan Install build step} In the \uicontrol {Conan file} field, enter the location of the \e conanfile.txt file for the project. @@ -28,4 +29,6 @@ Select \uicontrol {Build missing} to build packages from source if binary packages are not found. + + \sa {Conan Package Manager} */ diff --git a/doc/qtcreator/src/conan/creator-projects-conan.qdoc b/doc/qtcreator/src/conan/creator-projects-conan.qdoc index 3136e2a5888..0e1f60e664b 100644 --- a/doc/qtcreator/src/conan/creator-projects-conan.qdoc +++ b/doc/qtcreator/src/conan/creator-projects-conan.qdoc @@ -7,7 +7,7 @@ \ingroup creator-reference-build-systems - \title Setting Up Conan + \title Conan Package Manager \brief The experimental Conan plugin integrates the Conan package manager. @@ -43,10 +43,10 @@ {conanfile.txt} file that specifies the needed libraries and packages. Then, you must edit the build settings of the project to specify the location of the file and the contents of the Conan install command. - For more information, see \l {Conan Build Steps}. Alternatively, you can automatically set up the Conan package manager for - use with CMake. For more information, see \l{Using CMake with Conan}. + use with CMake. - \sa {Enable and disable plugins} + \sa {Conan Build Configuration}, {Enable and disable plugins}, + {Using CMake with Conan} */ diff --git a/doc/qtcreator/src/editors/creator-only/creator-preferences-nim.qdoc b/doc/qtcreator/src/editors/creator-only/creator-preferences-nim.qdoc index a72320b71fe..a20eaae5b78 100644 --- a/doc/qtcreator/src/editors/creator-only/creator-preferences-nim.qdoc +++ b/doc/qtcreator/src/editors/creator-only/creator-preferences-nim.qdoc @@ -30,5 +30,5 @@ \uicontrol Projects > \uicontrol {Code Style}. \sa {Find preferences}, {Indent text or code}, - {Specify code style}, {Setting Up Nimble} + {Specify code style}, {Nimble} */ diff --git a/doc/qtcreator/src/howto/creator-only/creator-vcpkg.qdoc b/doc/qtcreator/src/howto/creator-only/creator-vcpkg.qdoc index 2a639e1808f..caca0bae0f9 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-vcpkg.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-vcpkg.qdoc @@ -10,7 +10,7 @@ \title vcpkg Package Manager \brief The experimental vcpkg plugin integrates the vcpkg C/C++ package - manager into \QC. + manager. \l {https://vcpkg.io/en/}{vcpkg} is available on all the \l{Supported Platforms}{supported development platforms}. diff --git a/doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdoc b/doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdoc index 117ac6d6ad7..f872adc77e6 100644 --- a/doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdoc +++ b/doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdoc @@ -16,9 +16,6 @@ You can specify build steps and clean steps for IncrediBuild. - For more information about configuring IncrediBuild, see - \l{Setting Up IncrediBuild}. - \section1 IncrediBuild Build Steps To use IncrediBuild, select \uicontrol {Add Build Step} > @@ -65,58 +62,90 @@ You can specify the following settings for Windows builds: - \list - \li \uicontrol {Profile.xml} defines how Automatic Interception + \table + \header + \li Setting + \li Value + \row + \li \uicontrol {Profile.xml} + \li Defines how Automatic Interception Interface handles processes in a distributed job. It is not necessary for Visual Studio or Make and Build tools builds, but can be used to add configuration options if those builds use processes that are not included in those packages. It is required to configure distributable processes in Dev Tools builds. - \li \uicontrol {Avoid local task execution} frees up resources on the + \row + \li \uicontrol {Avoid local task execution} + \li Frees up resources on the initiator machine. This might be beneficial for distribution if the initiator turns into a bottleneck for the build because of high CPU usage. - \li \uicontrol {Maximum CPUs to utilize in the build} specifies the + \row + \li \uicontrol {Maximum CPUs to utilize in the build} + \li Specifies the maximum amount of remote cores to use in the build. Overrides the corresponding global setting. - \li \uicontrol {Newest allowed helper machine OS} and - \uicontrol {Oldest allowed helper machine OS} specify the newest and + \row + \li \uicontrol {Newest allowed helper machine OS} + + \uicontrol {Oldest allowed helper machine OS} + \li Specify the newest and oldest operating system installed on a Helper machine to be allowed to participate as a Helper in the build. - \li \uicontrol {Build title} specifies a custom header line which will + \row + \li \uicontrol {Build title} + \li Specifies a custom header line which will be displayed in the beginning of the build output text. This title will also be used for the Build History and Build Monitor displays. - \li \uicontrol {Save IncrediBuild monitor file} writes a copy of the + \row + \li \uicontrol {Save IncrediBuild monitor file} + \li Writes a copy of the build progress (\c{.ib_mon}) file to the specified location. If only a folder name is given, IncrediBuild generates a GUID for the file name. A message that has the location of the saved \c{.ib_mon} file is added to the end of the build output. - \li \uicontrol {Suppress STDOUT} does not write anything to the standard - output. - \li \uicontrol {Output Log file} writes build output to a file. - \li \uicontrol {Show Commands in output} shows the command-line used by - IncrediBuild to build the file. - \li \uicontrol {Show Agents in output} shows the Agent used to build - each file. - \li \uicontrol {Show Time in output} shows the start and finish time for - each file built. - \li \uicontrol {Hide IncrediBuild Header in output} suppresses the - IncrediBuild header in the build output. - \li \uicontrol {Internal IncrediBuild logging level} overrides the + \row + \li \uicontrol {Suppress STDOUT} + \li Does not write anything to the standard output. + \row + \li \uicontrol {Output Log file} + \li Writes build output to a file. + \row + \li \uicontrol {Show Commands in output} + \li Shows the command-line that IncrediBuild uses to build the file. + \row + \li \uicontrol {Show Agents in output} + \li Shows the Agent used to build each file. + \row + \li \uicontrol {Show Time in output} + \li Shows the start and finish time for each file built. + \row + \li \uicontrol {Hide IncrediBuild Header in output} + \li Suppresses the IncrediBuild header in the build output. + \row + \li \uicontrol {Internal IncrediBuild logging level} + \li Overrides the internal Incredibuild logging level for this build. Does not affect output or any user accessible logging. Used mainly to troubleshoot issues with the help of IncrediBuild support. - \li \uicontrol {Set an Environment Variable} sets or overrides + \row + \li \uicontrol {Set an Environment Variable} + \li Sets or overrides environment variables for the context of the build. - \li \uicontrol {Stop on errors} stops the execution as soon as an error + \row + \li \uicontrol {Stop on errors} + \li Stops the execution as soon as an error is encountered. This is the default behavior in Visual Studio builds, but not for Make and Build tools or Dev Tools builds. - \li \uicontrol {Additional Arguments} are concatenated to the final - build console command line. - \li \uicontrol {Open Build Monitor} opens an IncrediBuild Build Monitor - that graphically displays the build's progress once the build - starts. - \endlist + \row + \li \uicontrol {Additional Arguments} + \li Arguments that are concatenated to the final build console command + line. + \row + \li \uicontrol {Open Build Monitor} + \li Opens an IncrediBuild Build Monitor that graphically displays the + build's progress once the build starts. + \endtable \section1 IncrediBuild Clean Steps @@ -127,5 +156,5 @@ \sa {Activate kits for a project}, {Add clean steps}, {Configure projects for building}, {Configure projects for running}, - {Open projects}, {Configuring projects}, {Setting Up IncrediBuild} + {Open projects}, {Configuring projects}, {IncrediBuild} */ diff --git a/doc/qtcreator/src/incredibuild/creator-projects-incredibuild.qdoc b/doc/qtcreator/src/incredibuild/creator-projects-incredibuild.qdoc index 4cd352fb289..ba124cb8f81 100644 --- a/doc/qtcreator/src/incredibuild/creator-projects-incredibuild.qdoc +++ b/doc/qtcreator/src/incredibuild/creator-projects-incredibuild.qdoc @@ -7,7 +7,7 @@ \ingroup creator-reference-build-systems - \title Setting Up IncrediBuild + \title IncrediBuild \brief IncrediBuild decreases the time it takes to build C++ code. @@ -21,6 +21,7 @@ {IncrediBuild for Qt Creator}. To use IncrediBuild, install IncrediBuild Agent on the development - host. Then specify IncrediBuild build steps for your project. For - more information, see \l{IncrediBuild Build Steps}. + host. Then specify IncrediBuild build steps for your project. + + \sa {IncrediBuild Build Configuration} */ diff --git a/doc/qtcreator/src/meson/creator-projects-meson-building.qdoc b/doc/qtcreator/src/meson/creator-projects-meson-building.qdoc index f5f6f694c06..d0ada5efced 100644 --- a/doc/qtcreator/src/meson/creator-projects-meson-building.qdoc +++ b/doc/qtcreator/src/meson/creator-projects-meson-building.qdoc @@ -33,8 +33,6 @@ cross file instead, specify the file name in \uicontrol Parameters. For example, \c {--cross-file cross_file.txt}. - For more information about using Meson, see \l{Setting Up Meson}. - \section1 Meson Build Steps \QC builds Meson projects by running \c {ninja -v target}. @@ -56,5 +54,6 @@ The build errors and warnings are parsed and displayed in \uicontrol Issues. \sa {Activate kits for a project}, {Configure projects for building}, - {Configure projects for running}, {Open projects}, {Configuring projects} + {Configure projects for running}, {Open projects}, {Configuring projects}, + {Meson} */ diff --git a/doc/qtcreator/src/meson/creator-projects-meson.qdoc b/doc/qtcreator/src/meson/creator-projects-meson.qdoc index 44b25eed93d..0c08edc2718 100644 --- a/doc/qtcreator/src/meson/creator-projects-meson.qdoc +++ b/doc/qtcreator/src/meson/creator-projects-meson.qdoc @@ -7,7 +7,7 @@ \ingroup creator-reference-build-systems - \title Setting Up Meson + \title Meson \brief Use Meson to build native desktop applications. diff --git a/doc/qtcreator/src/projects/creator-only/creator-how-to-add-wizards.qdoc b/doc/qtcreator/src/projects/creator-only/creator-how-to-add-wizards.qdoc index 1181b3a9cdb..fa7663f02d7 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-how-to-add-wizards.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-how-to-add-wizards.qdoc @@ -3,8 +3,7 @@ /*! \page creator-how-to-add-wizards.html - \previouspage creator-project-qmake-libraries.html - \nextpage creator-version-control.html + \previouspage creator-how-tos.html \ingroup creator-how-to-projects-create diff --git a/doc/qtcreator/src/projects/creator-only/creator-how-to-select-build-systems.qdoc b/doc/qtcreator/src/projects/creator-only/creator-how-to-select-build-systems.qdoc index b8ed422cdfe..3bb5693f7e3 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-how-to-select-build-systems.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-how-to-select-build-systems.qdoc @@ -24,11 +24,11 @@ \li \l {https://mesonbuild.com/}{Meson} is a fast and user-friendly open-source build system that aims to minimize the time developers spend writing or debugging build definitions and waiting for the build system - to start compiling code. For more information, see \l {Setting Up Meson}. + to start compiling code. For more information, see \l {Meson}. \li \l{Qbs Manual}{Qbs} is an all-in-one build tool that generates a build graph from a high-level project description (like qmake or CMake do) and executes the commands in the low-level build graph (like make does). For more - information, see \l{Setting Up Qbs}. + information, see \l{qbs-build-system}{Build Systems: Qbs}. \endlist Typically, you select the build system when you create a project. @@ -57,5 +57,5 @@ \uicontrol Projects mode. \sa {Configure projects for building}, {Configure projects for running}, - {Build Systems}, {Use project wizards} + {Build Systems}{Reference: Build Systems}, {Use project wizards} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-autotools.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-autotools.qdoc index 7cf87b25684..0a0509e8f45 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-autotools.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-autotools.qdoc @@ -7,14 +7,17 @@ \ingroup creator-reference-build-systems - \title Setting Up an Autotools Project + \title Autotools - \brief \QC can open projects that use the Autotools build system. You can + \brief With Autotools, you can create a portable, complete, and + self-contained GNU Build System from simple instructions. + + \QC can open projects that use the Autotools build system. You can build and run the projects directly from \QC. - The AutotoolsProjectManager is a plugin for autotools support. + \note Enable the AutotoolsProjectManager plugin to use it. - \note Enable the Autotools plugin to use it. + \section1 Working with Autotools Projects To work with your Autotools project in \QC: @@ -31,9 +34,9 @@ \image qtcreator-autotools-buildrun.png - \li Select \uicontrol Run to build and run the application. The - predefined build steps (autogen.sh or autoreconf, configure, and - make) are executed. + \li Select \inlineimage icons/run_small.png (\uicontrol Run) to execute + the predefined build steps (\c autogen.sh or \c autoreconf, + \c configure, and \c make). The first time you run the application you must choose the executable. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc index a14ada89947..6e0b789358b 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc @@ -94,7 +94,7 @@ \li A C++ compiler that is installed with Microsoft Visual Studio. \row \li Nim - \li The Nim Compiler for Windows, Linux, and \macos. + \li The Nim compiler for Windows, Linux, and \macos. \row \li QCC \li The interface for compiling C++ applications for QNX. @@ -255,21 +255,6 @@ {Supported Platforms} */ -/*! - \page creator-how-to-add-nim-compilers.html - \previouspage creator-how-tos.html - - \ingroup creator-how-to-manage-kits - - \title Add Nim compilers - - To build an application using the Nim Compiler, select \preferences > - \uicontrol Kits > \uicontrol Compilers > \uicontrol Add > \uicontrol Nim, - and specify the path to the directory where the compiler is located. - - \sa {Add compilers}, {Compilers} -*/ - /*! \page creator-how-to-add-custom-compilers.html \previouspage creator-how-tos.html diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc index c94870b6db1..91cf7477158 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc @@ -131,8 +131,8 @@ code snippets. \row \li Non-Qt project - \li Create plain C or C++ applications or \l {Setting Up Nimble} - {Nim or Nimble} applications (experimental) + \li Create plain C or C++ applications or \l {Create Nimble projects} + {Nim or Nimble} applications (experimental). \row \li Imported project \li Import projects from a supported \l{Version Control Systems} @@ -170,7 +170,8 @@ \uicontrol Impl there. \sa {Assign keyboard shortcuts}, {Activate kits for a project}, - {Create files}, {Creating Projects} + {Create files}, {Create Projects}{How To: Create Projects}, + {Creating Projects} */ /*! diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc index 4062cf775e5..c85da814661 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2020 The Qt Company Ltd. +// Copyright (C) 2023 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! @@ -7,10 +7,10 @@ \ingroup creator-reference-build-systems - \title Setting Up Nimble + \title Nimble - \brief The Nimble package manager generates Nim application - executables that are supported on Windows, Linux, and \macos. + \brief The Nimble package manager uses the Nim compiler to generate Nim + application executables for the desktop platforms. \l {https://github.com/nim-lang/nimble#readme}{Nimble} is a package manager for the Nim programming language. It is delivered with @@ -19,14 +19,26 @@ \note Enable the Nim plugin to use Nimble and Nim. - In addition, you have to download and install Nim and set up a Nim kit - in \QC. + In addition, you have to download and install Nim and set up a + \l {glossary-buildandrun-kit}{kit} that contains the Nim compiler. You can use wizards to create Nim and Nimble projects. - \section1 Setting Up the Development Environment + \sa {Add Nim compilers}, {Create Nimble projects}, {Nim} +*/ - To configure \QC to build Nim executables: +/*! + \page creator-how-to-add-nim-compilers.html + \previouspage creator-how-tos.html + + \ingroup creator-how-to-manage-kits + + \title Add Nim compilers + + The Nimble package manager uses the Nim compiler to generate Nim + application executables for the desktop platforms. + + To build an application using the Nim compiler: \list 1 \li Select \preferences > \uicontrol Kits > @@ -44,10 +56,19 @@ \endlist \endlist - \section1 Creating Nimble Applications + \sa {Add compilers}, {Compilers}, {Create Nimble projects}, {Nim}, {Nimble} +*/ - To use a wizard to create boilerplate files for a Nim package that is - managed with Nimble: +/*! + \page creator-how-to-create-nimble.html + \previouspage creator-how-tos.html + + \ingroup creator-how-to-projects-create + + \title Create Nimble projects + + To use a wizard to create boilerplate files for a Nim package that you + manage with Nimble: \list 1 \li Select \uicontrol File > \uicontrol {New Project} > @@ -57,8 +78,10 @@ \li Select \uicontrol Next. \li Specify information about your application package. \image qtcreator-project-nimble.png + \li Select \uicontrol Next to select a kit that contains the Nim + compiler. \li Select \uicontrol Next to create the project. \endlist - \sa {Enable and disable plugins} + \sa {Add Nim compilers}, {Enable and disable plugins}, {Nim}, {Nimble} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-qbs.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-qbs.qdoc index bf88413305f..abdad87807e 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-qbs.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-qbs.qdoc @@ -7,7 +7,8 @@ \ingroup creator-reference-build-systems - \title Setting Up Qbs + \target qbs-build-system + \title Qbs \brief \l{Qbs Manual}{Qbs} is an all-in-one build tool that generates a build graph from a high-level project description (like qmake or CMake do) and @@ -39,7 +40,21 @@ \endlist - \section1 Specifying Qbs Settings + \sa {Select the build system}, {Open projects}, + {qbs-preferences}{Preferences: Qbs}, {Qbs Build Configuration}, + {Specifying Run Settings} +*/ + +/*! + \page creator-preferences-qbs.html + \previouspage creator-reference.html + + \ingroup creator-reference-preferences + + \target qbs-preferences + \title Qbs + + \brief Set preferences for Qbs and Qbs profiles. 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 @@ -68,11 +83,6 @@ For more information, see \l{Edit Qbs profiles}. \endlist - \section1 Related Topics - - \list - \li \l {Open projects} - \li \l {Qbs Build Configuration} - \li \l {Specifying Run Settings} - \endlist + \sa {Open projects}, {qbs-build-system}{Build Systems: Qbs}, + {Qbs Build Configuration}, {Specifying Run Settings} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build-qbs.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build-qbs.qdoc index 57b193a1e20..f6594671bcf 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build-qbs.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build-qbs.qdoc @@ -36,7 +36,8 @@ For more information about the QML debugging options, see \l{Setting Up QML Debugging}. - For more information about configuring Qbs, see \l{Setting Up Qbs}. + For more information about configuring Qbs, see \l{qbs-preferences} + {Preferences: Qbs}. \section1 Qbs Build Steps @@ -136,4 +137,7 @@ The \uicontrol {Equivalent command line} field displays the clean command that is constructed based on the selected options. + + \sa {qbs-build-system}{Build Systems: Qbs}, + {qbs-preferences}{Preferences: Qbs} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc index ee32aee0806..31bc8204d4a 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc @@ -107,7 +107,7 @@ \li \l{qmake Build Steps}{qmake} \li \l{Qbs Build Steps}{Qbs} \li \l{Meson Build Steps}{Meson} - \li \l{Conan Build Steps}{Conan} + \li \l{Conan Build Configuration}{Conan} \endlist You can use \l{IncrediBuild Build Steps}{IncrediBuild} to accelerate the diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc index 461ef91fa1b..18a0455163c 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc @@ -109,7 +109,7 @@ \title Specify a custom executable to run - If you use \l{Setting Up Meson}{Meson} or the + If you use \l{Meson} or the \l{Setting Up a Generic Project}{generic project type}, or want to run a custom desktop executable, create a \uicontrol {Custom Executable} run configuration for your project. For example, when working on a library, diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc index 42e3b987c2c..bf7b1bf5e7d 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc @@ -68,7 +68,7 @@ \li In the \uicontrol {Build system} field, select the build system to use for building and running the project: \l {CMake} - {CMake} or \l {Setting Up Qbs}{Qbs}. + {CMake} or \l {qbs-build-system}{Qbs}. \li Select \uicontrol Next to open the \uicontrol {Define Project Details} dialog.