[bind10-dev] removed generated docs and dist target will soon require extra dependencies
Jeremy C. Reed
jreed at isc.org
Fri Aug 31 19:26:42 UTC 2012
I removed the generated documentation from the git repo. This was for
ticket 1687.
They should never had been part of the repo since they may be considered
as binary objects. We often have problems due to differing tools, such
as simple:
can\*(Aqt
versus
can\'t
Or various comments and style information per the tools provided (even
some custom from the vendors).
The --enable-man switch is removed and now replaced with
--enable-generate-docs
It is not on by default. It will create dummy documentation by default.
The problem was: I don't want to generate manpages by default if don't
have tools but need to generate them because required for distdir target
(to make tarballs). In other words, make dist needs the manpages but I
don't want normal "make" builds to require building them due to more
build dependencies. I needed a way to make it so dist_man_MANS does not
become part of all-am target, but since I couldn't do that, I do
workaround instead. My hack (to create dummy docs) is prompted by build
code in pango.
Some points to consider are:
- to have it auto-detect working doxygen with correct stylesheets and
enable the documentation generation if they are available.
- if enable-generate-docs is used, then remove the dummy docs (if they
are fake).
- make sure that dist or distcheck build enables this and makes sure
dummy files aren't placed in dist tarball.
- Note that the html generation is done using elinks. It was already
like that before. But that should be checked in configure too. I will
handle that separately in maybe a different ticket.
I will add documentation tools as a dependency for the dist (or
distcheck) targets (via DISTCHECK_CONFIGURE_FLAGS).
Don't add your generated docs into the repo anymore. Thanks!
Jeremy C. Reed
ISC
More information about the bind10-dev
mailing list