ATF-log archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
#48: Remove XML docs madness
#48: Remove XML docs madness
-------------------+--------------------------------------------------------
Reporter: jmmv | Owner: jmmv
Type: task | Status: new
Priority: minor | Milestone: reorg
Component: MISC | Version:
Keywords: |
-------------------+--------------------------------------------------------
A while ago, I converted the distribution documents to XML thinking that
it made them nicer. It actually does, but the value is really little: it
does not make sense to provide some of these documents online as-is, and
some of the documents for which it makes sense should not be in the tree
(e.g. the specification document).
To make things worse, this document auto-generation adds a lot of
complexity to the build files and makes them very fragile. I'm not sure
if a --disable-doc-build build works fine in all cases, for example, and
ensuring it does requires quite a bit of effort.
Therefore:
* Move the specification, hacking and release creation documents to the
wiki, as they both have a very dynamic nature.
* Reformat the distribution documents as text files and put them in the
top level directory.
* Get rid of all build logic (in makefiles, scripts and m4 macros) used
to support these files.
* Adjust htdocs to not scrape these documents from the source repository.
''Maybe'' expose the plain-text ones, but probably just don't do it.
--
Ticket URL: <http://www.julipedia.org/projects/atf/trac/ticket/48>
Automated Testing Framework <http://www.NetBSD.org/~jmmv/atf/>
Automated Testing Framework
Home |
Main Index |
Thread Index |
Old Index