commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From adammurd...@apache.org
Subject cvs commit: jakarta-commons-sandbox/vfs/xdocs anttasks.xml todo.xml
Date Mon, 17 Mar 2003 09:07:12 GMT
adammurdoch    2003/03/17 01:07:12

  Modified:    vfs/xdocs anttasks.xml todo.xml
  Log:
  - Few more details on the ant tasks.
  - More todos.
  
  Revision  Changes    Path
  1.3       +54 -15    jakarta-commons-sandbox/vfs/xdocs/anttasks.xml
  
  Index: anttasks.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/anttasks.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- anttasks.xml	17 Nov 2002 03:30:13 -0000	1.2
  +++ anttasks.xml	17 Mar 2003 09:07:11 -0000	1.3
  @@ -7,28 +7,67 @@
       <body>
           <section name="Ant Tasks">
               <p>
  -                To use the Ant tasks, copy commons-jar.jar and its dependencies
  -                into the <code>$ANT_HOME/lib</code> directory,
  -                and use the following in your Ant scipt to define the tasks:
  +                Commons VFS includes several Ant tasks that can be used
  +                to create, delete, copy and move files of any supported type.
  +                The tasks are:
               </p>
  +            <ul>
  +                <li>
  +                    <a href="#V-Copy"><code>&lt;v-copy&gt;</code></a>.
  +                    Copies a set of source folders and files to a destination
  +                    folder.
  +                </li>
  +                <li>
  +                    <a href="#V-Delete"><code>&lt;v-delete&gt;</code></a>.
  +                    Deletes a file or folder.
  +                </li>
  +                <li>
  +                    <a href="#V-Mkdir"><code>&lt;v-mkdir&gt;</code></a>.
  +                    Creates a folder.
  +                </li>
  +                <li>
  +                    <a href="#V-Move"><code>&lt;v-move&gt;</code></a>.
  +                    Moves a set of source folders and files to a destination
  +                    folder.
  +                </li>
  +                <li>
  +                    <a href="#V-Sync"><code>&lt;v-sync&gt;</code></a>.
  +                    Synchronises a destination folder with a set of source
  +                    folder and files.
  +                </li>
  +            </ul>
  +            <p>
  +                All file name attributes support relative and absolute local
  +                file names, and <a href="filesystems.html">absolute URI</a>.
  +                File names are interpreted relative to the Ant project's base
  +                directory.
  +            </p>
  +
  +            <subsection name="Using the Tasks">
  +                <p>
  +                    To use the Ant tasks, copy commons-jar.jar and its
  +                    dependencies into the <code>$ANT_HOME/lib</code> directory,
  +                    and use the following in your Ant scipt to define the tasks:
  +                </p>
   
  -            <source><![CDATA[
  +                <source><![CDATA[
   <taskdef resource="/org/apache/commons/vfs/tasks/tasks.properties"/>
   ]]></source>
   
  -            <p>
  -                Alternatively, you can provide an explicit classpath when
  -                you define the tasks:
  -            </p>
  +                <p>
  +                    Alternatively, you can provide an explicit classpath when
  +                    you define the tasks:
  +                </p>
   
  -            <source><![CDATA[
  +                <source><![CDATA[
   <taskdef resource="/org/apache/commons/vfs/tasks/tasks.properties">
       <classpath> ... </classpath>
   </taskdef>
   ]]></source>
  +            </subsection>
           </section>
   
  -        <section name="Copy">
  +        <section name="V-Copy">
               <p>Copies a set of files to a destination folder.  Does not copy
               source files where the destination file exists and is newer than
               the source file.  The copy task takes the following attributes:</p>
  @@ -68,7 +107,7 @@
               </table>
   
               <subsection name="Nested Elements">
  -                <p><b>src</b></p>
  +                <p><b><code>&lt;src&gt;</code></b></p>
   
                   <p>Defines a source file or folder to copy.  It takes the
                   following attributes:</p>
  @@ -85,17 +124,17 @@
   
           </section>
   
  -        <section name="Move">
  +        <section name="V-Move">
               <p>Moves a set of files to a destination folder.  Has the same
                   attributes and elements as the copy task.</p>
           </section>
   
  -        <section name="Sync">
  +        <section name="V-Sync">
               <p>Synchronises a destination folder with a set of source files.
                   Has the same attributes and elements as the copy task.</p>
           </section>
   
  -        <section name="Delete">
  +        <section name="V-Delete">
               <p>Deletes a file or folder.  It takes the following attributes:</p>
   
               <table>
  @@ -109,7 +148,7 @@
               </table>
           </section>
   
  -        <section name="Mkdir">
  +        <section name="V-Mkdir">
               <p>Creates a folder.  It takes the following attributes:</p>
   
               <table>
  
  
  
  1.9       +10 -4     jakarta-commons-sandbox/vfs/xdocs/todo.xml
  
  Index: todo.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/todo.xml,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- todo.xml	27 Feb 2003 01:38:18 -0000	1.8
  +++ todo.xml	17 Mar 2003 09:07:11 -0000	1.9
  @@ -16,13 +16,14 @@
   
               <ul>
                   <li>More documentation (status, file naming etc).</li>
  -                <li>Fix all the todo items in the code.</li>
  +                <li>Fix the <a href="task-list.html">TODO items</a> in
the code.</li>
                   <li>Add more providers:
                       <ul>
                           <li>nfs</li>
                           <li>tar</li>
                           <li>gzip</li>
                           <li>bzip2</li>
  +                        <li>rsync</li>
                           <li>ClassLoader resources</li>
                           <li>cvs</li>
                           <li>subversion</li>
  @@ -31,6 +32,7 @@
                           <li>jndi</li>
                           <li>imap</li>
                           <li>local mirror</li>
  +                        <li>spidering http</li>
                           <li>...</li>
                       </ul>
                   </li>
  @@ -62,7 +64,8 @@
                   </li>
                   <li>FTP Provider:
                       <ul>
  -                        <li>Support last-modified.</li>
  +                        <li>Fix set last-modified.</li>
  +                        <li>Support passive mode.</li>
                       </ul>
                   </li>
                   <li>SMB Provider:
  @@ -133,6 +136,10 @@
                   <li>Get/set the file permissions.</li>
                   <li>Sort out threading model.</li>
                   <li>Automatically checksum and/or verify remote files.</li>
  +                <li>
  +                    Use remote copies and moves for those file systems that
  +                    support it.
  +                </li>
                   <li>Add a file monitor, that watches for external changes to files.</li>
                   <li>Add a DefaultFileSystemManager subclass that is an Avalon component.</li>
                   <li>
  @@ -144,5 +151,4 @@
               </ul>
           </section>
       </body>
  -</document>
  -
  +</document>
  \ No newline at end of file
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message