feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Reorganize info about build settings by build system

Browse Source 
Change-Id: Iaee9cc581f76a45cc10c9ae8cba601889320be86
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2021-03-26 16:38:39 +01:00
parent 8d54fb22bc
commit 49c7f21891
7 changed files with 49 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/qtcreator/src/conan/creator-projects-conan-building.qdocinc → doc/qtcreator/src/conan/creator-projects-conan-building.qdoc
+11 -5
View File
@@ -24,8 +24,17 @@
****************************************************************************/
/*!
//! [conan build steps]
\section1 Specifying Build Settings for Conan
\previouspage creator-build-settings-incredibuild.html
\page creator-build-settings-conan.html
\nextpage creator-run-settings.html
\title Conan Build Configuration
You can specify build steps for Conan.
For more information about configuring Conan, see \l{Setting Up Conan}.
\section1 Conan Build Steps
To configure a project to be built using the Conan package manager, select
\uicontrol {Add Build Step} > \uicontrol {Run Conan Install}.
@@ -38,7 +47,4 @@
The \uicontrol {Conan install} field displays the effective
build command. You can add arguments for the command in the
\uicontrol {Additional arguments} field.
For more information about configuring Conan, see \l{Setting Up Conan}.
//! [conan build steps]
*/
doc/qtcreator/src/conan/creator-projects-conan.qdoc
+1 -1
View File
@@ -62,5 +62,5 @@
{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 {Specifying Build Settings for Conan}.
For more information, see \l {Conan Build Steps}.
*/
doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdocinc → doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdoc
+15 -12
View File
@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -23,9 +23,18 @@
**
****************************************************************************/
/*!
//! [incredibuild build steps]
\previouspage creator-build-settings-meson.html
\page creator-build-settings-incredibuild.html
\nextpage creator-build-settings-conan.html
\section2 IncrediBuild Build Steps
\title IncrediBuild Build Configuration
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} >
\uicontrol {IncrediBuild for Linux} or
@@ -53,7 +62,7 @@
The distribution control settings to specify depend on whether you are using
Linux or Windows.
\section3 Distribution Control Settings on Linux
\section2 Distribution Control Settings on Linux
\image qtcreator-incredibuild-build-steps-linux.png
@@ -66,7 +75,7 @@
\li \uicontrol {Alternate tasks preference}
\endlist
\section3 Distribution Control Settings on Windows
\section2 Distribution Control Settings on Windows
\image qtcreator-incredibuild-build-steps-windows.png
@@ -125,11 +134,7 @@
starts.
\endlist
//! [incredibuild build steps]
//! [incredibuild clean steps]
\section2 IncrediBuild Clean Steps
\section1 IncrediBuild Clean Steps
When building with IncrediBuild, you can add arguments and targets for the
clean command in \uicontrol {Clean Steps}.
@@ -138,6 +143,4 @@
The build errors and warnings are parsed and displayed in the
\uicontrol Issues output pane.
//! [incredibuild clean steps]
*/
doc/qtcreator/src/meson/creator-projects-meson-building.qdocinc → doc/qtcreator/src/meson/creator-projects-meson-building.qdoc
+7 -15
View File
@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -23,9 +23,11 @@
**
****************************************************************************/
/*!
//! [meson build configuration]
\previouspage creator-build-settings-qbs.html
\page creator-build-settings-meson.html
\nextpage creator-build-settings-incredibuild.html
\section2 Meson Build Configuration
\title Meson Build Configuration
\image qtcreator-meson-build-settings.png
@@ -43,12 +45,7 @@
\note Any modified setting will remain in bold until \uicontrol
{Apply configuration changes} is selected.
//! [meson build configuration]
//! [meson build steps]
\section2 Meson Build Steps
\section1 Meson Build Steps
\QC builds Meson projects by running \c {ninja -v target}.
@@ -60,11 +57,7 @@
The build errors and warnings are parsed and displayed in the
\uicontrol Issues output pane.
//! [meson build steps]
//! [meson clean steps]
\section2 Meson Clean Steps
\section1 Meson Clean Steps
When building with Meson, you can add arguments and targets for the clean
command in \uicontrol {Clean Steps}.
@@ -74,5 +67,4 @@
The build errors and warnings are parsed and displayed in the
\uicontrol Issues output pane.
//! [meson clean steps]
*/
doc/qtcreator/src/meson/creator-projects-meson.qdoc
+1 -1
View File
@@ -111,7 +111,7 @@
\list
\li \l {Opening Projects}
\li \l {Specifying Build Settings}
\li \l {Meson Build Configuration}
\li \l {Specifying Run Settings}
\endlist
*/
doc/qtcreator/src/projects/creator-only/creator-projects-qbs.qdoc
+2 -2
View File
@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -89,7 +89,7 @@
\list
\li \l {Opening Projects}
\li \l {Specifying Build Settings}
\li \l {Qbs Build Configuration}
\li \l {Specifying Run Settings}
\endlist
*/
doc/qtcreator/src/projects/creator-only/creator-projects-settings-build-qbs.qdocinc → doc/qtcreator/src/projects/creator-only/creator-projects-settings-build-qbs.qdoc
+12 -11
View File
@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -24,9 +24,17 @@
****************************************************************************/
/*!
//! [qbs build steps]
\previouspage creator-build-settings-qmake.html
\page creator-build-settings-qbs.html
\nextpage creator-build-settings-meson.html
\section2 Qbs Build Steps
\title Qbs Build Configuration
You can specify build steps and clean steps for Qbs.
For more information about configuring Qbs, see \l{Setting Up Qbs}.
\section1 Qbs Build Steps
\image creator-qbs-build-app.png
@@ -95,12 +103,7 @@
The \uicontrol {Equivalent command line} field displays the build command
that is constructed based on the selected options.
//! [qbs build steps]
//! [qbs clean steps]
\section2 Qbs Clean Steps
\section1 Qbs Clean Steps
When building with Qbs, you can specify flags in \uicontrol {Clean Steps}:
@@ -118,6 +121,4 @@
The \uicontrol {Equivalent command line} field displays the clean command
that is constructed based on the selected options.
//! [qbs clean steps]
*/