After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 788295 - GtkDoc generation is failing
GtkDoc generation is failing
Status: RESOLVED FIXED
Product: gnome-todo
Classification: Other
Component: General
3.25.x
Other Linux
: Normal normal
: ---
Assigned To: GNOME To Do maintainer(s)
GNOME To Do maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2017-09-28 14:26 UTC by Iñigo Martínez
Modified: 2017-09-28 14:49 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Fix documentation generation (1.30 KB, patch)
2017-09-28 14:33 UTC, Iñigo Martínez
committed Details | Review

Description Iñigo Martínez 2017-09-28 14:26:16 UTC
Documentation generation is failing due to missing directories. The output when it fails is as follows:

> Building documentation for gnome-todo
> 
> Error in gtkdoc helper script:
> 'gtkdoc-scan' failed with status 2
> Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(.*?){ <-- HERE / at /usr/bin/gtkdoc-scan line 735.
> Can't open source directory /home/jack/Projects/gnome-todo/_build/src/engine: No such file or directory at /usr/bin/gtkdoc-scan line 223.
Comment 1 Iñigo Martínez 2017-09-28 14:33:27 UTC
Created attachment 360607 [details] [review]
Fix documentation generation

This is happening because GtkDoc tries to search for directories that are present in the source code tree, but are not in the build tree: 'src/engine', 'src/interfaces' and 'src/notification'.

These directories were added to `src_inc` in 450876f to give access to the objects defined in those directories to plugins. However, the `include_directories` function from meson includes directories from both source code and built trees.

This patch modifies the directories that GtkDoc scans in search for source code files.
Comment 2 Georges Basile Stavracas Neto 2017-09-28 14:49:30 UTC
Thanks for the patches