On Tue, 2015-02-03 at 13:26 +0000, Daniel Thompson wrote: > On 03/02/15 12:10, Graham Whaley wrote: > > Fix up a number of small typos, duplications and formatting issues. > > > > Signed-off-by: Graham Whaley <graham.whaley@xxxxxxxxxxxxxxx> > > --- > > V2: Against 3.19-rc7, not requring patch "kgdb,docs: Fix <para> pdfdocs build errors" to be applied first. > > > > Documentation/DocBook/kgdb.tmpl | 45 +++++++++++++++++++++-------------------- > > 1 file changed, 23 insertions(+), 22 deletions(-) > > > > diff --git a/Documentation/DocBook/kgdb.tmpl b/Documentation/DocBook/kgdb.tmpl > > index f77358f..4d782c12 100644 > > --- a/Documentation/DocBook/kgdb.tmpl > > +++ b/Documentation/DocBook/kgdb.tmpl > [...] > > @@ -261,9 +261,6 @@ > > </sect3> > > <sect3 id="kgdbocArgs3"> > > <title>More examples</title> > > - <para>You can configure kgdboc to use the keyboard, and or a serial > > - device depending on if you are using kdb and or kgdb, in one of the > > - following scenarios.</para> > > <para>You can configure kgdboc to use the keyboard, and or a serial device > > Not your fault but shouldn't this be ... and/or ... Yep, I reckon you are right. Reckon I missed that one during my read-through spotting niggles... Looks like I'll be doing a v3 from the below comments, so will pick this one up in that. Thanks. > > > > @@ -386,12 +383,12 @@ > > <title>Quick start for kdb on a serial port</title> > > <para>This is a quick example of how to use kdb.</para> > > <para><orderedlist> > > - <listitem><para>Boot kernel with arguments: > > + <listitem><para>Boot the kernel with the arguments: > > "the arguments" doesn't feel right here. How about a more aggressive > change such as "Configure kgdboc at boot using kernel parameters"? Maybe. I'll have to go have a re-read. I admit my version was only mildly better/different than the original. I still wasn't over the moon with the gist. I'll see if I can come up with something (and for the other occurrences). Other opinions welcome on that one. > > > > <itemizedlist> > > <listitem><para><constant>console=ttyS0,115200 kgdboc=ttyS0,115200</constant></para></listitem> > > </itemizedlist></para> > > <para>OR</para> > > - <para>Configure kgdboc after the kernel booted; assuming you are using a serial port console: > > + <para>Configure kgdboc after the kernel has booted; assuming you are using a serial port console: > > <itemizedlist> > > <listitem><para><constant>echo ttyS0 > /sys/module/kgdboc/parameters/kgdboc</constant></para></listitem> > > </itemizedlist> > > @@ -442,12 +439,12 @@ > > <title>Quick start for kdb using a keyboard connected console</title> > > <para>This is a quick example of how to use kdb with a keyboard.</para> > > <para><orderedlist> > > - <listitem><para>Boot kernel with arguments: > > + <listitem><para>Boot the kernel with the arguments: > > As above. > > > > <itemizedlist> > > <listitem><para><constant>kgdboc=kbd</constant></para></listitem> > > </itemizedlist></para> > > <para>OR</para> > > - <para>Configure kgdboc after the kernel booted: > > + <para>Configure kgdboc after the kernel has booted: > > <itemizedlist> > > <listitem><para><constant>echo kbd > /sys/module/kgdboc/parameters/kgdboc</constant></para></listitem> > > </itemizedlist> > > @@ -501,12 +498,12 @@ > > <title>Connecting with gdb to a serial port</title> > > <orderedlist> > > <listitem><para>Configure kgdboc</para> > > - <para>Boot kernel with arguments: > > + <para>Boot the kernel with the arguments: > > As above. > > > > <itemizedlist> > > <listitem><para><constant>kgdboc=ttyS0,115200</constant></para></listitem> > > </itemizedlist></para> > > <para>OR</para> > > - <para>Configure kgdboc after the kernel booted: > > + <para>Configure kgdboc after the kernel has booted: > > <itemizedlist> > > <listitem><para><constant>echo ttyS0 > /sys/module/kgdboc/parameters/kgdboc</constant></para></listitem> > > </itemizedlist></para> > > @@ -536,7 +533,7 @@ > > </para> > > </listitem> > > <listitem> > > - <para>Connect from from gdb</para> > > + <para>Connect from gdb</para> > > <para> > > Example (using a directly connected port): > > </para> > > @@ -584,8 +581,8 @@ > > <para> > > There are two ways to switch from kgdb to kdb: you can use gdb to > > issue a maintenance packet, or you can blindly type the command $3#33. > > - Whenever kernel debugger stops in kgdb mode it will print the > > - message <constant>KGDB or $3#33 for KDB</constant>. It is important > > + Whenever the kernel debugger stops in kgdb mode it will print the > > + message <constant>KGDB</constant> or <constant>$3#33 for KDB</constant>. It is important > > Introducing an extra constant is wrong here. The word "or" is part of > the message and should be shown in monotype. OK, I'll go check. I thought I'd checked the source to see what was actually printed - will do so again. > > > > to note that you have to type the sequence correctly in one pass. > > You cannot type a backspace or delete because kgdb will interpret > > that as part of the debug stream. > > @@ -704,7 +701,7 @@ Task Addr Pid Parent [*] cpu State Thread Command > > <listitem><para>Registration and unregistration of architecture specific trap hooks</para></listitem> > > <listitem><para>Any special exception handling and cleanup</para></listitem> > > <listitem><para>NMI exception handling and cleanup</para></listitem> > > - <listitem><para>(optional)HW breakpoints</para></listitem> > > + <listitem><para>(optional) HW breakpoints</para></listitem> > > </itemizedlist> > > </para> > > </listitem> > > @@ -760,7 +757,7 @@ Task Addr Pid Parent [*] cpu State Thread Command > > a kgdb I/O driver for characters when it needs input. The I/O > > driver is expected to return immediately if there is no data > > available. Doing so allows for the future possibility to touch > > - watch dog hardware in such a way as to have a target system not > > + watchdog hardware in such a way as to have a target system not > > reset when these are enabled. > > </para> > > </listitem> > > @@ -783,10 +780,14 @@ Task Addr Pid Parent [*] cpu State Thread Command > > NUMREGBYTES: The size in bytes of all of the registers, so > > that we can ensure they will all fit into a packet. > > </para> > > + </listitem> > > + <listitem> > > Indentation is mismatched here (you want tabs or spaces). Yep - will fix. FMI - any particular hints from anybody as what to edit these .tmpl files with to avoid this? I'm normally a vi/vim guy or *Office. I had a search for recommendations before doing the edits but came up moderately dry. Emacs is probably not going to work so well for me. Jonathan - expect a v3 soon. Thanks Daniel. Graham > > > > <para> > > BUFMAX: The size in bytes of the buffer GDB will read into. > > This must be larger than NUMREGBYTES. > > </para> > > + </listitem> > > + <listitem> > > As above. > > > <para> > > CACHE_FLUSH_IS_SAFE: Set to 1 if it is always safe to call > > flush_cache_range or flush_icache_range. On some architectures, > > @@ -812,8 +813,8 @@ Task Addr Pid Parent [*] cpu State Thread Command > > <para> > > The kgdboc driver is actually a very thin driver that relies on the > > underlying low level to the hardware driver having "polling hooks" > > - which the to which the tty driver is attached. In the initial > > - implementation of kgdboc it the serial_core was changed to expose a > > + to which the tty driver is attached. In the initial > > + implementation of kgdboc the serial_core was changed to expose a > > low level UART hook for doing polled mode reading and writing of a > > single character while in an atomic context. When kgdb makes an I/O > > request to the debugger, kgdboc invokes a callback in the serial > > > -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
