Re: [PATCH] kgdb,docs: Fix <para> pdfdocs build errors

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Jonathan,
 I don't think the below has made it into the mainline yet, and the
mainline 'make pdfdocs' as of commit
b2b89ebfc0f0287e20516a5443d93af309b800cf
still fails to build kgdb.tmpl due to the below errors.
 The below will also now not apply cleanly due to commit
bb485c289ce8902807d20ffedeceb91640c4d317 (kgdb,docs: Fix typo and
minor style issues)
 but does still apply and build for me with a --3way.

Do I/we need to do something to get this patch fixed up and in - maybe
contact the original author Rajaneesh or re-author/rebase the patch
or?

 Graham



On 31 December 2014 at 17:43, Graham Whaley <graham.whaley@xxxxxxxxx> wrote:
> From: Rajaneesh Acharya <rajaneesh.acharya@xxxxxxxxx>
>
> 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@xxxxxxxxx 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@xxxxxxxxx: Improved commit message and ported to 3.18.1]
> Signed-off-by: Graham Whaley <graham.whaley@xxxxxxxxx>
> ---
>  Looks like this patch never got taken up.
>  The original patch body was sound, with a minor line adjustment to apply
> to 3.18.1. I rewrote the commit message to be match style and succinctness.
>  I've tested this on Fedora20 against 3.18.1 and tip of mainline (v3.19-rc2)
>
>  Documentation/DocBook/kgdb.tmpl | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/DocBook/kgdb.tmpl b/Documentation/DocBook/kgdb.tmpl
> index f77358f..efca2a4 100644
> --- a/Documentation/DocBook/kgdb.tmpl
> +++ b/Documentation/DocBook/kgdb.tmpl
> @@ -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>
> --
> 1.9.3
>
--
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




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux