Skip to content

Commit

Permalink
Update documentation so it doesn't refer to sourceforge or CVS. Get r…
Browse files Browse the repository at this point in the history
…id of unnecessary variables in build properties.
  • Loading branch information
aquark committed Apr 12, 2009
1 parent dbb4bb3 commit 0484194
Show file tree
Hide file tree
Showing 7 changed files with 109 additions and 113 deletions.
12 changes: 6 additions & 6 deletions OrcDocs/src/root.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4769,10 +4769,10 @@ all and execution will deadlock. This situation is sufficiently rare that

<para>
Code which uses Kilim must be processed with the Kilim "weaver" after compiling
and before running. The weaver is bundled in <filename>kilim.jar</filename>,
which is available for download from <link
xlink:href="http://sourceforge.net/project/platformdownload.php?group_id=33781">SourceForge</link>
and is also bundled with the Orc source code.
and before running. The weaver is bundled with the Orc source code, or may be
downloaded separately from the <link
xlink:href="http://www.malhar.net/sriram/kilim/">Kilim project
site</link>.
</para>

<para>
Expand Down Expand Up @@ -5117,8 +5117,8 @@ should provide you with enough information to get started.

<para>All Orc sites related to web services are bundled in a separate
"OrcSites" library. As with the core Orc distribution, you can either
download this library as a prepackaged JAR from Sourceforge, or check out the
source code from the CVS "OrcSites" module. We generally recommend the latter
download this library as a prepackaged JAR or check out the
source code from the "OrcSites" module in version control. We generally recommend the latter
approach, since the source code provides several examples which can be used as
a basis for creating your own web service sites.
</para>
Expand Down
15 changes: 2 additions & 13 deletions OrcJava/build.properties
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
# version number for this build
orc.version=0.9.8

# the same as the Eclipse output folder
orc.location.build=build
# libraries
orc.location.lib=lib
# source code
orc.location.src=src
# javadoc
orc.location.javadoc=build/javadoc
# jarbundler
orc.location.jarbundler=jarbundler
# orchard icon
orchard.icon=jarbundler/orchard.icns

# where to find the OrcDocs project
orc.location.OrcDocs=../OrcDocs
81 changes: 40 additions & 41 deletions OrcJava/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
<property file="build.properties" />

<property file="googlecode.properties" />

<taskdef classname="net.bluecow.googlecode.ant.GoogleCodeUploadTask"
classpath="lib/ant-googlecode-0.0.1.jar" name="gcupload"/>
<target name="upload" depends="zip,javadoc" description="upload to google code">
Expand All @@ -29,18 +28,18 @@
</target>

<path id="orc.classpath">
<fileset dir="${orc.location.lib}" includes="*.jar" />
<pathelement path="${orc.location.build}" />
<fileset dir="lib" includes="*.jar" />
<pathelement path="build" />
</path>

<property name="target.name" value="${ant.project.name}-${orc.version}" />

<target name="jar" depends="kilim" description="generate the distribution">
<!-- Put everything in ${orc.location.build} into orc-sites.jar -->
<jar jarfile="${target.name}.jar" basedir="${orc.location.build}">
<!-- Put everything in build into orc-sites.jar -->
<jar jarfile="${target.name}.jar" basedir="build">
<exclude name="orc/test/**"/>
<!-- Include library dependencies -->
<zipgroupfileset dir="${orc.location.lib}">
<zipgroupfileset dir="lib">
<include name="*.jar"/>
<!-- Only needed for compilation -->
<exclude name="rats.jar"/>
Expand Down Expand Up @@ -77,20 +76,20 @@
<!--
<target name="macos" depends="jar" description="generate a Mac OS bundle">
<taskdef name="jarbundler"
classpath="${orc.location.jarbundler}/jarbundler.jar"
classpath="jarbundler/jarbundler.jar"
classname="net.sourceforge.jarbundler.JarBundler"/>
<jarbundler dir="${orc.location.build}" verbose="true" showPlist="true"
<jarbundler dir="build" verbose="true" showPlist="true"
name="Orchard"
mainclass="orc.Orc"
jar="${target.name}.jar"
icon="${orchard.icon}"
icon="jarbundler/orchard.icns"
version="${orc.version}"/>
</target>
-->

<target name="clean" description="clean up">
<delete dir="${orc.location.build}" />
<delete dir="build" />
<delete file="${ant.project.name}-${orc.version}.jar"/>
<delete file="${ant.project.name}-${orc.version}.zip"/>
<delete file="${ant.project.name}-${orc.version}-doc.zip"/>
Expand All @@ -103,29 +102,29 @@
<enable/>
</assertions>
<arg value="-d" />
<arg value="${orc.location.build}" />
<arg value="${orc.location.build}" />
<arg value="build" />
<arg value="build" />
</java>
</target>

