Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Adapt GLib documentation path to GLib 2.80.1 #619

Merged
merged 1 commit into from
May 15, 2024

Conversation

ppisar
Copy link
Collaborator

@ppisar ppisar commented May 15, 2024

With GLib 2.80.1 (commit 548ec9f1), the installation paths for the documentation have changed once again:

The `gi-docgen` tool is not designed to be used like that. In
particular, when nesting documentation directories, the generated
`*.devhelp2` files (needed by Devhelp to show the documentation) are
nested one directory level too deep for Devhelp to find them, and hence
are useless, and the documentation doesn’t show up in this common
documentation viewer.

So, change the installed documentation directory hierarchy:
 * `${PREFIX}/share/doc/glib-2.0/gio` → `${PREFIX}/share/doc/gio-2.0`
 * `${PREFIX}/share/doc/glib-2.0/glib-unix` → `${PREFIX}/share/doc/glib-unix-2.0` * `${PREFIX}/share/doc/glib-2.0/gobject` → `${PREFIX}/share/doc/gobject-2.0` * etc. * `${PREFIX}/share/doc/glib-2.0/glib` → `${PREFIX}/share/doc/glib-2.0`

https://gitlab.gnome.org/GNOME/glib/-/issues/3287
Reimplements #618

@ppisar ppisar force-pushed the glib_2_80_1 branch 3 times, most recently from 816088f to 1257009 Compare May 15, 2024 12:48
With GLib 2.80.1 (commit 548ec9f1), the installation paths for the documentation
have changed once again:

    The `gi-docgen` tool is not designed to be used like that. In
    particular, when nesting documentation directories, the generated
    `*.devhelp2` files (needed by Devhelp to show the documentation) are
    nested one directory level too deep for Devhelp to find them, and hence
    are useless, and the documentation doesn’t show up in this common
    documentation viewer.

    So, change the installed documentation directory hierarchy:
     * `${PREFIX}/share/doc/glib-2.0/gio` → `${PREFIX}/share/doc/gio-2.0`
     * `${PREFIX}/share/doc/glib-2.0/glib-unix` →
       `${PREFIX}/share/doc/glib-unix-2.0`
     * `${PREFIX}/share/doc/glib-2.0/gobject` →
       `${PREFIX}/share/doc/gobject-2.0`
     * etc.
     * `${PREFIX}/share/doc/glib-2.0/glib` → `${PREFIX}/share/doc/glib-2.0`

https://gitlab.gnome.org/GNOME/glib/-/issues/3287
Reimplements fedora-modularity#618
@ppisar ppisar merged commit f333619 into fedora-modularity:main May 15, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants