File: palcom/doc/developer/before_commit.txt

CHECKLIST OF ACTIONS BEFORE DOING A COMMIT IN DEVELOPER TREE
============================================================

1. CHECK VERSIONS

   Make sure that version numbers are appropriately updated  for the
   affected tools (if any).
   The version numbers are manually updated in the following files, 
   all in palcom/developer:

   - runtime/pal-vm/src/VM/Version.hpp
   - tools/compilers/pal-j/Backend/version/Version.java
   - tools/compilers/pal-st/src/ist/palcom/st/Version.java
   - tools/bytecode/pal-asm/src/ist/palcom/assembler/Version.java
   - tools/bytecode/pal-dis/src/ist/palcom/disassembler/Version.java


2. CHECK COMMAND LINE BUILDABILITY

   Make sure everything builds from the command line by calling
      pal-dev-build
   This should complete by building two versions of the pal-vm.
   
   If you changed anything in the VM, instead use
      pal-dev-build -d
   which will compile 4 versions of the VM.


4. CHECK ECLIPSE BUILDABILITY

   This step assumes that you have all Eclipse projects in the palcom
   SVN tree imported into Eclipse.
   Perform a Refresh and possible Team->Update on all PalCom projects
   and verify that all projects build (some require manual run of Ant
   scripts, see palcom/doc/setup/Eclipse-CVS.txt).


5. CHECK TESTABILITY

   You MUST test the system by calling
     pal-dev-test -b
   from the command line.

   If the tests that use multicast hang on your machine, then add the
     -m
   option to all calls of pal-dev-test.  This will run only the tests
   that can be expected to work regardless of network environment.

   If you changed a compiler or anything in the VM, you should also test
   using
     pal-dev-test -b -c
   which tests the programs using the Checked build of the VM instead
   of the default Release build.


6. CHECK NEW FILES

   Make sure you have added new files to SVN.
   Perform e.g.
     svn stat
   from the palcom source tree top level, and notice if you see
   any files marked with '?'


7. CONSIDER EXPORT

   Are your changes important to export into palcom/bin and
   palcom/lib?
   If you think so, please do a
     pal-dev-export


8. ANNOUNCE YOUR CHANGES

   If you did anything but trivial stuff, please announce your changes
   on, e.g., 
     palcom2-wp3@ist-palcom.org
   or
     palcom2-wp3-4@ist-palcom.org
   or
     palcom2-wp2-6@ist-palcom.org
   and possibly other PalCom mailing lists too, dependent on
   the type of changes you made.

