]> source.dussan.org Git - aspectj.git/commitdiff
doc process for adding new modules (soon to be superceded)
authorwisberg <wisberg>
Thu, 3 Aug 2006 16:03:35 +0000 (16:03 +0000)
committerwisberg <wisberg>
Thu, 3 Aug 2006 16:03:35 +0000 (16:03 +0000)
build/readme-build-and-test-aspectj.html

index 7292fc2ac5e289a2826984b4e0b1d3070b2ace3b..6ae35203ff448e09103049eab38afae1372464e8 100644 (file)
@@ -448,6 +448,39 @@ the web with the release files and documentation,
        in Eclipse but fails in the Ant, it's your responsibility to fix it
        by following the build invariants below.        
 </p>
+<p>
+<p>What to do when adding a new module (i.e., eclipse project):
+</p>
+<ol>
+       <li>Setup like the other modules, following the invariants below, esp.
+    <ol>
+        <li>same directory level</li>
+        <li>same naming conventions for source folders</li>
+        <li>same use of known classpath variables/entries</li>
+    </ol>
+       </li>
+       <li>Add module to those checked for copyright/license in 
+        <a href="testsrc/org/aspectj/build/BuildModuleTests.java">
+            testsrc/org/aspectj/build/BuildModuleTests.java
+        </a>
+       </li>
+    <li>Add module to module dependency tree as usual in Eclipse project properties</li>
+    <li>If the module is to produce a jar visible in {AspectJ}/lib,
+        then add a zero-length file of the correct name to 
+        <a href="products/tools/dist/lib">products/tools/dist/lib</a>
+        and an alias to that file from the module name in 
+               <a href="src/org/aspectj/internal/tools/build/Builder.properties">
+                       Builder.properties</a>
+    </li>
+    <li>To make the JUnit tests visible to the Ant builder, include a
+        top-level Ant suite titled {Module}ModuleTests.java
+    </li>
+    <li>Test the build in Eclipse/JUnit using
+        <a href="testsrc/org/aspectj/internal/build/BuildModuleTest.java">
+            testsrc/org/aspectj/internal/build/BuildModuleTest.java
+        </a>
+    </li>
+</ol>
 <p>
        How the build system introspects, and the build invariants that
        are enforced by the Ant build: