gtkspell2 @2.0.16_6: fails to build with gtk-doc @1.26

[majoc-at-astro (majoc-at-astro)]

Full log included, but this seems to be the nub of it:

:info:build gtk-doc: Rebuilding template files
:info:build cd . && gtkdoc-mktmpl --module=gtkspell 
:info:build /bin/sh: gtkdoc-mktmpl: command not found
:info:build make[2]: *** [tmpl-build.stamp] Error 127

Please see also:

https://bugs.archlinux.org/task/55210

.... which shows the same problem, and suggests disabling gtk-doc while building gtkspell as a kludgearound.

Feel free to raise this as a bug against gtk-doc instead (or as well), if that's where the true bug lies. Apologies for possibly-inappropriate CC: I see no maintainer for gtkspell2.

[majoc-at-astro (majoc-at-astro)]

logfile for gtkspell2 build

[majoc-at-astro (majoc-at-astro)]

PS: knock-on effects include taking out inkscape and rednotebook.

[Russell-Jones-OxPhys (Russell Jones)]

Happened in 1.26 ​https://github.com/GNOME/gtk-doc/blob/GTK_DOC_1_26/NEWS

GTK-Doc 1.26  (Aug 11 2017)
==============

Remove tmpl support (gtkdoc-mktmpl). Port all tools from bash/perl to python.
...

configure.ac says GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) as per ​https://developer.gnome.org/gtk-doc-manual/unstable/settingup_autoconf.html.en , so I wonder if it's the line in docs/Makefile.am that's causing the build to try and use gtkdoc-mktmpl.

[ggmessier]

I can confirm that the issue is fixed by switching back to gtk-doc 1.25 using the procedure described here: wiki:howto/InstallingOlderPort. Both gtkspell2 (and inkscape) build now.

[majoc-at-astro (majoc-at-astro)]

Replying to ggmessier:

I can confirm that the issue is fixed by switching back to gtk-doc 1.25 using the procedure described here: wiki:howto/InstallingOlderPort. Both gtkspell2 (and inkscape) build now.

Apologies, but that wouldn't work for us, as our build systems install everything from scratch in the interests of repeatability. Please see the above diff: an admitted quick-and-dirty to omit the documentation, which I can confirm works for us. I'll do better later. Would adding a +docs variant be acceptable?

Thanks in advance.

[mf2k (Frank Schima)]

Replying to majoc-at-astro:

Would adding a +docs variant be acceptable?

Yes, that would be a good workaround.

[majoc-at-astro (majoc-at-astro)]

Replying to mf2k:

Replying to majoc-at-astro:

Would adding a +docs variant be acceptable?

Yes, that would be a good workaround.

Please find diff for same attached: found to build successfully without +docs, and to correctly fail with it. Desciption string provisional.

[majoc-at-astro (majoc-at-astro)]

Patch to make documentation optional

[majoc-at-astro (majoc-at-astro)]

Corrected diff (re)attached: now adds gtk-doc back correctly. My bad. Apologies.

[mf2k (Frank Schima)]

I don't understand the variant description you are using. The description on most +docs variants is something like "Build documentation". Can it be changed?

[majoc-at-astro (majoc-at-astro)]

Replying to mf2k:

I don't understand the variant description you are using. The description on most +docs variants is something like "Build documentation". Can it be changed?

That was a placeholder to suggest it shouldn't be used. Will change.

[majoc-at-astro (majoc-at-astro)]

Add variant to make documentation optional

[kurthindenburg (Kurt Hindenburg)]

In 9d85ed22298f7150af92ed71fa141596e1171c33/macports-ports:

gtkspell2: move building docs to +docs variant

Issue caused by version of gtk-doc - bypass issue for now
GTK-Doc 1.26 (Aug 11 2017)
Remove tmpl support (gtkdoc-mktmpl).

closes #54755

[ryandesign (Ryan Carsten Schmidt)]

As I'm sure you can guess, the port doesn't build when the +docs variant is used:

/bin/sh: gtkdoc-mktmpl: command not found

So why did we add the variant?

This version of gtkspell is from 2009 so I doubt its developers will be fixing this problem. I don't see the same problem with gtkspell3 though, even if I add --enable-gtk-doc, so maybe a fix can be backported.

[kurthindenburg (Kurt Hindenburg)]

It was a quick fix since a lot of port were broken. I meant to return to this. I don't see any reference to _tmpl in gtkspell3.

Perhaps +docs should be just removed

[kurthindenburg (Kurt Hindenburg)]

In 83fa2df9b7a608dc21ca6d8ae09303822d70bc3b/macports-ports:

gtkspell2: remove docs variant

The variant docs was just added to get gtkspell2 to compile after the
upgrade to gtk-doc. There is unlikely to be anymore releases to v2
as it came out in 2009.

see #54755

[dbevans (David B. Evans)]

Just a few clarifications.

Removing the +doc variant is truly appropriate as this port (as do most that use gtk-doc) have the (pregenerated) docs included as part of the tarball. Thus the variant attempts to redundantly regenerate the existing docs (and fails). Without the variant, the pregenerated docs are installed as part of the port.

gtkspell2 is, indeed, the legacy version of gtkspell and is no longer being maintained. It provides only a gtk2 compatible API. gtkspell3 is the current version of gtkspell and contains APIs for both gtk2 and gtk3 although the the gtk2 API is incompatible with gtkspell2. So gtkspell2 is still necessary for gtk2 apps that use the old API (inkscape for instance). Most newer apps have now moved to gtk3 so the newer gtk2 API is not widely used.

Hope this is helpful

[MarcusCalhoun-Lopez (Marcus Calhoun-Lopez)]

In 927e907b708edf0542527e6f24ec4e842a289ea4/macports-ports:

liboil: remove doc variant

Current gtk-doc is incomparable with liboil.
See #54755 for an equivalent problem.