<!-- javac does some weird compilation that Kilim doesn't like, so for now
you have to use the eclipse compiler
<target name="compile" depends="rats" description="javac compile">
<mkdir dir="${orc.location.build}" />
<mkdir dir="build" />
<javac source="1.5" target="1.5" debug="yes"
srcdir="${orc.location.src}"
destdir="${orc.location.build}"
srcdir="src"
destdir="build"
classpathref="orc.classpath" />
<copy todir="${orc.location.build}">
<fileset dir="${orc.location.src}" excludes="**/*.java **/CVS/*"/>
<copy todir="build">
<fileset dir="src" excludes="**/*.java **/CVS/*"/>
</copy>
</target>
-->

<target name="stdlib-doc" description="Build standard library docs">
<java classname="orc.doc.MakeDoc" fork="yes"
dir="${orc.location.src}/orc/inc/prelude"
output="../OrcDocs/src/stdlib.xml">
dir="src/orc/inc/prelude"
output="${orc.location.OrcDocs}/src/stdlib.xml">
<classpath refid="orc.classpath"/>
<assertions>
<enable/>
Expand All @@ -146,74 +145,74 @@
<target name="rats1" depends="rats1.required" unless="rats1.notRequired">
<java classname="xtc.parser.Rats" fork="yes">
<classpath>
<pathelement path="${orc.location.lib}/rats.jar" />
<pathelement path="lib/rats.jar" />
</classpath>
<arg value="-lgpl" />
<arg value="-in" />
<arg value="${orc.location.src}" />
<arg value="src" />
<arg value="-out" />
<arg value="${orc.location.src}/orc/parser" />
<arg value="${orc.location.src}/orc/parser/OrcParserRats.rats" />
<arg value="src/orc/parser" />
<arg value="src/orc/parser/OrcParserRats.rats" />
</java>
</target>
<target name="rats1.required">
<uptodate property="rats1.notRequired"
srcfile="${orc.location.src}/orc/parser/OrcParserRats.rats"
targetfile="${orc.location.src}/orc/parser/OrcParserRats.java"/>
srcfile="src/orc/parser/OrcParserRats.rats"
targetfile="src/orc/parser/OrcParserRats.java"/>
</target>

<target name="rats2" depends="rats2.required" unless="rats2.notRequired">
<java classname="xtc.parser.Rats" fork="yes">
<classpath>
<pathelement path="${orc.location.lib}/rats.jar" />
<pathelement path="lib/rats.jar" />
</classpath>
<arg value="-lgpl" />
<arg value="-in" />
<arg value="${orc.location.src}" />
<arg value="src" />
<arg value="-out" />
<arg value="${orc.location.src}/orc/doc" />
<arg value="${orc.location.src}/orc/doc/DocParser.rats" />
<arg value="src/orc/doc" />
<arg value="src/orc/doc/DocParser.rats" />
</java>
</target>
<target name="rats2.required">
<uptodate property="rats2.notRequired"
srcfile="${orc.location.src}/orc/doc/DocParser.rats"
targetfile="${orc.location.src}/orc/doc/DocParser.java"/>
srcfile="src/orc/doc/DocParser.rats"
targetfile="src/orc/doc/DocParser.java"/>
</target>

<target name="rats3" depends="rats3.required" unless="rats3.notRequired">
<java classname="xtc.parser.Rats" fork="yes">
<classpath>
<pathelement path="${orc.location.lib}/rats.jar" />
<pathelement path="lib/rats.jar" />
</classpath>
<arg value="-lgpl" />
<arg value="-in" />
<arg value="${orc.location.src}" />
<arg value="src" />
<arg value="-out" />
<arg value="${orc.location.src}/orc/parser" />
<arg value="${orc.location.src}/orc/parser/OrcLiteralParser.rats" />
<arg value="src/orc/parser" />
<arg value="src/orc/parser/OrcLiteralParser.rats" />
</java>
</target>
<target name="rats3.required">
<uptodate property="rats3.notRequired"
srcfile="${orc.location.src}/orc/parser/OrcLiteralParser.rats"
targetfile="${orc.location.src}/orc/parser/OrcLiteralParser.java"/>
srcfile="src/orc/parser/OrcLiteralParser.rats"
targetfile="src/orc/parser/OrcLiteralParser.java"/>
</target>

<target name="javadoc" description="Build Javadoc">
<delete dir="${orc.location.javadoc}" />
<javadoc destdir="${orc.location.javadoc}"
<delete dir="javadoc" />
<javadoc destdir="javadoc"
author="true"
access="protected"
source="1.5"
sourcepath="${orc.location.src}"
sourcepath="src"
splitindex="true"
windowtitle="Orc ${orc.version}"
doctitle="Orc ${orc.version}"
use="true"
version="true">
<classpath refid="orc.classpath"/>
</javadoc>
<zip zipfile="${ant.project.name}-${orc.version}-doc.zip" basedir="${orc.location.javadoc}" />
<zip zipfile="${ant.project.name}-${orc.version}-doc.zip" basedir="javadoc" />
</target>
</project>
13 changes: 2 additions & 11 deletions OrcSites/build.properties
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# version number for this build
orc.version=0.9.8

