Author: kelvingoodson
Date: Tue Oct 10 01:54:44 2006
New Revision: 454666
URL: http://svn.apache.org/viewvc?view=rev&rev=454666
Log:
TUSCANY-804 updated references to source code location for spec project and
clarified build instructions. Made reference to sample and plugin projects.
Modified:
incubator/tuscany/site/site-author/java_sdo_overview.xml
incubator/tuscany/site/site-publish/java_sdo_overview.html
Modified: incubator/tuscany/site/site-author/java_sdo_overview.xml
URL:
http://svn.apache.org/viewvc/incubator/tuscany/site/site-author/java_sdo_overview.xml?view=diff&rev=454666&r1=454665&r2=454666
==============================================================================
--- incubator/tuscany/site/site-author/java_sdo_overview.xml (original)
+++ incubator/tuscany/site/site-author/java_sdo_overview.xml Tue Oct 10
01:54:44 2006
@@ -87,7 +87,22 @@
<H4 >SDO Java Build
Environment Setup</H4>
-<P>If you want to work with the SDO 2 project alone, without the rest of
+<P>There are two motivations for building SDO from source and two well tested
approches to doing so.
+You may be wanting to build a binary release distribution from source code.
Alternatively you may be
+wishing to establish a development environment in order to futher the
development of the code. The two
+tested approaches are either to use maven 2 commandline builds or to java
source code create projects
+in the Eclipse SDK.
+</P>
+
+<P>If you simply want to create a source code distribution, then even if you
are an Eclipse user
+its best to just follow the instructions in the BUILDING.txt file at the top
of the source code distribution
+and run a maven command line build (since the route to establishing an Eclipse
environment requires installing maven anyway).
+Note that SDO for Java is distributed as two source code distributions. You'll
need to
+<A HREF="downloads.html">download</A>
+two archives, one for the SDO API, and one for the Tuscany implementation of
that API.
+</P>
+
+<P>If you want to work with the SDO projects alone, without the rest of
Tuscany, proceed with the following steps.</P>
<OL type="1">
<LI>
@@ -95,7 +110,7 @@
href="java-projects.html"> instructions for building the whole
of Tuscany</A>,
<STRONG>but</STRONG> only download and install Java 5, Maven and Svn
(note that only one file, Interface2JavaGenerator.java, has a Java 5
- dependency, if you want to work with Java 1.4 then just delete this
+ dependency, if you want to work with Java 1.4.2 then just delete this
file before building).</P>
</LI>
<LI>
@@ -117,7 +132,7 @@
svn up sdo <BR/>
svn up -N spec <BR/>
cd spec <BR/>
- svn up sdo <BR/>
+ svn up sdo-api <BR/>
</P>
</LI>
</UL>
@@ -153,7 +168,7 @@
<P>Commands:</P>
<UL>
<LI style="list-style-type: none;">
- <P>cd <local tuscany dir>/java/spec/sdo <BR/>
+ <P>cd <local tuscany dir>/java/spec/sdo-api <BR/>
mvn <BR/>
mvn eclipse:eclipse (optional: Run this command if you
are using
Eclipse for development.) <BR/>
@@ -182,6 +197,17 @@
</P>
</LI>
</UL>
+ <P><STRONG>sdo.samples</STRONG> project</P>
+ <P>Commands:</P>
+ <UL>
+ <LI style="list-style-type: none;">
+ <P>cd <local tuscany dir>/java/sdo/sample <BR/>
+ mvn <BR/>
+ mvn eclipse:eclipse (optional: Run this command if you
are using
+ Eclipse for development.) <BR/>
+ </P>
+ </LI>
+ </UL>
</LI>
</UL>
</LI>
@@ -191,16 +217,19 @@
<P><STRONG>Notes:</STRONG></P>
<OL type="1">
<LI>
- <P>You can build both sdo.impl and sdo.tools in one step by
running
+ <P>You can all of the sdo.impl, sdo.tools and sdo.sample
projects in one step by running
mvn in <local tuscany dir>/java/sdo.</P>
</LI>
<LI>
<P>If the mvn command completed successfully, you will see BUILD
- SUCCESSFUL in the output and sdo-api-SNAPSHOP.jar is created
under
- <local tuscany dir>/java/spec/sdo/target directory.</P>
+ SUCCESSFUL in the output and the results of compilation will be
available in jar files created under
+ directories named "target" directly under the root directories
of the projects. These jar files are also
+ installed into your local maven repository ($HOME/.m2/repository) and
are available as inputs to later build
+ operations.</P>
</LI>
<LI>
- <P>External resources are at times unavailable. It may be
necessary to
+ <P>Maven fetches external resources required for a build
process from the internet.
+ These resources are at times unavailable. It may be necessary to
run "mvn" again at a later time.</P>
</LI>
<LI>
@@ -215,7 +244,7 @@
<H3 >SDO Project
Structure</H3>
-<P>The SDO project is divided into three parts:</P>
+<P>The SDO project is divided into five parts:</P>
<OL type="1">
<LI>
<P><STRONG>sdo.spec</STRONG> contains the SDO (commonj) interfaces
@@ -228,6 +257,13 @@
<LI>
<P><STRONG>sdo.tools</STRONG> contains import and generator tools.</P>
</LI>
+ <LI>
+ <P><STRONG>sdo.sample</STRONG> contains sample sdo code.</P>
+ </LI>
+ <LI>
+ <P><STRONG>sdo.plugin</STRONG> contains code to configure the way in
which SDO is build by maven.</P>
+ </LI>
+
</OL>
<P>The main source code in each of these subprojects is located in the
directory src/main/java, and if applicable, test (example) classes are
@@ -237,8 +273,8 @@
<H4 >sdo.spec</H4>
<P>(<A rel="nofollow"
- href="https://svn.apache.org/repos/asf/incubator/tuscany/java/spec/sdo";>
-https://svn.apache.org/repos/asf/incubator/tuscany/java/spec/sdo</A>)</P>
+
href="https://svn.apache.org/repos/asf/incubator/tuscany/java/spec/sdo-api";>
+https://svn.apache.org/repos/asf/incubator/tuscany/java/spec/sdo-api</A>)</P>
<P>This project contains the interfaces provided with the SDO 2
specification. It is essentially an unzipped copy of the SDO Java API
sources zip file available at <A rel="nofollow"
@@ -359,58 +395,60 @@
Framework - www.eclipse.org/emf) runtime jars to build:</P>
<UL>
<LI>
- <P>emf-common-2.2.0-SNAPSHOT.jar - some common framework utility and
+ <P>emf-common-2.2.1-SNAPSHOT.jar - some common framework utility and
base classes</P>
</LI>
<LI>
- <P>emf-ecore-2.2.0-SNAPSHOT.jar - the EMF core runtime implementation
+ <P>emf-ecore-2.2.1-SNAPSHOT.jar - the EMF core runtime implementation
classes (the Ecore metamodel)</P>
</LI>
<LI>
- <P>emf-ecore-change-2.2.0-SNAPSHOT.jar - the EMF change recorder and
+ <P>emf-ecore-change-2.2.1-SNAPSHOT.jar - the EMF change recorder and
framework</P>
</LI>
<LI>
- <P>emf-ecore-xmi-2.2.0-SNAPSHOT.jar - EMF's default XML (and XMI)
+ <P>emf-ecore-xmi-2.2.1-SNAPSHOT.jar - EMF's default XML (and XMI)
serializer and loader</P>
</LI>
<LI>
- <P>xsd-2.2.0-SNAPSHOT.jar - the XML Schema model</P>
+ <P>xsd-2.2.1-SNAPSHOT.jar - the XML Schema model</P>
</LI>
</UL>
<P>The sdo.tools project also requires the EMF code generator framework
jars:</P>
<UL>
<LI>
- <P>emf-codegen-2.2.0-SNAPSHOT.jar - template-based codegen framework
+ <P>emf-codegen-2.2.1-SNAPSHOT.jar - template-based codegen framework
(JET - Java Emitter Templates)</P>
</LI>
<LI>
- <P>emf-codegen-ecore-2.2.0-SNAPSHOT.jar - the EMF code generator</P>
+ <P>emf-codegen-ecore-2.2.1-SNAPSHOT.jar - the EMF code generator</P>
</LI>
<LI>
- <P>emf-common-2.2.0-SNAPSHOT.jar - some common framework utility and
+ <P>emf-common-2.2.1-SNAPSHOT.jar - some common framework utility and
base classes</P>
</LI>
<LI>
- <P>emf-ecore-2.2.0-SNAPSHOT.jar - the EMF core runtime implementation
+ <P>emf-ecore-2.2.1-SNAPSHOT.jar - the EMF core runtime implementation
classes (the Ecore metamodel)</P>
</LI>
<LI>
- <P>emf-ecore-change-2.2.0-SNAPSHOT.jar - the EMF change recorder and
+ <P>emf-ecore-change-2.2.1-SNAPSHOT.jar - the EMF change recorder and
framework</P>
</LI>
<LI>
- <P>emf-ecore-xmi-2.2.0-SNAPSHOT.jar - EMF's default XML (and XMI)
+ <P>emf-ecore-xmi-2.2.1-SNAPSHOT.jar - EMF's default XML (and XMI)
serializer and loader</P>
</LI>
<LI>
- <P>xsd-2.2.0-SNAPSHOT.jar - the XML Schema model</P>
+ <P>xsd-2.2.1-SNAPSHOT.jar - the XML Schema model</P>
</LI>
</UL>
<P>These are simply Maven-friendly versions of corresponding jar
files/plugins obtained from Eclipse. SNAPSHOT maps to an EMF weekly
-integration build (for example, I200602160000).</P>
+integration build (for example, I200602160000). Note that if you are building
+SDO for a released source code distribution then the dependency jars will not
be
+snapshot jars, but will instead themselves be released versions of the
dependencies.</P>
<A id="runtime"></A>
<P></P>
Modified: incubator/tuscany/site/site-publish/java_sdo_overview.html
URL:
http://svn.apache.org/viewvc/incubator/tuscany/site/site-publish/java_sdo_overview.html?view=diff&rev=454666&r1=454665&r2=454666
==============================================================================
--- incubator/tuscany/site/site-publish/java_sdo_overview.html (original)
+++ incubator/tuscany/site/site-publish/java_sdo_overview.html Tue Oct 10
01:54:44 2006
@@ -393,14 +393,27 @@
<P>To build the whole Tuscany
project follow <A class="external" rel="nofollow" href="java-projects.html">
these instructions</A>.</P>
<H4>SDO Java Build
Environment Setup</H4>
- <P>If you want to work with the
SDO 2 project alone, without the rest of
+ <P>There are two motivations for
building SDO from source and two well tested approches to doing so.
+You may be wanting to build a binary release distribution from source code.
Alternatively you may be
+wishing to establish a development environment in order to futher the
development of the code. The two
+tested approaches are either to use maven 2 commandline builds or to java
source code create projects
+in the Eclipse SDK.
+</P>
+ <P>If you simply want to create a
source code distribution, then even if you are an Eclipse user
+its best to just follow the instructions in the BUILDING.txt file at the top
of the source code distribution
+and run a maven command line build (since the route to establishing an Eclipse
environment requires installing maven anyway).
+Note that SDO for Java is distributed as two source code distributions. You'll
need to
+<A HREF="downloads.html">download</A>
+two archives, one for the SDO API, and one for the Tuscany implementation of
that API.
+</P>
+ <P>If you want to work with the
SDO projects alone, without the rest of
Tuscany, proceed with the following steps.</P>
<OL type="1">
<LI>
<P>Set up your environment using the <A class="external" rel="nofollow"
href="java-projects.html"> instructions for building the whole of Tuscany</A>,
<STRONG>but</STRONG> only download and install Java 5, Maven and Svn
(note that only one file, Interface2JavaGenerator.java, has a Java 5
- dependency, if you want to work with Java 1.4 then just delete this
+ dependency, if you want to work with Java 1.4.2 then just delete this
file before building).</P>
</LI>
<LI>
@@ -421,7 +434,7 @@
svn up sdo <BR />
svn up -N spec <BR />
cd spec <BR />
- svn up sdo <BR />
+ svn up sdo-api <BR />
</P>
</LI>
</UL>
@@ -457,7 +470,7 @@
<P>Commands:</P>
<UL>
<LI style="list-style-type: none;">
- <P>cd <local tuscany dir>/java/spec/sdo <BR />
+ <P>cd <local tuscany dir>/java/spec/sdo-api <BR />
mvn <BR />
mvn eclipse:eclipse (optional: Run this command if you
are using
Eclipse for development.) <BR />
@@ -486,6 +499,17 @@
</P>
</LI>
</UL>
+ <P><STRONG>sdo.samples</STRONG> project</P>
+ <P>Commands:</P>
+ <UL>
+ <LI style="list-style-type: none;">
+ <P>cd <local tuscany dir>/java/sdo/sample <BR />
+ mvn <BR />
+ mvn eclipse:eclipse (optional: Run this command if you
are using
+ Eclipse for development.) <BR />
+ </P>
+ </LI>
+ </UL>
</LI>
</UL>
</LI>
@@ -495,16 +519,19 @@
<P><STRONG>Notes:</STRONG></P>
<OL type="1">
<LI>
- <P>You can build both sdo.impl and sdo.tools in one step by
running
+ <P>You can all of the sdo.impl, sdo.tools and sdo.sample
projects in one step by running
mvn in <local tuscany dir>/java/sdo.</P>
</LI>
<LI>
<P>If the mvn command completed successfully, you will see BUILD
- SUCCESSFUL in the output and sdo-api-SNAPSHOP.jar is created
under
- <local tuscany dir>/java/spec/sdo/target directory.</P>
+ SUCCESSFUL in the output and the results of compilation will be
available in jar files created under
+ directories named "target" directly under the root directories
of the projects. These jar files are also
+ installed into your local maven repository ($HOME/.m2/repository) and
are available as inputs to later build
+ operations.</P>
</LI>
<LI>
- <P>External resources are at times unavailable. It may be
necessary to
+ <P>Maven fetches external resources required for a build
process from the internet.
+ These resources are at times unavailable. It may be necessary to
run "mvn" again at a later time.</P>
</LI>
<LI>
@@ -517,7 +544,7 @@
</UL>
<H3>SDO Project
Structure</H3>
- <P>The SDO project is divided into
three parts:</P>
+ <P>The SDO project is divided into
five parts:</P>
<OL type="1">
<LI>
<P><STRONG>sdo.spec</STRONG> contains the SDO (commonj) interfaces
@@ -530,14 +557,21 @@
<LI>
<P><STRONG>sdo.tools</STRONG> contains import and generator tools.</P>
</LI>
+ <LI>
+ <P><STRONG>sdo.sample</STRONG> contains sample sdo code.</P>
+ </LI>
+ <LI>
+ <P><STRONG>sdo.plugin</STRONG> contains code to configure the way in
which SDO is build by maven.</P>
+ </LI>
+
</OL>
<P>The main source code in each of
these subprojects is located in the
directory src/main/java, and if applicable, test (example) classes are
located in src/test/java. The directory src/test/resources contains any
data files needed by the test programs.</P>
<H4>sdo.spec</H4>
- <P>(<A rel="nofollow"
href="https://svn.apache.org/repos/asf/incubator/tuscany/java/spec/sdo";>
-https://svn.apache.org/repos/asf/incubator/tuscany/java/spec/sdo</A>)</P>
+ <P>(<A rel="nofollow"
href="https://svn.apache.org/repos/asf/incubator/tuscany/java/spec/sdo-api";>
+https://svn.apache.org/repos/asf/incubator/tuscany/java/spec/sdo-api</A>)</P>
<P>This project contains the
interfaces provided with the SDO 2
specification. It is essentially an unzipped copy of the SDO Java API
sources zip file available at <A rel="nofollow"
href="http://ftpna2.bea.com/pub/downloads/SDO_20_Source.zip";>
@@ -646,58 +680,60 @@
Framework - www.eclipse.org/emf) runtime jars to build:</P>
<UL>
<LI>
- <P>emf-common-2.2.0-SNAPSHOT.jar - some common framework utility and
+ <P>emf-common-2.2.1-SNAPSHOT.jar - some common framework utility and
base classes</P>
</LI>
<LI>
- <P>emf-ecore-2.2.0-SNAPSHOT.jar - the EMF core runtime implementation
+ <P>emf-ecore-2.2.1-SNAPSHOT.jar - the EMF core runtime implementation
classes (the Ecore metamodel)</P>
</LI>
<LI>
- <P>emf-ecore-change-2.2.0-SNAPSHOT.jar - the EMF change recorder and
+ <P>emf-ecore-change-2.2.1-SNAPSHOT.jar - the EMF change recorder and
framework</P>
</LI>
<LI>
- <P>emf-ecore-xmi-2.2.0-SNAPSHOT.jar - EMF's default XML (and XMI)
+ <P>emf-ecore-xmi-2.2.1-SNAPSHOT.jar - EMF's default XML (and XMI)
serializer and loader</P>
</LI>
<LI>
- <P>xsd-2.2.0-SNAPSHOT.jar - the XML Schema model</P>
+ <P>xsd-2.2.1-SNAPSHOT.jar - the XML Schema model</P>
</LI>
</UL>
<P>The sdo.tools project also
requires the EMF code generator framework
jars:</P>
<UL>
<LI>
- <P>emf-codegen-2.2.0-SNAPSHOT.jar - template-based codegen framework
+ <P>emf-codegen-2.2.1-SNAPSHOT.jar - template-based codegen framework
(JET - Java Emitter Templates)</P>
</LI>
<LI>
- <P>emf-codegen-ecore-2.2.0-SNAPSHOT.jar - the EMF code generator</P>
+ <P>emf-codegen-ecore-2.2.1-SNAPSHOT.jar - the EMF code generator</P>
</LI>
<LI>
- <P>emf-common-2.2.0-SNAPSHOT.jar - some common framework utility and
+ <P>emf-common-2.2.1-SNAPSHOT.jar - some common framework utility and
base classes</P>
</LI>
<LI>
- <P>emf-ecore-2.2.0-SNAPSHOT.jar - the EMF core runtime implementation
+ <P>emf-ecore-2.2.1-SNAPSHOT.jar - the EMF core runtime implementation
classes (the Ecore metamodel)</P>
</LI>
<LI>
- <P>emf-ecore-change-2.2.0-SNAPSHOT.jar - the EMF change recorder and
+ <P>emf-ecore-change-2.2.1-SNAPSHOT.jar - the EMF change recorder and
framework</P>
</LI>
<LI>
- <P>emf-ecore-xmi-2.2.0-SNAPSHOT.jar - EMF's default XML (and XMI)
+ <P>emf-ecore-xmi-2.2.1-SNAPSHOT.jar - EMF's default XML (and XMI)
serializer and loader</P>
</LI>
<LI>
- <P>xsd-2.2.0-SNAPSHOT.jar - the XML Schema model</P>
+ <P>xsd-2.2.1-SNAPSHOT.jar - the XML Schema model</P>
</LI>
</UL>
<P>These are simply Maven-friendly
versions of corresponding jar
files/plugins obtained from Eclipse. SNAPSHOT maps to an EMF weekly
-integration build (for example, I200602160000).</P>
+integration build (for example, I200602160000). Note that if you are building
+SDO for a released source code distribution then the dependency jars will not
be
+snapshot jars, but will instead themselves be released versions of the
dependencies.</P>
<A id="runtime" />
<P />
<H3>Runtime
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
