summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2023-03-27 14:22:18 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2023-03-28 14:19:39 +0000
commitdf53b7c9b73efbb8730e7a9e0c65375f8010c822 (patch)
treee7ebe7d8c159c4b9566a8548d4933e82676c545c /doc
parentc46dff01995128bd97c03e6d732c85f662355bf9 (diff)
downloadqt-creator-df53b7c9b73efbb8730e7a9e0c65375f8010c822.tar.gz
Doc: Add docs for Peripheral Registers view in Debug mode
Task-number: QTCREATORBUG-28778 Change-Id: I17b66417c943c08295a8e7fb9936e5f8d28b9263 Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/qtcreator/images/qtcreator-debugger-peripheral-registers-view.webpbin0 -> 2414 bytes
-rw-r--r--doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc47
2 files changed, 43 insertions, 4 deletions
diff --git a/doc/qtcreator/images/qtcreator-debugger-peripheral-registers-view.webp b/doc/qtcreator/images/qtcreator-debugger-peripheral-registers-view.webp
new file mode 100644
index 0000000000..34c8813108
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-debugger-peripheral-registers-view.webp
Binary files differ
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
index cd05267996..a5e49e3749 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
@@ -632,9 +632,11 @@
\row
\li Peripheral Registers
\li View the current state of peripheral registers.
- \li
+ \li \l {Peripheral Registers}
\row
- \li Debugger Log
+ \li Global Debugger Log
+
+ Debugger Log
\li View debug output to find out why the debugger does not work.
The log view acts as a console, so you can send the contents
@@ -653,6 +655,9 @@
\li \l {Working in Edit Mode}
\endtable
+ \note The \uicontrol Views menu shows some views only while you are
+ debugging.
+
\section1 Managing Debug Views
When you are not debugging, the \uicontrol Debug mode shows the
@@ -1003,7 +1008,7 @@
/*!
\page creator-registers-view.html
\previouspage creator-expressions-view.html
- \nextpage creator-debugger-log-view.html
+ \nextpage creator-peripheral-registers-view.html
\title Viewing and Editing Register State
@@ -1033,6 +1038,7 @@
\li Open \l {Examining Memory}{Memory Editor} at the selected value.
\li Open the \l {Viewing Disassembled Code}{Disassembler} view.
\li Display a value in hexadecimal, decimal, octal, or binary format.
+ \li Set \l{Debugger Preferences}{debugger preferences}.
\endlist
By default, the \uicontrol Registers view is hidden. To show it, select it in
@@ -1061,8 +1067,41 @@
*/
/*!
- \page creator-debugger-log-view.html
+ \page creator-peripheral-registers-view.html
\previouspage creator-registers-view.html
+ \nextpage creator-debugger-log-view.html
+
+ \title Peripheral Registers
+
+ The \uicontrol {Peripheral Registers} view displays the current state of
+ peripheral devices, such as a mouse, keyboard, display, printer, or USB
+ drive. Applications write registers to send information to the device and
+ read them to get information from the device. To read registers in a
+ peripheral device, the application accesses its I/O addresses with a load
+ or store instruction that the CPU issues.
+
+ \image qtcreator-debugger-peripheral-registers-view.webp {Peripheral Registers view}
+
+ The \uicontrol Access column shows whether the register is read-and-write
+ (\uicontrol RW), read-only (\uicontrol RO), or write-only (\uicontrol WO).
+ \uicontrol N/A means that the access type is not available.
+
+ Right-click column headers to show and hide columns in the view.
+
+ Right-click the view to select the following actions:
+
+ \list
+ \li View register groups.
+ \li Set \l{Debugger Preferences}{debugger preferences}.
+ \endlist
+
+ By default, the \uicontrol {Peripheral Registers} view is hidden. To show it,
+ select it in \uicontrol Views on the debugger toolbar.
+*/
+
+/*!
+ \page creator-debugger-log-view.html
+ \previouspage creator-peripheral-registers-view.html
\nextpage creator-disassembler-view.html
\title Debugger Log