[FOray-commit] SF.net SVN: foray: [7752] trunk/foray/doc/web/module

[<vic...@us...>]

Revision: 7752
Author:   victormote
Date:     2006-07-01 12:31:10 -0700 (Sat, 01 Jul 2006)
ViewCVS:  http://svn.sourceforge.net/foray/?rev=7752&view=rev

Log Message:
-----------
Update build documentation.

Modified Paths:
--------------
    trunk/foray/doc/web/app/using/build.html
    trunk/foray/doc/web/module/index.html
Modified: trunk/foray/doc/web/app/using/build.html
===================================================================
--- trunk/foray/doc/web/app/using/build.html	2006-07-01 01:09:57 UTC (rev 7751)
+++ trunk/foray/doc/web/app/using/build.html	2006-07-01 19:31:10 UTC (rev 7752)
@@ -22,6 +22,7 @@
   <li><a href="#download-source">Downloading Source Code</a></li>
   <li><a href="#enviro">Setting Up Your Environment</a></li>
   <li><a href="#build">Run the Build Script</a></li>
+  <li><a href="#subset">Building a Subset of FOray</a></li>
 </ul>
 
 <h2><a name="intro">Introduction</a></h2>
@@ -30,16 +31,12 @@
 you need access to source code or to an unreleased feature, you probably just
 need to <a href="download.html">download a FOray binary distribution</a>.</p>
 
-<p>If you are wanting to build only some FOray modules (instead of the complete
-application), please consult the <a href="/module/index.html">FOray Module
-User documentation</a>.</p>
-
 <h2><a name="download-source">Downloading Source Code</a></h2>
 
 <p><!-- FOray source code can be downloaded through from
 <a rel="external" href="http://sourceforge.net/projects/foray/">FOray's
 SourceForge site</a>. -->
-FOray source code is currently available only from the <a
+FOray source code is currently available only from the <a rel="external"
 href="http://sourceforge.net/svn/?group_id=109663">source code
 repository</a>, maintained by SourceForge. Thank you SourceForge!</p>
 
@@ -95,8 +92,35 @@
 
 <h2><a name="build">Run the Build Script</a></h2>
 <p>The actual build process can be started from foray/scripts/build.sh (for
-Unix/Linux) or foray/scripts/build.bat (for Windows).</p>
+Unix/Linux) or foray/scripts/build.bat (for Windows). The results of the build
+can be found in foray/build/ant/.</p>
 
+<h2><a name="subset">Building a Subset of FOray</a></h2>
+<p>Most FOray users will want to build and use the entire product, which is the
+default of the build script.
+However, some software developers may wish to use a subset of FOray in their
+"lib".
+For example, a project might wish to use FOray's font and fotree systems, but
+want to build the remaining modules themselves.
+The FOray build system allows the modules to be built in any combination,
+automatically including all FOray dependencies.
+To use this feature, select the "clean" target first, followed by the names of
+the module(s) that you wish to include in the build, then followed by the
+"package" target.
+So for the example above, run "ant clean font fotree package".</p>
+
+<p>The module targets available are: common, pretty, ps, graphic, mif, font,
+hyphen, text, pdf, fotree, areatree, output, layout, pioneer, render, core,
+app.
+For more information on the meaning of these targets, see
+<a href="/module/">Modules</a>.</p>
+
+<p>When a subset is built, the resulting jar file includes the word "subset" in
+its name. In all cases, the jar manifest includes a list of the modules that
+were included in the build, in a heading entitled "FOray-Modules".</p>
+
+<p>Note that if a subset is built, some FOray lib entries may not be needed.</p>
+
 <!--#include virtual="/00-rsrc/include/leftmenu-end.html" -->
 </body>
 </html>

Modified: trunk/foray/doc/web/module/index.html
===================================================================
--- trunk/foray/doc/web/module/index.html	2006-07-01 01:09:57 UTC (rev 7751)
+++ trunk/foray/doc/web/module/index.html	2006-07-01 19:31:10 UTC (rev 7752)
@@ -150,16 +150,12 @@
 </table>
 
 <h2><a name="build">Building a Module</a></h2>
-<p>To build a FOray module, please first make sure that you understand the
-dependencies documented above. To download a FOray module, access the FOray
-source code repository, and download the foray/&lt;module&gt; source code
-module. The value for &lt;module&gt; can be found in the “Repository module”
-column in the table above. For example, to download FOrayGraphic, download the
-source module “foray/foray-graphic”.</p>
+<p>Although each FOray module has its own build script, the preferred way to
+build FOray modules is to use the main build script, which can intelligently
+build any subset of FOray that is needed.
+See <a href="/app/using/build.html">Building a Subset of FOray</a> for
+details.</p>
 
-<p>Each module has a scripts/build.sh Bourne shell script for Unix/Linux, and
-a scripts/build.bat for Windows.</p>
-
 <!--#include virtual="/00-rsrc/include/leftmenu-end.html" -->
 </body>
 </html>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.