db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tfisc...@apache.org
Subject svn commit: r692864 - in /db/torque/torque4/trunk/site/xdocs/developer-info: developer-guide.xml subversion.xml
Date Sun, 07 Sep 2008 14:36:47 GMT
Author: tfischer
Date: Sun Sep  7 07:36:47 2008
New Revision: 692864

URL: http://svn.apache.org/viewvc?rev=692864&view=rev
Log:
documented svn changes

Modified:
    db/torque/torque4/trunk/site/xdocs/developer-info/developer-guide.xml
    db/torque/torque4/trunk/site/xdocs/developer-info/subversion.xml

Modified: db/torque/torque4/trunk/site/xdocs/developer-info/developer-guide.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/site/xdocs/developer-info/developer-guide.xml?rev=692864&r1=692863&r2=692864&view=diff
==============================================================================
--- db/torque/torque4/trunk/site/xdocs/developer-info/developer-guide.xml (original)
+++ db/torque/torque4/trunk/site/xdocs/developer-info/developer-guide.xml Sun Sep  7 07:36:47
2008
@@ -33,65 +33,34 @@
 
     <section name="Building from SVN">
       <p>
-        The Torque build process uses
-        <a href="http://maven.apache.org/maven1">Maven 1</a>.  The recommended
-        Maven version is Maven 1.0.2. A rudimentary
-        <a href="http://maven.apache.org">Maven 2</a> build exists (see below),
-        but is only used to build the Maven 2 plugin.
-        <br/>
-        Note that the Maven 1 build uses the groupId <code>torque</code>, 
-        wheras the Maven 2 build uses the group id 
-        <code>org.apache.db.torque</code>.
-      </p>
-      <p>
-        Before you begin, you'll need to check out the <code>trunks</code> 
+        The Torque build process uses 
+        <a href="http://maven.apache.org">Maven 2</a>.
+        You need ton install Maven 2 in order to be able to build torque.
+        Then, you need to check out the <code>torque4/trunk</code> 
         part of the <code>db/torque</code> SVN repository.
         Please read the <a href="subversion.html">Torque Subversion</a> page
         for more information.
       </p>
       
-      <subsection name="Maven 1 build">
-        <p>
-          To build the Torque generator jar, first execute
-          <code>maven jar:install</code> in the
-          <code>templates</code> directory to install a copy
-          of the templates jar in your local Maven repository. Note that
-          <code>maven jar:jar</code> does not suffice because the
-          main generator jar depends upon the template jar.
-          Afterwards, execute <code>maven jar:jar</code> in the generator
-          directory to build the generator jar (<code>maven jar:install</code>
-          to install a copy of the jar in your local Maven repository).
-        </p>
-        <p>
-          To build and install the Torque Maven 1 plugin, execute <code>maven
-          plugin:install</code> in the <code>maven-plugin</code> directory.
-          You need to have the generator installed in your local repository
-          to do that (see paragraph above).
-        </p>
-        <p>
-          To build the Torque runtime jar execute <code>maven jar:jar</code>
in
-          the <code>runtime</code> directory 
-          (<code>maven jar:install</code> to install a copy of the jar 
-          in your local Maven repository).
-        </p>
-        <p>
-          If you need everything at once, run <code>maven install</code> in the
-          top level directory. This will perform all the steps described above and
-          place the results into your local maven repository.
-        </p>
+      <subsection name="Maven 2 build">
         <p>
-          The Torque Maven 2 plugin cannot be built using Maven 1.
+          Change into the directory torque-maven-parent in your local copy
+          of the torque 4 trunk. Run "mvn install". The runtime, generator,
+          templates and maven 2 plugin will be built in turn and installed
+          in your local maven 2 repository.
         </p>
       </subsection>
       
-      <subsection name="Maven 2 build">
-        <p>
-          Change into the directories common, village, runtime, templates, generator, and
-          maven2-plugin in this order and run <code>mvn install</code>
-          in each of them.
-        </p>
+      <subsection name="Eclipse integration">
         <p>
