aboutsummaryrefslogtreecommitdiff
path: root/build/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'build/README.txt')
-rw-r--r--build/README.txt80
1 files changed, 80 insertions, 0 deletions
diff --git a/build/README.txt b/build/README.txt
new file mode 100644
index 000000000..4c8a1cf27
--- /dev/null
+++ b/build/README.txt
@@ -0,0 +1,80 @@
+MOA BUILD-SYSTEM
+================
+
+
+Einleitung
+----------
+
+Das MOA Build-System bietet eine einheitliche Build-Umgebung für
+alle MOA Sub-Projekte.
+
+Es bietet folgende Vorteile:
+ - zentrale Installation des Build-Tools (Ant)
+ - zentrale Ablage der Build-Scripts
+ - standardisiertes Build über alle Sub-Projekte
+ - einfache Möglichkeit, alle Sub-Projekte auf einmal zu erzeugen
+
+
+Voraussetzungen
+---------------
+
+Das MOA Build-System setzt ein JDK 1.3.1 oder höher voraus. Folgende
+Umgebungsvariablen müssen (required) oder können (optional) gesetzt
+sein:
+
+ - JAVA_HOME (required): zeigt auf das vom Build-System zu verwendende
+ JDK (ab Version 1.3.1)
+ - CATALINA_HOME (optional): zeigt auf eine Tomcat-4.1 Installation; wird
+ verwendet, um Web-Applikationen zu deployen
+ - JMETER_HOME (optional): zeigt auf eine JMeter-1.8 Installation; wird
+ verewndet, um das JMeter-Plugin zu deployen
+
+
+Aufruf
+------
+
+Unter Windows:
+ build [project [targets]]
+
+Unter Unix:
+ build.sh [project [targets]]
+
+Der Parameter 'project' spezifiziert das Sub-Projekt, für das das Build
+aufzurufen ist. Der Wert 'all' gibt an, dass das Build für alle MOA Sub-Projekte
+durchgeführt werden soll.
+
+Der Parameter 'targets' spezifiziert eine Liste von Build-Targets. Werden keine
+Targets angegeben, wird automatisch der Default-Target des jeweiligen Projekts
+ausgeführt.
+
+Ein Aufruf ohne Parameter wird wie ein Aufruf mit dem Parameter 'all' interpretiert.
+
+
+Sub-Projekte
+------------
+
+Als Sub-Projekte stehen derzeit zur Verfügung:
+
+ - common
+ - spss.client
+ - spss.server
+ - id.server
+
+Das MOA Build-System geht davon aus, dass die Sub-Projekte in der selben
+Verzeichnis-Ebene zu finden sind wie das Build-System selbst.
+
+
+Targets
+-------
+
+Sub-Projekte stellen ihre Targets in einem Build-File namens 'build.xml' in
+ihrem Wurzelverzeichnis zur Verfügung. Jedes Sub-Projekt hat grundsätzlich
+die Freiheit, eigene Targets zu definieren. Für ein möglichst automatisiertes
+Build und Deployment aller Sub-Projekte auf einmal, sollten einige Top-Level
+Targets über alle Sub-Projekte hinweg standardisiert sein:
+
+dist-all: erzeugt deploy-fähige bzw. verteilbare Module
+
+deploy-catalina: führt das Deployment in einen Tomcat-4.1 durch
+
+deploy-all: führt das Deployment in Zielumgebungen durch