Bug 263852 - graphics/cairo: Install documentation to a path accessible in the GNOME Devhelp browser
Summary: graphics/cairo: Install documentation to a path accessible in the GNOME Devhe...
Status: Open
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-desktop (Team)
URL:
Keywords: needs-qa
Depends on:
Blocks:
 
Reported: 2022-05-07 20:12 UTC by Sean Champ
Modified: 2022-05-08 03:14 UTC (History)
1 user (show)

See Also:
bugzilla: maintainer-feedback? (desktop)
koobs: merge-quarterly?


Attachments
patch for installing documentation directly to DOCSDIR (7.13 KB, patch)
2022-05-07 20:12 UTC, Sean Champ
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Sean Champ 2022-05-07 20:12:10 UTC
Created attachment 233799 [details]
patch for installing documentation directly to DOCSDIR

This patch updates the Makefile and pkg-plist for graphics/cairo as
to ensure that the documentation will be installed directly to the
port's DOCSDIR.

Rationale:

In the Devehelp User Documentation - available under the GNOME Yelp
documentation browser, with the documentation installed from the
devel/devhelp port - the section "Installing API Documentation" mentions
a number of standard pathnames that documentation may be installed to,
such as to be accessible in the Devhelp browser.

With the devehelp build under FreeBSD ports, it seems that documentation
installed directly to a port's DOCSDIR may also be accessible in the
Devhelp browser.

Previous to this changeset, then with the DOCS option enabled for
graphics/cairo, documentation was being installed to a subdirectory of
the graphics/cairo DOCSDIR, i.e was installed to the directory
/usr/local/share/doc/cairo/cairo/. While accessible for normal browsing,
this documentation was not appearing in the Devhelp UI.

When setting the HTML_DIR for the build to the parent directory of the
port's docsdir, then at least with the graphics/cairo port, the
documentation will be installed directly into the port's DOCSDIR. This
documentation may then be browsed normally with Devhelp.

for graphics/cairo the HTML_DIR for build may be set in configure, using
the configure arg --with-html-dir=...
Comment 1 Sean Champ 2022-05-08 03:14:51 UTC
With the patch as initially attached here, graphics/cairo would continue to install docs under the port's DOCSDIR.

Looking at where the *.devhelp2 files are being installed for other ports, maybe it could be more effective to set something like the following instead, in the Makefile

	DOCS_CONFIGURE_ON+=	--with-html-dir=${LOCALBASE}/share/gtk-doc/html

Of course this would affect pkg-plist. It might serve to move the cairo docs to under a same general subdir as other manuals generally built with gtk-doc tools and accessible with GNOME devhelp