aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2020-07-01 09:01:26 +0200
committerEike Ziller <eike.ziller@qt.io>2020-07-01 09:01:26 +0200
commit5a97e8ceb9e61d24dbd9d5dc24b8310aa6817f25 (patch)
tree3b788c67cdbceca612969df06d851a806de3d73b /doc
parent5143e6c8ba2b131378646fdb03ac0da4d2e30b56 (diff)
parentebf03b5c23e2222f52315b3544c93062910e9c5c (diff)
Merge remote-tracking branch 'origin/4.13'
Conflicts: src/plugins/android/androidsettingswidget.cpp Change-Id: Iadf1d58a1e867ae7bb2dca55d3951613cfcc3d07
Diffstat (limited to 'doc')
-rw-r--r--doc/qtcreator/images/qtcreator-kits.pngbin27172 -> 78166 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-meson-build-settings.pngbin0 -> 18693 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-meson-build-steps.pngbin0 -> 9760 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-meson-clean-steps.pngbin0 -> 9851 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-mesonexecutable.pngbin0 -> 41877 bytes
-rw-r--r--doc/qtcreator/src/analyze/creator-analyze.qdoc2
-rw-r--r--doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc8
-rw-r--r--doc/qtcreator/src/debugger/qtquick-debugging.qdoc2
-rw-r--r--doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc5
-rw-r--r--doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc2
-rw-r--r--doc/qtcreator/src/howto/creator-ui.qdoc4
-rw-r--r--doc/qtcreator/src/howto/creator-workspaces.qdoc4
-rw-r--r--doc/qtcreator/src/meson/creator-projects-meson-building.qdocinc78
-rw-r--r--doc/qtcreator/src/meson/creator-projects-meson.qdoc117
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc7
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc2
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc2
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-other.qdoc7
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc5
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc5
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc9
-rw-r--r--doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc2
-rw-r--r--doc/qtcreator/src/qtquick/qtquick-designer.qdoc2
-rw-r--r--doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc2
-rw-r--r--doc/qtdesignstudio/examples/doc/loginui1.qdoc2
-rw-r--r--doc/qtdesignstudio/examples/doc/loginui3.qdoc2
-rw-r--r--doc/qtdesignstudio/examples/doc/loginui4.qdoc2
-rw-r--r--doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc3
-rw-r--r--doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc20
-rw-r--r--doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc12
-rw-r--r--doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc41
-rw-r--r--doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc10
-rw-r--r--doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc31
-rw-r--r--doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc2
34 files changed, 311 insertions, 79 deletions
diff --git a/doc/qtcreator/images/qtcreator-kits.png b/doc/qtcreator/images/qtcreator-kits.png
index 4dfaa560f3..7ff9513320 100644
--- a/doc/qtcreator/images/qtcreator-kits.png
+++ b/doc/qtcreator/images/qtcreator-kits.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-meson-build-settings.png b/doc/qtcreator/images/qtcreator-meson-build-settings.png
new file mode 100644
index 0000000000..6686555054
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-meson-build-settings.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-meson-build-steps.png b/doc/qtcreator/images/qtcreator-meson-build-steps.png
new file mode 100644
index 0000000000..410d6ae059
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-meson-build-steps.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-meson-clean-steps.png b/doc/qtcreator/images/qtcreator-meson-clean-steps.png
new file mode 100644
index 0000000000..c84aa1d217
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-meson-clean-steps.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-mesonexecutable.png b/doc/qtcreator/images/qtcreator-mesonexecutable.png
new file mode 100644
index 0000000000..bfaa7cc1bd
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-mesonexecutable.png
Binary files differ
diff --git a/doc/qtcreator/src/analyze/creator-analyze.qdoc b/doc/qtcreator/src/analyze/creator-analyze.qdoc
index 06fe3ce1b7..cff0f46cb3 100644
--- a/doc/qtcreator/src/analyze/creator-analyze.qdoc
+++ b/doc/qtcreator/src/analyze/creator-analyze.qdoc
@@ -44,7 +44,7 @@
You can drag and drop the views in the \uicontrol Debug mode to new
positions on the screen. The size and position of views are saved for future
- sessions. Select \uicontrol Window > \uicontrol Views >
+ sessions. Select \uicontrol View > \uicontrol Views >
\uicontrol {Reset to Default Layout} to reset the views to their original
sizes and positions.
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
index e65407716c..be5b4edffb 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
@@ -608,7 +608,7 @@
program you are debugging. The availability of views depends on whether
you are debugging C++ or QML. Frequently used views are shown by
default and rarely used ones are hidden. To change the default settings,
- select \uicontrol Window > \uicontrol Views, and then select views to
+ select \uicontrol View > \uicontrol Views, and then select views to
display or hide. Alternatively, you can enable or disable views from the
context menu of the title bar of any visible debugger view.
@@ -616,10 +616,10 @@
You can drag and drop the views in \QC to new positions on the screen. The
size and position of views are saved for future sessions. Select
- \uicontrol Window > \uicontrol Views > \uicontrol {Reset to Default Layout}
+ \uicontrol View > \uicontrol Views > \uicontrol {Reset to Default Layout}
to reset the views to their original sizes and positions.
- To save space on the screen, select \uicontrol Window > \uicontrol Views >
+ To save space on the screen, select \uicontrol View > \uicontrol Views >
\uicontrol {Automatically Hide View Titlebars}.
To show and hide columns in views, toggle \uicontrol {Show Column} in
@@ -1478,7 +1478,7 @@
\li Make sure the debugger is set up properly. For more information,
see \l{Setting Up Debugger}.
- \li In the \uicontrol Debug mode, select \uicontrol Window >
+ \li In the \uicontrol Debug mode, select \uicontrol View >
\uicontrol Views > \uicontrol {Debugger Log} to open the
\uicontrol {Debugger Log} view. Browse the contents of the pane on
the right hand side to find out what went wrong. Always attach the
diff --git a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc
index 98978259ac..39a87166ac 100644
--- a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc
+++ b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc
@@ -234,7 +234,7 @@
When the application is interrupted by a breakpoint, you can use the
\uicontrol {QML Debugger Console} to execute JavaScript expressions in the
- current context. To open it, choose \uicontrol Window >
+ current context. To open it, choose \uicontrol View >
\uicontrol {Output Panes} > \uicontrol {QML Debugger Console}.
\image qml-script-console.png "QML Debugger Console"
diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
index f51b91006d..6ba4f49a6d 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
@@ -135,8 +135,9 @@
\endlist
To open the other output panes, such as \uicontrol{General Messages} and
- \uicontrol{Version Control}, select \uicontrol Window > \uicontrol {Output Panes}. The menu
- items also display the keyboard shortcuts that you can use.
+ \uicontrol{Version Control}, select \uicontrol View >
+ \uicontrol {Output Panes}. The menu items also display
+ the keyboard shortcuts that you can use.
For more information about output panes, see \l{Viewing Output}.
diff --git a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
index 4035cda3d0..7b06e117ed 100644
--- a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
@@ -196,7 +196,7 @@
\b {How do I generate a core file in \QC?}
To trigger the GDB command that generates a core file while debugging,
- select \uicontrol Window > \uicontrol Views > \uicontrol {Debugger Log}.
+ select \uicontrol View > \uicontrol Views > \uicontrol {Debugger Log}.
In the \uicontrol Command field, type \c gcore and press \key Enter. The
core file is created in the current working directory. You can specify
another location for the file, including a relative or absolute path, as an
diff --git a/doc/qtcreator/src/howto/creator-ui.qdoc b/doc/qtcreator/src/howto/creator-ui.qdoc
index ff5d0baf72..eeef2601a4 100644
--- a/doc/qtcreator/src/howto/creator-ui.qdoc
+++ b/doc/qtcreator/src/howto/creator-ui.qdoc
@@ -286,7 +286,7 @@
{corresponding keyboard shortcut}.
To hide the mode selector and to save space on the display, select
- \uicontrol Window > \uicontrol {Mode Selector Style} > \uicontrol Hidden.
+ \uicontrol View > \uicontrol {Mode Selector Style} > \uicontrol Hidden.
To only show icons on the mode selector, select the \uicontrol {Icons Only}
style.
@@ -402,7 +402,7 @@
\else
\l{Using Git}{Version Control}
\endif
- panes, select \uicontrol Window > \uicontrol {Output Panes}.
+ panes, select \uicontrol View > \uicontrol {Output Panes}.
\if defined(qtcreator)
To display the \uicontrol {To-Do Entries} pane, enable the Todo plugin.
\endif
diff --git a/doc/qtcreator/src/howto/creator-workspaces.qdoc b/doc/qtcreator/src/howto/creator-workspaces.qdoc
index 56177f5107..356063ac33 100644
--- a/doc/qtcreator/src/howto/creator-workspaces.qdoc
+++ b/doc/qtcreator/src/howto/creator-workspaces.qdoc
@@ -57,12 +57,12 @@
To close groups of views, select the \uicontrol {Close Group} button.
- To open closed views, select \uicontrol Window > \uicontrol Views.
+ To open closed views, select \uicontrol View > \uicontrol Views.
\section1 Saving Workspaces
The changes you make to a workspace are saved when you exit \QC.
- In \QMLD, you can select \uicontrol Window > \uicontrol Workspaces >
+ In \QMLD, you can select \uicontrol View > \uicontrol Workspaces >
\uicontrol Manage > \uicontrol {Restore last workspace on startup}
to restore the current workspace the next time you start \QC.
diff --git a/doc/qtcreator/src/meson/creator-projects-meson-building.qdocinc b/doc/qtcreator/src/meson/creator-projects-meson-building.qdocinc
new file mode 100644
index 0000000000..40b5f929fe
--- /dev/null
+++ b/doc/qtcreator/src/meson/creator-projects-meson-building.qdocinc
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt Creator documentation.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** 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. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+**
+****************************************************************************/
+/*!
+//! [meson build configuration]
+
+ \section2 Meson Build Configuration
+
+ \image qtcreator-meson-build-settings.png
+
+ Settings are grouped by category by Meson. All items are user modifiable
+ except \c backend which is forced to Ninja, \c {buildtype}, \c debug as well
+ as \c optimization to ensure a good compatibility with \QC.
+
+ Each setting type has its own editor. To modif any setting, double-click it,
+ either edit the field, or select your choice depending on the control. To
+ apply changes, select \uicontrol {Apply configuration changes}. This will
+ trigger a \c {meson configure} command if there were any configuration
+ changes. If for any reason the build directory configuration is broken,
+ select \uicontrol {Wipe project}. This should fix any build directory.
+
+ \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
+
+ \QC builds Meson projects by running \c {ninja -v target}.
+
+ You can add arguments and targets for the build command in
+ \uicontrol {Build Steps}.
+
+ \image qtcreator-meson-build-steps.png
+
+ 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
+
+ When building with Meson, you can add arguments and targets for the clean
+ command in \uicontrol {Clean Steps}.
+
+ \image qtcreator-meson-clean-steps.png
+
+ The build errors and warnings are parsed and displayed in the
+ \uicontrol Issues output pane.
+
+//! [meson clean steps]
+*/
diff --git a/doc/qtcreator/src/meson/creator-projects-meson.qdoc b/doc/qtcreator/src/meson/creator-projects-meson.qdoc
new file mode 100644
index 0000000000..2dd40fa56a
--- /dev/null
+++ b/doc/qtcreator/src/meson/creator-projects-meson.qdoc
@@ -0,0 +1,117 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt Creator documentation.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** 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. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+**
+****************************************************************************/
+
+/*!
+ \previouspage creator-project-nimble.html
+ \page creator-project-meson.html
+ \nextpage creator-cli.html
+
+ \title Setting Up Meson
+
+ \l{https://mesonbuild.com/}{Meson} is an open source and multi-platform build
+ system generator using Ninja as main backend. Build definitions are located
+ in \c {meson.build} files while build options are located in
+ \c {meson_options.txt}.
+
+ Meson build support in \QC is not mature yet, you can only use it to build
+ native desktop applications. Many features available with Meson build or
+ usually available from \QC are missing.
+
+ \QC automatically detects the Meson and Ninja executables specified in the
+ \c PATH. You can add paths to other Meson or Ninja executables and use them
+ in different build and run \l{glossary-buildandrun-kit}{kits}.
+
+ \note Meson build plugin is disabled by default, see
+ \l{Enabling and Disabling Plugins}.
+
+ \section1 Adding Meson Tools
+
+ \QC does not have strong requirements on Meson build's version, any version
+ above 0.49.0 should be compatible.
+
+ To specify paths to Meson or Ninja executables:
+
+ \list 1
+
+ \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Meson >
+ \uicontrol Tools > \uicontrol Add.
+
+ \image qtcreator-mesonexecutable.png
+
+ \li In the \uicontrol Name field, specify a name for the tool.
+
+ \li In the \uicontrol Path field, specify the path to the Meson or Ninja
+ executable.
+
+ \li Select \uicontrol Apply to save your changes.
+
+ \endlist
+
+ Select the
+ \uicontrol Tools > \uicontrol Options > \uicontrol Kits > \uicontrol Kits
+ tab to add the Meson and Ninja tools to a build and run kit:
+
+ \image qtcreator-kits.png
+
+ For more information, see \l {Adding Kits}.
+
+ \section1 Editing Meson Build Descriptions
+
+ To open a meson.build file for editing, double-click it from project tree.
+ Only plain text editor is available now.
+
+
+ \section1 Code Completion and External Libraries
+
+ Through external libraries, \QC can support code completion and syntax
+ highlighting as if they were part of the current project or the Qt library.
+
+ \QC handles code completion from compilation flags in Meson introspection
+ data. Any external library added with \c {dependency()} or found in include
+ path will be known by \QC for code completion.
+
+ Syntax completion and highlighting work once your project configures successfully.
+
+ \section1 Current Meson Support Limitations
+
+ The following features are not supported yet:
+
+ \list
+ \li Cross compilation.
+ \li Showing header files in project tree.
+ \li Configuration change detection, for example when building triggers a
+ Meson configuration first.
+ \li Actions from locator such as searching or triggering builds.
+ \li Adding files to Meson projects from \QC.
+ \endlist
+
+ \section1 Related Topics
+
+ \list
+ \li \l {Opening Projects}
+ \li \l {Specifying Build Settings}
+ \li \l {Specifying Run Settings}
+ \endlist
+*/
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc b/doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc
index 224c1e1b40..7ade105e82 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc
@@ -49,6 +49,13 @@
generation of build configurations. For more information, see
\l {Setting Up CMake}.
+ \l {https://mesonbuild.com/}{Meson} Meson is an open source build system meant
+ to be both extremely fast, and, even more importantly, as user friendly as
+ possible. The main design point of Meson is that every second a developer
+ spends writing or debugging build definitions is a second wasted. So is every
+ second spent waiting for the build system to actually start compiling code.
+ For more information, see \l {Setting Up Meson}.
+
\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
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 6df963bdf8..0860df2dbe 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc
@@ -26,7 +26,7 @@
/*!
\previouspage creator-project-generic.html
\page creator-project-nimble.html
- \nextpage creator-cli.html
+ \nextpage creator-project-meson.html
\title Setting Up Nimble
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc
index 929996dd98..186d6f614e 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc
@@ -82,7 +82,7 @@
\li Select \uicontrol File > \uicontrol {Open File or Project}
(\key Ctrl+O or \key Cmd+O on \macos) and select the project file
for the project to open: \e {.pro} (qmake), \e {CMakeLists.txt}
- (CMake), \e {.qbs} (Qbs), \e {pyproject} (Python), or
+ (CMake), \e {.qbs} (Qbs), \e {meson.build} (Meson), \e {pyproject} (Python), or
\e {Makefile.am} (Autotools, experimental).
\li In the \uicontrol {Configure Project} tab, select kits for building
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-other.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-other.qdoc
index 5ff6d1b637..83b1176e0a 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-other.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-other.qdoc
@@ -37,7 +37,7 @@
\title Using Other Build Systems
Most \QC project wizards enable you to choose the build system to use for
- building the project: qmake, CMake, or Qbs. qmake is installed and
+ building the project: qmake, CMake, Meson, or Qbs. qmake is installed and
configured when you install Qt. To use one of the other supported build
systems, you need to set it up, as described in the the following sections:
@@ -73,6 +73,11 @@
the Nimble package manager for generating Nim application
executables that are supported on Windows, Linux, and \macos.
+ \li \l{Setting Up Meson}
+
+ Meson is an open source build system meant to be both extremely fast,
+ and, even more importantly, as user friendly as possible.
+
\endlist
*/
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 73c7c383e2..5b0a7030b4 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
@@ -113,6 +113,7 @@
information, see \l{http://doc.qt.io/QtQuickCompiler/}{Qt Quick Compiler}.
\include creator-projects-cmake-building.qdocinc cmake build configuration
+ \include creator-projects-meson-building.qdocinc meson build configuration
\section1 Starting External Processes
@@ -145,7 +146,7 @@
\section1 Build Steps
In \uicontrol{Build Steps} you can change the settings for the build system
- selected for building the project: qmake, CMake, or Qbs.
+ selected for building the project: qmake, CMake, Meson, or Qbs.
\section2 qmake Build Steps
@@ -166,6 +167,7 @@
\include creator-projects-cmake-building.qdocinc cmake build steps
\include creator-projects-settings-build-qbs.qdocinc qbs build steps
+ \include creator-projects-meson-building.qdocinc meson build steps
\section2 Adding Custom Build Steps
@@ -211,4 +213,5 @@
\include creator-projects-cmake-building.qdocinc cmake clean steps
\include creator-projects-settings-build-qbs.qdocinc qbs clean steps
+ \include creator-projects-meson-building.qdocinc meson clean steps
*/
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 3b564ee283..54ab836e6f 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
@@ -69,6 +69,9 @@
\QC automatically adds run configurations for all targets specified in the
CMake project file, \c {CMakeLists.txt}.
+ \QC automatically adds run configurations for all targets declared with
+ \c {executable()} function in Meson build descriptions.
+
\section1 Creating Run Configurations for Subprojects
To prevent \QC from automatically creating run configurations for SUBDIRS
@@ -113,7 +116,7 @@
\section1 Specifying a Custom Executable to Run
- If you use CMake or the generic project type in \QC, or want
+ If you use CMake, Meson or the generic project type in \QC, 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,
you can run a test application that links against the library.
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc
index caa3d94082..6c3f32596d 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc
@@ -178,6 +178,15 @@
\uicontrol Change to edit the variables of the CMake configuration
for the kit.
+ \li In the \uicontrol {Meson tool} field, select the Meson tool to use
+ for building the project. Select \uicontrol Manage to add installed
+ Meson tools to the list. For more information, see
+ \l{Adding Meson Tools}.
+
+ \li In the \uicontrol {Ninja tool} field, select the Ninja tool to use
+ for building the project with Meson. Select \uicontrol Manage to add installed
+ Ninja tools to the list.
+
\endlist
\QC uses the \e {default kit} if it does not have enough information to
diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc
index 03c406a0c1..511a0c61c3 100644
--- a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc
+++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc
@@ -72,7 +72,7 @@
\image qmldesigner-tutorial-design-mode.png "Transitions project in Design Mode"
\note If a view is hidden, you can show it by selecting
- \uicontrol Window > \uicontrol Views.
+ \uicontrol View > \uicontrol Views.
\li In the \uicontrol Navigator, select \uicontrol Label and press
\key Delete to delete it.
diff --git a/doc/qtcreator/src/qtquick/qtquick-designer.qdoc b/doc/qtcreator/src/qtquick/qtquick-designer.qdoc
index fe524b7acd..412cbc8f55 100644
--- a/doc/qtcreator/src/qtquick/qtquick-designer.qdoc
+++ b/doc/qtcreator/src/qtquick/qtquick-designer.qdoc
@@ -49,7 +49,7 @@
\image studio-design-mode.png "Design mode"
The Design mode contains different views for designing UIs. To open the
- following views, select \uicontrol Window > \uicontrol Views:
+ following views, select \uicontrol View > \uicontrol Views:
\list
\li \uicontrol {Form Editor} (1) provides a canvas for designing 2D UIs.
diff --git a/doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc b/doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc
index faafb290f5..e981c40e57 100644
--- a/doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc
+++ b/doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc
@@ -130,7 +130,7 @@
\endlist
The \uicontrol{Version Control} output pane displays the commands that are
- executed, a timestamp, and the relevant output. Select \uicontrol Window >
+ executed, a timestamp, and the relevant output. Select \uicontrol View >
\uicontrol {Output Panes} > \uicontrol {Version Control} to open the pane.
\image qtcreator-vcs-pane.png
diff --git a/doc/qtdesignstudio/examples/doc/loginui1.qdoc b/doc/qtdesignstudio/examples/doc/loginui1.qdoc
index ebf66aa0aa..d3ce72be5d 100644
--- a/doc/qtdesignstudio/examples/doc/loginui1.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui1.qdoc
@@ -133,7 +133,7 @@
\uicontrol Projects view to open it.
\note The visibility of views depends on the selected workspace. To open
- hidden views, select \uicontrol Window > \uicontrol Views in the Design
+ hidden views, select \uicontrol View > \uicontrol Views in the Design
mode. For more information, see \l {Managing Workspaces}.
To modify \e Screen01.ui.qml in \uicontrol {Form Editor}:
diff --git a/doc/qtdesignstudio/examples/doc/loginui3.qdoc b/doc/qtdesignstudio/examples/doc/loginui3.qdoc
index 84e5d06779..a49d211a1d 100644
--- a/doc/qtdesignstudio/examples/doc/loginui3.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui3.qdoc
@@ -189,7 +189,7 @@
to \e loginState:
\list 1
- \li Select \uicontrol Window > \uicontrol Views >
+ \li Select \uicontrol View > \uicontrol Views >
\uicontrol {Connection View} to open the \uicontrol Connection view.
\li Select \e registerButton in the \uicontrol Navigator.
\li In the \uicontrol Connection view, select the \inlineimage plus.png
diff --git a/doc/qtdesignstudio/examples/doc/loginui4.qdoc b/doc/qtdesignstudio/examples/doc/loginui4.qdoc
index 3566eea72b..62db589dc7 100644
--- a/doc/qtdesignstudio/examples/doc/loginui4.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui4.qdoc
@@ -135,7 +135,7 @@
To add a timeline with settings for running the animation:
\list 1
- \li Select \uicontrol Window > \uicontrol Views >
+ \li Select \uicontrol View > \uicontrol Views >
\uicontrol Timeline to open the \uicontrol Timeline view.
\li In \uicontrol Timeline, select \inlineimage plus.png
to add a 1000-frame timeline and settings for running the animation.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc
index c40b845742..4d870c8497 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc
@@ -36,7 +36,8 @@
\list
\li Place your Illustrator content into Adobe Photoshop and
- use \QBPS to export the assets to .ui.qml files.
+ use \QBPS to export the assets to \e {.metadata} format that
+ you can import to \QDS.
\li Use the Illustrator \e {export for screens workflow} to export your
assets into formats supported by \QDS, such as PNG and JPEG.
\endlist
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc
index 4fc6d2eefb..58e782c2ae 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc
@@ -30,13 +30,17 @@
\title Exporting Artwork from Design Tools
- You need to use \QB to first export 2D assets from design tools and then
- import them. When working with 3D assets, you can use the export functions
- provided by the 3D graphics tools to save the assets in widely-used 3D
- graphics formats, and then use \QB to import them. You can download \QB
- from the \l{https://marketplace.qt.io/}{Qt Marketplace}.
+ You need to use \QB to first export 2D assets from design tools and then use
+ \QB to \l{Importing Designs}{import} them into \QDS.
- For best results when importing 3D assets, follow
+ When working with 3D assets, you can use the export functions provided by
+ the 3D graphics tools to save the assets in widely-used 3D graphics formats,
+ and then use \QB to import them into \QDS.
+
+ You can use the Qt online installer to install \QB if you have a license, or
+ download \QB from the \l{https://marketplace.qt.io/}{Qt Marketplace}.
+
+ For best results when importing assets, follow
the guidelines for creating and exporting them.
\list
@@ -50,13 +54,13 @@
\li \l{Exporting Designs from Adobe Photoshop}
You can use the \QBPS export tool in Adobe Photoshop to convert
- artwork into Qt Quick files (.ui.qml) that you can import to
+ artwork into \e {.metadata} format that you can import into
projects in \QDS.
\li \l{Exporting Designs from Sketch}
You can use the \QBSK export tool in Sketch to convert artwork into
- Qt Quick files that you can import to projects in \QDS.
+ metadata that you can import into projects in \QDS.
\li \l{Exporting 3D Assets}
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc
index d6f0b8239c..26eda08a08 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Design Studio documentation.
@@ -32,7 +32,8 @@
\title Exporting Designs from Adobe Photoshop
- You can use \QBPS to export designs from Adobe Photoshop to .ui.qml files.
+ You can use \QBPS to export designs from Adobe Photoshop to \e {.metadata}
+ format that you can \l{Importing 2D Assets}{import} to projects in \QDS.
\image studio-ps-export.png
@@ -43,13 +44,12 @@
\li \l{Setting Up Qt Bridge for Adobe Photoshop}
You must install and set up the \QBPS export tool before you can use
- it to convert artwork into Qt Quick files that you can import to
- projects in \QDS.
+ it to export artwork.
\li \l{Using Qt Bridge for Adobe Photoshop}
To get the best results when you use \QBPS to export designs from
- Photoshop to Qt Quick files, you should follow the guidelines for
- working with Photoshop and organizing your assets.
+ Photoshop, you should follow the guidelines for working with
+ Photoshop and organizing your assets.
\endlist
*/
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc
index 61adb5a0ab..ff12226ab4 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc
@@ -33,7 +33,8 @@
\section1 Organizing Assets
To get the best results when you use \QBPS to export designs from Adobe
- Photoshop to \QDS, follow these guidelines when working with Photoshop:
+ Photoshop for importing them to \QDS, follow these guidelines when working
+ with Photoshop:
\list
\li Arrange your art into artboards and organize it into groups and
@@ -55,9 +56,9 @@
when you export designs from Adobe Photoshop and import them into \QDS.
When you use \QBPS to export your designs, you will determine how you want
- each group or layer exported: as a \e component or \e child. A component is
- a single QML file that can contain other assets. A child is a single PNG
- file that you can use within QML files.
+ each group or layer exported: as a \e component or \e child. A component
+ will be imported as a single QML file that can contain other assets. A child
+ will be imported as a single PNG file that you can use within QML files.
If you plan to use pieces of your artwork as separate images in the UI,
group them on an artboard as separate layers. You can then export the group
@@ -74,7 +75,7 @@
Place different parts of the UI, such as menus and pop-ups, on separate
artboards to be able to export them as components or children and to
- import them as QML and PNG files that you can drag and drop to the
+ import them as QML and PNG files that you can drag and drop to
\uicontrol {Form Editor} in \QDS Design mode while creating a UI.
\QDS offers predefined sets of UI controls that you can modify according
@@ -85,12 +86,13 @@
However, if you want your UI controls, such as check boxes, to look exactly
like they do in Photoshop, you have to create the control in an Artboard and
use the artboard in the layers where the control instance is to be created.
- \QB exports the control as a custom QML component that you can program in
+ \QB imports the control as a custom QML component that you can program in
\QDS.
\section1 Exporting Assets
- Each artboard is exported automatically as a component. That is, a separate
+ Each artboard is exported automatically as a component, which means that it
+ will be imported as a separate
QML file that contains all the artwork on the artboard, except layers that
are set to be skipped or exported as child items. You determine how
each group or layer in an artboard is exported: as a component or a child
@@ -147,13 +149,14 @@
\li In the \uicontrol {Export As} field, select the export type for the
group or layer:
\list
- \li \uicontrol Component creates a separate QML file for the
- selected artboard, group, or layer that contains all the
- artwork in it, except layers that are set to be skipped or
- exported as child items.
- \li \uicontrol Child creates a separate PNG file for each asset
- of the selected group or layer, with references to the
- images in the component file.
+ \li \uicontrol Component exports the selected artboard, group,
+ or layer with metadata. The exported data can be used later
+ to import the component as a separate QML file that contains
+ all the artwork in it, except layers that are set to be
+ skipped or exported as child items.
+ \li \uicontrol Child exports each asset of the selected group
+ or layer as a separate PNG file, with references
+ to the images in the component file.
\li \uicontrol Merged merges the selected groups and layers into
the parent as one item.
\li \uicontrol Skipped completely skips the selected layer.
@@ -162,9 +165,9 @@
to reuse. For example, you can use an artboard to define a
component, such as a button, and reuse it in other artboards.
\li In the \uicontrol {QML Type} field, specify the QML type
- or Studio component to morph this layer into. The generated
- component will be of this type. For example, if you drew a
- rectangle, you can export it as a Rectangle Studio component.
+ or Studio component to morph this layer into. The component that is
+ generated during import will be of this type. For example, if you
+ drew a rectangle, you can export it as a Rectangle Studio component.
You can provide the import statement of the module where the QML
type is defined in the \uicontrol {Add Imports} field.
\li In the \uicontrol {Add Imports} field, enter additional
@@ -225,8 +228,8 @@
PSD Document instance. You can undo the temporary changes done in the function
\e preExport(...).
\li customDefaultQmlId(name, instance)
- The function is called for settings the default QML id of the layer. The returned value
- is used for the QML id. Return \e Falsey to use the auto generated QML id instead.
+ The function is called for setting the default QML id of the layer. The returned value
+ is used for the QML id. Return \c false to use the auto generated QML id instead.
The parameter \a name is the auto generated QML id by the plugin and \a instance is the
PSD layer instance.
\endlist
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc
index a897ab044d..a85a247310 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc
@@ -32,7 +32,8 @@
\title Exporting Designs from Sketch
- You can use \QBSK to export designs from Sketch to .ui.qml files.
+ You can use \QBSK to export designs from Sketch to \e {.metadata}
+ format that you can \l{Importing 2D Assets}{import} to projects in \QDS.
\image studio-sketch-export.png
@@ -43,13 +44,12 @@
\li \l{Setting Up Qt Bridge for Sketch}
You must install Sketch and the \QBSK export tool before you can use
- the tool to convert artwork into Qt Quick files that you can import
- to projects in \QDS.
+ the tool to export artwork.
\li \l{Using Qt Bridge for Sketch}
To get the best results when you use \QBSK to export designs from
- Sketch to Qt Quick files, you should follow the guidelines for
- working with Sketch and organizing your assets.
+ Sketch, you should follow the guidelines for working with Sketch and
+ organizing your assets.
\endlist
*/
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc
index 82b9c0b807..677c1c610e 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc
@@ -77,10 +77,10 @@
The relationships between artboards and layers are preserved when you export
designs from Sketch and import them into \QDS.
- An artboard can only be exported as a component or skipped. A component is
- a separate QML file that contains all the artwork on the artboard, except
- layers that are set to be skipped or exported as child items. The child
- items can contain graphical assets or text.
+ An artboard can only be exported as a component or skipped. A component will
+ be imported as a separate QML file that contains all the artwork on the
+ artboard, except layers that are set to be skipped or exported as child
+ items. The child items can contain graphical assets or text.
To use the contents of an artboard as a single image in the UI, you can
merge the groups and layers when you export them. During import, the
@@ -149,23 +149,24 @@
\li In the \uicontrol {Export As} field, select the export type for the
group or layer:
\list
- \li \uicontrol Component creates a separate QML file for the
- selected symbol that contains all the artwork in it, except
- layers or groups that are set to be skipped or exported as
- child items.
- \li \uicontrol Child creates a separate file for each asset
- of the selected group or layer, with references to the
- images in the component file. You select the image format
- in the \uicontrol {Asset Format} field.
+ \li \uicontrol Component exports the selected symbol with
+ metadata. The exported data can be used later to import
+ the component as a separate QML file that contains all
+ the artwork in it, except layers or groups that are set
+ to be skipped or exported as child items.
+ \li \uicontrol Child exports each asset of the selected group
+ or layer a separate PNG file, with references
+ to the images in the component file. You select the image
+ format in the \uicontrol {Asset Format} field.
\li \uicontrol Merged merges the selected groups and layers into
the parent artboard or group as one item.
\li \uicontrol Skipped completely skips the selected layer.
\endlist
\li In the \uicontrol {QML Type} field, specify the QML type or
\l {Studio Components}{Qt Quick Studio Component} to morph this
- layer into. The generated component will be of this type. For
- example, if you drew a rectangle, you can export it as a
- \l Rectangle component.
+ layer into. The component that is generated during import will be
+ of this type. For example, if you drew a rectangle, you can export
+ it as a \l Rectangle component.
You can provide the import statement of the module where the QML
type is defined in the \uicontrol {QML Imports} field.
\li In the \uicontrol {QML Imports} field, enter
diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc
index e2457f512f..d0bb49043a 100644
--- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc
+++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc
@@ -43,7 +43,7 @@
\image studio-editing-3d-scenes.png "3D assets in Design mode"
- To open the following views, select \uicontrol Window > \uicontrol Views:
+ To open the following views, select \uicontrol View > \uicontrol Views:
\list
\li \uicontrol {3D Editor} (1) is the working area where you create the