--On Wednesday, February 21, 2007 12:42 AM -1000 Austen Ito <[EMAIL PROTECTED]>
wrote:
Hi Philip,
I was working on a new module, creating an alert that will associate
the SVN commits with JIRA issues, when I found that the link to the
hackyDoc_NewModule.zip is broken:
http://hackydev.ics.hawaii.edu/hackyDevSite/external/docbook/ch14s03.html
Also, after following the developer docs and being unsuccessful in
getting the unit tests to pass, I found that the command xml
definition file in the hackyDoc_NewModule.zip, was was named
incorrectly. It was command.sensordatasummary.xml when it should have
been hackyDoc_NewModule.sensordatasummary.command.def.xml.
Anyways, I updated the zip file with the renamed xml file so new
developers won't run into problems. Other than that minor problem,
the developer docs for creating a new module were clear and easy to
follow. :D
Cheers,
austen
Hi Austen,
First off, thanks for diagnosing the problem and fixing it!
I've always felt that those zip files were kind of bogus: they don't exist on the
hackydev site, and the underlying source files aren't under CM control. Finally, as you
discovered, they can get out of date and no one knows.
Until yesterday, our Subversion server only had two active repositories: hackystat and
csdl. I've just added two more: hackystat-exp and hackystat-doc. Hackystat-exp will
hold the "retired" and/or "experimental" modules. Hackystat-doc now holds the sources
for the "documentation" modules (hackyDoc_SimpleSdt, hackyDoc_NewModule, and
hackyDoc_SimpleSensor). I have downloaded your .zip and fixed the sources.
After reading your email, it occurs to me that it might be much better to get rid of the
.zip files entirely and simply point people to the appropriate SVN URL, such as:
svn://www.hackystat.org/hackystat-doc/hackyDoc_SimpleSensor/trunk
What's cool about this is that (a) this URL solves the problem with the broken .zip link
on the hackydev version of the documentation; and (b) we can now actually build and test
the 'doc' modules as part of the daily build!
The only downside is that people reading the documentation need to use SVN to get at the
module. However, if they're learning about modules, they need to download hackystat from
sources anyway, so it shouldn't be a problem.
BTW, Subversion is totally cool with having a single directory containing subdirectories
from more than one repository. So, for example, you can check out
svn://www.hackystat.org/hackystat/trunk into a directory called svn, and get the 75
modules in the public distribution. Then, you can check out
svn://www.hackystat.org/hackystat-doc/hackyDoc_SimpleSensor/trunk into
svn/hackyDoc_SimpleSensor, and now your svn directory contains 76 modules, 75 from
hackystat and 1 from hackystat-doc.
Anyone have any thoughts about this approach?
Cheers,
Philip
