After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 764407 - Broken links to structs in function definitions
Broken links to structs in function definitions
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.25
Other Linux
: Normal normal
: 1.26
Assigned To: gtk-doc maintainers
gtk-doc maintainers
: 762520 766939 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2016-03-31 10:56 UTC by zingmars
Modified: 2016-06-07 10:00 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
build.log.xz (273.64 KB, application/x-xz)
2016-05-30 22:02 UTC, Tim-Philipp Müller 		Details

Description zingmars 2016-03-31 10:56:25 UTC 
on page: https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html

Pretty much all of the links in function definitions seem to be broken. For example clicking gboolean in any function def. will lead to https://gstreamer.freedesktop.org/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean which 404's. Seems like any links that lead to the same page (for example GstVideoInfo) work, but the rest don't. 

On an additional note you might want to recheck the information on that page. For example the example for gst_video_frame_map() (https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#gst-video-frame-map) uses a non-existing function GST_VIDEO_FRAME_PLANE_PSTRIDE().
Comment 1 Tim-Philipp Müller 2016-05-27 11:34:12 UTC 
*** Bug 766939 has been marked as a duplicate of this bug. ***
Comment 2 Tim-Philipp Müller 2016-05-27 13:56:20 UTC 
This must be a gtk-doc bug, I don't think anything changed here on our side.

> Preparing docs for upload (rebasing cross-references) ...
> On-line location of glib: https://developer.gnome.org/glib/unstable/
> ...

Stefan, any ideas?
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2016-05-29 17:33:16 UTC 
How do we upload the docs? Do we run 'gtkdoc-rebase --online --html-dir=/path/to/our/docs' ?
Comment 4 Tim-Philipp Müller 2016-05-30 11:17:12 UTC 
Yes, afaict: https://cgit.freedesktop.org/gstreamer/common/tree/upload-doc.mak#n20
Comment 5 Tim-Philipp Müller 2016-05-30 22:02:23 UTC 
Created attachment 328765 [details]
build.log.xz

We narrowed this down to a problem with gtkdoc-fixxref.

Log attached, not sure if it shows anything useful though.
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2016-05-31 07:42:29 UTC 
Tim, is this with the patch I posted:
https://paste.fedoraproject.org/372781/64205314/

If you run:
xzcat ~/Downloads/build.log.xz | grep "Scanning index" | grep --color "dir="
or look at:
https://paste.fedoraproject.org/372835/68000014/

we can see that the issue is that the dirs are not ending on a '/'.
Comment 7 Tim-Philipp Müller 2016-05-31 11:29:27 UTC 
Everything works fine for me now with that gtkoc-fixxref patch applied.
Comment 8 Stefan Sauer (gstreamer, gtkdoc dev) 2016-05-31 19:23:45 UTC 
Thanks for verifying!

commit 86eeca1a9b27fb68aeaba77ad1959b3aa1a78080
Author: Stefan Sauer <ensonic@users.sf.net>
Date:   Tue May 31 21:05:35 2016 +0200

    fixxref: add missing path separator
Comment 9 Tim-Philipp Müller 2016-06-07 10:00:33 UTC 
*** Bug 762520 has been marked as a duplicate of this bug. ***