Adapt to GLib 2.79 documentation #612
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A checks and an application of extra directories for gtkdoc-fixxref were computed independetly. This patch removes the code duplication. It also adds the discovered path to a "meson setup" summary output.
GLib 2.79.0 switched from gtk-doc to gi-docgen, whose format and installation location are both not compatible. The libmodulemd build script reported an error because of the new location. This patch fixes the build failure by using the new location if GLib is 2.79.0 or greater. Although the libmodulemd documentation references to GLib remain unresolved now (i.e. names of the functions and the types are not hyperlinks), we keep using the new location because the new GLib *.devhelp2 indices remain there and they can only improve over the time. If this expection does not fulfill, libmodulemd will either migrate to gi-docgen, or drop the hard build-time dependency on GLib documentation. Reimplements: fedora-modularity#611
sgallagher
approved these changes
Jan 26, 2024
There was a problem hiding this comment.
It's unfortunate that the doc links are broken. I think we need to unbreak the build failure immediately, so I'm approving the ticket.
In a follow-up patch, could we modify .ci/ci-docs.sh to pin the documentation generation on F39 for now, so that we push the properly-linked version to the web?
ppisar
added a commit
that referenced
this pull request
Jan 29, 2024
glib-2.79.0 available since Fedora ≥ 40 changed a documentation format and references in libmodulemd documentation do not resolve to glib documentation anymore. To have an on-line documentation with the hyperlinks, keep using older Fedora. See <#612>.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patchset first moves a code in the build script, and then implements a special case GLib ≥ 2.79.0. If the special case proves unproductive, we will turned it into a skip later. This is a more compatible approach comparing to PR #611.