commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From e...@apache.org
Subject svn commit: r1650650 - in /commons/proper/vfs/trunk: core/src/site/xdoc/ core/src/site/xdoc/index.xml examples/src/site/xdoc/index.xml sandbox/src/site/xdoc/ sandbox/src/site/xdoc/index.xml src/site/site.xml
Date Fri, 09 Jan 2015 20:32:03 GMT
Author: ecki
Date: Fri Jan  9 20:32:02 2015
New Revision: 1650650

URL: http://svn.apache.org/r1650650
Log:
site: describe each module, fix example syntax

Added:
    commons/proper/vfs/trunk/core/src/site/xdoc/
    commons/proper/vfs/trunk/core/src/site/xdoc/index.xml
    commons/proper/vfs/trunk/sandbox/src/site/xdoc/
    commons/proper/vfs/trunk/sandbox/src/site/xdoc/index.xml
Modified:
    commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml
    commons/proper/vfs/trunk/src/site/site.xml

Added: commons/proper/vfs/trunk/core/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/site/xdoc/index.xml?rev=1650650&view=auto
==============================================================================
--- commons/proper/vfs/trunk/core/src/site/xdoc/index.xml (added)
+++ commons/proper/vfs/trunk/core/src/site/xdoc/index.xml Fri Jan  9 20:32:02 2015
@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+    <properties>
+        <title>Apache Commons VFS Core</title>
+        <author email="dev@commons.apache.org">Apache Commons Developers</author>
+    </properties>
+
+    <body>
+
+      <section name="About Apache Commons VFS Core">
+        <p>
+          This is the core module containing the Apache Commons VFS API,
+          implementation as well as various
+          <a href="../filesystems.html">file system providers</a>.
+        </p><p>
+          The documentation on how to use the API can be found in the
+          <a href="../api.html">parent module</a>.
+        </p>
+      </section>
+
+    </body>
+</document>

Modified: commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml?rev=1650650&r1=1650649&r2=1650650&view=diff
==============================================================================
--- commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml (original)
+++ commons/proper/vfs/trunk/examples/src/site/xdoc/index.xml Fri Jan  9 20:32:02 2015
@@ -57,34 +57,38 @@
                 <a href="../commons-vfs2/dependencies.html">dependencies</a>
manually. (The commons-collection4
                 dependency is not needed for the VFS Shell as it does not use <code>LRUFilesCache</code>.)
Because
                 of licensing restrictions the sandbox component must be
-                <a href="../commons-vfs2-sandbox/index.html">build locally</a>
and then installed into the repository.
+                <a href="../commons-vfs2-sandbox/index.html">built locally</a>
and then installed into the repository.
             </p>
-        </section>
 
-        <section name="VFS Shell (Linux)">
-<pre>REP=~/.m2/repositroy
+            <subsection name="Starting VFS Shell on Linux/Unix">
+                <source><![CDATA[
+REP=~/.m2/repositroy
 LIB=$REP/commons-logging/commons-logging/1.2/commons-logging-1.2.jar
 LIB=$LIB:$REP/commons-net/commons-net/2.2/commons-net-2.2.jar
 # LIB=$LIB:$REP/org/apache/commons/commons-collections4/4.0/commons-collection-4.0.jar
-LIB=$LIB:$REP/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:%REP%/commons-codec/commons-codec/1.2/commons-codec-1.2.jar
+LIB=$LIB:$REP/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:$REP/commons-codec/commons-codec/1.2/commons-codec-1.2.jar
 LIB=$LIB:$REP/com/jcraft/jsch/0.1.51/jsch-0.1.51.jar
-# LIBS=$LIB:$REP/org/apache/commons/commons-vfs2-sandbox/2.1/commons-vfs2-sandbox-2.1.jar:$REP/jcifs/jcifs/0.8.3/jcifs-0.8.3.jar
+# LIB=$LIB:$REP/org/apache/commons/commons-vfs2-sandbox/2.1/commons-vfs2-sandbox-2.1.jar:$REP/jcifs/jcifs/0.8.3/jcifs-0.8.3.jar
 LIB=$LIB:$REP/org/apache/commons/commons-vfs2-examples/2.1/commons-vfs2-examples-2.1.jar
 LIB=$LIB:$REP/org/apache/commons/commons-vfs2/2.1/commons-vfs2-2.1.jar
-java -cp $LIB org.apache.commons.vfs2.example.Shell</pre>
-        </section>
+java -cp $LIB org.apache.commons.vfs2.example.Shell
+]]></source>
+            </subsection>
 
