From df53b7c9b73efbb8730e7a9e0c65375f8010c822 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Mon, 27 Mar 2023 14:22:18 +0200
Subject: [PATCH] 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>
---
 ...or-debugger-peripheral-registers-view.webp | Bin 0 -> 2414 bytes
 .../creator-only/creator-debugger.qdoc        |  47 ++++++++++++++++--
 2 files changed, 43 insertions(+), 4 deletions(-)
 create mode 100644 doc/qtcreator/images/qtcreator-debugger-peripheral-registers-view.webp

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 0000000000000000000000000000000000000000..34c88131085c8270fa5e1b9e04cb5775bf181312
GIT binary patch
literal 2414
zcmWIYbaPANWMBw)bqWXzu<(iEWMI(W$!N-O^}^h3=L>IJJfE|9YH`^)vzIx-E$J^D
zm(S5&UDV_icJ2@Rldhb(sxu4zaIgEcq4c@Y@>7TJ-hU^1LN)Ipi*{qNz@mx}z9TOf
zejf1tz`@-V(6Bo9_N^yJFKNz=F<0SyS1@f3ld*Vq`W@S*$!m50J)XtBF6VaE?9Hmp
z1!n}7ojSw!-)`|ve^uX*pP>t9{_`%l?J-GZ=k9c^?VF++yH44q#T!U3+HRx%x3?$U
z>VNq5|A#|FJ0_fY=5}kk3a979{7;j+^zEig1$HW^zjarY%&=-%A7NY9J|XzoiR$X>
z_KF+!uJSpedanNUvy9r0xn;aFuf1UGs9YVcKIvZi`9<1d&+L8fNH5FGyY3tGWbQiq
zoCLL!$zFP)uQD_C$#7fx9X2_*gQ@1@&MOmcOnfI6ar|80&CTX3gY>rU+M;f%66HR>
z<dKKT(l5K-HVV9Ui+jP(tQ^2~K3i7wo9@|X6@Tyb39LT8k|S{0&2#f?<ph(a9B$Zu
z`Jl3z-K0Bg84cGiE{{2SwYcNd0gtT=eN%2sT&C&hd#fPwy64J3TTRVFDyLk;FXc3H
zwKLXFXZ+*0RH>sow8O~i>Xdl}Zk*h+Ce0IY3Swb&3VJ;E%i49<Z*zQOowRnbzrZZr
zpobP`HpmBjxOu%)Oa0pWw-W-UY`D|;wfe$^$!iz;x9Ic6`g1AxY-ZK^^KF5)#58u@
zLm^rVL^H&;T)&*v=-}3ML*duqqkbmQ3l8NUuG(?=0RKwGU&jO$-CpL;a*>StpHyoY
zb-#hDE|D!L<EL7gXM^c|!PHs00S`BvpO|0%?{t0NnUi&WDNir6Y&=)|x!nBCL!O=w
zpS~~cX|%U}=iy#lzxc=Imei)dHv02K+kd;|YRP<;Ot5d4Z~I%j*i5wVwfLL#nO8Kn
z><gUDb^I&y@5r`qOF^pUtmsQSSU0W9ZRI`ltl)<`zNVEf^^iR$HF4silvZ(LU-ugs
z#o--WkFUM^)oRUz*e`cqc^R8r)@=!id#yK%@$BjRBvbE&g1NW0d|Pq#;hKpK?iVB&
z<(gY<W^Y}%CS!}Ums9zv{Gf|F>>dWM7dR8@9QB*aA}X=6{>_G2s*4;g&V5RY-gW;6
zTcL^Ot&olE>n2>hCA0i&{<fXk>hFcMq|ST{k_(uma`EAsLT1nJLXP<tpP9FwSS(!Y
zF-awNRnCLUei}Nj{XXp2DlO7>&~;H^gt)T|U#r!=JvZfS8@i{cEIeGf!Ds=4O$eL(
zr;EBe-<5WxMjmkN5;?V|wvx3!YSG!qsGVE#18%53kJ>v=bp>POw5w&8O4bHlm>n&)
z)+5JZb@#+u)68!vUOQ~}YN5mFy(dn!H*Ly}JYo|Ox$bae<g}@$qq2k>rk-x9bn@^z
za8u>jbn{!6=C%k#rkz`+AMbyeD>y*hIyN)+Y?SBAyvLDZhWugE*6fHl7%Dq!L1$cI
zWPMCd(sJW9EViP1QhWVYWlm5lvvRgs!+5OGV`8gLTl<0top-<OXRIyDx;&*lXhuxz
znJe2)3TjL;Q;p!wl{*)$t}FQES%G~h=MstaH{w2QxH|K$$<t2na?ZKF=c3<r$#$t9
zahMo%!%jEUCh7662&V8*op+amew)Pb&T(J)<_N<L|EU`DHtemP_2P`$-0v4Ok7+xl
zL@L_75zTCs6<l;!FjCyQ<VP>#1*yn_i|l(X=df#AE4l1q`4%jFh+o)c!mWP>OE@>q
zKl(zkWJCUyWrqsqJH1I)tYXN0E4_7P!JR^lDsPkT_2-iQ34fkH<Nu$>(&k+ql6nut
zIwt&-mNi~z#=XdF*#VOoj2|<4HyQ}0X4|yhe==_a@1lp6&$pkooxk&Ey#4nZ_fMTT
z^FPT>g=yMORo2%m8#L~8lyR?HWZzq!yJ7pRLk)JHr1LxvTj?JTob>vlgo$KZI-`5x
z`SiSh(|4-&mT~|5c`QYwh&%6q#fHf<)QhJ)usW!(@t$jsbM3yLCm*X;+C7_QQr5h;
zm9Osffjp)w<v$DO@WgFs6qZ~6K5K(avR#FT)XohK&ot&Qv`s9U$F`fr+<E`?`PY6i
zKgg8i7d|lKF4N~kJNuu%YMPf{^*6f_y(eSx9G-|{E@BCt&r2Pm?@TIUX1l=pBgt=x
zapdLvIl>XG6$(|H77MN|vU#%6b^EI0`=uY|vhk>IQe#_t(&4e(ZO)pRNeBMiNq)L%
z8QV8r_8+f)x12QGSQzry<b&sTlO3O`9GLrm9&GkHr<=*~f$g9Aha#TqxmOYsCZ<1h
zuyL`Fx9o_$z;<Cl&8j#4DnfD<QaPm-{62rocC`Poc=03RP~yYQT+a{0z1p1-FY!lI
z$oKNUX)cTB_s)1I6t!&*$IN<(<*BdNtd9F1X0(fI^E7k!Y2nY++-iMGKIY1-Us>Dg
zdivVi?cPQ_i|@`2)Y%u?#a=nblw17%v8t`VncsfTI^JGm|3)%Ms;YmAd99hz^Qtv>
z<d*)upv;rHzc*diwf*_Yc|Mc;lO?L#PW}9LZC+x^2cbERu??xWVt4=cc(Ci3`>!{t
z-=oh?I-xSR<v<y;($hbyW!anE*mM|{tUELDlBdGj8O3#n-R`UIh@8c8d7)UiP~O7V
z+1EZj3%K?)=exF6T*c~_Di@U_metmMS)0T)JHbE1IAnoGWpH?+S<jl(l9$)6@=TKp
zI(Jnq<I7!xhcno33D<11xZxagjb+8$6=Fw1b0ltSmRyx=Q96)xTW*%#TMv`X1wUeM
z&F1FslYE!xr}ngMAqP|J53k0whfR4h#{#Z0Tt0B@<Px4IR^7W-dC61-x7p?LiyZvC
z!Bk|*-G($5#|>(%52WKA?WBLm%#=0Rb^hH18Rt;uJ=<4G9ZOdhv$%R=(v2G_3I0wj
zd*2^?zq&yocKV&8H{|pl9Mk-gwMl*Q-euB#TbT~L{pQ_nee>Giy?*Oo3SF~pue}*v
zpsIOp5&OOgzr!}CtbaM_n(c}Fi02Ptr{A#oB=9n5d*Z&SwR-nv9O=8YVgJNZyL&BQ
z*0fSayK;e#Mc3jxegvA`Qr)@zkc`&ESvP8xe|@(STv#;A>Gn6j&>xI_bN5X8BH>WK
z_<_)}gDzXDdAdR@V;OhJTXi2WJ0E1g=*w!SXg5dnzw4?w3lDhrdcN^2U_3be)Gcwf
zf4(Vv*LJYj#;xXcUlr3ZUrWX&!Xo<M`%B@Q&IJZ^Z*H&Raanc6LC^2c`jnf`wR%>o
tyt;hi@`m$a6_t;Cm1J8TJ<rttbK>}~{><L+f9FsCGxgBo<A}^bRsa}Rr3nB4

literal 0
HcmV?d00001

diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
index cd052679964..a5e49e3749f 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