GNOME Bugzilla – Bug 728283
Linking to a section in a DocBook file is broken
Last modified: 2018-05-22 13:08:04 UTC
While looking at the remaining non-markdown links in the glib docs (the .h files still have some) I stumbled across this: All links of the form <link linkend="extending-gio">Extending GIO</link> seem to be broken for many versions (at least in every version available at https://developer.gnome.org/gio/). In the current 2.40.x version it became obvious since in the .h files these links are not converted to markdown links yet (so they show up literally with '<link...' while in previous versions the link was just ignored during the doc generation since it didn't exist. The errors when generating the docs look like: html/GVfs.html:350: warning: no link for: 'extending-gio' -> (Extending GIO).
<chapter id="extending-gio"> is here: https://git.gnome.org/browse/glib/tree/docs/reference/gio/overview.xml#n523
This looks like a gtk-doc bug: linking to an ID from a DocBook file seems to be broken.
I am quite busy right now. If I get a patch for gtk-doc with a test case I'll take a look. Or at least more detail - like what ends up in the html (no link at all?)
I won’t be able to write a patch, but here are some details. Markdown (for example, from G_PROXY_EXTENSION_POINT_NAME, https://git.gnome.org/browse/glib/tree/gio/gproxy.h#n39): /** * G_PROXY_EXTENSION_POINT_NAME: * * Extension point for proxy functionality. * See [Extending GIO][extending-gio]. * * Since: 2.26 */ Generated HTML (no link, just the link text): <div class="refsect2"> <a name="G-PROXY-EXTENSION-POINT-NAME:CAPS"></a><h3>G_PROXY_EXTENSION_POINT_NAME</h3> <pre class="programlisting">#define G_PROXY_EXTENSION_POINT_NAME "gio-proxy" </pre> <p>Extension point for proxy functionality. See Extending GIO.</p> <p class="since">Since: <a class="link" href="api-index-2-26.html#api-index-2.26">2.26</a></p> </div> The `extending-gio` anchor is defined in a DocBook file: https://git.gnome.org/browse/glib/tree/docs/reference/gio/overview.xml#n577
-- GitLab Migration Automatic Message -- This bug has been migrated to GNOME'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.gnome.org/GNOME/gtk-doc/issues/27.