Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit dd8f30cc authored by Rajaneesh Acharya's avatar Rajaneesh Acharya Committed by Jason Wessel
Browse files

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: default avatarGraham Whaley <graham.whaley@intel.com>
Signed-off-by: default avatarJason Wessel <jason.wessel@windriver.com>
parent 5516fd7b

Documentation/DocBook/kgdb.tmpl

+3 −3
Original line number Diff line number Diff line
@@ -197,6 +197,7 @@ 
   may be configured as a kernel built-in or a kernel loadable module.

   You can only make use of <constant>kgdbwait</constant> and early

   debugging if you build kgdboc into the kernel as a built-in.

   </para>

   <para>Optionally you can elect to activate kms (Kernel Mode

   Setting) integration.  When you use kms with kgdboc and you have a

   video driver that has atomic mode setting hooks, it is possible to
@@ -206,7 +207,6 @@ 
   crashes or doing analysis of memory with kdb while allowing the

   full graphics console applications to run.

   </para>

   </para>

   <sect2 id="kgdbocArgs">

   <title>kgdboc arguments</title>

   <para>Usage: <constant>kgdboc=[kms][[,]kbd][[,]serial_device][,baud]</constant></para>
@@ -287,7 +287,6 @@ 
   </listitem>

   </orderedlist>

   </para>

   </sect3>

   <para>NOTE: Kgdboc does not support interrupting the target via the

   gdb remote protocol.  You must manually send a sysrq-g unless you

   have a proxy that splits console output to a terminal program.
@@ -308,6 +307,7 @@ 
    as well as on the initial connect, or to use a debugger proxy that

    allows an unmodified gdb to do the debugging.

   </para>

   </sect3>

   </sect2>

   </sect1>

   <sect1 id="kgdbwait">
@@ -353,12 +353,12 @@ 
   </para>

   </listitem>

   </orderedlist>

  </para>

   <para>IMPORTANT NOTE: You cannot use kgdboc + kgdbcon on a tty that is an

   active system console.  An example incorrect usage is <constant>console=ttyS0,115200 kgdboc=ttyS0 kgdbcon</constant>

   </para>

   <para>It is possible to use this option with kgdboc on a tty that is not a system console.

   </para>

  </para>

  </sect1>

   <sect1 id="kgdbreboot">

   <title>Run time parameter: kgdbreboot</title>