BUSHFIRE CVS Repository

SP BUSHFIRE Team <sp-bosbrand@cs.uu.nl>
Jelle Herold <jherold@math.uu.nl>

General

If some file can be generated from some other file (compilation, conversion, parsing), it should not go into the CVS. This is very important. For example, the .eps files in the figures subdirectories of our latex documents are not kept in the repository, because they can be generated from the .dia files. This is to prevent files from getting out of sync. Another (obvious) example would be .class files. We will put CVS ignores on these files.

Make

To support this file ``generation'' we need to use a build system. JCreator can be used for this, and other IDE's as well, but this will not be automatable. Therefor I suggest we use make, and widespread build system. When you check out the project from cvs it should be possible to build all the ``missing'' file using just the make command. I will explain this in the meeting.

Layout

Please note that the folowing directory structure is below /cvsroot/bushfire/.

Module `docs`

/docs/
    /cvs_repository/
    /functionaldesign/
        Makefile
        functionaldesign.tex
        /figures/
            someumlfigure.dia
    /specifications/
    /skeleton/

All the handwritten L^ATEX documentation should go here, each document in it's own subdirectory. If the document uses figures, those should go the /bushfire/docs/<document>/figures directory. The .tex file should have exactly the same name and name of the directory it is in. It's also important (for the website) that there is a Makefile in the /bushfire/docs/<document>/ directory that allows building a HTML, PDF and Postscript file using the commands make html, make pdf and make ps. The Makefile in the /bushfire/docs/skeleton/ directory does this. The HTML files should go into the /bushfire/docs/<document>/html/ subdir. the PDF and Postscript file should go into the /bushfire/docs/<document>/ directory.

Module `bushfire`

/bushfire/
    /src/
        Makefile
        Simulation.java
        Training.java
        /attribute/
            IntAttr.java
            /views/
                IntAttrView.java
        /world
            Simulation.java
        /ctrl
        /util
        /fp
        /simgui
        /traingui
    /docs/
    /testlab/

The `/src/` subdir

This is where the source code will reside. The drivers of the two applications, Simulation and Training, are in /bushfire/src/simgui and /bushfire/src/traingui/.

/attribute/ Attribute classes.
/attribute/views Swing views on the attribute classes.
/world World foundation.
/util Utility classes such as Error and Matrix.
/ctrl Controller package. Might contain more subdirs.
/fp Fire propagation simulation package (cellular automata).
/simgui Simulation GUI and related code.
/traingui Training GUI and related code (ESP).

The `/docs/` subdir

Here all the automatically generated documents (doxygen) are stored.

The `/testlab/` subdir

This is where all temporary test code is kept, such as examples on how the Attribute classes are used etc.

The `/unittests/` subdir

The bushfire unit tests are kept here. All these tests are run using JUnit.

Module `website`

This is were all the website code will reside (the stuff that builds the website, pdf files etc) and all static pages. The actual output of this will be kept in the sourceforge www directory, and possibly and mirror on the students.cs.uu.nl server.

Module `text_*`

All kinds of independen developed test projects, such as the NN/ESP code, pathplanning and firepropagation code. This will be mixed into the main bushfire module asap.

License

Because the project falls under the GPL license we should include the following comment in a each source file.

/*

This file is part of the Bushfire project.

Copyright 2003, M. Albers, H Boros, R Burema, N. Goh, J. Herold, B.
Maasen, R. Peek, J. Priem, Bas Steunebrink, P. van de Werken.

The Bushfire project is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.

The Bushfire project is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with Foobar; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

*/

The best location is the top of the file.

CVS Keywords

Each file should include the $id$ keyword. This makes it easyer for us to identify which revision a file is when it is exported out of the repository. The keyword should be put inside the license comment one line below the last line of license text.

About this document ...

BUSHFIRE CVS Repository

This document was generated using the LaTeX2HTML translator Version 2K.1beta (1.48)

The command line arguments were:
latex2html -dir /home/wires/Bushfire/website/html/docs/cvs_repository -split 0 ../../../tmp/docs/cvs_repository/cvs_repository.tex

The translation was initiated by Jelle on 2003-04-26

Jelle 2003-04-26