GNOME Bugzilla – Bug 794558
Glib documentation fails to build in meson builds
Last modified: 2018-05-24 20:18:57 UTC
On glib side the errors are mostly due to non-existing sections and broken references. There are other problems, but those can be fixed in meson. I don't really understand how gtk-doc works, so this is just me throwing changes at the docs to see if they fix anything.
Created attachment 369949 [details] [review] Remove nonexisting section from gio-docs
Created attachment 369950 [details] [review] Try to fix a href to gdbus-example-objectmanager.xml In the end this doesn't seem to be working (the example is still missing from the generated documentation page), but at least gtk-doc does not error out anymore.
Review of attachment 369949 [details] [review]: Okay
(In reply to LRN from comment #2) > Created attachment 369950 [details] [review] [review] > Try to fix a href to gdbus-example-objectmanager.xml The issue is that the location of the generated file is in the builddir, and that may not match what gtk-doc expects. It should be possible to add the build directory to the search paths for xsltproc/gtk-doc, but I'm not sure how.
Created attachment 370258 [details] [review] Fix gio tool documentation * Remove the xml header from gio.xml (other tool xmls don't have them). * Add gio.xml to content_files list This turned out to be a better solution than simply removing gio.xml from gio-docs.xml
(In reply to Emmanuele Bassi (:ebassi) from comment #4) > (In reply to LRN from comment #2) > > Created attachment 369950 [details] [review] [review] [review] > > Try to fix a href to gdbus-example-objectmanager.xml > > The issue is that the location of the generated file is in the builddir, and > that may not match what gtk-doc expects. > > It should be possible to add the build directory to the search paths for > xsltproc/gtk-doc, but I'm not sure how. I don't think so. In this case the gdbus-example-objectmanager.xml is included verbatim, from the source directory. It's not about the generated .c file.
I've checked out the situation with gdbus-example-objectmanager.xml, and i think that it should be possible to give xsltproc a list of directories to include stuff from. In fast, gtk-doc *does* give such a list, but passing it around is broken on W32, because no one is using path separators consistently. Would someone please test attachment 369950 [details] [review] (and other meson doc fixes currently in bugzilla) on a non-W32 machine and see if it works there? If so, then this patch can be just accepted as-is (fixes for W32-specific issues are discussed in bug 788911).
-- 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/glib/issues/1356.