-          The Torque Maven 1 plugin cannot be built using Maven 2.
+          Change into the directory torque-maven-parent in your local copy
+          of the torque 4 trunk. Run 
+          "mvn eclipse:configure-workspace install eclipse:clean eclipse:eclipse".
+          Then start eclipse, and open the directoy you checked out from svn
+          as eclipse workspace. Create the projects "torque-runtime", 
+          "torque-maven-parent", "maven-torque-plugin", "torque-generator"
+          and "torque-templates" (the contents of the projects are already 
+          in the workspace). That's it.
         </p>
       </subsection>
     </section>

Modified: db/torque/torque4/trunk/site/xdocs/developer-info/subversion.xml
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/site/xdocs/developer-info/subversion.xml?rev=692864&r1=692863&r2=692864&view=diff
==============================================================================
--- db/torque/torque4/trunk/site/xdocs/developer-info/subversion.xml (original)
+++ db/torque/torque4/trunk/site/xdocs/developer-info/subversion.xml Sun Sep  7 07:36:47 2008
@@ -28,16 +28,10 @@
   <body>
    <section name="Torque Source code management">
      <p>
-      Up to release 3.1.1, Torque used CVS as its source code
-      repository. Most of the older releases still point to the CVS
-      repository at cvs.apache.org. During the 3.2 development cycle,
-      the Torque team (with a few well-meant nudges from the Apache
-      Software Foundation infrastructure team) decided to move the
-      Torque source code from CVS to <a
-      href="http://subversion.tigris.org">Subversion</a>.
-    </p>
-
-    <p>
+      The Torque source code is located inside the Apache Software 
+      Foundation's 
+      <a href="http://subversion.tigris.org">subversion</a>
+      repository.
       If you have never worked with Subversion before, please take a
       look at <a href="http://svnbook.red-bean.com/">the free
       subversion book</a> and also at <a
@@ -48,37 +42,27 @@
    </section>
 
    <section name="The Torque repository">
-    <p>
-     Unlike some other repositories you might know, Torque makes some
-     use of the <a
-     href="http://svnbook.red-bean.com/en/1.1/ch07s04.html">svn:externals</a>
-     feature of Subversion to organize its tree. This might lead to
-     some &quot;gotchas&quot;, so be warned.
-    </p>
 
-    <subsection name="Torque Repository Structure">
+    <subsection name="Torque 4 Repository Structure">
 
       <p>
-        Here is what the Torque directory structure looks like in SVN:
+        The base directory of torque 4 is db/torque/torque4.
+        The main branch is located in the trunk subdirectory of that
+        directory. The layout is:
       </p>
 
       <source><![CDATA[
-    db/torque/
-      common           <--- contains files common to all components.
-                            Referenced by svn:externals
-      runtime          <--- contains the runtime component
-      generator        <--- contains the generator component
-      templates        <--- contains the generator templates component
-      maven-plugin     <--- contains the maven plugin component
-      maven2-plugin    <--- contains the maven 2 plugin component
-      test             <--- contains the test component
-      trunks           <--- contains references to the trunks of all 
-                            component (via svn:externals)
-      site             <--- contains the "frame" of the sources of the
-                            homepage (everything not related to a specific 
-                            component)
-      branches         <--- old branches (pre-3.2)
-      tags             <--- old tags (pre-3.2)
+    db/torque/torque4/trunk
+      torque-maven-parent  <--- contains files common to all components.
+      torque-runtime       <--- contains the runtime component
+      torque-generator     <--- contains the generator component
+      torque-templates     <--- contains the generator templates component
+      torque-maven-plugin  <--- contains the maven 2 plugin component
+      test                 <--- contains the test component
+      site                 <--- contains the "frame" of the sources of the
+                              homepage (everything not related to a specific 
+                              component)
+      tutorial             <--- contains the tutorial part of the site.
       ]]></source>
     </subsection>
 
@@ -89,19 +73,19 @@
       <table>
        <tr><th>Component</th><th>Trunk repository location</th></tr>
 
