You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ad...@apache.org on 2003/01/21 03:46:13 UTC
cvs commit: jakarta-commons-sandbox/vfs/xdocs download.xml index.xml navigation.xml

adammurdoch    2003/01/20 18:46:13

  Modified:    vfs/xdocs download.xml index.xml navigation.xml
  Log:
  Added details of how to download and build VFS.
  
  Revision  Changes    Path
  1.3       +68 -2     jakarta-commons-sandbox/vfs/xdocs/download.xml
  
  Index: download.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/download.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- download.xml	20 Nov 2002 23:52:38 -0000	1.2
  +++ download.xml	21 Jan 2003 02:46:13 -0000	1.3
  @@ -6,11 +6,77 @@
       </properties>
   
       <body>
  +        <section name="Building VFS">
  +            <p>
  +                Firstly, you will need to check the VFS source out of CVS, as
  +                described on the
  +                <a href="cvs-usage.html">Source Repository</a> page.
  +            </p>
  +            <p>
  +                To build VFS, you can use either
  +                <a href="http://ant.apache.org">Ant</a> or
  +                <a href="http://jakarta.apache.org/turbine/maven">Maven</a>.
  +            </p>
  +            <p>
  +                To build using Ant, you will need Ant 1.5 or later.  Use the
  +                <code>build.xml</code> file in the root source directory.
  +                The default target downloads the dependencies used to build
  +                VFS, and then builds the VFS jar file into the <code>target</code>
  +                directory.
  +            </p>
  +            <p>
  +                To build using Maven, you will need to use Maven beta 7 or later.
  +                Use the <code>jar</code> goal to download the dependencies,
  +                and build the VFS jar.  Maven builds the jar file into the
  +                <code>target</code> directory.
  +            </p>
  +        </section>
           <section name="Download">
               <p>
  -                Nightly builds of the VFS can be found
  -                <a href="http://gump.covalent.net/jars/latest/commons-vfs/">here</a>.
  +                Nightly builds of VFS are performed as part of the
  +                <a href="http://jakarta.apache.org/gump">gump</a>
  +                nightly builds.
  +                You can download the VFS jar from the
  +                <a href="http://gump.covalent.net/jars/latest/commons-vfs/">latest build</a>.
  +            </p>
  +            <p>
  +                Note that sometimes the gump VFS build does not get run for some
  +                reason.  If that is the case, you can download the VFS jar
  +                from one of the
  +                <a href="http://gump.covalent.net/jars/">archived builds</a>.
  +            </p>
  +            <p>
  +                You will also need to download the jars used by VFS.
  +                These are listed below:
               </p>
  +            <table>
  +                <tr>
  +                    <th>Dependency</th><th>Required For</th>
  +                </tr>
  +                <tr>
  +                    <td>
  +                        Jakarta <a href="http://jakarta.apache.org/commons/logging.html">Commons Logging</a>
  +                        Version 1.0 or later.
  +                    </td>
  +                    <td>All</td>
  +                </tr>
  +                <tr>
  +                    <td>
  +                        <a href="http://jcifs.samba.org/">jCIFS</a> Version 0.7.0 b5 or later.
  +                    </td>
  +                    <td>
  +                        CIFS file system.
  +                    </td>
  +                </tr>
  +                <tr>
  +                    <td>
  +                        Jakarta <a href="http://jakarta.apache.org/commons/sandbox/net/index.html">Commons Net</a>.
  +                    </td>
  +                    <td>
  +                        FTP file system.
  +                    </td>
  +                </tr>
  +            </table>
           </section>
       </body>
   </document>
  
  
  
  1.3       +4 -4      jakarta-commons-sandbox/vfs/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/index.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- index.xml	28 Oct 2002 02:05:30 -0000	1.2
  +++ index.xml	21 Jan 2003 02:46:13 -0000	1.3
  @@ -10,17 +10,17 @@
           <section name="VFS : Virtual File System">
   
               <p>
  -                The VFS component provides a common API for accessing
  +                Commons VFS provides a single API for accessing
                   various different file systems.  It presents a uniform view of
                   the files from various different sources, such as the files on
                   local disk, on an HTTP server, or inside a Zip archive.
               </p>
   
  -            <p>Some of the features of the VFS component are:</p>
  +            <p>Some of the features of Commons VFS are:</p>
               <ul>
  -                <li>A consistent API for accessing files of different types.</li>
  +                <li>A single API for accessing files of different types.</li>
                   <li>Support for numerous <a href="filesystems.html">file system types</a>.</li>
  -                <li>Utilities like a VFS ClassLoader and URLStreamHandlerFactory.</li>
  +                <li>Utilities like a VFS-aware ClassLoader and URLStreamHandlerFactory.</li>
                   <li>A set of VFS <a href="anttasks.html">Ant tasks</a>.</li>
                   <li>More coming soon ...</li>
               </ul>
  
  
  
  1.6       +1 -1      jakarta-commons-sandbox/vfs/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/navigation.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- navigation.xml	20 Nov 2002 23:53:16 -0000	1.5
  +++ navigation.xml	21 Jan 2003 02:46:13 -0000	1.6
  @@ -7,7 +7,7 @@
     <body>
       <menu name="VFS">
         <item name="Overview"                href="/index.html"/>
  -      <item name="Download"                href="/download.html"/>
  +      <item name="Download and Build"      href="/download.html"/>
         <item name="Using the API"           href="/api.html"/>
         <item name="API JavaDocs"            href="/apidocs/org/apache/commons/vfs/package-summary.html"/>
         <item name="File Systems"            href="/filesystems.html"/>
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>