Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add note to also increase Perm Size

...

  • Java JDK 1.5.0 (aka Java 5.0)
  • Maven
  • Netbeans (optional but recommended)
  • CVS client (normally pre-installed on any Linux box)
    Tip
    titleWindows CVS Software
    • cvs, command-line program
    • Tortoise CVS, graphical CVS client with Explorer integration
    Tip
    titleSLAC Unix Tools

    If you are at SLAC the tools above, including netbeans, are all pre-installed on SLAC Unix.

Building org.lcsim software

...

Oftentimes new directories are added in a new release. In order
to make sure that cvs adds those, please use the command

No Format

cvs update -PdA

which will

P: prune empty directories
d: create directories
A: reset sticky tags

No Format

man cvs

will give more information on the cvs program.

Installing Custom JARs into JAS3

...

Note
titleTest Directory

By default, maven will also run the JUnit tests associated with this distribution.
Test reports are written to

No Format

target/test-reports/

If you wish to build without testing, issue the following command:

...

The reference copy of the lcsim documentation is kept at http://www.lcsim.org/software/lcsim. This usually corresponds to the CVS head version.

Increasing the Java Heap and Perm Size

The LCSim tests can take up more memory than the default heap/perm size assigned to the java VM.

Use this environment variable setting to allocate more memory, i.e. 1 gigabyte heap / 256 megabyte perm, to maven.

No Format
MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=256m

If you are building the lcsim documentation, including running all the tests, you are required to increase the heap size beyond the initial default of 256 megabytes. Otherwise, the target will fail due to an "out of memory" error.