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 752795 - documentation is not rebuilt when only content of doc comments change
documentation is not rebuilt when only content of doc comments change
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.25
Other Linux
: Normal normal
: 1.25
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2015-07-23 19:06 UTC by Stefan Sauer (gstreamer, gtkdoc dev)
Modified: 2015-07-23 19:13 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Stefan Sauer (gstreamer, gtkdoc dev) 2015-07-23 19:06:59 UTC
The $(HFILE_GLOB) $(CFILE_GLOB) are used as prerequisites for the scan step:
https://git.gnome.org/browse/gtk-doc/tree/gtk-doc.notmpl.make#n113

If a change in a doc comment in any *.c or *.h file (or anything covered by --suffixes) results in no change of the files generated by the scan step (e.g. only a typo was fixed), we don't proceed.

In order to fix this, we need to add $(HFILE_GLOB) $(CFILE_GLOB) also as prerequisites for the mkdb step:
https://git.gnome.org/browse/gtk-doc/tree/gtk-doc.notmpl.make#n145

In fact we can probably merge them.

The mkdb takes care that the sgml.stamp is only written if any of the docbook files changed. Hence this change should be safe.
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2015-07-23 19:13:05 UTC
commit 08899bc14254bcd3bc0f5c41fa6bf2a36d1e0333
Author: Stefan Sauer <ensonic@users.sf.net>
Date:   Thu Jul 23 21:10:10 2015 +0200

    make: run mkdb on any source change
    
    We did not rebuild the docs when sources where edited in a way that did not
    result in a structural doc change (e.g. a typo fix).
    
    Fixes #752795