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.wha...@linux.intel.com> > --- > 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 ... > @@ -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"? > <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. > 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). > <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 > ------------------------------------------------------------------------------ Dive into the World of Parallel Programming. The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/ _______________________________________________ Kgdb-bugreport mailing list Kgdb-bugreport@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/kgdb-bugreport
