Bug 101585

Summary: Cannot build documentation with the latest gtk-doc because of xml error
Product: Telepathy Reporter: Ting-Wei Lan <lantw44>
Component: loggerAssignee: Telepathy bugs list <telepathy-bugs>
Status: RESOLVED MOVED QA Contact: Telepathy bugs list <telepathy-bugs>
Severity: normal    
Priority: medium    
Version: git master   
Hardware: Other   
OS: All   
Whiteboard:
i915 platform: i915 features:
Attachments: doc: Use CDATA section to avoid XML error caused by example code

Description Ting-Wei Lan 2017-06-25 15:54:08 UTC 
It seems that gtk-doc tools no longer allow using < and > directly in <programlisting> after gtk-doc is rewritten in python.


../xml/log-walker.xml:82: parser error : error parsing attribute name
  #include <telepathy-glib/telepathy-glib.h>
                          ^
../xml/log-walker.xml:82: parser error : attributes construct error
  #include <telepathy-glib/telepathy-glib.h>
                          ^
../xml/log-walker.xml:82: parser error : Couldn't find end of Start Tag telepathy-glib line 82
  #include <telepathy-glib/telepathy-glib.h>
                          ^
../xml/log-walker.xml:83: parser error : error parsing attribute name
  #include <telepathy-logger/telepathy-logger.h>
                            ^
../xml/log-walker.xml:83: parser error : attributes construct error
  #include <telepathy-logger/telepathy-logger.h>
                            ^
../xml/log-walker.xml:83: parser error : Couldn't find end of Start Tag telepathy-logger line 83
  #include <telepathy-logger/telepathy-logger.h>
                            ^
../docs.xml:14: element include: XInclude error : could not load ../xml/log-walker.xml, and no fallback was found


This problem has been reported to gtk-doc as https://bugzilla.gnome.org/show_bug.cgi?id=783420, and they recommend using CDATA sections or |[ and ]|.
Comment 1 Ting-Wei Lan 2017-06-25 15:57:58 UTC 
Created attachment 132230 [details] [review]
doc: Use CDATA section to avoid XML error caused by example code
Comment 2 GitLab Migration User 2019-12-03 19:32:46 UTC 
-- GitLab Migration Automatic Message --

This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/telepathy/telepathy-logger/issues/46.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.