aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@qt.io>2018-11-06 09:20:00 +0100
committerEike Ziller <eike.ziller@qt.io>2018-11-06 09:20:00 +0100
commit1473bc5891cc06ff7f0a431fe0212b4321e266de (patch)
tree188c5862ef56c1ee7b06439b5423ea650dfc125a /doc
parent9d296cf1f12e95f55f25a8ca11608df29b11dfce (diff)
parente18cbad28592eb911b8c82b7f71b8ee0382a19f9 (diff)
Merge remote-tracking branch 'origin/4.8'
Conflicts: src/plugins/debugger/debuggermainwindow.cpp src/plugins/qbsprojectmanager/qbsbuildstep.cpp src/plugins/winrt/winrtdevicefactory.cpp tests/unit/unittest/gtest-creator-printing.cpp tests/unit/unittest/gtest-creator-printing.h tests/unit/unittest/unittest.pro Change-Id: Ie9b80b87a8a4fa81baf72a2daa7919b21371c15e
Diffstat (limited to 'doc')
-rw-r--r--doc/images/qtcreator-build-steps.pngbin19561 -> 71616 bytes
-rw-r--r--doc/images/qtcreator-clang-format-options.pngbin0 -> 49932 bytes
-rw-r--r--doc/src/android/androiddev.qdoc4
-rw-r--r--doc/src/editors/creator-clangformat.qdocinc66
-rw-r--r--doc/src/editors/creator-code-indentation.qdoc2
-rw-r--r--doc/src/editors/creator-only/creator-clang-codemodel.qdoc2
-rw-r--r--doc/src/editors/creator-only/creator-compilation-database.qdocinc52
-rw-r--r--doc/src/overview/creator-only/creator-supported-platforms.qdoc4
-rw-r--r--doc/src/projects/creator-only/creator-projects-settings-build.qdoc6
-rw-r--r--doc/src/projects/creator-only/creator-projects-settings-run.qdoc21
10 files changed, 148 insertions, 9 deletions
diff --git a/doc/images/qtcreator-build-steps.png b/doc/images/qtcreator-build-steps.png
index 74822377d4..5d15cd9d1d 100644
--- a/doc/images/qtcreator-build-steps.png
+++ b/doc/images/qtcreator-build-steps.png
Binary files differ
diff --git a/doc/images/qtcreator-clang-format-options.png b/doc/images/qtcreator-clang-format-options.png
new file mode 100644
index 0000000000..cce8d09fa4
--- /dev/null
+++ b/doc/images/qtcreator-clang-format-options.png
Binary files differ
diff --git a/doc/src/android/androiddev.qdoc b/doc/src/android/androiddev.qdoc
index dceb987dc6..e7fd3901be 100644
--- a/doc/src/android/androiddev.qdoc
+++ b/doc/src/android/androiddev.qdoc
@@ -75,7 +75,7 @@
\li A tool chain for building applications for Android devices provided
by the \l{http://developer.android.com/tools/sdk/ndk/index.html}
- {Android NDK} from Google. The recommended version is 10e.
+ {Android NDK} from Google.
\li \l{http://developer.android.com/sdk/index.html}{Android SDK Tools}
@@ -92,8 +92,6 @@
\list
- \li MinGW v4.8.0 revision 2
-
\li Android Debug Bridge (ADB) driver on the Windows platform to
enable USB debugging. The default USB driver on Windows does not
allow debugging. For more information about obtaining the USB
diff --git a/doc/src/editors/creator-clangformat.qdocinc b/doc/src/editors/creator-clangformat.qdocinc
new file mode 100644
index 0000000000..3ba9984f9f
--- /dev/null
+++ b/doc/src/editors/creator-clangformat.qdocinc
@@ -0,0 +1,66 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 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.
+**
+****************************************************************************/
+
+/*!
+//! [clang format]
+
+ \section2 Automatic Indentation
+
+ The experimental Clang Format plugin uses the
+ \l{https://clang.llvm.org/docs/LibFormat.html}{LibFormat}
+ library for automatic indentation.
+
+ To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} >
+ \uicontrol {C++} > \uicontrol {ClangFormat}. Then restart \QC to load the
+ plugin.
+
+ To specify global settings for Clang Format:
+
+ \list 1
+ \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {C++} >
+ \uicontrol {Clang Format}.
+ \image qtcreator-clang-format-options.png "C++ Clang Format options"
+ \li Double-click a value to modify it.
+ \endlist
+
+ You can also specify formatting separately for each project.
+ Create a \c {.clang-format} file that contains the
+ \l{https://clang.llvm.org/docs/ClangFormatStyleOptions.html}
+ {Clang Format Style Options} to use and save it in the project directory.
+
+ You can create \c {.clang-format} files that contain the configuration
+ options of a certain predefined style from the command line. For example,
+ to create a format file for the LLVM style, enter the following command:
+
+ \badcode
+ clang-format -style=llvm -dump-config > .clang-format
+ \endcode
+
+ To view the \c {.clang-format} file for a project, select
+ \uicontrol Projects > \uicontrol {Project Settings} >
+ \uicontrol {Clang Format}.
+
+//! [clang format]
+*/
diff --git a/doc/src/editors/creator-code-indentation.qdoc b/doc/src/editors/creator-code-indentation.qdoc
index 61d67f6750..c1427f460a 100644
--- a/doc/src/editors/creator-code-indentation.qdoc
+++ b/doc/src/editors/creator-code-indentation.qdoc
@@ -86,6 +86,8 @@
To specify different settings for a particular project, select
\uicontrol Projects > \uicontrol {Code Style Settings}.
+
+ \include creator-clangformat.qdocinc clang format
\endif
\section1 Indenting QML Files
diff --git a/doc/src/editors/creator-only/creator-clang-codemodel.qdoc b/doc/src/editors/creator-only/creator-clang-codemodel.qdoc
index 9cf15ab4dd..7fd7791209 100644
--- a/doc/src/editors/creator-only/creator-clang-codemodel.qdoc
+++ b/doc/src/editors/creator-only/creator-clang-codemodel.qdoc
@@ -185,4 +185,6 @@
\image qtcreator-clang-code-model-build-settings.png
+ \include creator-compilation-database.qdocinc using compilation databases
+
*/
diff --git a/doc/src/editors/creator-only/creator-compilation-database.qdocinc b/doc/src/editors/creator-only/creator-compilation-database.qdocinc
new file mode 100644
index 0000000000..b1481f561d
--- /dev/null
+++ b/doc/src/editors/creator-only/creator-compilation-database.qdocinc
@@ -0,0 +1,52 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 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.
+**
+****************************************************************************/
+
+/*!
+//! [using compilation databases]
+
+ \section1 Using Compilation Databases
+
+ The \l{https://clang.llvm.org/docs/JSONCompilationDatabase.html}
+ {JSON compilation database format} specifies how to replay single builds
+ independently of the build system.
+
+ A \e {compilation database} is basically a list of files and the compiler
+ flags that are used to compile the files. The database is used to feed the
+ code model with the necessary information for correctly parsing the code
+ when you open a file for editing.
+
+ To generate a compilation database from the information that the code model
+ has, select \uicontrol Build > \uicontrol {Generate Compilation Database}.
+
+ You can use the experimental Compilation Database Project Manager to open
+ the files in a compilation database with access to all the editing features
+ provided by the Clang code model.
+
+ To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} >
+ \uicontrol {Build Systems} > \uicontrol {Compilation Database Project Manager}.
+ Then restart \QC to load the plugin.
+
+//! [using compilation databases]
+*/
diff --git a/doc/src/overview/creator-only/creator-supported-platforms.qdoc b/doc/src/overview/creator-only/creator-supported-platforms.qdoc
index 1e44a792d3..b91b67803f 100644
--- a/doc/src/overview/creator-only/creator-supported-platforms.qdoc
+++ b/doc/src/overview/creator-only/creator-supported-platforms.qdoc
@@ -41,6 +41,10 @@
You can install and run \QC on several operating systems to create
applications for multiple desktop, embedded, and mobile device platforms.
+ \QC automatically runs scheduled checks for updates based on the settings
+ specified in \uicontrol Tools > \uicontrol Options \uicontrol Environment >
+ \uicontrol Update.
+
\section1 Development Platforms
\QC is available in binary packages for the following operating systems:
diff --git a/doc/src/projects/creator-only/creator-projects-settings-build.qdoc b/doc/src/projects/creator-only/creator-projects-settings-build.qdoc
index 1d65f4193c..e836be1d50 100644
--- a/doc/src/projects/creator-only/creator-projects-settings-build.qdoc
+++ b/doc/src/projects/creator-only/creator-projects-settings-build.qdoc
@@ -163,6 +163,12 @@
the build step and add a custom build step that specifies another shell
command.
+ By default, \QC uses all the CPU cores available to achieve maximum build
+ parallelization. On Linux and \macos, you can specify the number of parallel
+ jobs to use for building in the \uicontrol {Parallel jobs} field. Select the
+ \uicontrol {Override MAKEFLAGS} check box to override existing MAKEFLAGS
+ variables.
+
To generate debug symbols also for applications compiled in release mode,
select the \uicontrol {Generate separate debug info} check box. For more
information, see \l{Using the Performance Analyzer}.
diff --git a/doc/src/projects/creator-only/creator-projects-settings-run.qdoc b/doc/src/projects/creator-only/creator-projects-settings-run.qdoc
index ef82619577..1010186a3f 100644
--- a/doc/src/projects/creator-only/creator-projects-settings-run.qdoc
+++ b/doc/src/projects/creator-only/creator-projects-settings-run.qdoc
@@ -37,14 +37,23 @@
\title Specifying Run Settings
- \QC automatically creates run configurations for your project.
- To view and modify the settings, select \uicontrol {Projects > Build & Run > Run}.
-
- The settings to specify depend on the type of the project and on the
+ The run settings to specify depend on the type of the project and on the
\l{glossary-buildandrun-kit}{kit} that you build and run the project with.
- Click \uicontrol Add to add run settings for a project and \uicontrol Remove to remove
- the current settings.
+ \QC automatically creates run configurations for your project.
+ To view and modify them, select \uicontrol Projects >
+ \uicontrol {Build & Run} > \uicontrol Run.
+
+ The available run configurations are listed in the
+ \uicontrol {Run configuration} field.
+ To add run configurations for a project, select \uicontrol Add.
+ To remove the current run configuration, select \uicontrol Remove.
+ To rename the current run configuration, select \uicontrol Rename.
+
+ To prevent \QC from automatically creating run configurations, select
+ \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run},
+ and then deselect the \uicontrol {Create suitable run configurations
+ automatically} check box.
The run configurations for qmake projects derive their executable from the
parsed .pro files. For more information on how the commands are constructed,