Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Sirius/Build"

(Adding sections. Adding instruction for build Javadoc)
Line 1: Line 1:
Sirius uses Maven/Tycho to build. To build it yourself:
+
= Prerequisite =
 +
Sirius uses Maven/Tycho to build.
 
# Install Maven 3 if if do not have it already.
 
# Install Maven 3 if if do not have it already.
 
# Get a Git clone of http://git.eclipse.org/gitroot/sirius/org.eclipse.sirius.git.
 
# Get a Git clone of http://git.eclipse.org/gitroot/sirius/org.eclipse.sirius.git.
 +
 +
 +
= Build =
 +
== Zipped update-site ==
 +
To build zipped update-site yourself:
 
# From the top-level directory of the clone, issue a simple <code>mvn clean package</code>.
 
# From the top-level directory of the clone, issue a simple <code>mvn clean package</code>.
  
 
The resulting update-site is then available in <code>packaging/org.eclipse.sirius.update/target/repository</code>.
 
The resulting update-site is then available in <code>packaging/org.eclipse.sirius.update/target/repository</code>.
 +
 +
== Javadoc ==
 +
To build the Javadoc of Sirius:
 +
# From the top-level directory of the clone, issue a simple <code>mvn clean install javadoc:aggregate</code>.
 +
 +
To build the JAR-packaged Javadoc of Sirius:
 +
# From the top-level directory of the clone, issue a simple <code>mvn clean install javadoc:aggregate-jar</code>.
  
 
[[Category:Sirius]]
 
[[Category:Sirius]]

Revision as of 10:27, 23 July 2014

Prerequisite

Sirius uses Maven/Tycho to build.

  1. Install Maven 3 if if do not have it already.
  2. Get a Git clone of http://git.eclipse.org/gitroot/sirius/org.eclipse.sirius.git.


Build

Zipped update-site

To build zipped update-site yourself:

  1. From the top-level directory of the clone, issue a simple mvn clean package.

The resulting update-site is then available in packaging/org.eclipse.sirius.update/target/repository.

Javadoc

To build the Javadoc of Sirius:

  1. From the top-level directory of the clone, issue a simple mvn clean install javadoc:aggregate.

To build the JAR-packaged Javadoc of Sirius:

  1. From the top-level directory of the clone, issue a simple mvn clean install javadoc:aggregate-jar.

Back to the top