GNOME Bugzilla – Bug 644687
Not finding cross-links in current doc set
Last modified: 2011-07-11 03:57:34 UTC
Building glib-2.28.2 with --enable-gtk-doc on a bare-bones system (*not* glib2 installed), I got lots of warnings about inability to find links for various tokens during the "Fixing cross-references" stage. Beginning of that section is: >gtk-doc: Fixing cross-references >html/ch01.html:148: warning: no link for: 'http://www.freedesktop.org/wiki/Software/dbus' -> (D-Bus). >html/ch02.html:36: warning: no link for: 'GUnixMount' -> (<span class="type">GUnixMount</span>). >html/ch02.html:41: warning: no link for: 'g-type-init' -> (<code class="function">g_type_init()</code>). >html/ch02.html:43: warning: no link for: 'gtk-init' -> (<code class="function">gtk_init()</code>). >html/ch03.html:35: warning: no link for: 'Gvfs' -> (<span class="type">Gvfs</span>). >html/ch27.html:207: warning: no link for: 'gnome-vfs-find-directory' -> (<code class="function">gnome_vfs_find_directory()</code>). >html/ch27.html:207: warning: no link for: 'GNOME-VFS-DIRECTORY-KIND-TRASH:CAPS' -> (<code class="literal">GNOME_VFS_DIRECTORY_KIND_TRASH</code>). Some of those are to doc-sets that are not yet available (no gnome-vfs, gtk, or dbus installed yet) But if I first install glib2 (including its gtk-doc files) and then rebuild it, some those warnings do go away, for example, that ch02.html:41...g-type-init one. Looking at the generated .html, it appears the links are to other files within the same .html set built as part of the glib suite, but in a different subdir. I know glib includes multiple libraries, each apparently with their own gtk-doc set...is there a way to specify the cross-link to a sibling subdir of doc files in the build dir? I'm just an end-user, feel free to re-assign to glib if they just have a simple bug in their files, but at least from my perpective it acts as a gtk-doc problem.
These are warnings and its save to ignore them. Some of them can only be "fixed" by building everything twice: no link for: 'gtk-init' -> (<code class="function">gtk_init()</code>). for others glib could probably specify the local dirs in docs/reference/xxx/Makefile.am FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/reference/xxx/html Could you try that? E.g. for docs/reference/glib/Makefile.am -> no changes for docs/reference/gobject/Makefile.am FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/reference/glib/html for docs/reference/gio/Makefile.am FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/reference/glib/html \ --extra-dir=$(top_builddir)/docs/reference/gobject/html If that improves it, attach the patch here and reassign to glib.
Created attachment 183496 [details] [review] Fix gtk-doc crosslinking among glib/gobject/gio With the analogous patch applied to the Makefile.in, I now get identical output regardless of whether or not glib2-dev is already installed.
Looks ok to me
The following fix has been pushed: 653c2f7 Fix gtk-doc cross-linking among glib/gobject/gio
Created attachment 191672 [details] [review] Fix gtk-doc cross-linking among glib/gobject/gio Patch by Daniel Macks, bug 644687.