small incompatible change in gtk-doc 1.20 wrt |[]| markdown
Stefan Sauer <[email protected]> Wed, 19 Feb 2014 10:13:14 +0100
| Newsgroups | gmane.comp.gnome.devel,gmane.comp.gnome.gtk+.documentation,gmane.comp.gnome.desktop |
|---|---|
| Message-ID | <[email protected]> |
hi, we discovered that change c4d09c7c95c45a1226e83f5ddd7d0f4ce2b1a1a9 which has been release as part of gtk-doc 1.20 causes a regression for a use that worked so far. The |[ ... ]| syntax is a shortcut for <informalexample><programlisting> ... </programlisting></informalexample>. Now this is automatically wrapped as CDATA which is convenient as one does not need to use entities for e.g. &. Unfortunately that breaks cases where one uses xi:inlcude to embed the actual example. We fixed all the cases that we found in modules part of the jhbuild gnome module set. The fix is easy, just replace the |[ ]| with the docbook tags for now. For a example see http://cgit.freedesktop.org/gstreamer/gst-plugins-good/commit/?id=a4fd0f9351ee319f850aca2acb42f8856a2c1a12 Sorry for any inconvenience, Stefan