# the same as the Eclipse output folder
orc.location.build=build
# libraries
orc.location.lib=lib
# source code
orc.location.src=src
# javadoc
orc.location.javadoc=build/javadoc

orc.location.OrcJava.build=../OrcJava/build
orc.location.OrcJava.lib=../OrcJava/lib
# where to find the OrcJava project
orc.location.OrcJava=../OrcJava
50 changes: 36 additions & 14 deletions OrcSites/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,42 @@
Ant build file for Orc binary distribution.
</description>
<property file="build.properties" />

<property file="${orc.location.OrcJava}/googlecode.properties" />
<taskdef classname="net.bluecow.googlecode.ant.GoogleCodeUploadTask"
classpath="${orc.location.OrcJava}/lib/ant-googlecode-0.0.1.jar" name="gcupload"/>
<target name="upload" depends="zip,javadoc" description="upload to google code">
<gcupload
username="${orc.googlecode.username}"
password="${orc.googlecode.password}"
projectname="orc"
filename="${ant.project.name}-${orc.version}.zip"
targetfilename="${ant.project.name}-${orc.version}.zip"
summary="Supplemental Orc sites, for webservices and other demos."
labels="Type-Archive, OpSys-All" />
<gcupload
username="${orc.googlecode.username}"
password="${orc.googlecode.password}"
projectname="orc"
filename="${ant.project.name}-${orc.version}-doc.zip"
targetfilename="${ant.project.name}-${orc.version}-doc.zip"
summary="Javadoc documentation for supplemental Orc sites."
labels="Type-Docs, OpSys-All" />
</target>

<path id="orc.classpath">
<fileset dir="${orc.location.lib}" includes="*.jar" />
<pathelement path="${orc.location.build}" />
<fileset dir="lib" includes="*.jar" />
<pathelement path="build" />
<!-- FIXME: I hate having to hard-code these -->
<pathelement path="${orc.location.OrcJava.build}" />
<fileset dir="${orc.location.OrcJava.lib}" includes="*.jar" />
<pathelement path="${orc.location.OrcJava}/build" />
<fileset dir="${orc.location.OrcJava}/lib" includes="*.jar" />
</path>

<target name="jar" depends="kilim" description="generate the distribution">
<!-- Put everything in ${orc.location.build} into orc-sites.jar -->
<jar jarfile="${ant.project.name}-${orc.version}.jar" basedir="${orc.location.build}">
<!-- Put everything in build into orc-sites.jar -->
<jar jarfile="${ant.project.name}-${orc.version}.jar" basedir="build">
<!-- Include library dependencies -->
<zipgroupfileset dir="${orc.location.lib}"
<zipgroupfileset dir="lib"
includes="*.jar" />
</jar>
</target>
Expand All @@ -38,7 +60,7 @@
</target>

<target name="clean" description="clean up">
<delete dir="${orc.location.build}" />
<delete dir="build" />
<delete>
<fileset dir="." includes="${ant.project.name}-*.jar"/>
</delete>
Expand All @@ -51,24 +73,24 @@
<enable/>
</assertions>
<arg value="-d" />
<arg value="${orc.location.build}" />
<arg value="${orc.location.build}" />
<arg value="build" />
<arg value="build" />
</java>
</target>
<target name="javadoc" description="Build Javadoc">
<delete dir="${orc.location.javadoc}" />
<javadoc destdir="${orc.location.javadoc}"
<delete dir="javadoc" />
<javadoc destdir="javadoc"
author="true"
access="protected"
source="1.5"
sourcepath="${orc.location.src}"
sourcepath="src"
splitindex="true"
windowtitle="{$ant.project.name} ${orc.version}"
doctitle="{$ant.project.name} ${orc.version}"
use="true"
version="true">
<classpath refid="orc.classpath"/>
</javadoc>
<zip zipfile="${ant.project.name}-${orc.version}-doc.zip" basedir="${orc.location.javadoc}" />
<zip zipfile="${ant.project.name}-${orc.version}-doc.zip" basedir="javadoc" />
</target>
</project>
7 changes: 1 addition & 6 deletions Orchard/build.properties
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,4 @@
# version number hard-coded there
orc.version=0.9.8

# the same as the Eclipse output folder
orc.location.build=build
# libraries
orc.location.lib=lib

orc.location.OrcJava.lib=../OrcJava/lib
orc.location.OrcJava=../OrcJava
Loading

0 comments on commit 0484194

Please sign in to comment.