adammurdoch    02/05/09 00:39:24

  Modified:    site/src/xdocs project-descriptor.xml todo.xml
               site/src/xdocs/stylesheets project.xml
  Added:       site/src/xdocs building.xml running.xml
  Removed:     site/src/xdocs user.xml
  Log:
  Updated the how-to-build info and todo list.
  
  Revision  Changes    Path
  1.2       +4 -8      
jakarta-ant-myrmidon/site/src/xdocs/project-descriptor.xml
  
  Index: project-descriptor.xml
  ===================================================================
  RCS file: 
/home/cvs/jakarta-ant-myrmidon/site/src/xdocs/project-descriptor.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- project-descriptor.xml    8 May 2002 10:18:44 -0000       1.1
  +++ project-descriptor.xml    9 May 2002 07:39:23 -0000       1.2
  @@ -74,13 +74,6 @@
               </tr>
   
               <tr>
  -                <td>package</td>
  -                <td>The root Java package for the project.  Used to generate 
the
  -                project's Javadocs.</td>
  -                <td>yes</td>
  -            </tr>
  -
  -            <tr>
                   <td>property</td>
                   <td>A global build property.  This is an Ant
                   <code>&lt;property&gt;</code> task.</td>
  @@ -121,7 +114,10 @@
                       <td>classpath</td>
                       <td>The classpath to use for compiling the project 
source.
                       This is appended to the project classpath.  This is
  -                    an Ant <code>&lt;path&gt;</code> data-type.</td>
  +                    an Ant <code>&lt;path&gt;</code> data-type.  Note that
  +                    the Ant runtime is not included in the compile classpath.
  +                    To include the Ant runtime, add an empty 
<code>&lt;ant-runtime&gt;</code>
  +                    element to the <code>&lt;classpath&gt;</code> 
element.</td>
                       <td>no</td>
                   </tr>
   
  
  
  
  1.2       +22 -24    jakarta-ant-myrmidon/site/src/xdocs/todo.xml
  
  Index: todo.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/todo.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- todo.xml  10 Apr 2002 23:43:46 -0000      1.1
  +++ todo.xml  9 May 2002 07:39:23 -0000       1.2
  @@ -161,6 +161,12 @@
                   stopped?" ? Probably as that way long running tasks are 
given the opportunity
                   to be gracefully halted by the end users (primarily aimed at 
IDE vendors here).</p>
   
  +                <ul>
  +                    <li>Add verbosity level to TaskEvent.</li>
  +                    <li>Fire taskFinished() events on task failure.</li>
  +                    <li>Get target finished and project finished events 
working.</li>
  +                </ul>
  +
               </subsection>
   
               <subsection name="XPath-like Locators for tasks">
  @@ -505,42 +511,26 @@
   
                   <ul>
                       <li>Search through the code for 'TODO' items and fix 
them.</li>
  -                    <li>Allow service factories to be configured from the 
contents of the
  -
  -                        <code>ant-services.xml</code> descriptor.
  -                    </li>
  -                    <li>Add verbosity level to ProjectListener LogEvent</li>
  -                    <li>Fire ProjectListener events taskFinished(), 
targetFinished() and
  -                    projectFinished() events on build failure, adding 
indicator methods to
  -                    ProjectEvent.</li>
  -                    <li>Fire ProjectListener events projectStarted() and 
projectFinished()
  -                    events on start and finish of referenced projects, 
adding indicator methods
  -                    to ProjectEvent.</li>
                       <li>Detect duplicate type names.</li>
  -                    <li>Add fully qualified type names, based on antlib name 
and type shorthand name.
  -                    Allow these to be used in build files in addition to the 
shorthand names.</li>
  +                    <li>Validate type and role names.</li>
                       <li>Move the
                           <code>&lt;http&gt;</code> and
                           <code>&lt;socket&gt;</code>
  -                    conditions to an antlib.  Need to resolve how these will 
