Prechádzať zdrojové kódy

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>
Rajaneesh Acharya 10 rokov pred
rodič
commit
dd8f30cc05
1 zmenil súbory, kde vykonal 3 pridanie a 3 odobranie
  1. 3 3
      Documentation/DocBook/kgdb.tmpl

+ 3 - 3
Documentation/DocBook/kgdb.tmpl

@@ -197,6 +197,7 @@
    may be configured as a kernel built-in or a kernel loadable module.
    may be configured as a kernel built-in or a kernel loadable module.
    You can only make use of <constant>kgdbwait</constant> and early
    You can only make use of <constant>kgdbwait</constant> and early
    debugging if you build kgdboc into the kernel as a built-in.
    debugging if you build kgdboc into the kernel as a built-in.
+   </para>
    <para>Optionally you can elect to activate kms (Kernel Mode
    <para>Optionally you can elect to activate kms (Kernel Mode
    Setting) integration.  When you use kms with kgdboc and you have a
    Setting) integration.  When you use kms with kgdboc and you have a
    video driver that has atomic mode setting hooks, it is possible to
    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
    crashes or doing analysis of memory with kdb while allowing the
    full graphics console applications to run.
    full graphics console applications to run.
    </para>
    </para>
-   </para>
    <sect2 id="kgdbocArgs">
    <sect2 id="kgdbocArgs">
    <title>kgdboc arguments</title>
    <title>kgdboc arguments</title>
    <para>Usage: <constant>kgdboc=[kms][[,]kbd][[,]serial_device][,baud]</constant></para>
    <para>Usage: <constant>kgdboc=[kms][[,]kbd][[,]serial_device][,baud]</constant></para>
@@ -287,7 +287,6 @@
    </listitem>
    </listitem>
    </orderedlist>
    </orderedlist>
    </para>
    </para>
-   </sect3>
    <para>NOTE: Kgdboc does not support interrupting the target via the
    <para>NOTE: Kgdboc does not support interrupting the target via the
    gdb remote protocol.  You must manually send a sysrq-g unless you
    gdb remote protocol.  You must manually send a sysrq-g unless you
    have a proxy that splits console output to a terminal program.
    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
     as well as on the initial connect, or to use a debugger proxy that
     allows an unmodified gdb to do the debugging.
     allows an unmodified gdb to do the debugging.
    </para>
    </para>
+   </sect3>
    </sect2>
    </sect2>
    </sect1>
    </sect1>
    <sect1 id="kgdbwait">
    <sect1 id="kgdbwait">
@@ -353,12 +353,12 @@
    </para>
    </para>
    </listitem>
    </listitem>
    </orderedlist>
    </orderedlist>
+  </para>
    <para>IMPORTANT NOTE: You cannot use kgdboc + kgdbcon on a tty that is an
    <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>
    active system console.  An example incorrect usage is <constant>console=ttyS0,115200 kgdboc=ttyS0 kgdbcon</constant>
    </para>
    </para>
    <para>It is possible to use this option with kgdboc on a tty that is not a system console.
    <para>It is possible to use this option with kgdboc on a tty that is not a system console.
    </para>
    </para>
-  </para>
   </sect1>
   </sect1>
    <sect1 id="kgdbreboot">
    <sect1 id="kgdbreboot">
    <title>Run time parameter: kgdbreboot</title>
    <title>Run time parameter: kgdbreboot</title>