Return-Path: <arminw@apache.org>
Mailing-List: contact ojb-dev-help@db.apache.org; run by ezmlm
Delivered-To: mailing list ojb-dev@db.apache.org
Received: (qmail 4936 invoked by uid 500); 28 May 2003 09:00:03 -0000
Received: (qmail 4918 invoked from network); 28 May 2003 09:00:02 -0000
Received: from icarus.apache.org (208.185.179.13)
  by daedalus.apache.org with SMTP; 28 May 2003 09:00:02 -0000
Received: (qmail 95888 invoked by uid 1510); 28 May 2003 09:00:00 -0000
Date: 28 May 2003 09:00:00 -0000
Message-ID: <20030528090000.95887.qmail@icarus.apache.org>
From: arminw@apache.org
To: db-ojb-cvs@apache.org
Subject: cvs commit: db-ojb/xdocs deployment.xml
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N

arminw      2003/05/28 02:00:00

  Modified:    .        build-xdoclet.xml
               xdocs    deployment.xml
  Log:
  update, using xdoclet 1.2xx
  to generate beans
  
  Revision  Changes    Path
  1.10      +4 -13     db-ojb/build-xdoclet.xml
  
  Index: build-xdoclet.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/build-xdoclet.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- build-xdoclet.xml	13 Feb 2003 23:39:53 -0000	1.9
  +++ build-xdoclet.xml	28 May 2003 08:59:58 -0000	1.10
  @@ -42,7 +42,7 @@
   	<target name="xdoclet" depends="check">
   		<taskdef
   				name="ejbdoclet"
  -				classname="xdoclet.ejb.EjbDocletTask">
  +				classname="xdoclet.modules.ejb.EjbDocletTask">
   			<classpath refid="ojb.classpath"/>
   		</taskdef>
   
  @@ -50,11 +50,11 @@
   		<mkdir dir="${generated.src.dir}"/>
   
   		<ejbdoclet
  -			sourcepath="${java.src.dir}"
   			destdir="${generated.src.dir}"
  -			classpathref="ojb.classpath"
   			excludedtags="@version,@author"
  -			ejbspec="2.0">
  +            addedtags="@xdoclet-generated at ${TODAY}"
  +			ejbspec="2.0"
  +        >
   
   			<fileset dir="${java.src.dir}">
                   <include name="**/Bean*.java" />
  @@ -181,14 +181,5 @@
           </jar>
   
       </target>
  -
  -
  -    <!-- =================================================================== -->
  -	<!-- Start the OJB sample session beans                                  -->
  -	<!-- =================================================================== -->
  -	<target name="start-client"
  -            description="Start the OJB client sample tests">
  -
  -	</target>
   
   </project>
  
  
  
  1.21      +38 -23    db-ojb/xdocs/deployment.xml
  
  Index: deployment.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/xdocs/deployment.xml,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- deployment.xml	26 May 2003 09:59:02 -0000	1.20
  +++ deployment.xml	28 May 2003 08:59:59 -0000	1.21
  @@ -13,41 +13,41 @@
   
   <ul>
       <li>
  -        <a href="#1">Things needed for deploying OJB</a>
  +        <a href="#Things needed for deploying OJB">Things needed for deploying OJB</a>
           <ul>
  -            <li><a href="#2">The OJB binary jar archive</a></li>
  -            <li><a href="#3">Configuration data</a></li>
  -            <li><a href="#4">Additional jar archives</a></li>
  -            <li><a href="#5">Don't forget the JDBC driver</a></li>
  +            <li><a href="#The OJB binary jar archive">The OJB binary jar archive</a></li>
  +            <li><a href="#Configuration data">Configuration data</a></li>
  +            <li><a href="#Additional jar archives">Additional jar archives</a></li>
  +            <li><a href="#Don't forget the JDBC driver">Don't forget the JDBC driver</a></li>
           </ul>
       </li>
   
       <li>
  -        <a href="#10">Deployment in standalone applications</a>
  +        <a href="#Deployment in standalone applications">Deployment in standalone applications</a>
       </li>
       <li>
  -        <a href="#20">Deployment in servlet based applications</a>
  +        <a href="#Deployment in servlet based applications">Deployment in servlet based applications</a>
       </li>
       <li>
  -        <a href="#30">Deployment in EJB based applications</a>
  +        <a href="#Deployment in EJB based applications">Deployment in EJB based applications</a>
           <ul>
  -            <li><a href="#31">Instructions for JBoss</a></li>
  -            <li><a href="#32">Build the OJB sample session beans</a></li>
  -            <li><a href="#33">Instructions for Weblogic</a></li>
  +            <li><a href="#Instructions for JBoss">Instructions for JBoss</a></li>
  +            <li><a href="#Build the OJB sample session beans">Build the OJB sample session beans</a></li>
  +            <li><a href="#Instructions for Weblogic">Instructions for Weblogic</a></li>
           </ul>
       </li>
   </ul>
   </p>
   </section>
   
  -<section name="Things needed for deploying OJB" anchor="1">
  +<section name="Things needed for deploying OJB" anchor="Things needed for deploying OJB">
   <p>
   	This section enumerates all things needed to deploy OJB.
   </p>
   
   
   
  -<subsection name="1. The OJB binary jar archive" anchor="2">
  +<subsection name="1. The OJB binary jar archive" anchor="The OJB binary jar archive">
   <P>
   	You need a <code>db-ojb-&lt;version&gt;.jar</code> file containing the compiled OJB library.
   	<br/>This jar files contains all OJB code neccessary in
  @@ -62,7 +62,7 @@
   
   </P>
   </subsection>
  -<subsection name="2. Configuration data" anchor="3">
  +<subsection name="2. Configuration data" anchor="Configuration data">
   <P>OJB needs two kinds of configuration data:</P>
   <OL>
     <LI>configuration of the OJB runtime environment. This data is
  @@ -81,7 +81,7 @@
   	lookup and must therefore be placed on the classpath.</b>
   </P>
   </subsection>
  -<subsection name="3. Additional jar archives" anchor="4">
  +<subsection name="3. Additional jar archives" anchor="Additional jar archives">
   <P>
   	OJB depends on several other jar archives. These jar files are
   	shipped in the <code>db-ojb-&lt;version&gt;/lib</code> directory.
  @@ -126,7 +126,7 @@
   
   </subsection>
   
  -<subsection name="4. Don't forget the JDBC driver" anchor="1">
  +<subsection name="4. Don't forget the JDBC driver" anchor="Don't forget the JDBC driver">
   <P>
   	The repository.xml defines JDBC Connections
   	to your runtime databases. To use the declared JDBC drivers the
  @@ -145,7 +145,7 @@
   
   
   
  -<section name="Deployment in standalone applications" anchor="10">
  +<section name="Deployment in standalone applications" anchor="Deployment in standalone applications">
   <P>
   Deploying OJB for standalone applications is most simple. If you
   follow these four steps your application will be up in a few minutes.
  @@ -172,7 +172,7 @@
   
   
   
  -<section name="Deployment in servlet based applications" anchor="20">
  +<section name="Deployment in servlet based applications" anchor="Deployment in servlet based applications">
   <P>
   	Generally speaking the four steps described in the previous
   	section have to be followed also in Servlet / JSP based environments.
  @@ -224,7 +224,7 @@
   
   
   
  -<section name="Deployment in EJB based applications" anchor="30">
  +<section name="Deployment in EJB based applications" anchor="Deployment in EJB based applications">
   
   <p>
   The above mentioned guidelines concerning
  @@ -241,7 +241,7 @@
   
   
   
  -<subsection name="Instructions for JBoss" anchor="31">
  +<subsection name="Instructions for JBoss" anchor="Instructions for JBoss">
   <br/>
   <i>The eight step guide to felicity</i>
   <br/>
  @@ -479,12 +479,26 @@
   </subsection>
   
   
  -<subsection name="Build the OJB sample session beans" anchor="32">
  +<subsection name="Build the OJB sample session beans" anchor="Build the OJB sample session beans">
   <p>
   The OJB source distribution was shipped with a bunch of sample
   beans. We are using xdoclet to build the necessary classes and deployment
   descriptors.
  -<br/>
  +</p>
  +
  +<p>
  +To run xdoclet properly you need the following xdoclet jar files
  +in <code>[db-ojb]/lib</code> directory (xdoclet version 1.2xx or higher):
  +<source>
  +    xdoclet-xxx.jar
  +    xdoclet-ejb-module-xxx.jar
  +    xdoclet-jboss-module-xxx.jar
  +    xdoclet-jmx-module-xxx.jar
  +    xdoclet-web-module-xxx.jar
  +    xdoclet-xjavadoc-module-xxx.jar
  +</source>
  +</p>
  +<p>
   You could find the source code of the beans under
   <br/>
   <code>[db-ojb]/src/ejb/org/apache/ojb/ejb</code>
  @@ -497,6 +511,7 @@
   <br/>
   in three sub-dirs.
   </p>
  +
   <p>
   Run the following ant target
   <source><![CDATA[
  @@ -542,7 +557,7 @@
   
   
   
  -<subsection name="Instructions for Weblogic" anchor="33">
  +<subsection name="Instructions for Weblogic" anchor="Instructions for Weblogic">
   <br/>
   <font size="-1">(Thanks Christophe Lombart and Lucy Zhao)</font>
   <p>