Drop fixxref from gtk-doc #611
Closed
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
GLib 2.79.0 switched from gtk-doc to gi-docgen, whose format and installation location are both not compatible. This allows the docs to build with the latest GLib at the price of some broken links.
|
Thanks for the patch. I will try to make the fixxref optional not to regress libmodulemd documentation for people with old glib2 < 2.79.0. I'm also considering to refer to new locations in glib2 ≥ 2.79.0 because they keep providing |
|
When using the new path, not a single reference to glib and gobject is resolved. |
ppisar
added a commit
to ppisar/libmodulemd
that referenced
this pull request
Jan 26, 2024
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
ppisar
added a commit
to ppisar/libmodulemd
that referenced
this pull request
Jan 26, 2024
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
|
Closing in favor of #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.
GLib 2.79.0 switched from gtk-doc to gi-docgen, whose format and installation location are both not compatible. This allows the docs to build with the latest GLib at the price of some broken links.
This fixes the F40FTBFS from the mass rebuild.