Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This should have the same effect as changing the project.properties file, but command-line builds using maven only will unaffected.

Building the Documentation

Generating the documentation with maven is quite easy. Just execute this command.

No Format

maven site

This builds the site at the location ./target/docs. You can use this site for local documentation by browsing to ./target/docs/index.html.

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 Size

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

Use this environment variable setting to allocate more memory, i.e. 1 gigabyte to maven.

No Format

MAVEN_OPTS=-Xmx1024m

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.