be passed a logger.
  +                    conditions to an antlib.
                       </li>
                       <li>Add an else block to the
                           <code>&lt;if&gt;</code> task.
                       </li>
  -                    <li>Move
  -                        <code>crimson.jar</code> to
  -                        <code>bin/lib</code> in the distribution,
  +                    <li>Move the XML parser to <code>bin/lib</code> in the 
distribution,
                       and make available to other jars via the extension 
mechanism.
                       </li>
                       <li>Change <code>DefaultPropertyResolver</code> to 
ignore '$${'.</li>
  -                    <li>Add a <code>--type</code> command-line option, to 
allow
  -                        the project builder to be manually selected.
  -                    </li>
  +                    <li>Add a property resolver which uses xpath to resolve 
values.</li>
                       <li>Change <code>ProjectBuilder</code>
                           and <code>Embeddor</code> to throw something more
                           specialised than Exception.
                       </li>
  -                    <li>Change <code>DefaultClassLoaderManager</code> to 
handle
  +                    <li>Change <code>DefaultLibraryManager</code> to handle
                           directories as part of a library classpath.
                       </li>
                       <li><code>&lt;condition&gt;</code> should set the 
property
  @@ -552,9 +542,17 @@
                           check Ant version, check whether a particular antlib 
or extension is
                           available, match a string against a regular 
expression.</li>
                       <li>Add a task to unset a property.</li>
  -                    <li>Change the various def and import task to allow a 
classpath
  -                        to be provided.</li>
  -                    <li>Unit tests.</li>
  +                    <li>Change the typelib, import and -def tasks to allow 
more than one
  +                    type to be specified.</li>
  +                    <li>Use AUT jprocess in the ExecuteJava class, running 
the
  +                    app in another thread.  This will allow setting system 
properties
  +                    to be re-enabled.</li>
  +                    <li>Change DefaultEmbeddor to implement 
ExecutionContainer,
  +                    to allow it to be supplied with initial properties, 
services,
  +                    logger, etc.</li>
  +                    <li>Add a ScopedService interface, to replace
  +                    TypeManager.createChildTypeManager(), 
Deployer.createChildDeployer, etc.</li>
  +                    <li>Configurer needs to be scoped.  RoleManager probably 
does too.</li>
                   </ul>
   
               </subsection>
  
  
  
  1.1                  jakarta-ant-myrmidon/site/src/xdocs/building.xml
  
  Index: building.xml
  ===================================================================
  <document>
  
  <properties>
  <author email="[EMAIL PROTECTED]">Adam Murdoch</author>
  <title>Building Myrmidon</title>
  </properties>
  
  <body>
  
  <section name="Building Myrmidon">
  
  <p>
  First, you will need to fetch the Myrmidon source from CVS.  The source
  can be found in the <code>jakarta-ant-myrmidon</code> CVS module.  Details can
  be found <a href="http://jakarta.apache.org/site/cvsindex.html";>here</a>.
  </p>
  
  <p>
  To build Myrmidon, use the <code>build.xml</code> file in the root of the 
source
  tree.  You will need to use Ant 1.5 or later, and you will need to include 
junit
  and xalan in your CLASSPATH.  The default target builds a minimal Myrmidon
  distribution into the <code>myrmidon/dist</code> directory.  The distribution
  is a ready-to-run installation of Myrmidon.  Use the <code>dist</code> target 
to
  build a full Myrmidon distribution, including all documentation, into the
  <code>myrmidon/distributions</code> directory.
  </p>
  
  <p>There are a number features that are not built unless the appropriate 
optional Jar
  files are found in the <code>lib</code> directory:</p>
  
  <table>
      <tr><th>Feature</th><th>Jar File</th><th>Download From</th></tr>
      <tr>
          <td>SMB VFS support (Samba, Windows shares)</td>
          <td>jcifs.jar</td>
          <td><a href="http://jcifs.samba.org";>jcifs.samba.org</a>.
          <p>Note: there are problems using the 0.6.1 release.  Try 0.6.0 
