aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator/src/debugger
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2023-02-03 17:25:21 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2023-02-06 11:09:29 +0000
commit738819ec71261009e650ae378ffcafe7512841ce (patch)
tree972e7a9a75e9dec255b23788fb6e0297f5852bb0 /doc/qtcreator/src/debugger
parent33badfa660f57fe62547f9c609d58088c2165280 (diff)
Doc: Replace "provide" with something simpler
This follows the ComplexWords rule in vale. Change-Id: I99d8e5dc3ee4736a254064b6ef00166419fccee8 Reviewed-by: <github-actions-qt-creator@cristianadam.eu> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'doc/qtcreator/src/debugger')
-rw-r--r--doc/qtcreator/src/debugger/creator-debugger-common.qdocinc19
-rw-r--r--doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdocinc7
-rw-r--r--doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc19
-rw-r--r--doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc21
4 files changed, 30 insertions, 36 deletions
diff --git a/doc/qtcreator/src/debugger/creator-debugger-common.qdocinc b/doc/qtcreator/src/debugger/creator-debugger-common.qdocinc
index d295676cfc..ac4a2e4164 100644
--- a/doc/qtcreator/src/debugger/creator-debugger-common.qdocinc
+++ b/doc/qtcreator/src/debugger/creator-debugger-common.qdocinc
@@ -368,7 +368,7 @@
\uicontrol {Locals} and \uicontrol {Expressions} view to show
unexpected data.
\row
- \li The debug information provided by GCC does not include enough
+ \li The debug information from GCC does not include enough
information about the time when a variable is initialized.
Therefore, \QC can not tell whether the contents of a local
variable are \e {real data} or \e {initial noise}. If a QObject
@@ -385,21 +385,20 @@
\section1 Inspecting Basic Qt Objects
- The \uicontrol {Locals} and \uicontrol {Expressions} views also provide access
- to the most powerful feature of the debugger: comprehensive display of data
- belonging to Qt's basic objects. For example, in case of QObject, instead of
- displaying a pointer to some private data structure, you see a list of
+ The most powerful feature of the debugger is that the \uicontrol {Locals}
+ and \uicontrol {Expressions} views show the data that belongs to
+ Qt's basic objects. For example, in case of QObject, instead of
+ a pointer to some private data structure, you see a list of
children, signals, and slots.
Similarly, instead of displaying many pointers and integers, \QC's debugger
displays the contents of a QHash or QMap in an orderly manner. Also, the
- debugger displays access data for QFileInfo and provides access to the
- \e real contents of QVariant.
+ debugger shows access data for QFileInfo and the \e real contents of QVariant.
Right-click in the \uicontrol {Locals} or the \uicontrol {Expressions} view
- to open a context menu that provides additional options for viewing data. The
- available options depend on the type of the current items, and are provided
- by the \l{Using Debugging Helpers}{Debugging Helpers}. Typically,
+ to open a context menu that has more options for viewing data. The
+ available options depend on the type of the current items, and come from
+ the \l{Using Debugging Helpers}{Debugging Helpers}. Typically,
string-like data, such as \c{QByteArray} and \c{std::string}, offer a
selection of encodings, as well as the possibility to use a full editor
window. Map-like data, such as \c{QMap}, \c{QHash}, and \c{std::map}, offer
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdocinc b/doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdocinc
index f6e5fedcf6..0cf94c9f7d 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdocinc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdocinc
@@ -170,9 +170,8 @@
source code editor, select the \uicontrol {Correct breakpoint location}
check box. For more information, see \l{Setting Breakpoints}.
- To use the abstraction layer provided by Python Dumper
- classes to create a description of data items displayed
- in the \uicontrol Locals and \uicontrol Expressions
+ To use the abstraction layer of Python Dumper classes to create a description
+ of data items in the \uicontrol Locals and \uicontrol Expressions
views, select the \uicontrol {Use Python dumper} check box.
For more information, see \l{Debugging Helper Implementation}.
@@ -183,7 +182,7 @@
\section2 Setting CDB Paths on Windows
To obtain debugging information for the operating system libraries for
- debugging Windows applications, add the Symbol Server provided by Microsoft
+ debugging Windows applications, add the Microsoft Symbol Server
to the symbol search path of the debugger:
\list 1
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc
index ec607e0f29..ca68d35d37 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc
@@ -37,14 +37,14 @@
\uicontrol Debuggers > \uicontrol Add to add it.
\note To use the debugging tools for Windows, you must install them and add
- the Symbol Server provided by Microsoft to the symbol search path of the
+ the Microsoft Symbol Server to the symbol search path of the
debugger. For more information, see \l{Setting CDB Paths on Windows}.
\note To use the Free Software Foundation (FSF) version of GDB on \macos, you
must sign it and modify your \l{glossary-buildandrun-kit}{kit} settings.
- This section explains the options you have for debugging C++ code and
- provides installation notes for the supported native debuggers. It also
+ This section describes the options you have for debugging C++ code and
+ installing the supported native debuggers. It also
applies for code in other compiled languages such as C, FORTRAN, Ada.
For more information on the debugger modes, see
@@ -145,8 +145,7 @@
\section1 Installing Native Debuggers
- The following sections provide information about installing native
- debuggers.
+ The following sections describe installing native debuggers.
\section2 GDB
@@ -185,12 +184,10 @@
\section3 Symbol Server
- It is highly recommended that you add the Symbol Server provided
- by Microsoft to the symbol search path of the debugger. The
- Symbol Server provides you with debugging information for the
- operating system libraries for debugging Windows applications.
- For more information, see
- \l{Setting CDB Paths on Windows}.
+ We highly recommend that you add the Microsoft Symbol Server to the
+ symbol search path of the debugger. The Symbol Server has debugging
+ information for the operating system libraries for debugging Windows
+ applications. For more information, see \l{Setting CDB Paths on Windows}.
\section2 Debugging Tools for \macos
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
index 74ffd9c09a..163981b3a5 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
@@ -14,7 +14,7 @@
\title Debugging
- \QC provides a debugger plugin that acts as an interface between the \QC
+ \QC has a debugger plugin that acts as an interface between the \QC
core and external native debuggers such as the GNU Symbolic Debugger (GDB),
the Microsoft Console Debugger (CDB), a QML/JavaScript debugger, and the
debugger of the low level virtual machine (LLVM) project, LLDB.
@@ -325,8 +325,7 @@
\section1 Remote Debugging
- \QC provides very easy access to remote debugging.
-
+ \QC makes remote debugging easy.
In general, the remote debugging setup consist of a probe running on the
remote machine and a counterpart running on the host side. The probe is
either integrated into the running process (e.g. for QML debugging) or runs
@@ -533,11 +532,11 @@
\endlist
- \QC displays the raw information provided by the native debuggers in a clear
+ \QC displays the raw information from the native debuggers in a clear
and concise manner with the goal to simplify the debugging process as much
as possible without losing the power of the native debuggers.
- In addition to the generic IDE functionality provided by stack view, views
+ In addition to the generic IDE functionality offered by stack view, views
for locals and expressions, registers, and so on, \QC includes features to
make debugging Qt-based applications easy. The debugger plugin understands
the internal layout of several Qt classes, for example, QString, the Qt
@@ -627,7 +626,7 @@
into one step for less noisy debugging. For more information, see
\l{Specifying GDB Settings}.
- The extended GDB settings provide the option to step backwards in code,
+ The extended GDB settings have the option to step backwards in code,
but this option should be used with care, as it is slow and unstable on the
GDB side. For more information, see \l{Specifying GDB Settings}.
@@ -665,8 +664,8 @@
the bottom of the view. Output is displayed in the right pane of the
\uicontrol {Debugger Log} view.
- \note Usually, you do not need this feature because \QC provides you
- with better ways to handle the task. For example, instead of using the GDB
+ \note Usually, you do not need this feature because \QC offers better ways to
+ handle the task. For example, instead of using the GDB
\c print command from the command line, you can evaluate an expression in
the \uicontrol {Expressions} view.
@@ -1093,9 +1092,9 @@
As the format is not guaranteed to be stable, it is strongly recommended
not to generate the wire format directly, but to use the abstraction
- layer provided by the Python Dumper classes, specifically the \c{Dumper}
+ layer of the Python Dumper classes, specifically the \c{Dumper}
class itself, and the \c{Dumper:Value} and \c{Dumper:Type} abstractions.
- These provide a complete framework to take care of the \c iname and \c addr
+ These offer a complete framework to take care of the \c iname and \c addr
fields, to handle children of simple types, references, pointers, enums, and
known and unknown structs, as well as some convenience functions to handle
common situations.
@@ -1287,7 +1286,7 @@
built into or shipped alongside the debugged binary, or created on-the-fly
by the debugging helper.
- \QC uses the possibility to provide type information on-the-fly for most Qt
+ \QC offers type information on-the-fly for most Qt
classes, obliterating the need to use \e Debug builds of Qt for the purpose
of object introspection.