GNOME Bugzilla – Bug 166462
'make dist' should abort if html docs were not generated
Last modified: 2007-01-04 13:26:12 UTC
1. make clean 2. make dist -> result: generated tarball does not include html docs The generic gtk-doc.make makefile should add a dist hook that checks if html docs are present and abort if they're not. Otherwise it's very easy to accidentally make releases not containing html docs.
docs are generated at build time. I don't think that pre-build docs should be shipped.
I second the request to _not_ ship with pre-build docs. The tar.gz. is the source. No need to include "compiled" stuff. The argument "it is a nice service to our users" is invalid ( IM(NS)HO ) `make dist` should just and only just build the tar.gz. Abusing `make dist` for `make gtkdoc` is the wrong thing.
I won't debate on whether shipping built docs is good or bad. But one thing you can't deny is that there is inconsistency in handling of built docs. If not, see the following rule in the gtk-doc.make: --------------- # # Require gtk-doc when making dist # if ENABLE_GTK_DOC dist-check-gtkdoc: else dist-check-gtkdoc: @echo "*** gtk-doc must be installed and enabled in order to make dist" @false endif --------------- See what I mean? The html docs _are_ shipped by default, if available, and "make dist" checks that gtk-doc was enabled, it only forgets to check that the html docs were actually built and exist at the time "make dist" runs. It's a matter of consistency.
building HTML API for GTK by example is longer than the build itself, having html with the tarball is the standard behaviour for GNOME components and handy for distribution
Gustavo: what should gtkdoc do if not html docs are present. Care to submit a patch?
Created attachment 63024 [details] [review] patch
I've applied the html part of the patch. Thanks. I didn't want to apply the tmpl/* line as we may support template-less builds in future.