Bug 184771 - [GTK] Local cross references are broken in API documentation
Summary: [GTK] Local cross references are broken in API documentation
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: WebKitGTK (show other bugs)
Version: WebKit Nightly Build
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: Nobody
URL:
Keywords: Gtk
Depends on:
Blocks:
 
Reported: 2018-04-19 00:12 PDT by Carlos Garcia Campos
Modified: 2018-04-20 03:33 PDT (History)
3 users (show)

See Also:


Attachments
Patch (7.48 KB, patch)
2018-04-19 00:19 PDT, Carlos Garcia Campos
mcatanzaro: review+
Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Carlos Garcia Campos 2018-04-19 00:12:05 PDT
The problem is that gtkdoc-fixxref expects the links to be in the form html/modulename (like the installed ones), but we generate the documentation as modulename/html. So, links to WebKitDOM or JSC are generated as ../html/Foo. The rebase command considers html to be the module name in this case, creating broken links in all the cases.
Comment 1 Carlos Garcia Campos 2018-04-19 00:19:36 PDT
Created attachment 338315 [details]
Patch
Comment 2 EWS Watchlist 2018-04-19 00:22:36 PDT
Attachment 338315 [details] did not pass style-queue:


ERROR: Tools/gtk/gtkdoc.py:377:  [GTKDoc._run_gtkdoc_fixxref] Instance of 'GTKDoc' has no 'virtual_root' member  [pylint/E1101] [5]
ERROR: Tools/gtk/gtkdoc.py:377:  [GTKDoc._run_gtkdoc_fixxref] Instance of 'GTKDoc' has no 'prefix' member  [pylint/E1101] [5]
Total errors found: 2 in 5 files


If any of these errors are false positives, please file a bug against check-webkit-style.
Comment 3 Michael Catanzaro 2018-04-19 08:14:10 PDT
Comment on attachment 338315 [details]
Patch

If you have spare cycles, I would investigate whether we can dump our custom gtkdoc scripts in favor of https://git.gnome.org/browse/gtk-doc/tree/cmake
Comment 4 Carlos Garcia Campos 2018-04-19 22:25:24 PDT
(In reply to Michael Catanzaro from comment #3)
> Comment on attachment 338315 [details]
> Patch
> 
> If you have spare cycles, I would investigate whether we can dump our custom
> gtkdoc scripts in favor of https://git.gnome.org/browse/gtk-doc/tree/cmake

I already did that for poppler when we switched to CMake and we ended up using the WebKit scripts there too :-)
Comment 5 Carlos Garcia Campos 2018-04-20 03:33:41 PDT
Committed r230837: <https://trac.webkit.org/changeset/230837>