-        <section name="VFS Shell (Windows)">
-<pre>set REP=%USERPROFILE\.m2\repository
+            <subsection name="Starting VFS Shell on Windows">
+                <source><![CDATA[
+set REP=%USERPROFILE%\.m2\repository
 set LIB=%REP%\commons-logging\commons-logging\1.2\commons-logging-1.2.jar
 set LIB=%LIB%;%REP%\commons-net\commons-net\2.2\commons-net-2.2.jar
 rem # set LIB=%LIB%;%REP%\org\apache\commons\commons-collections4\4.0\commons-collection-4.0.jar
 set LIB=%LIB%;%REP%\commons-httpclient\commons-httpclient\3.1\commons-httpclient-3.1.jar;%REP%\commons-codec\commons-codec\1.2\commons-codec-1.2.jar
 set LIB=%LIB%;%REP%\com\jcraft\jsch\0.1.51\jsch-0.1.51.jar
-rem # set LIBS=%LIB%:%REP%\org\apache\commons\commons-vfs2-sandbox\2.1\commons-vfs2-sandbox-2.1.jar:$REP\jcifs\jcifs\0.8.3\jcifs-0.8.3.jar
-set LIB=%LIB%:%REP%\org\apache\commons\commons-vfs2-examples\2.1\commons-vfs2-examples-2.1.jar
-set LIB=%LIB%:%REP%\org\apache\commons\commons-vfs2\2.1\commons-vfs2-2.1.jar
-java -cp %LIB% org.apache.commons.vfs2.example.Shell</pre>
+rem # set LIB=%LIB%;%REP%\org\apache\commons\commons-vfs2-sandbox\2.1\commons-vfs2-sandbox-2.1.jar;%REP%\jcifs\jcifs\0.8.3\jcifs-0.8.3.jar
+set LIB=%LIB%;%REP%\org\apache\commons\commons-vfs2-examples\2.1\commons-vfs2-examples-2.1.jar
+set LIB=%LIB%;%REP%\org\apache\commons\commons-vfs2\2.1\commons-vfs2-2.1.jar
+java -cp %LIB% org.apache.commons.vfs2.example.Shell
+]]></source>
+            </subsection>
         </section>
 
     </body>

Added: commons/proper/vfs/trunk/sandbox/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/sandbox/src/site/xdoc/index.xml?rev=1650650&view=auto
==============================================================================
--- commons/proper/vfs/trunk/sandbox/src/site/xdoc/index.xml (added)
+++ commons/proper/vfs/trunk/sandbox/src/site/xdoc/index.xml Fri Jan  9 20:32:02 2015
@@ -0,0 +1,47 @@
+<?xml version="1.0"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+    <properties>
+        <title>Apache Commons VFS Sandbox</title>
+        <author email="dev@commons.apache.org">Apache Commons Developers</author>
+    </properties>
+
+    <body>
+
+      <section name="About Apache Commons VFS Sandbox">
+        <p>
+          This sandbox module contains VFS packages (<a href="../filesystems.html">filesystem
+          providers</a>) which cannot be shipped with the official Apache release.
+          This includes experimental code as well as components which have 
+          <a href="dependencies.html">dependencies</a> not compatible with the

+          <a href="http://www.apache.org/legal/resolved.html#category-x">ASF redistribution
policy
+          (especially LGPL)</a>.
+        </p><p>
+          To build the sandbox binaries, see the <a href="../download.html">download
and build
+          instructions</a>.
+          Make sure to enable the sandbox maven profile with <code>-Pinclude-sandbox</code>.
+          If you use <code>mvn install</code> the sandbox binary archive can
be used from
+          the local repository. If you are not using the released source archive, you may
have
+          to adjust the parent-version and version-numbers if you want to avoid SNAPSHOT
+          artifacts.
+        </p>
+      </section>
+
+    </body>
+</document>

Modified: commons/proper/vfs/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/src/site/site.xml?rev=1650650&r1=1650649&r2=1650650&view=diff
==============================================================================
--- commons/proper/vfs/trunk/src/site/site.xml (original)
+++ commons/proper/vfs/trunk/src/site/site.xml Fri Jan  9 20:32:02 2015
@@ -15,7 +15,7 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -->
-<project name="Commons&#xA0;VFS">
+<project name="Apache&#xA0;Commons&#xA0;VFS">
 
   <bannerRight>
     <name>Commons&#xA0;VFS</name>
@@ -42,7 +42,7 @@
       <item name="Source Repository"       href="/source-repository.html"/>
     </menu>
 
-    <menu name="VFS Components" inherit="top">
+    <menu name="VFS Modules" inherit="top">
       <item name="Core" href="commons-vfs2/index.html"/>
       <item name="Examples" href="commons-vfs2-examples/index.html"/>
       <item name="Sandbox" href="commons-vfs2-sandbox/index.html"/>



Mime
View raw message