Skip to content

Commit dba5d21

Browse files
author
mgricken
committed
Updated developer documentation to reflect renamed environment
variables and Ant targets after dropping Java 1.4. M docs/src/developer/gettingStarted.docbook git-svn-id: file:///tmp/test-svn/trunk@4701 fe72c1cf-3628-48e9-8b72-1c46755d3cff
1 parent d963865 commit dba5d21

File tree

1 file changed

+43
-16
lines changed

1 file changed

+43
-16
lines changed

docs/src/developer/gettingStarted.docbook

Lines changed: 43 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<para>For Rice students wishing to work with the DrJava developer team, you should also do the following:
3333
<itemizedlist>
3434
<listitem><para>Get a Computer Science Department Unix account, if you don't already have one. This account is distinct from the Owlnet account given to all undergraduates, and will allow you to login and develop in the PLT computer lab. You can pick up an application from the department secretaries; have it signed by Corky Cartwright.</para></listitem>
35-
<listitem><para>Subscribe to the <literal>javaplt</literal> mailing list. You can do so here: <ulink url="https://mailman.rice.edu/mailman/listinfo/javaplt">https://mailman.rice.edu/mailman/listinfo/javaplt</ulink>. This list is the main electronic forum for communication among the team members (like a course discussion board). Feel free to post your ideas or ask for help here.</para></listitem>
35+
<listitem><para>Subscribe to the <literal>drjava</literal> mailing list. You can do so here: <ulink url="https://mailman.rice.edu/mailman/listinfo/drjava-l">https://mailman.rice.edu/mailman/listinfo/drjava-l</ulink>. This list is the main electronic forum for communication among the team members (like a course discussion board). Feel free to post your ideas or ask for help here.</para></listitem>
3636
</itemizedlist>
3737
</para>
3838
</section>
@@ -47,7 +47,7 @@
4747

