Skip to content
  • Philip Withnall's avatar
    docs: Reduce nesting of documentation directories · 548ec9f1
    Philip Withnall authored
    
    
    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`
    
    This is going to seem like pointless churn (the contents of the
    documentation have not changed), and packagers may mourn the split of
    content in `/usr/share/doc` from `/usr/share/doc/${package_name}` to
    `/usr/share/doc/${pkg_config_id}` instead, but that seems to be the best
    approach to fix this issue in GLib. gi-docgen’s behaviour does feel
    fairly consistent and correct with the rest of how it works (single
    output directory).
    
    Signed-off-by: default avatarPhilip Withnall <pwithnall@gnome.org>
    
    Fixes: #3287
    548ec9f1