-       <tr><td>Runtime</td>       <td><a href="http://svn.apache.org/viewcvs/db/torque/runtime/trunk/">http://svn.apache.org/repos/asf/db/torque/runtime/trunk</a></td></tr>
-       <tr><td>Generator</td>     <td><a href="http://svn.apache.org/viewcvs/db/torque/generator/trunk/">http://svn.apache.org/repos/asf/db/torque/generator/trunk/</a></td></tr>
-       <tr><td>Templates</td>     <td><a href="http://svn.apache.org/viewcvs/db/torque/templates/trunk/">http://svn.apache.org/repos/asf/db/torque/templates/trunk/</a></td></tr>
-       <tr><td>Maven 1 Plugin</td><td><a href="http://svn.apache.org/viewcvs/db/torque/maven-plugin/trunk/">http://svn.apache.org/repos/asf/db/torque/maven-plugin/trunk/</a></td></tr>
-       <tr><td>Maven 2 Plugin</td><td><a href="http://svn.apache.org/viewcvs/db/torque/maven2-plugin/trunk/">http://svn.apache.org/repos/asf/db/torque/maven2-plugin/trunk/</a></td></tr>
-       <tr><td>Site</td>          <td><a href="http://svn.apache.org/viewcvs/db/torque/site/trunk/">http://svn.apache.org/repos/asf/db/torque/site/trunk/</a></td></tr>
-       <tr><td>Common</td>        <td><a href="http://svn.apache.org/viewcvs/db/torque/common/trunk/">http://svn.apache.org/repos/asf/db/torque/common/trunk/</a></td></tr>
-       <tr><td>Test</td>          <td><a href="http://svn.apache.org/viewcvs/db/torque/test/trunk/">http://svn.apache.org/repos/asf/db/torque/test/trunk/</a></td></tr>
+       <tr><td>Runtime</td>       <td><a href="http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime">http://svn.apache.org/db/torque/torque4/trunk/torque-runtime</a></td></tr>
+       <tr><td>Generator</td>     <td><a href="http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator">http://svn.apache.org/db/torque/torque4/trunk/torque-generator</a></td></tr>
+       <tr><td>Templates</td>     <td><a href="http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates">http://svn.apache.org/repos/asf/db/torque/torque4/trunk/torque-templates</a></td></tr>
+       <tr><td>Maven 2 Plugin</td><td><a href="http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-maven-plugin">http://svn.apache.org/repos/asf/db/torque/torque4/trunk/torque-maven-plugin</a></td></tr>
+       <tr><td>Site</td>          <td><a href="http://svn.apache.org/viewvc/db/torque/torque4/trunk/site">http://svn.apache.org/repos/asf/db/torque/torque4/trunk/site/</a></td></tr>
+       <tr><td>Tutorial</td>      <td><a href="http://svn.apache.org/viewvc/db/torque/torque4/trunk/tutorial">http://svn.apache.org/repos/asf/db/torque/torque4/trunk/tutorial</a></td></tr>
+       <tr><td>Maven parent</td>  <td><a href="http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-maven-parent/trunk/">http://svn.apache.org/repos/asf/db/torque/torque4/trunk/torque-maven-parent</a></td></tr>
+       <tr><td>Test</td>          <td><a href="http://svn.apache.org/viewvc/db/torque/torque4/trunk/test">http://svn.apache.org/repos/asf/db/torque/torque4/trunk/test</a></td></tr>
       </table>
      </p>
     </subsection>
 
-    <subsection name="Runtime, Generator, Templates, Maven 1 Plugin, Maven 2 Plugin">
+    <subsection name="Runtime, Generator, Templates, Maven 2 Plugin">
      <p>
       These modules make up the main torque distribution. They
       are released in regular intervals and are available as binary
@@ -113,16 +97,10 @@
      </p>
     </subsection>
 
-    <subsection name="Common">
+    <subsection name="Maven parent">
      <p>
-      The common module is a special module because it contains files
-      that are needed in all main modules of the Torque source
-      tree. Every module pulls it into its source tree through an
-      external reference and references the files in the common module
-      as <code>/common/...</code> <br/>
-      Please be aware that every change
-      inside this module influences the build process of all the
-      Torque modules!.
+      The maven parent module is a special module because it contains files
+      that are needed in all main modules of the Torque source tree.
      </p>
     </subsection>
     <subsection name="Test project">
@@ -142,63 +120,68 @@
    </section>
 
    <section name="Old CVS tags and branches">
