--- projects/cms/source/server/build.config	2001/05/18 02:12:33	1.8
+++ projects/cms/source/server/build.config	2001/05/19 16:28:24	1.9
@@ -1,70 +1,139 @@
-# Configuration file for XML build (ant)
+# Configuration file for i-scream DCMS server build script (ANT XML).
 
-# TODO: Major tidying and commenting
+# Most of this file should be fine as is, although there
+# are a few options you may wish to change.
+# This file should conform the the Java Properties standards.
 
+# $Id: build.config,v 1.9 2001/05/19 16:28:24 tdb Exp $
+
+#### Locations of directions ####
+
+# nb. ${SOURCEROOT} points to the root of the server directory
+
 # Location of the build directory
 BUILDDIR = ${SOURCEROOT}/build
-# Relative (to BUILD) location of the libraries
+# Relative location of the libraries
 LIBDIR = ${BUILDDIR}/lib
 
-# IDL file details
-IDLDIR = ${SOURCEROOT}/idl
-IDLFILE = ${IDLDIR}/iscream.idl
-IDLPARSER = org.jacorb.idl.parser
-IDLPARSERJAR = ${LIBDIR}/idl.jar
+# Root directory of source files
+# (this will be the first java package)
+ROOTPKG = uk
 
-# Required Libraries
+
+#### Compiler Options ####
+
+# Libraries required by the server
+# this should match ${MFCLPATH} (although layout differs)
 JCLIBS = ${LIBDIR}/idl.jar:${LIBDIR}/jacorb.jar:${LIBDIR}/jaxp.jar:${LIBDIR}/crimson.jar:${LIBDIR}/mm.mysql-2.0.4-bin.jar
 # Compiler Classpath
 JCCLASSPATH = ${JCLIBS}:${SOURCEROOT}:${BUILDDIR}
 
 # Compiler options
+# turn on debugging?
 JCDEBUG = no
+# turn on optimisation?
 JCOPTIM = yes
+# turn on deprecation warnings?
 JCDEPRE = no
 
-# Root package
-ROOTPKG = uk
 
-# JAR Package names
+#### IDL Information ####
+
+# Directory of IDL file
+IDLDIR = ${SOURCEROOT}/idl
+# IDL file name
+IDLFILE = ${IDLDIR}/iscream.idl
+# Java IDL parser (part of jacorb)
+IDLPARSER = org.jacorb.idl.parser
+# JAR containing IDLPARSER
+IDLPARSERJAR = ${LIBDIR}/idl.jar
+
+
+#### JAR Packages ####
+
+# Server JAR name
 SERVERJAR = iscream-server.jar
-UTILJAR = iscream-util.jar
-# Main-class to be added to the Manifest
+
+# Main-class to be added to the Manifest of the Server JAR
+# this is the class that will be loaded on starting the JAR
 MFMAINCLASS = uk.org.iscream.componentmanager.ComponentManager
-# Class-path to be added to the Manifest
+
+# Class-path to be added to the Manifest of the Server JAR
+# this should match ${JCLIBS} (although layout differs)
 MFCLPATH = lib/idl.jar lib/jacorb.jar lib/jaxp.jar lib/mm.mysql-2.0.4-bin.jar lib/crimson.jar
 
-# Name of archives
+# Util JAR name
+UTILJAR = iscream-util.jar
+# Location of Util source files
+UTILSRC = uk/org/iscream/util/**/*.java
+
+
+#### Distributions ####
+
+# we do that so we could later expand filenames to for example;
+# ${ARCNAME}-something${TARGZEXT}
+
+# Base name of archive
 ARCNAME = iscream-server
+
+# archive extensions defined
 TAREXT = .tar
 TARGZEXT = .tar.gz
 ZIPEXT = .zip
 
+# complete archive names
 TARFILE = ${ARCNAME}${TAREXT}
 TARGZFILE = ${ARCNAME}${TARGZEXT}
 ZIPFILE = ${ARCNAME}${ZIPEXT}
 
-# note NO trailing slash
-LIBURL = http://killigrew.ukc.ac.uk
 
-RUNFILTERNAME = filter1
+#### Install ####
 
+# Default Prefix
+prefix = /usr/local/iscream-server
+INSTALLDEST = ${prefix}
+
+
+#### Javadoc ####
+
+# Location of Javadoc output
 JDOCDIR = ${SOURCEROOT}/doc
+# Packages to include in the Javadoc
 JDOCPKGS = uk.org.iscream.*
-JDOCTITLE = i-scream server
+# Title to put on the Javadoc pages
+JDOCTITLE = i-scream DCMS server
+# Header of Javadoc pages
 JDOCHEADER = <img src='http://www.i-scream.org.uk/i-scream_small.gif' width='146' height='38'>
+# Footer of Javadoc pages
 JDOCBOTTOM = <i>Copyright &#169; 2000-2001 i-scream. All Rights Reserved.</i>
+# Live link to 1.3 Java API (to allow linking)
 JDOCJAPI = http://java.sun.com/j2se/1.3/docs/api/
 
-UTILJAR = iscream-util.jar
-UTILSRC = uk/org/iscream/util/**/*.java
 
-# Install Prefix
-prefix = /usr/local/iscream-server
-INSTALLDEST = ${prefix}
+#### CVS Information ####
 
+# These are required for the cvsbuild target
+
+# CVS Repository
 CVSROOT = /usr/local/proj/co600_10/cvs
+# Module of server
 CVSMODULE = source/server
+# Temporary directory to use
 CVSBUILDTEMP = ${SOURCEROOT}/cvsbuildtemp
+# Default revision to build
 rev = HEAD
 REVISION = ${rev}
+
+
+#### Library Fetching ####
+
+# would be nice to be able to list JARs here too...
+
+# base url for JARs
+# note NO trailing slash
+LIBURL = http://killigrew.ukc.ac.uk
+
+#### Running ####
+
+# Name of the filter to be given on the command line
+RUNFILTERNAME = filter1