db-ojb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From to...@apache.org
Subject cvs commit: db-ojb build.xml build.properties
Date Tue, 15 Jun 2004 21:23:32 GMT
tomdz       2004/06/15 14:23:31

  Modified:    forrest/src/documentation/content/xdocs/docu
                        getting-started.xml
               forrest/src/documentation/content/xdocs site.xml
               .        build.xml build.properties
  Log:
  Some changes to "Getting started" doc and ojb-blank target
  
  Revision  Changes    Path
  1.4       +50 -46    db-ojb/forrest/src/documentation/content/xdocs/docu/getting-started.xml
  
  Index: getting-started.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/forrest/src/documentation/content/xdocs/docu/getting-started.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- getting-started.xml	14 May 2004 11:05:15 -0000	1.3
  +++ getting-started.xml	15 Jun 2004 21:23:31 -0000	1.4
  @@ -27,31 +27,33 @@
       </header>
   
       <body>
  +		<p>
  +    	This document will guide you through the very first steps of setting up a project
with OJB. To
  +    	make this easier, OJB comes with a blank project template which you're encouraged
to use.<br/>
  +    	In the next tutorial parts you'll then learn how to specify your persistent classes
and how to
  +    	use OJB's APIs to perform database operations.
  +    	</p>
           <section>
               <title>Building OJB</title>
               <p>
  -                First, ensure that you have
  -                <link href="ext:ant">
  -                    <strong>Ant</strong>
  -                </link> installed (including
  -                module for optional
  -                <em>junit</em> task and junit jar itself in ant /lib directory)
and have the
  -                <code>ANT_HOME</code> and
  -                <code>JAVA_HOME</code> environment variables set so that you
can
  -                build OJB. Setting these up is described in Ant documentation.
  +            	OJB uses <link href="ext:ant"><strong>Ant</strong></link>
to build, so please install it
  +            	prior to using OJB. You'll also need the <link href="ext:junit"><strong>Junit</strong></link>
  +            	runtime jar (included in OJB in the lib folder) for running the unit tests;
simply put it
  +            	into the lib subfolder of your Ant directory. In addition, please make sure
that the
  +            	environment variables <code>ANT_HOME</code> and <code>JAVA_HOME</code>
are correctly set
  +            	to the top-level folders of your Ant distribution and your JDK installation,
respectively.
               </p>
               <p>
                   Next download the latest
  -                <link href="ext:ojb/source-version">source distribution</link>.
  +                <link href="ext:ojb/source-version">OJB source distribution</link>.
                   It is easiest to start with the source distribution rather than the binary
                   as the unit tests provide excellent sample code, and it makes the ojb-blank
                   task available for setting up a basic project.
               </p>
               <p>
  -                Unpack the source distribution and retrieve the additional
  +                Unpack the source distribution and retrieve any missing additional
                   <link href="site:deployment/additional-jars">required libaries</link>.
Place these jar files in the
  -                <code>lib</code> directory
  -                of the OJB distribution.
  +                <code>lib</code> directory of the OJB distribution.
               </p>
               <p>
                   Change to the OJB installation directory and run
  @@ -59,20 +61,16 @@
                   <source><![CDATA[
   ant ojb-blank]]></source>
               <p>
  -                This will
  -                build OJB and an additional jar file containing a rudimentary project which
uses OJB. After
  -                the build finishes you will find the
  -                <code>ojb-blank.jar</code> library in the
  -                <code>dist</code> directory.
  +                This will build OJB as well as an additional jar file called <code>ojb-blank.jar</code>
  +                containing a rudimentary OJB project for your use. After the build finishes
you will find it
  +                library in the <code>dist</code> directory.
               </p>
           </section>
           <section>
  -            <title>Your Project</title>
  +            <title>Preparing your project</title>
               <p>
  -                Copy the
  -                <code>ojb-blank.jar</code> file to your project directory and
unpack it via
  -                the
  -                <code>jar xvf ojb-blank.jar</code> command. This will unpack
it into the
  +                Copy the <code>ojb-blank.jar</code> file to your project directory
and unpack it via
  +                the <code>jar xvf ojb-blank.jar</code> command. This will unpack
it into the
                   <code>ojb-blank</code> directory under wherever you unpacked
it from. You can move things out
                   of that directory into your project directory, or, more simply, rename
the
                   <code>ojb-blank</code>
  @@ -81,8 +79,7 @@
               <p>
                   The ojb-blank project provides the libraries, basic configuration files,
and an ant
                   build file which can be used to get started with OJB. The first thing you
will need to
  -                do is edit the
  -                <code>build.properties</code> file to enter your database information.
By
  +                do is edit the <code>build.properties</code> file to enter
your database information. By
                   default it is set up to work against an embedded HSQLDB instance. This
will work fine
                   for learning, but you will probably want to configure it to run against
a different RDBMS for
                   most projects. For example configurations you can look in the
  @@ -94,34 +91,41 @@
               </p>
               <p>
                   If you are not using HSQLDB make sure to copy your JDBC driver into the
  -                <code>lib</code>
  -                directory and ensure it is in the classpath used by the
  +                <code>lib</code> directory and ensure it is in the classpath
