Commit dd8f30cc0550f36861ddfa42c27cc5c580b0bf8c

Authored by Rajaneesh Acharya
Committed by Jason Wessel
1 parent 5516fd7b92

kgdb, docs: Fix <para> pdfdocs build errors

kgdb.pdf failed to build from 'make pdfdocs' giving errors such as:

jade:... Documentation/DocBook/kgdb.xml:200:8:E:
document type does not allow element "para" here; missing one of
"footnote", "caution", "important", "note", "tip", "warning",
"blockquote", "informalexample" start-tag

Fixing minor <para> and <sect> issues allows kgdb.pdf to be generated
under Fedora20.

Originally submitted by rajaneesh.acharya@yahoo.com in 2011, discussed here:
http://permalink.gmane.org/gmane.linux.documentation/3954
as patch:
 The following are the enhancements that removed the errors
 while issuing "make pdfdocs"

[graham.whaley@intel.com: Improved commit message and ported to 3.18.1]
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
Signed-off-by: Jason Wessel <jason.wessel@windriver.com>

Showing 1 changed file with 3 additions and 3 deletions Side-by-side Diff

Documentation/DocBook/kgdb.tmpl
... ... @@ -197,6 +197,7 @@
197 197 may be configured as a kernel built-in or a kernel loadable module.
198 198 You can only make use of <constant>kgdbwait</constant> and early
199 199 debugging if you build kgdboc into the kernel as a built-in.
  200 + </para>
200 201 <para>Optionally you can elect to activate kms (Kernel Mode
201 202 Setting) integration. When you use kms with kgdboc and you have a
202 203 video driver that has atomic mode setting hooks, it is possible to
... ... @@ -206,7 +207,6 @@
206 207 crashes or doing analysis of memory with kdb while allowing the
207 208 full graphics console applications to run.
208 209 </para>
209   - </para>
210 210 <sect2 id="kgdbocArgs">
211 211 <title>kgdboc arguments</title>
212 212 <para>Usage: <constant>kgdboc=[kms][[,]kbd][[,]serial_device][,baud]</constant></para>
... ... @@ -287,7 +287,6 @@
287 287 </listitem>
288 288 </orderedlist>
289 289 </para>
290   - </sect3>
291 290 <para>NOTE: Kgdboc does not support interrupting the target via the
292 291 gdb remote protocol. You must manually send a sysrq-g unless you
293 292 have a proxy that splits console output to a terminal program.
... ... @@ -308,6 +307,7 @@
308 307 as well as on the initial connect, or to use a debugger proxy that
309 308 allows an unmodified gdb to do the debugging.
310 309 </para>
  310 + </sect3>
311 311 </sect2>
312 312 </sect1>
313 313 <sect1 id="kgdbwait">
314 314  
... ... @@ -353,12 +353,12 @@
353 353 </para>
354 354 </listitem>
355 355 </orderedlist>
  356 + </para>
356 357 <para>IMPORTANT NOTE: You cannot use kgdboc + kgdbcon on a tty that is an
357 358 active system console. An example incorrect usage is <constant>console=ttyS0,115200 kgdboc=ttyS0 kgdbcon</constant>
358 359 </para>
359 360 <para>It is possible to use this option with kgdboc on a tty that is not a system console.
360 361 </para>
361   - </para>
362 362 </sect1>
363 363 <sect1 id="kgdbreboot">
364 364 <title>Run time parameter: kgdbreboot</title>