-    <p>
-     All CVS tags and branches that existed before the conversion to Subversion have
-     been preserved. These are only for historic reasons and there will be no more
-     development here. Branches and Tags after the Subversion conversion will be located
-     in the module specific branches/ and tags/ directories.
-
-     <ul>
-      <li>
-        <a href="http://svn.apache.org/viewcvs/db/torque/tags/">Old CVS Tags</a>

-        -- http://svn.apache.org/repos/asf/db/torque/tags/
-      </li>
-      <li>
-        <a href="http://svn.apache.org/viewcvs/db/torque/branches/">Old CVS Branches</a>
-        -- http://svn.apache.org/repos/asf/db/torque/branches/
-      </li>
-     </ul>
+    <subsection name="Torque 3 Repository Structure">
+
+      <p>
+        Here are the torque 3 paths in SVN:
+      </p>
+
+      <source><![CDATA[
+    db/torque/
+      common           <--- contains files common to all components.
+                            Referenced by svn:externals
+      runtime          <--- contains the runtime component
+      generator        <--- contains the generator component
+      templates        <--- contains the generator templates component
+      maven-plugin     <--- contains the maven plugin component
+      maven2-plugin    <--- contains the maven 2 plugin component
+      test             <--- contains the test component
+      trunks           <--- contains references to the trunks of all 
+                            component (via svn:externals)
+      site             <--- contains the "frame" of the sources of the
+                            homepage (everything not related to a specific 
+                            component)
+      branches         <--- old branches (pre-3.2)
+      tags             <--- old tags (pre-3.2)
+      ]]></source>
+    </subsection>
+
+    <subsection name="The trunks module">
+     <p>
+       The Torque subversion repository contains another module for
+       development called <i>trunks</i>. While
+       this module seems quite empty, it is not.<br/>
+       If you want to work on the Torque code base, your best guess will be to
+       check out this module using
+  
+       <source><![CDATA[svn checkout http://svn.apache.org/repos/asf/db/torque/trunks
torque]]></source>
+  
+       The resulting directory will contain the trunk locations of all
+       main Torque parts. This also happens through svn:external
+       references.
      </p>
-   </section>
+    </subsection>
 
-   <section name="The trunks module">
-    <p>
-     The Torque subversion repository contains another module for
-     development called <i>trunks</i>. While
-     this module seems quite empty, it is not.<br/>
-     If you want to work on the Torque code base, your best guess will be to
-     check out this module using
-
-     <source><![CDATA[svn checkout http://svn.apache.org/repos/asf/db/torque/trunks
torque]]></source>
-
-     The resulting directory will contain the trunk locations of all
-     main Torque parts. This also happens through svn:external
-     references.
-    </p>
+    <subsection name="CVS remnants">
+      <p>
+       All CVS tags and branches that existed before the conversion to Subversion have
+       been preserved. These are only for historic reasons and there will be no more
+       development here. Branches and Tags after the Subversion conversion will be located
+       in the module specific branches/ and tags/ directories.
+  
+       <ul>
+        <li>
+          <a href="http://svn.apache.org/viewcvs/db/torque/tags/">Old CVS Tags</a>

+          -- http://svn.apache.org/repos/asf/db/torque/tags/
+        </li>
+        <li>
+          <a href="http://svn.apache.org/viewcvs/db/torque/branches/">Old CVS Branches</a>
+          -- http://svn.apache.org/repos/asf/db/torque/branches/
+        </li>
+       </ul>
+       </p>
+     </subsection>
    </section>
 
-   <section name="Multi-Project build">
-    <p>
-     The <i>trunks</i> module also contains a <a
-     href="http://maven.apache.org/reference/plugins/multiproject/">Multi-Project</a>
-     build environment to build all the major parts of Torque in one
-     go.<br/>
-     If you checked out the <i>trunks</i> module from subversion, you can run
one of
-     the following goals inside the resulting directory:
-
-     <ul>
-      <li>
-        build -- Builds all parts of Torque
-      </li>
-      <li>
-        install - Builds all parts of Torque and installs the resulting jars
-        and plugins into your local maven repository
-      </li>
-      <li>
-        site -- Builds the documentation sites for all parts of Torque
-      </li>
-     </ul>
-    </p>
-   </section>
   </body>
 </document>



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


Mime
View raw message