GNOME Bugzilla – Bug 724085
gst-plugins-good/docs: Rebalance docbook <para> tags in comments
Last modified: 2014-02-17 17:55:25 UTC
Trying to build gst-plugins-good using HEAD gtk-doc results in the errors below. These errors appear to be due to unbalanced <para> tags, so my patch attempts to re-balance these. I assume that these errors now appear due to stricter checking by gtk-doc. DOC Building HTML xml/element-audiocheblimit.xml:66: parser error : Opening and ending tag mismatch: refsect1 line 53 and para </para></para> ^ xml/element-audiocheblimit.xml:83: parser error : Opening and ending tag mismatch: para line 71 and refsect1 </refsect1> ^ gst-plugins-good-plugins-docs.sgml:36: element include: XInclude error : could not load xml/element-audiocheblimit.xml, and no fallback was found xml/element-udpsrc.xml:119: parser error : Opening and ending tag mismatch: refsect1 line 72 and para </para></para> ^ xml/element-udpsrc.xml:147: parser error : Opening and ending tag mismatch: para line 120 and refsect1 </refsect1> ^ gst-plugins-good-plugins-docs.sgml:167: element include: XInclude error : could not load xml/element-udpsrc.xml, and no fallback was found
Created attachment 268744 [details] [review] Proposed patch fixing unbalanced docbook tags.
Created attachment 268745 [details] [review] Proposed patch fixing unbalanced docbook tags.
Created attachment 268746 [details] [review] Proposed patch fixing unbalanced docbook tags.
Review of attachment 268746 [details] [review]: ::: gst/audiofx/audiocheblimit.c @@ +52,3 @@ * a cutoff frequency at a quarter of the sampling rate. * </para></note> + * </para> I think in this case the para inside the note is useless and can be removed? ::: gst/udp/gstudpsrc.c @@ +82,1 @@ * <para> I think the intent here was to end the paragraph after "firewall." and let the next paragraph be at the same level
Sorry that we missed the patch. This got already fixed a few days ago: commit 577d87300906f961d13f76b44ba60fc40f0c637a Author: William Jon McCann <william.jon.mccann@gmail.com> Date: Fri Feb 14 15:27:20 2014 -0500 docs: fix mismatched para tags newer gtkdoc is more sensitive to mismatched docbook tags. This fixes the build in master Eventually we should consider bumping the gtk-doc requiremtns to 1.18 and use the markdown syntax.
Please apply this patch to the 1.2 branch aswell and not just master, would be nice to have it in the next stable release.
done.