[Bug 263781] [patch] devel/devehlp: Adding options for docs and editor plugin to port build

From: <bugzilla-noreply_at_freebsd.org>
Date: Thu, 05 May 2022 04:04:06 UTC

            Bug ID: 263781
           Summary: [patch] devel/devehlp: Adding options for docs and
                    editor plugin to port build
           Product: Ports & Packages
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Individual Port(s)
          Assignee: ports-bugs@FreeBSD.org
          Reporter: lab+bsd@thinkum.space

Created attachment 233731
  --> https://bugs.freebsd.org/bugzilla/attachment.cgi?id=233731&action=edit
patch for devhelop port options (docs, editor plugins)

When searching for the devhelp documentation for devhelp, I'd noticed that
there are some meson options that are available for the devehlp build.

This patch - attached - adds options for docs and editor plugins to the port

In all candor, I haven't tested the editor plugings or reviewed the docs for
their availability and presentation in devhelp. I've tested the patch on the
Makefile and PLIST, and it seems to build.

Aside to the port build, related to devhelop though perhaps I should add a
second bug item for this I'm not certain if all ports are installing their
*.devhelp2 files into a place that could be accessed by devhelp. For instance,
the cairo devehlp2 file has been installed to
but I don't see the Cairo API docs showing up in the devhelp browser. On a
search for 'cairo' the only docs I'm finding are for cairomm.

There might seem to be a few ports with .devhelp2 files not installed under
.... it seems that the path might be /usr/local/share/devhelp/books/<pkgdir>/

I assume that the <pkgdir> might be derived from the pkgconf/pkgconfig pkg

AFter this patch in this present revision, devel/devhelp itself would be added
to that list of ports installing *.devhelp2 files under DOCSDIR.

Candidly, I'm not immediately aware of how the paths thing works out in
devhelp. Maybe there's a devhelp analogy to MANPATH? I hope it's mentioned in
the documentation, lol (hence the patch version 1)

If to provide support for ports with a gtkdoc option that build and install a
devhelp2 file under some config, then to ensure if  ports' devhelp2 files would
be installed under e.g /usr/local/share/devhelp/books/<pkgdir>/ (if that's the
dir for it) could there be a possibility in FreeBSD ports for adding a
'devehelp' feature under USES=gnome or some other USES property?

Of course, it may be possible for a devhelp2 file to be installed without
GNOME. After some local hacks, maybe the devhelp browser could even be used for
browsing Ruby docs from rdoc/YARD, with some appropriate templates and
formatting on the Ruby side.

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