[Bug 263852] [patch] graphics/cairo: Install documentation to a path accessible in the GNOME Devehlp browser

From: <bugzilla-noreply_at_freebsd.org>
Date: Sat, 07 May 2022 20:12:10 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=263852

            Bug ID: 263852
           Summary: [patch] graphics/cairo: Install documentation to a
                    path accessible in the GNOME Devehlp browser
           Product: Ports & Packages
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Individual Port(s)
          Assignee: desktop@FreeBSD.org
          Reporter: lab+bsd@thinkum.space
          Assignee: desktop@FreeBSD.org
             Flags: maintainer-feedback?(desktop@FreeBSD.org)

Created attachment 233799
  --> https://bugs.freebsd.org/bugzilla/attachment.cgi?id=233799&action=edit
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=...

-- 
You are receiving this mail because:
You are the assignee for the bug.