instead.</p></td>
      </tr>
      <tr>
          <td>FTP VFS support</td>
          <td>netcomponents.jar</td>
          <td><a 
href="http://www.savarese.org/oro/software/NetComponents.html";>www.savarese.org</a></td>
      </tr>
  </table>
  
  </section>
  
  
  </body>
  
  </document>
  
  
  
  1.1                  jakarta-ant-myrmidon/site/src/xdocs/running.xml
  
  Index: running.xml
  ===================================================================
  <document>
  
  <properties>
  <author email="[EMAIL PROTECTED]">Adam Murdoch</author>
  <title>Running Myrmidon</title>
  </properties>
  
  <body>
  
      <section name="Running Myrmidon">
  
      <p>
      To run Myrmidon, use one of the following methods:
      </p>
  
      <subsection name="Launcher Script">
  
      <p>
      On Windows and Unix platforms, you can use the <code>ant</code> script
      in the distribution's <code>bin</code> directory.  The following 
environment
      variables can be used, but are not required (except on Windows 9x - see 
below).
      </p>
  
      <p>
  
      </p>
  
      <table>
          <tr><th>Variable</th><th>Description</th></tr>
          <tr>
              <td>JAVA_HOME</td>
              <td>The directory that the JDK is installed in.</td>
          </tr>
          <tr>
              <td>JAVACMD</td>
              <td>The command to use to start the JVM.  Defaults to 
<code>java</code>.</td>
          </tr>
          <tr>
              <td>ANT_HOME</td>
              <td>
                  The directory containing the Myrmidon distribution.  This 
must be
                  set when running on Windows 95, 98 or Me.
              </td>
          </tr>
      </table>
  
      </subsection>
  
      <subsection name="Executable Jar File">
  
      <p>
      The Myrmidon distribution includes an executable Jar file, which can be 
used
      to run Myrmidon.  Use the following command:
      </p>
      <pre>
      prompt> <i>java</i> -jar <i>ant-home</i>/bin/myrmidon-launcher.jar 
<i>options</i>
      </pre>
  
      </subsection>
  
      <p>When started, Myrmidon looks for a project file called 
<code>build.ant</code>
      in the current directory.  A different project file can be specified 
using the
      <code>-f</code> command-line option.  Myrmidon executes the targets that 
are
      listed on the command-line, or the default target if none is given.  For
      example, the following command executes targets <code>clean</code> and
      <code>build</code> from project file <code>my-project.xml</code>:</p>
  
      <pre>
      prompt> ant -f my-project.xml clean build
      </pre>
  
      <p>
      Run Myrmidon with the <code>-h</code> command-line option for a list of
      the command-line options that are available.
      </p>
  
      </section>
  
  </body>
  
  </document>
  
  
  1.4       +2 -1      
jakarta-ant-myrmidon/site/src/xdocs/stylesheets/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: 
/home/cvs/jakarta-ant-myrmidon/site/src/xdocs/stylesheets/project.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- project.xml       8 May 2002 10:18:44 -0000       1.3
  +++ project.xml       9 May 2002 07:39:24 -0000       1.4
  @@ -6,11 +6,12 @@
           <menu name="Myrmidon">
               <item name="Introduction" href="/index.html"/>
               <item name="Get Involved" href="/getinvolved.html"/>
  -            <item name="Building Myrmidon" href="/user.html"/>
  +            <item name="Building Myrmidon" href="/building.html"/>
               <item name="Todo List" href="/todo.html"/>
           </menu>
   
           <menu name="User Guide">
  +            <item name="Installing and Running" href="/running.html"/>
               <item name="Project File" href="/buildfile.html"/>
               <item name="Virtual File System" href="/vfs.html"/>
               <item name="Ant 1 Compatibility Layer" href="/ant1compat.html"/>
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to