[ET Trac] [Einstein Toolkit] #642: Cactus documentation target AllDoc does not make all the documentation
Einstein Toolkit
trac-noreply at einsteintoolkit.org
Sun May 6 09:49:40 CDT 2012
#642: Cactus documentation target AllDoc does not make all the documentation
--------------------------+-------------------------------------------------
Reporter: hinder | Owner:
Type: enhancement | Status: new
Priority: optional | Milestone:
Component: Cactus | Version:
Resolution: | Keywords:
--------------------------+-------------------------------------------------
Comment (by eschnett):
The underlying question is whether we treat a failure to build
documentation as something that we just tolerate and ignore, or as
something that needs to be corrected. If we want to correct it, we need to
test it, e.g. by updating the nightly tests, and by recording failures in
the release process.
Another question is whether it even makes sense to build a global
ThornGuide. This will include all thorns present in the source tree, which
is something that nothing else in Cactus does -- for example, there is no
target to build a configuration consisting of all thorns. For example,
copying a thorn will lead to latex errors unless one is careful with
labels and references (and renames them). The resulting ThornGuide is also
not portable, because section numbers etc. depend on what is present in
the source tree. In addition, having one huge pdf file is rarely useful.
I suggest to remove the (global) ThornGuide as makefile target, and leave
only the configuration-specific ThornGuides.
--
Ticket URL: <https://trac.einsteintoolkit.org/ticket/642#comment:4>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit
More information about the Trac
mailing list