used by the
                   <code>build.xml</code>.
               </p>
               <p>
  -                The ojb-blank project also includes the
  -                <link href="ext:torque">Torque</link>
  -                schema for OJB's required tables. You do not need to use Torque to build
your database, but
  -                it can also be used generate the DDL for you to modify an existing database.
The OJB tables
  -                are required for specific options, such as clustered locking and OJB managed
sequences. More
  -                information on these tables is available
  -                <link href="site:platform">platform documentation</link>
  -            </p>
  -            <p>
  -                The repository metadata files  are located in the
  -                <code>src/resources/</code> directory. The
  -                <code>repository_user.xml</code> file
  -                should be used for describing your specific mappings.
  +            	Two other files of interest are <code>src/resources/OJB.properties</code>
and
  +            	<code>src/resources/OJB-logging.properties</code>. The former
is used to configure the OJB
  +            	runtime. Here you can finetune OJB to suit your needs. For the various options
see
  +            	<link href="site:ojb-properties">here</link>.<br/>
  +            	The other file defines the logging within OJB, but you can also use it for
your own logging
  +            	settings.
  +            </p>
  +            <p>
  +                The ojb-blank project also includes a schema that describes in an RDBMS-independent
manner
  +                a database containing tables that are required for certain OJB operations.
This schema is
  +                intened to be used with <link href="ext:torque">Torque</link>
or
  +                <link href="ext:commons-sql">commons-sql</link>. Of course,
you do not need to use this schema
  +                to build your database, but it is a convenient way to setup your database
and it can also be used
  +                to generate the actual database DDL for you to modify an existing database.<br/>
  +                The OJB tables are only required for certain options, such as clustered
locking and OJB managed
  +                sequences. More information on these tables is available
  +                <link href="site:platform">platform documentation</link>. If
you do not use these, you can
  +                safely remove the tables.
  +            </p>
  +            <p>
  +                The repository metadata files are located in the <code>src/resources/</code>
directory. The
  +                <code>repository_user.xml</code> file should be used for describing
your specific mappings.
  +                The tutorials will explain their definition in more detail.
               </p>
           </section>
           <section>
               <title>Learning More</title>
               <p>
  -                The next step is to go through the
  -                <link href="site:documentation/index">tutorials</link> for
the things
  -                you need to do. The
  -                <link href="site:mapping-tutorial">Mapping Tutorial</link>
in particular is required to learn how to map
  -                your objects to relational tables.
  +                The next step is to go through the <link href="site:documentation/index">tutorials</link>
for the things
  +                you need to do. The <link href="site:mapping-tutorial">Mapping Tutorial</link>
in particular is required
  +                to learn how to map your objects to relational tables.
               </p>
           </section>
       </body>
  
  
  
  1.20      +2 -1      db-ojb/forrest/src/documentation/content/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/forrest/src/documentation/content/xdocs/site.xml,v
  retrieving revision 1.19
  retrieving revision 1.20
  diff -u -r1.19 -r1.20
  --- site.xml	14 Jun 2004 14:18:56 -0000	1.19
  +++ site.xml	15 Jun 2004 21:23:31 -0000	1.20
  @@ -251,6 +251,7 @@
                   <configuration href="guide.html"/>
                   <api-log href="api/org/apache/commons/logging/Log.html"/>
               </commons-logging>
  +            <commons-sql href="commons/sandbox/sql/"/>
               <commons-pool href="commons/pool/"/>
               <commons-dbcp href="commons/dbcp/"/>
               <jcs href="http://jakarta.apache.org/turbine/jcs/index.html"/>
  
  
  
  1.133     +39 -37    db-ojb/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/db-ojb/build.xml,v
  retrieving revision 1.132
  retrieving revision 1.133
  diff -u -r1.132 -r1.133
  --- build.xml	15 Jun 2004 13:36:16 -0000	1.132
  +++ build.xml	15 Jun 2004 21:23:31 -0000	1.133
  @@ -541,67 +541,69 @@
       <!-- ================================================================== -->
       <!-- Build sample jar-file for a new project                            -->
       <!-- ================================================================== -->
  -    <target name="ojb-blank" depends="jar, prepare-testdb"
  +    <target name="ojb-blank" depends="jar-debug, prepare-testdb"
               description="Build a sample project">
  +        <property name="build.ojb-blank" value="${build.dir}/ojb-blank"/>
  +
           <delete file="${dist}/ojb-blank.jar"/>
  -        <delete dir="${build.dir}/ojb-blank" verbose="false"/>
  -        <mkdir dir="${build.dir}/ojb-blank"/>
  -        <mkdir dir="${build.dir}/ojb-blank/src"/>
  -        <mkdir dir="${build.dir}/ojb-blank/src/java"/>
  -        <mkdir dir="${build.dir}/ojb-blank/src/schema"/>
  -        <mkdir dir="${build.dir}/ojb-blank/src/resources"/>
  -        <mkdir dir="${build.dir}/ojb-blank/src/test"/>
  -        <mkdir dir="${build.dir}/ojb-blank/lib"/>
  +        <delete dir="${build.ojb-blank}" verbose="false"/>
  +        <mkdir dir="${build.ojb-blank}"/>
  +        <mkdir dir="${build.ojb-blank}/src"/>
  +        <mkdir dir="${build.ojb-blank}/src/java"/>
  +        <mkdir dir="${build.ojb-blank}/src/schema"/>
  +        <mkdir dir="${build.ojb-blank}/src/resources"/>
  +        <mkdir dir="${build.ojb-blank}/src/test"/>
  +        <mkdir dir="${build.ojb-blank}/lib"/>
   
  -        <copy file="${dist}/${archive}.jar" todir="${build.dir}/ojb-blank/lib"/>
  +        <copy file="${dist}/${archive}.jar" todir="${build.ojb-blank}/lib"/>
           <!--
               Eventually it would be nice to include Torque schema stuff, but
               not yet
   
           <copy file="${source}/schema/ojbcore-schema.xml" todir="${build.dir}/ojb-blank/src/schema"
