aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwisberg <wisberg>2002-12-17 14:38:06 +0000
committerwisberg <wisberg>2002-12-17 14:38:06 +0000
commitf1b734ae88881c8f8d38db2942a3f35207401c1f (patch)
tree22b23aa8c65f8f04cc0f649032cc7399d0f5cd33
parent12a9d7fee224d79e2b8fe01d5e2f5a0e34710891 (diff)
downloadaspectj-f1b734ae88881c8f8d38db2942a3f35207401c1f.tar.gz
aspectj-f1b734ae88881c8f8d38db2942a3f35207401c1f.zip
doc/script cleanup
-rw-r--r--docs/build.xml74
-rw-r--r--docs/readme-docs-module.html9
2 files changed, 10 insertions, 73 deletions
diff --git a/docs/build.xml b/docs/build.xml
index 4ad90170b..c7548f9f0 100644
--- a/docs/build.xml
+++ b/docs/build.xml
@@ -11,82 +11,14 @@
<!-- Xerox/PARC initial implementation -->
<!-- ========================================================================= -->
-<!--
-
-Using this:
- - default target (dist) creates deployment-like dir in build output dir
- - target download.files deploys locally and creates installers
- - individual targets build pieces (api, etc.)
- - clean only cleans the build directory
-
-Understanding this:
-
- The documentation output structure is (ignoring alpha order):
-
- aspectj/
- README-DOC.html
- style.css
- examples/
- doc/
- index.html
- changes.html
- porting.html
- oldversions/
- faq.html
- quickref.html
-
- devguide.pdf
- progguide.pdf
- quickref.pdf
-
- api/
- progguide/
- devguide/
-
- The input structure is
-
- aspectj/
- README-DOC.html
- style.css
- examples/
- doc/
- index.html
- changes.html
- porting.html
- oldversions/
- faq/faq.html
-
- devGuideDB/ to devguide/ devguide.pdf
- progGuideDB/ to progguide/ progguide.pdf
- ?? to quickref.pdf quickref.html
- src/org/aspectj/lang/*.java | to api
- src/org/aspectj/lang/reflect/*.java |
-
-data flow and operations (in terms of script names):
- - input - - target - - output -
- ${docs.src.dir} dist ${docs.dist.dir}
- ${docs.src.dir} api ${docs.dist.dir}
- ${docs.src.dir} faq ${docs.dist.dir}
- ${docs.src.dir} examples ${docs.dist.dir}
- ${docs.src.dir} devguide ${docs.dist.dir}
- ${docs.src.dir} progguide ${docs.dist.dir}
- ${docs.src.dir} allTheRest ${docs.dist.dir}
- ${docs.dist.dir} web.deploy ${web.doc.dir}
- ${aj.release.dir}/.. download.push (ajpush)
-
-XXX no update to avoid builds in this script
- -->
-
<!DOCTYPE project [
<!ENTITY build-properties SYSTEM "file:../build/build-properties.xml">
]>
<project name="build-docs" default="dist" basedir=".">
- <!-- todo: download.files requires build-installer -->
+
<property name="project.name" value="build-docs"/>
- <target name="quicklook" depends="dist"/>
<target name="product" depends="local-dist"/>
- <target name="download.files" depends="dist"/>
<target name="clean"
depends="clean-directories,clean-doc-directories"/>
@@ -152,7 +84,7 @@ XXX no update to avoid builds in this script
</target>
<target name="dist" depends="init,local-dist"
- description="create doc distribution zip"
+ description="create unused doc zip - see ../build/build.xml for installer"
unless="dist.uptodate">
<delete file="${docs.product.zip}"/>
<zip zipfile="${docs.product.zip}"
@@ -268,7 +200,7 @@ XXX no update to avoid builds in this script
<target name="devguide" depends="init">
<copy todir="${docs.src.dir}/devGuideDB" filtering="off" >
- <fileset dir="${aspectj.modules.dir}/ajde/src/org/aspectj/ajde/resources/actions"
+ <fileset dir="${devguide.icons.dir}"
includes="${include.devguide.icons}" />
</copy>
<antcall target="build-guide">
diff --git a/docs/readme-docs-module.html b/docs/readme-docs-module.html
index f46b39257..fdb7866a1 100644
--- a/docs/readme-docs-module.html
+++ b/docs/readme-docs-module.html
@@ -15,8 +15,10 @@ contain sources for the FAQ and the Programming and Development Guides,
generated using the Ant <a href="build.xml">build.xml</a> script.
<p>
-<u>Build</u>: The script uses a taskdefs defined in ../lib/build/build.jar
-to generate the installers, and others to do misc. text-conversion.
+<u>Build</u>: <a href="build.xml">build.xml</a> assembles a local
+distribution which is gathered into the product distribution by
+the master build script,
+<a href="../build/build.xml">../build/build.xml</a>.
Dependencies outside this directory:
<ul>
<li>.xml files refer to their docbook dtds using relative
@@ -27,6 +29,9 @@ Dependencies outside this directory:
<li>When building installer, using ../lib/build/build.jar
and the ../build/installer-resources.
</li>
+<li><a href="dist/doc/quick.pdf">dist/doc/quick.pdf</a>
+ is generated manually from <a href="quick.doc">quick.doc</a>.
+ </li>
</ul>
</body>
</html>