forked from qt-creator/qt-creator
Merge remote-tracking branch 'origin/15.0'
Conflicts: src/plugins/android/androiddeployqtstep.cpp src/plugins/debugger/debuggerdialogs.cpp src/plugins/projectexplorer/kitaspect.cpp Change-Id: Iebc1d7a38db4c228282c04c63d7f11ee76072a06
This commit is contained in:
Binary file not shown.
Before Width: | Height: | Size: 21 KiB |
BIN
doc/qtcreator/images/qtcreator-preferences-debugger-general.webp
Normal file
BIN
doc/qtcreator/images/qtcreator-preferences-debugger-general.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
After Width: | Height: | Size: 4.1 KiB |
Binary file not shown.
Before Width: | Height: | Size: 16 KiB |
@@ -15,7 +15,7 @@
|
||||
\uicontrol Debugger. In the \uicontrol General tab, you can specify settings
|
||||
that are common to all debuggers.
|
||||
|
||||
\image qtcreator-debugger-general-options.png "Debugger General preferences"
|
||||
\image qtcreator-preferences-debugger-general.webp {Debugger General preferences}
|
||||
|
||||
You can customize the appearance and behavior of the debug views and
|
||||
setting breakpoints, as well as map source paths to target paths.
|
||||
|
@@ -838,7 +838,7 @@
|
||||
To change the appearance and behavior of the debug views, set preferences
|
||||
in \preferences > \uicontrol Debugger > \uicontrol General.
|
||||
|
||||
\image qtcreator-debugger-general-options.png {General tab in Debugger preferences}
|
||||
\image qtcreator-preferences-debugger-general.webp {General tab in Debugger preferences}
|
||||
|
||||
For example, you can:
|
||||
|
||||
@@ -1270,7 +1270,7 @@
|
||||
at which the libraries were built, you can map source paths to target
|
||||
paths in \preferences > \uicontrol Debugger > \uicontrol General.
|
||||
|
||||
\image qtcreator-debugger-general-options.png {General tab in Debugger preferences}
|
||||
\image qtcreator-preferences-debugger-general.webp {General tab in Debugger preferences}
|
||||
|
||||
For more information, see \l{Source Paths Mapping}.
|
||||
|
||||
|
@@ -74,8 +74,8 @@
|
||||
To use a context-specific margin when available, select the
|
||||
\uicontrol {Use context-specific margin} check box.
|
||||
\if defined(qtcreator)
|
||||
Then, use the ClangFormat \c ColumnLimit option to set the margin, for
|
||||
example.
|
||||
Then, use the \l{ClangFormat Style Options}{ClangFormat} \c ColumnLimit
|
||||
option to set the margin, for example.
|
||||
|
||||
\sa {C++ Code Style}
|
||||
\endif
|
||||
|
@@ -23,7 +23,7 @@
|
||||
|
||||
\li \l{http://astyle.sourceforge.net}{Artistic Style}
|
||||
|
||||
\li \l{http://clang.llvm.org/docs/ClangFormat.html}{ClangFormat}
|
||||
\li \l{ClangFormat: Documentation}{ClangFormat}
|
||||
|
||||
\li \l{http://uncrustify.sourceforge.net}{Uncrustify}
|
||||
|
||||
@@ -41,7 +41,7 @@
|
||||
\list
|
||||
\li \l{http://sourceforge.net/projects/astyle/files/astyle}
|
||||
{Artistic Style}
|
||||
\li \l{http://llvm.org/releases/download.html}{ClangFormat}
|
||||
\li \l{ClangFormat: Download}{ClangFormat}
|
||||
\li \l{http://sourceforge.net/projects/uncrustify/files/uncrustify}
|
||||
{Uncrustify}
|
||||
\endlist
|
||||
|
@@ -11,7 +11,7 @@
|
||||
|
||||
\brief Set global code style for C++ files.
|
||||
|
||||
\QC uses the Clang \l{https://clang.llvm.org/docs/LibFormat.html}{LibFormat}
|
||||
\QC uses the Clang \l{LibFormat: Documentation}{LibFormat}
|
||||
library to automatically format and indent C++ code. It enforces a coding
|
||||
style for a project or the whole organization.
|
||||
|
||||
@@ -25,7 +25,8 @@
|
||||
\li \uicontrol {Indenting Only} to only indent code.
|
||||
\li \uicontrol {Full Formatting} to use the \key {Ctrl+I}
|
||||
keyboard shortcut to format code instead of indenting.
|
||||
\li \uicontrol {Use Built-In Indenter} to turn off ClangFormat.
|
||||
\li \uicontrol {Use Built-In Indenter} to turn off
|
||||
\l{ClangFormat: Documentation}{ClangFormat}.
|
||||
\endlist
|
||||
\li Select \uicontrol {Ignore files greater than} to make parsing faster
|
||||
by ignoring big files. Specify the maximum size of files to parse.
|
||||
@@ -38,10 +39,8 @@
|
||||
\li In \uicontrol {Custom settings}, select the settings to change, and
|
||||
then select \uicontrol Copy.
|
||||
\li Give a name to the settings, and select \uicontrol OK.
|
||||
\li In \uicontrol ClangFormat, edit the
|
||||
\l{https://clang.llvm.org/docs/ClangFormatStyleOptions.html}
|
||||
{ClangFormat Style Options}. The live preview shows how the
|
||||
preferences change the indentation.
|
||||
\li In \uicontrol ClangFormat, edit the \l {ClangFormat Style Options}.
|
||||
The live preview shows how the preferences change the indentation.
|
||||
If you enter invalid values, you see warning messages.
|
||||
\endlist
|
||||
|
||||
|
@@ -253,3 +253,19 @@
|
||||
\externalpage https://code.qt.io/cgit/qt-creator/qt-creator.git/tree/share/qtcreator/jsonschemas/project.json
|
||||
\title project.json
|
||||
*/
|
||||
/*!
|
||||
\externalpage https://clang.llvm.org/docs/ClangFormat.html
|
||||
\title ClangFormat: Documentation
|
||||
*/
|
||||
/*!
|
||||
\externalpage https://llvm.org/releases/download.html
|
||||
\title ClangFormat: Download
|
||||
*/
|
||||
/*!
|
||||
\externalpage https://clang.llvm.org/docs/ClangFormatStyleOptions.html
|
||||
\title ClangFormat Style Options
|
||||
*/
|
||||
/*!
|
||||
\externalpage https://clang.llvm.org/docs/LibFormat.html
|
||||
\title LibFormat: Documentation
|
||||
*/
|
||||
|
38
doc/qtcreator/src/howto/creator-only/creator-telemetry.qdoc
Normal file
38
doc/qtcreator/src/howto/creator-only/creator-telemetry.qdoc
Normal file
@@ -0,0 +1,38 @@
|
||||
// Copyright (C) 2024 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||
|
||||
/*!
|
||||
\page creator-how-to-collect-usage-statistics.html
|
||||
\previouspage creator-how-tos.html
|
||||
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Collect usage statistics
|
||||
|
||||
When you install \QC with \QOI, you can allow it to collect pseudonymous
|
||||
information about your system and \QC use. If you decline, the telemetry
|
||||
plugin is not installed and no usage statistics are collected.
|
||||
|
||||
\section1 Principles of data collection
|
||||
|
||||
No personal data, such as names, IP addresses, MAC addresses, or project
|
||||
and path names are collected. However, QUuid objects are used to identify
|
||||
data records that belong to one user. The objects cannot be converted
|
||||
back to the actual values from which they were generated.
|
||||
|
||||
For more information about Qt privacy policy, see
|
||||
\l{https://www.qt.io/terms-conditions/privacy-and-security}
|
||||
{Qt Appendix for Privacy and Security}.
|
||||
|
||||
\QC respects the same privacy rules.
|
||||
|
||||
\section1 Turn on data collection
|
||||
|
||||
To allow the telemetry plugin to collect data, go to \preferences >
|
||||
\uicontrol Telemetry > \uicontrol {Usage Statistics}, and then select
|
||||
\uicontrol {Send pseudonymous usage statistics}.
|
||||
|
||||
\image qtcreator-preferences-telemetry-usage-statistics.webp {Usage Statistics}
|
||||
|
||||
\sa {Installation}
|
||||
*/
|
@@ -1,106 +0,0 @@
|
||||
// Copyright (C) 2023 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||
|
||||
/*!
|
||||
\page creator-telemetry.html
|
||||
\if defined(qtdesignstudio)
|
||||
\previouspage creator-quick-ui-forms.html
|
||||
\nextpage collecting-usage-statistics.html
|
||||
\else
|
||||
\previouspage creator-how-tos.html
|
||||
\endif
|
||||
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Manage data collection
|
||||
|
||||
\if defined (qtcreator)
|
||||
When you install \QC as a part of Qt installation, you are asked whether
|
||||
you allow it to collect pseudonymous information about your system and \QC
|
||||
use. If you decline, the plugin is not installed and no analytics data is
|
||||
collected.
|
||||
|
||||
If you accept, all collected and transmitted data is fully transparent to
|
||||
you. You can change the settings for collecting and transmitting data any
|
||||
time. By default, no data is collected and you have to select a telemetry
|
||||
mode for data collection to begin.
|
||||
|
||||
|
||||
See \l {Collect usage statistics} for more information about the data
|
||||
transmitted by the telemetry plugin and \l {Specify telemetry settings}
|
||||
{specifying telemetry settings}.
|
||||
\else
|
||||
To enable the use of the telemetry plugin, you need to select \uicontrol
|
||||
{Enable Usage Statistics} in the splash screen that appears when you first
|
||||
launch \QDS. If the splash screen does not appear, you can enable the
|
||||
telemetry plugin by selecting \uicontrol Help > \uicontrol {About Plugins} >
|
||||
\uicontrol Utilities > \uicontrol UsageStatistic on Linux and Windows (or
|
||||
\uicontrol {\QDS} > \uicontrol {About Plugins} > \uicontrol Utilities >
|
||||
\uicontrol UsageStatistic on \macos).
|
||||
\image studio-usage-statistics.png "Enabling Usage Statistics"
|
||||
\endif
|
||||
|
||||
\if defined(qtdesignstudio)
|
||||
See below for more information about the collected data:
|
||||
|
||||
\list
|
||||
\li \l {Collect usage statistics}
|
||||
\li \l {Collecting User Feedback}
|
||||
\li \l {Reporting Crashes}
|
||||
\endlist
|
||||
\endif
|
||||
|
||||
\section1 Principles of data collection
|
||||
|
||||
No personal data, such as names, IP addresses, MAC addresses, or project
|
||||
and path names are collected. However, QUuid objects are used to identify
|
||||
data records that belong to one user. The objects cannot be converted
|
||||
back to the actual values from which they were generated.
|
||||
|
||||
For more information about Qt privacy policy, select
|
||||
\l{https://www.qt.io/terms-conditions/#privacy}
|
||||
{Legal Notice and Privacy Policy}.
|
||||
|
||||
\sa {Collect usage statistics}
|
||||
*/
|
||||
|
||||
/*!
|
||||
\page collecting-usage-statistics.html
|
||||
\if defined(qtdesignstudio)
|
||||
\previouspage creator-telemetry.html
|
||||
\nextpage studio-user-feedback.html
|
||||
\else
|
||||
\previouspage creator-how-tos.html
|
||||
\endif
|
||||
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Collect usage statistics
|
||||
|
||||
The telemetry plugin uses the
|
||||
\l{https://api.kde.org/frameworks/kuserfeedback/html/index.html}
|
||||
{KUserFeedback} framework to collect the usage data. The library
|
||||
has been designed from the user data privacy point of view and
|
||||
\QC respects the same privacy rules.
|
||||
|
||||
The data is transmitted to the backend storage using an encrypted
|
||||
connection. The storage is located in the same Heroku backend as the
|
||||
\QOI backend. Physically, data is stored in the Amazon cloud.
|
||||
|
||||
\section1 Specify telemetry settings
|
||||
|
||||
To determine what data is transmitted to the backend storage:
|
||||
|
||||
\list 1
|
||||
\li Select \preferences > \uicontrol Telemetry
|
||||
> \uicontrol {Usage Statistics}.
|
||||
\image qtcreator-telemetry-settings.png "Telemetry settings"
|
||||
\li In the \uicontrol {Telemetry mode} list, select the mode that
|
||||
determines what kind of data is collected.
|
||||
\li In the \uicontrol {Data sources} list, select entries to view
|
||||
exactly what data is collected. Deselect check boxes for data
|
||||
that you do not want to transmit to the backend storage.
|
||||
\endlist
|
||||
|
||||
\sa {Manage data collection}
|
||||
*/
|
@@ -258,17 +258,29 @@
|
||||
system libraries or your own libraries. Further, your own libraries might
|
||||
link to other libraries. To compile your project and benefit from services
|
||||
such as code completion and syntax highlighting, add the libraries to your
|
||||
project. The process of adding a library to a project depends on the build
|
||||
system that you use.
|
||||
project.
|
||||
|
||||
\section1 CMake projects
|
||||
\section1 Create subprojects
|
||||
|
||||
To add CMakeLists.txt files to any project, use the
|
||||
\l{https://cmake.org/cmake/help/latest/command/add_subdirectory.html}
|
||||
{add_subdirectory} command. The files can define complete projects that
|
||||
you include into the top-level project or any other CMake commands.
|
||||
To create subprojects and add them to a project:
|
||||
|
||||
\section1 qmake projects
|
||||
\list 1
|
||||
\li Right-click the project name in the \l Projects view to open the
|
||||
context menu, and select \uicontrol {New Subproject}.
|
||||
\li Follow the instructions of the wizard to create a subproject.
|
||||
\image qtcreator-project-qt-quick.webp {New Project dialog}
|
||||
\endlist
|
||||
|
||||
\section1 Add existing projects as subprojects
|
||||
|
||||
To add an existing project as a subproject:
|
||||
|
||||
\list 1
|
||||
\li Select \uicontrol {Add Existing Projects} in the context menu.
|
||||
\li In the file browser dialog, locate your subproject.
|
||||
\endlist
|
||||
|
||||
\section1 Create SUBDIRS projects for qmake
|
||||
|
||||
When you create a new project and select qmake as the build system,
|
||||
you can add it to another project as a subproject in the
|
||||
@@ -292,28 +304,15 @@
|
||||
and the subproject that you add as a value of the \l{Variables#subdirs}
|
||||
{SUBDIRS variable}. It also adds all the necessary files for the subproject.
|
||||
|
||||
\section2 Add subprojects to the root project
|
||||
\section2 Specify dependencies
|
||||
|
||||
To create more subprojects, right-click the project name in the
|
||||
\l Projects view to open the context menu, and select
|
||||
\uicontrol {New Subproject}. Follow the steps in the
|
||||
\uicontrol {New Subproject} wizard to create a subproject.
|
||||
|
||||
\image qtcreator-project-qt-quick.webp {New Project dialog}
|
||||
|
||||
To add an existing project as a subproject, select
|
||||
\uicontrol {Add Existing Projects} in the context menu.
|
||||
In the file browser dialog, locate your subproject.
|
||||
To specify dependencies, use the \uicontrol{Add Library} wizard.
|
||||
|
||||
\section2 Remove subprojects
|
||||
|
||||
To remove subprojects, right-click the project name in the \uicontrol Projects
|
||||
view, and select \uicontrol {Remove Subproject} in the context menu.
|
||||
|
||||
\section2 Specify dependencies
|
||||
|
||||
To specify dependencies, use the \uicontrol{Add Library} wizard.
|
||||
|
||||
\sa {Creating Projects}, {Use project wizards},
|
||||
{Add libraries to qmake projects}, {Add libraries to CMake projects}
|
||||
*/
|
||||
|
@@ -53,9 +53,9 @@
|
||||
project.
|
||||
\endlist
|
||||
|
||||
In rare cases, ClangFormat can trip over a code construct and
|
||||
trigger a \QC crash. If that happens for your project, select
|
||||
\uicontrol {Use Built-In Indenter} in \uicontrol {Formatting mode} to
|
||||
In rare cases, \l{ClangFormat: Documentation}{ClangFormat} can trip over a
|
||||
code construct and trigger a \QC crash. If that happens for your project,
|
||||
select \uicontrol {Use Built-In Indenter} in \uicontrol {Formatting mode} to
|
||||
turn off ClangFormat for the project. If you can reproduce the crash,
|
||||
go to \uicontrol Help > \uicontrol {Report Bug} to report
|
||||
the bug and attach the code that triggers the crash to the bug report.
|
||||
|
Binary file not shown.
After Width: | Height: | Size: 3.9 KiB |
@@ -0,0 +1,59 @@
|
||||
// Copyright (C) 2024 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||
|
||||
/*!
|
||||
\page studio-telemetry.html
|
||||
\previouspage creator-quick-ui-forms.html
|
||||
\nextpage studio-collecting-usage-statistics.html
|
||||
|
||||
\title Managing Data Collection
|
||||
|
||||
See below for more information about the collected data:
|
||||
|
||||
\list
|
||||
\li \l {Collecting Usage Statistics}
|
||||
\li \l {Collecting User Feedback}
|
||||
\li \l {Reporting Crashes}
|
||||
\endlist
|
||||
|
||||
\section1 Principles of Data Collection
|
||||
|
||||
No personal data, such as names, IP addresses, MAC addresses, or project
|
||||
and path names are collected. However, QUuid objects are used to identify
|
||||
data records that belong to one user. The objects cannot be converted
|
||||
back to the actual values from which they were generated.
|
||||
|
||||
For more information about Qt privacy policy, see
|
||||
\l{https://www.qt.io/terms-conditions/privacy-and-security}
|
||||
{Qt Appendix for Privacy and Security}.
|
||||
|
||||
\sa {Collecting Usage Statistics}
|
||||
*/
|
||||
|
||||
/*!
|
||||
\page studio-collecting-usage-statistics.html
|
||||
\previouspage studio-telemetry.html
|
||||
\nextpage studio-user-feedback.html
|
||||
|
||||
\title Collecting Usage Statistics
|
||||
|
||||
The telemetry plugin uses the
|
||||
\l{https://api.kde.org/frameworks/kuserfeedback/html/index.html}
|
||||
{KUserFeedback} framework to collect the usage data. The library
|
||||
has been designed from the user data privacy point of view and
|
||||
\QC respects the same privacy rules.
|
||||
|
||||
The data is transmitted to the backend storage using an encrypted
|
||||
connection. The storage is located in the same Heroku backend as the
|
||||
\QOI backend. Physically, data is stored in the Amazon cloud.
|
||||
|
||||
\section1 Turning on Telemetry
|
||||
|
||||
To determine what data is transmitted to the backend storage, go to
|
||||
\preferences > \uicontrol Telemetry > \uicontrol {Usage Statistics},
|
||||
and then select \uicontrol {Enable telemetry}.
|
||||
|
||||
\image studio-preferences-telemetry-usage-statistics.webp {Usage Statistics}
|
||||
|
||||
\sa {Managing Data Collection}
|
||||
*/
|
@@ -23,7 +23,7 @@
|
||||
Some of the wizard templates create projects that contain UI files.
|
||||
You should always edit UI files in the \l {2D}
|
||||
and \l Properties view, to avoid breaking the code.
|
||||
\li \l{Manage Data Collection}
|
||||
\li \l{Managing Data Collection}
|
||||
|
||||
You can enable \QDS to report crashes automatically. If you enable
|
||||
the telemetry plugin, you can turn on the pseudonymous user
|
||||
|
@@ -217,9 +217,9 @@
|
||||
\li Extending Component Functionality
|
||||
\endomit
|
||||
\li \l{UI Files}
|
||||
\li \l{Manage Data Collection}
|
||||
\li \l{Managing Data Collection}
|
||||
\list
|
||||
\li \l {Collect Usage Statistics}
|
||||
\li \l {Collecting Usage Statistics}
|
||||
\li \l {Collecting User Feedback}
|
||||
\li \l {Reporting Crashes}
|
||||
\endlist
|
||||
|
Reference in New Issue
Block a user