gtk-doc: remove source-highlight dependency or make it optional

[ryandesign (Ryan Carsten Schmidt)]

In r124901 gtk-doc got a dependency on source-highlight. This is a problem because source-highlight depends on boost, and boost doesn't build on older systems (#44918). This causes problems for all sorts of ports that depend on gtk-doc.

Could the dependency be either removed (since we know gtk-doc built fine without it before), or if it is thought to be very useful, then placed in a variant, which is off by default at least on Mac OS X 10.5 and earlier?

[cooljeanius (Eric Gallager)]

iirc, source-highlight is just one of multiple highlighting options that gtk-doc can use. The others are:

• Just-plain "highlight" (whose port also has a dependency on boost)
• vim (not sure if we'd need to use the port for it, or if the system one works)
• maybe one other?

Anyways, sounds like a case where variants would make sense...

[cooljeanius (Eric Gallager)]

Cc Me!

[ryandesign (Ryan Carsten Schmidt)]

Before it got the source-highlight dependency (r124901), gtk-doc briefly had a dependency on the vim port (r123123) because OS X's vim didn't always work (#44546) but this had to be undone because it introduced a circular dependency when vim's +gtk2 variant was used.

[dbevans (David B. Evans)]

Although source highlighting is technically optional in gtk-doc, it is used extensively in GNOME API docs so I'm not so enthusiastic about just turning it off.

As stated above, the problems are

• source highlighting is a build option for vim and so is not always enabled. This may also be version dependent. At any rate, the vim port has the circular dependency problem (can this be fixed?).
• source-highlight and highlight both use boost. Even if we avoid using these, there are other boost based ports (e.g. inkscape, gimp2) which must not build on the earlier platforms if boost won't build there (but I haven't heard any complaints and don't have an appropriate test environment).

The gtk-doc configure file prefers source-highlight and is least happy about vim hence the current choice. The earlier version of the port (without source-highlight) did not disable source highlighting so configuration fell back to system vim if source-highlight or highlight were not used. I'm not sure if disabling source highlighting altogether will just eliminate the highlighting from generated documentation or cause a build failure. Will take a look.

Best would be to fix boost on the earlier platforms but I realize that may be problematic. Otherwise, looks like disabling source highlighting on 10.5 and earlier may be the least offensive alternative if it doesn't break anything.

[ryandesign (Ryan Carsten Schmidt)]

Unfortunately fixing boost to build on older systems may be difficult. The boost portfile blacklists all compilers included in Xcode on those versions of OS X, and even some older clang ports, and newer clang ports don't build on older systems and Jeremy doesn't plan to fix that either. Using a gcc port may still be a possibility though that implies mixing the system's libstdc++ with libgcc's libstdc++ which can be problematic.

[dbevans (David B. Evans)]

Proposed patch to disable syntax highlighting on older platforms

[dbevans (David B. Evans)]

Attached is a patch that adds a variant to enable highlighting using source-highlight and makes it the default for SL and later. Highlighting and the dependency on source-highlight are removed for older platforms or if -highlighting is asserted on newer ones. I think this is what you want but let me know if this works for you. You should verify that gtk-doc works for you on the target platform by building a port that uses the gtkdoc-fixxref utility when building API documentation. A good example is appstream-glib (#44546).

[ryandesign (Ryan Carsten Schmidt)]

Thanks. Let's hold off on this for a moment. I believe I was able to fix boost for Tiger and Leopard just by removing the gcc 4.2 blacklisting; apparently whatever was preventing earlier versions from building with gcc 4.2 is no longer a problem.

[mascguy (Christopher Nielsen)]

Take over Dave's tickets for GTK and friends, now that he's formally dropped maintainership. Boo! ;-)

[mascguy (Christopher Nielsen)]

Dependency source-highlight removed in July 2019, via the following commit:

​https://github.com/macports/macports-ports/commit/461cc48c31ad7389c2812f8aaaf8fc57b72bff6c

Closing as fixed.