4848
<section id="installJDK">
4949
<title>Sun Java Development Kit</title>
50-
<para>If it's not already installed on your system, you can download the JDK from <ulink url="http://java.sun.com">Sun's Web site</ulink>. You will need to have installed both the J2SE JDK 5 and the J2SE SDK 1.4 (note the distinction on the download pages between a Java <emphasis>Runtime Environment</emphasis>, which just contains the tools needed to <emphasis>run</emphasis> Java programs, and a Java <emphasis>Development Kit</emphasis>, which contains a compiler and other tools, in addition to the runtime application). The DrJava sources are written in the Java 5 language. However, in order to support users who only have Java 1.4 installed, the 1.4 SDK is also used in the build process. (Note: theoretically, any Java 5.0 compiler should be able to handle the DrJava sources. However, there are currently some dependencies on Sun's tools in the main DrJava code module, so you will need to have those tools available.)</para>
50+
<para>If it's not already installed on your system, you can download the JDK from <ulink url="http://java.sun.com">Sun's Web site</ulink>. You will need to have installed the J2SE JDK 5 (note the distinction on the download pages between a Java <emphasis>Runtime Environment</emphasis>, which just contains the tools needed to <emphasis>run</emphasis> Java programs, and a Java <emphasis>Development Kit</emphasis>, which contains a compiler and other tools, in addition to the runtime application). The DrJava sources are written in the Java 5 language. (Note: theoretically, any Java 5.0 compiler should be able to handle the DrJava sources. However, there are currently some dependencies on Sun's tools in the main DrJava code module, so you will need to have those tools available.)</para>
5151

5252
<para>If you like, you can set up your command-line environment to better support Java, but it's not strictly necessary. See <link linkend="environmentSettings">Command-Line Environment Settings</link> for details.</para>
5353

@@ -72,7 +72,7 @@
7272

7373
<note>
7474
<title>Rice Java PLT</title>
75-
<para>On the Rice Computer Science department network, the Subversion client is located at <filename>/home/javaplt/packages/RHE4/subversion-1.3.2/subversion/clients/cmdline</filename>.</para>
75+
<para>On the Rice Computer Science department network, the Subversion client is located at <filename>/home/javaplt/packages/subversion-1.5.4/bin</filename>.</para>
7676
</note>
7777

7878
</section>
@@ -85,7 +85,7 @@
8585

8686
<note>
8787
<title>Rice Java PLT</title>
88-
<para>On the Rice Computer Science department network, Ant is installed in the <filename>/home/javaplt/packages</filename> directory.</para>
88+
<para>On the Rice Computer Science department network, Ant is installed in the <filename>/home/javaplt/packages/ant/bin</filename> directory.</para>
8989
</note>
9090

9191
<note>
@@ -141,21 +141,46 @@
141141
<tbody>
142142

143143
<row>
144-
<entry><literal>JAVA_HOME</literal></entry>
144+
<entry><literal>JAVA5_HOME</literal></entry>
145145
<entry>Location of the Java 5 installation. The specified directory should have a <filename>bin</filename> subdirectory containing <command>java</command>, <command>javac</command>, <command>javadoc</command>, etc.</entry>
146-
<entry>Specifies which Java installation Ant should use (not strictly necessary if the correct <command>java</command> command is on the command path).</entry>
146+
<entry>Specifies which Java 5 installation Ant should use. <!-- (not strictly necessary if the correct <command>java</command> command is on the command path) --> On CSnet, this should be set to <filename>/home/javaplt/java/Linux-i686/1.5</filename>.</entry>
147147
</row>
148-
148+
149+
<row>
150+
<entry><literal>JAVA6_HOME</literal></entry>
151+
<entry>Location of the Java 6 installation. The specified directory should have a <filename>bin</filename> subdirectory containing <command>java</command>, <command>javac</command>, <command>javadoc</command>, etc.</entry>
152+
<entry>Specifies which Java 6 installation Ant should use. <!-- (not strictly necessary if the correct <command>java</command> command is on the command path) --> On CSnet, this should be set to <filename>/home/javaplt/java/Linux-i686/1.6</filename>.</entry>
153+
</row>
154+
155+
<!--
149156
<row>
150157
<entry><literal>JAVA14_HOME</literal></entry>
151158
<entry>Location of the Java 1.4 installation. The specified directory should have a <filename>bin</filename> subdirectory similar to that of <literal>JAVA_HOME</literal>.</entry>
152159
<entry>The DrJava build scripts use this variable to locate the 1.4 installation.</entry>
153160
</row>
154-
161+
-->
155162
<row>
156163
<entry><literal>ANT_HOME</literal></entry>
157164
<entry>Location of the Ant installation. The specified directory should contain the <filename>bin</filename> and <filename>lib</filename> subdirectories.</entry>
158-
<entry>The Ant command generally needs this in order to work correctly (although on some platforms Ant will work fine without it).</entry>
165+
<entry>The Ant command generally needs this in order to work correctly (although on some platforms Ant will work fine without it). On CSnet, this should be set to <filename>/home/javaplt/packages/ant</filename>.</entry>
166+
</row>
167+
168+
<row>
169+
<entry><literal>LAUNCH4J_HOME</literal></entry>
170+
<entry>Location of the Launch4J installation. The specified directory should contain the <filename>bin</filename> subdirectory.</entry>
171+
<entry>This is not necessary for normal building, only for making release builds. On CSnet, this should be set to <filename>/home/javaplt/packages/launch4j</filename>.</entry>
172+
</row>
173+
174+
<row>
175+
<entry><literal>CLOVER_JAR</literal></entry>
176+
<entry>Location of the Clover jar file.</entry>
177+
<entry>This is not necessary for normal building, only for creating code coverage reports. On CSnet, this should be set to <filename>/home/javaplt/packages/clover-ant-1.3.14/lib/clover.jar</filename>.</entry>
178+
</row>
179+
180+
<row>
181+
<entry><literal>FINDBUGS_HOME</literal></entry>
182+
<entry>Location of the Findbugs installation. The specified directory should contain the <filename>bin</filename> and <filename>lib</filename> subdirectories.</entry>
183+
<entry>This is not necessary for normal building, only for creating static analysis reports. On CSnet, this should be set to <filename>/home/javaplt/packages/findbugs</filename>.</entry>
159184
</row>
160185

161186
<row>
@@ -264,7 +289,7 @@
264289

265290
<informalexample><para><literal>ant -p</literal></para></informalexample>
266291

267-
You will see a list of all the documented targets in the project. Note that, due to the dependencies between targets, the <literal>build</literal> target will run <literal>generate-source</literal>, <literal>compile-15</literal>, <literal>compile-14</literal>, <literal>test-14-in-15</literal>, and <literal>jar-14</literal>. That is, it will do everything required to build and test a new application. Try it out:
292+
You will see a list of all the documented targets in the project. Note that, due to the dependencies between targets, the <literal>build</literal> target will run <literal>generate-source</literal>, <literal>compile</literal>, <literal>test</literal>, and <literal>jar</literal>. That is, it will do everything required to build and test a new application. Try it out:
268293

269294
<informalexample><para><literal>ant build</literal></para></informalexample>
270295

@@ -285,39 +310,41 @@
285310
<para>Invokes the <command>javac</command> compiler. Generated class files will be placed in a new <filename>classes</filename> directory, with the subdirectories <filename>base</filename> and <filename>test</filename> for standard and test classes, respectively. Any compiler errors or warnings will be printed to the console. Where warnings are expected, they will be tagged in the code with a <literal>@SuppressWarnings</literal> annotation. Thus, any warnings you see during compilation highlight a problem that should be addressed.</para>
286311
</formalpara>
287312
</listitem>
288-
313+
<!--
289314
<listitem>
290315
<formalpara>
291316
<title><literal>rmi-compile</literal></title>
292317
<para>Invokes <command>rmic</command>, the <firstterm>Remote Method Invocation</firstterm> compiler. This allows (relatively) transparent communication to occur between the main DrJava process and the Interactions Pane helper process.</para>
293318
</formalpara>
294319
</listitem>
320+
-->
295321

296322
<listitem>
297323
<formalpara>
298324
<title><literal>unjar-libs</literal></title>
299325
<para>Expands the <filename>*.jar</filename> files in the <filename>lib</filename> directory into <filename>classes/lib</filename>. These library classes will be bundled with the finished product.</para>
300326
</formalpara>
301327
</listitem>
302-
328+
<!--
303329
<listitem>
304330
<formalpara>
305331
<title><literal>compile-14</literal></title>
306332
<para>Invokes the Retroweaver tool on the <filename>classes</filename> directories, generating class files compatible with Java 1.4 in the <filename>classes/base-14</filename>, <filename>classes/test-14</filename>, and <filename>classes/lib-14</filename> directories. This allows us to support users who only have Java 1.4 available on their systems. If there are any references to unavailable classes (such as <literal>java.util.Queue</literal>, which was introduced in the Java 5 APIs), a warning will be generated and should be immediately addressed.</para>
307333
</formalpara>
308334
</listitem>
335+
-->
309336

310337
<listitem>
311338
<formalpara>
312-
<title><literal>test-14-in-15</literal></title>
313-
<para>Runs the JUnit tests in <filename>classes/test-14</filename> under Java 5. This will constitute the bulk of the build time. A summary of the running time for each test will be logged, and if a failure occurs, testing will halt immediately. Note that there are also a <literal>test-14</literal> target and a <literal>test-15</literal> target that will not be run by <literal>build</literal>, but that can be invoked manually.</para>
339+
<title><literal>test</literal></title>
340+
<para>Runs the JUnit tests in <filename>classes/test</filename> under Java 5. This will constitute the bulk of the build time. A summary of the running time for each test will be logged, and if a failure occurs, testing will halt immediately. Note that there are also a <literal>test-6</literal> target that will not be run by <literal>build</literal>, but that can be invoked manually.</para>
314341
</formalpara>
315342
</listitem>
316343

317344
<listitem>
318345
<formalpara>
319-
<title><literal>jar-14</literal></title>
320-
<para>Creates the <filename>drjava.jar</filename> file using the Java 1.4-compatible classes. This is the executable application. It will contain a <filename>MANIFEST.MF</filename> file listing the build's unique version number and your user name.</para>
346+
<title><literal>jar</literal></title>
347+
<para>Creates the <filename>drjava.jar</filename> file using the Java 5-compatible classes. This is the executable application. It will contain a <filename>MANIFEST.MF</filename> file listing the build's unique version number and your user name.</para>
321348
</formalpara>
322349
</listitem>
323350
</itemizedlist>

0 commit comments

Comments
 (0)