/>
           -->
  -        <copy todir="${build.dir}/ojb-blank/src/resources">
  +        <copy todir="${build.ojb-blank}/src/resources">
               <fileset dir="${src.test}/org/apache/ojb">
  -                <include name="*.properties" />
  -                <include name="*.dtd" />
  -                <include name="repository.xml" />
  -                <include name="repository_*.xml" />
  -                <exclude name="build.properties" />
  +                <include name="OJB*.properties" />
  +                <include name="log4j.properties" />
  +                <include name="repository.dtd" />
  +                <include name="repository*.xml" />
               </fileset>
           </copy>
   
  -        <copy todir="${build.dir}/ojb-blank">
  -            <fileset dir="${src.test}/org/apache/ojb">
  -                <include name="build.xml"/>
  -                <include name="build.properties"/>
  -            </fileset>
  +        <copy todir="${build.ojb-blank}">
  +            <fileset dir="${src.ojb-blank}"/>
           </copy>
   
  -        <copy todir="${build.dir}/ojb-blank/src/schema">
  +        <copy todir="${build.ojb-blank}/src/schema">
               <fileset dir="${source}/schema">
                   <include name="ojbcore-schema.xml"/>
               </fileset>
           </copy>
   
  -        <copy todir="${build.dir}/ojb-blank/lib">
  +        <copy todir="${build.ojb-blank}/lib">
               <fileset dir="${lib}">
  -              <include name="*.jar"/>
  -              <exclude name="ant-*.jar"/>
  -              <exclude name="antlr.debug.jar"/>
  -              <exclude name="antlr_compiletime.jar"/>
  -              <exclude name="junit.jar"/>
  -              <exclude name="xalan.jar"/>
  -              <exclude name="ejb.jar"/>
  -              <exclude name="servlet.jar"/>
  -              <exclude name="jakarta-regexp-*.jar"/>
  -              <exclude name="torque-*.jar"/>
  -              <exclude name="velocity-*.jar"/>
  +				<include name="*.jar"/>
  +				<exclude name="ant-*.jar"/>
  +				<exclude name="antlr.debug.jar"/>
  +				<exclude name="antlr_compiletime.jar"/>
  +				<exclude name="junit.jar"/>
  +				<exclude name="xalan.jar"/>
  +				<exclude name="ejb.jar"/>
  +                <exclude name="j2ee.jar"/>
  +                <exclude name="jdo*.jar"/>
  +                <exclude name="prevlayer.jar"/>
  +				<exclude name="servlet.jar"/>
  +				<exclude name="jakarta-regexp-*.jar"/>
  +				<exclude name="torque-*.jar"/>
  +				<exclude name="p6spy.jar"/>
  +                <exclude name="velocity-*.jar"/>
               </fileset>
           </copy>
   
           <jar jarfile="${dist}/ojb-blank.jar"
  -            basedir="${build.dir}"
  -            includes="ojb-blank/**"/>
  +             basedir="${build.dir}"
  +             includes="ojb-blank/**"/>
       </target>
   
       <!-- ================================================================== -->
  
  
  
  1.61      +2 -1      db-ojb/build.properties
  
  Index: build.properties
  ===================================================================
  RCS file: /home/cvs/db-ojb/build.properties,v
  retrieving revision 1.60
  retrieving revision 1.61
  diff -u -r1.60 -r1.61
  --- build.properties	14 Jun 2004 22:01:53 -0000	1.60
  +++ build.properties	15 Jun 2004 21:23:31 -0000	1.61
  @@ -83,6 +83,7 @@
   src.jca=${src.dir}/jca
   src.doc=forrest
   src.javadoc=${src.dir}/doc
  +src.ojb-blank=${src.dir}/ojb-blank
   ojb=${source}/ojb
   etc=${source}/etc
   test=${build.dir}/test
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org


Mime
View raw message