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 479923 - distclean test output properly
distclean test output properly
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.9
Other Linux
: Normal normal
: 1.9
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2007-09-24 18:38 UTC by Yeti
Modified: 2007-09-24 20:43 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
proposed patch (1.71 KB, patch)
2007-09-24 18:59 UTC, Yeti
reviewed Details | Review

Description Yeti 2007-09-24 18:38:38 UTC
After unpacking would-be-gtk-doc-1.9 and running (did not dare to run distcheck)

  ./configure --enable-maintainer-mode  
  make
  make check
  make distclean

the following extra files are left in the source tree:

tests/bugs/docs/gtkdoc-fixxref.log
tests/bugs/docs/gtkdoc-mkdb.log
tests/bugs/docs/gtkdoc-mkhtml.log
tests/bugs/docs/gtkdoc-scan.log
tests/bugs/docs/tester-decl-list.txt
tests/bugs/docs/tester-decl.txt
tests/bugs/docs/xml/object_index.sgml
tests/bugs/docs/xml/tester-doc.bottom
tests/bugs/docs/xml/tester-doc.top
tests/bugs/docs/xml/tree_index.sgml
tests/gobject/docs/gtkdoc-fixxref.log
tests/gobject/docs/gtkdoc-mkdb.log
tests/gobject/docs/gtkdoc-mkhtml.log
tests/gobject/docs/gtkdoc-scan.log
tests/gobject/docs/gtkdoc-scangobj.log
tests/gobject/docs/tester-decl-list.txt
tests/gobject/docs/tester-decl.txt
tests/gobject/docs/xml/object_index.sgml
tests/gobject/docs/xml/tester-doc.bottom
tests/gobject/docs/xml/tester-doc.top
tests/gobject/docs/xml/tree_index.sgml

In addition, the following files are distributed yet cleaned by make distclean:

gtk-doc.spec
help/manual/C/gtk-doc-manual-C.omf
Comment 1 Yeti 2007-09-24 18:59:24 UTC
Created attachment 96130 [details] [review]
proposed patch

Adapt xml/ cleaning from gtk-doc.notmpl.make.  Clean log files.
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2007-09-24 19:36:10 UTC
Yes, make distcheck is on my todo list still :)

Patch looks good. What about
DISTCLEANFILES = gtkdoc-*.log
Comment 3 Yeti 2007-09-24 19:59:07 UTC
(In reply to comment #2)
> What about
> DISTCLEANFILES = gtkdoc-*.log

I have aversion to wildcards in Makefiles.  But, whatever.

Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2007-09-24 20:12:35 UTC
Okay. Applied as is. One thing I wonder - do we want to dist built test docs at all? 

2007-09-24  Stefan Kost  <ensonic@users.sf.net>

	patch by: David Nečas <yeti@physics.muni.cz>

	* NEWS:
	* tests/bugs/docs/Makefile.am:
	* tests/gobject/docs/Makefile.am:
	* tests/gtk-doc.make:
	  Adapt xml/ cleaning from gtk-doc.notmpl.make.  Clean log files.
Comment 5 Yeti 2007-09-24 20:21:13 UTC
(In reply to comment #4)
> One thing I wonder - do we want to dist built test docs at all? 

Built HTML -- probably makes no sense.
The rest -- does not make much sense either, though it makes it work with make -j N>1.

It depends on what the tests are supposed to test.  If bootstrapping too, the rest should be also removed (it would be nice if it could bootstrap with parallel make then...).
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2007-09-24 20:28:05 UTC
Hmm, I'll get rid of the disted html, but what do you mean with 'rest'. I would like to dist all files people would need to run 'make check'.
Comment 7 Yeti 2007-09-24 20:43:01 UTC
By the rest I mean files such as tester-docs.xml, tester-overrides.txt, tester-sections.txt.  Although gtk-doc creates them during the very first build if they do not exist (which normally happens only when a project is first gtkdocized), this is a hackish side-effect invisible to make.

For some reason it works with serial make (part the reason probably is that it was developed with it), but with parallel make the invisibility becomes painfully visible.  I recall complaints about no rules to make overrides and docs -- it should be easy to reproduce if you want to know the exact errors: check out a fresh working copy, autogen it and make check with -j 4.

If these files are distributed -- as a normal gtk-doc-employing project does -- it builds all right.