commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nia...@apache.org
Subject svn commit: r1004394 - in /commons/proper/io/trunk/src/site: site.xml xdoc/building.xml xdoc/download_io.xml xdoc/index.xml xdoc/upgradeto2_0.xml
Date Mon, 04 Oct 2010 20:19:40 GMT
Author: niallp
Date: Mon Oct  4 20:19:39 2010
New Revision: 1004394

URL: http://svn.apache.org/viewvc?rev=1004394&view=rev
Log:
Preparation for 2.0 release

Added:
    commons/proper/io/trunk/src/site/xdoc/upgradeto2_0.xml   (with props)
Modified:
    commons/proper/io/trunk/src/site/site.xml
    commons/proper/io/trunk/src/site/xdoc/building.xml
    commons/proper/io/trunk/src/site/xdoc/download_io.xml
    commons/proper/io/trunk/src/site/xdoc/index.xml

Modified: commons/proper/io/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/site/site.xml?rev=1004394&r1=1004393&r2=1004394&view=diff
==============================================================================
--- commons/proper/io/trunk/src/site/site.xml (original)
+++ commons/proper/io/trunk/src/site/site.xml Mon Oct  4 20:19:39 2010
@@ -28,7 +28,8 @@
             <item name="Download"                 href="http://commons.apache.org/io/download_io.cgi"/>
             <item name="User guide"               href="/description.html"/>
             <item name="Best practices"           href="/bestpractices.html"/>
-            <item name="Javadoc (latest release)" href="api-release/index.html"/>
+            <item name="Javadoc (2.0)"            href="api-release/index.html"/>
+            <item name="Javadoc (1.4)"            href="api-1.4/index.html"/>
         </menu>
 
         <menu name="Development">

Modified: commons/proper/io/trunk/src/site/xdoc/building.xml
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/site/xdoc/building.xml?rev=1004394&r1=1004393&r2=1004394&view=diff
==============================================================================
--- commons/proper/io/trunk/src/site/xdoc/building.xml (original)
+++ commons/proper/io/trunk/src/site/xdoc/building.xml Mon Oct  4 20:19:39 2010
@@ -24,19 +24,15 @@ limitations under the License.
 <!-- ================================================== -->
 <section name="Overview">
 <p>
-  Commons IO uses <a href="http://maven.apache.org/maven-1.x/">Maven 1</a>,
-  <a href="http://maven.apache.org">Maven 2</a> or
+  Commons IO uses <a href="http://maven.apache.org">Maven 2+</a> or
   <a href="http://ant.apache.org">Ant</a> as a build system.
 </p>
 <p>
-  IO 1.4 requires a minimum of JDK 1.4 to build. However all but four
-  new implementations are JDK 1.3 compatible (by the <code>source</code> and
-  <code>target</code> compiler options being set to <code>1.3</code>)
and
-  the <i>ant</i> build excludes those new JDK 1.4 implementations, if the
-  JDK is version 1.3.
+  IO 2.0 requires a minimum of JDK 1.5 to build.
 </p>
 <p>
   You may also be interested in the upgrade notes:<br />
+  Upgrade <a href="upgradeto2_0.html">from 1.4 to 2.0</a><br />
   Upgrade <a href="upgradeto1_4.html">from 1.3.2 to 1.4</a><br />
   Upgrade <a href="upgradeto1_3_2.html">from 1.3, or 1.3.1 to 1.3.2</a><br
/>
   Upgrade <a href="upgradeto1_3_1.html">from 1.3 to 1.3.1</a><br />
@@ -47,28 +43,14 @@ limitations under the License.
 </section>
 <section name="Maven 2 Goals">
   <p>
-    The following <strong><i>Maven 2</i></strong> commands can be
used to build io:
+    The following <a href="http://maven.apache.org">Maven</a> commands can be
used to build io:
   </p>
   <ul>
     <li><code>mvn clean</code> - clean up</li>
     <li><code>mvn test</code> - compile and run the unit tests</li>
     <li><code>mvn site</code> - create io documentation</li>
     <li><code>mvn package</code> - build the jar</li>
-    <li><code>mvn install</code> - build the jar and install in local maven
repository</li>
-    <li><code>mvn site assembly:assembly</code> - Create the source and
binary distributions</li>
-  </ul>
-</section>
-<!-- ================================================== -->
-<section name="Maven 1 Goals">
-  <p>
-    The following <strong><i>Maven 1</i></strong> commands can be
used to build io:
-  </p>
-  <ul>
-    <li><code>maven clean</code> - clean up</li>
-    <li><code>maven test</code> - compile and run the unit tests</li>
-    <li><code>maven site</code> - create io documentation</li>
-    <li><code>maven jar</code> - build the jar</li>
-    <li><code>maven dist</code> - Create the source and binary distributions</li>
+    <li><code>mvn package -Prc</code> - Create the source and binary distributions</li>
   </ul>
 </section>
 <!-- ================================================== -->
@@ -76,14 +58,12 @@ limitations under the License.
   <p>
     <strong>Note:</strong>
     <ul>
-        <li>The Ant build is JDK dependent. Building with JDK 1.3 excludes
-            JDK 1.4 dependent classes.</li>
         <li>Dependencies are automatically downloaded if not specified explicitly in
             a <code>build.properties</code> file.</li>
     </ul>
   </p>
   <p>
-    The following <strong><i>Ant</i></strong> commands can be used
to build io:
+    The following <a href="http://ant.apache.org">Ant</a> commands can be used
to build io:
   </p>
   <ul>
     <li><code>ant clean</code> - clean up</li>

Modified: commons/proper/io/trunk/src/site/xdoc/download_io.xml
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/site/xdoc/download_io.xml?rev=1004394&r1=1004393&r2=1004394&view=diff
==============================================================================
--- commons/proper/io/trunk/src/site/xdoc/download_io.xml (original)
+++ commons/proper/io/trunk/src/site/xdoc/download_io.xml Mon Oct  4 20:19:39 2010
@@ -95,7 +95,37 @@ limitations under the License.
       </p>
     </subsection>
     </section>
-    <section name="Commons IO 1.4 ">
+    <section name="Commons IO 2.0 (requires JDK 1.5+)">
+      <subsection name="Binaries">
+        <table>
+          <tr>
+              <td><a href="[preferred]/commons/io/binaries/commons-io-2.0-bin.tar.gz">commons-io-2.0-bin.tar.gz</a></td>
+              <td><a href="http://www.apache.org/dist/commons/io/binaries/commons-io-2.0-bin.tar.gz.md5">md5</a></td>
+              <td><a href="http://www.apache.org/dist/commons/io/binaries/commons-io-2.0-bin.tar.gz.asc">pgp</a></td>
+          </tr>
+          <tr>
+              <td><a href="[preferred]/commons/io/binaries/commons-io-2.0-bin.zip">commons-io-2.0-bin.zip</a></td>
+              <td><a href="http://www.apache.org/dist/commons/io/binaries/commons-io-2.0-bin.zip.md5">md5</a></td>
+              <td><a href="http://www.apache.org/dist/commons/io/binaries/commons-io-2.0-bin.zip.asc">pgp</a></td>
+          </tr>
+        </table>
+      </subsection>
+      <subsection name="Source">
+        <table>
+          <tr>
+              <td><a href="[preferred]/commons/io/source/commons-io-2.0-src.tar.gz">commons-io-2.0-src.tar.gz</a></td>
+              <td><a href="http://www.apache.org/dist/commons/io/source/commons-io-2.0-src.tar.gz.md5">md5</a></td>
+              <td><a href="http://www.apache.org/dist/commons/io/source/commons-io-2.0-src.tar.gz.asc">pgp</a></td>
+          </tr>
+          <tr>
+              <td><a href="[preferred]/commons/io/source/commons-io-2.0-src.zip">commons-io-2.0-src.zip</a></td>
+              <td><a href="http://www.apache.org/dist/commons/io/source/commons-io-2.0-src.zip.md5">md5</a></td>
+              <td><a href="http://www.apache.org/dist/commons/io/source/commons-io-2.0-src.zip.asc">pgp</a></td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+    <section name="Commons IO 1.4 (requires JDK 1.3+)">
       <subsection name="Binaries">
         <table>
           <tr>

Modified: commons/proper/io/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/site/xdoc/index.xml?rev=1004394&r1=1004393&r2=1004394&view=diff
==============================================================================
--- commons/proper/io/trunk/src/site/xdoc/index.xml (original)
+++ commons/proper/io/trunk/src/site/xdoc/index.xml Mon Oct  4 20:19:39 2010
@@ -27,50 +27,62 @@ limitations under the License.
 Commons IO is a library of utilities to assist with developing IO functionality.
 </p>
 <p>
-There are four main areas included:
+There are six main areas included:
 <ul>
-<li>Utility classes - with static methods to perform common tasks</li>
-<li>Filters - various implementations of file filters</li>
-<li>Comparators - various implementations of <code>java.util.Comparator</code>
for files</li>
-<li>Streams - useful stream, reader and writer implementations</li>
+<li><a href="api-release/index.html?org/apache/commons/io/package-summary.html">Utility
classes</a>
+   - with static methods to perform common tasks</li>
+<li><a href="api-release/index.html?org/apache/commons/io/input/package-summary.html">Input</a>
+   - useful Input Stream and Reader implementations</li>
+<li><a href="api-release/index.html?org/apache/commons/io/output/package-summary.html">Output</a>
+   - useful Output Stream and Writer implementations</li>
+<li><a href="api-release/index.html?org/apache/commons/io/filefilter/package-summary.html">Filters</a>
+   - various implementations of file filters</li>
+<li><a href="api-release/index.html?org/apache/commons/io/comparator/package-summary.html">Comparators</a>
+   - various implementations of <code>java.util.Comparator</code> for files</li>
+<li><a href="api-release/index.html?org/apache/commons/io/monitor/package-summary.html">File
Monitor</a>
+   - a component for monitoring file system events</li>
 </ul>
 </p>
 </section>
 <!-- ================================================== -->
-<section name="Documentation">
+<section name="Releases">
+
+<subsection name="Commons IO 2.0 (requires JDK 1.5+)">
 <p>
-A getting started <a href="description.html">user guide</a> is available,
-as are some IO <a href="bestpractices.html">best practices</a>
-and various <a href="project-reports.html">project reports</a>.
-</p>
+Commons IO 2.0 is the latest version and requires a minimum of JDK 1.5 -
+<a href="http://commons.apache.org/io/download_io.cgi">Download now!</a>
+</p> 
+<p>
+View the <a href="upgradeto2_0.html">Release Notes</a> and
+<a href="api-release/index.html">JavaDoc API documents</a>
+</p> 
+</subsection>
+
+<subsection name="Commons IO 1.4  (requires JDK 1.3+)">
 <p>
+Commons IO 1.4 requires a minimum of JDK 1.3 - 
+<a href="http://commons.apache.org/io/download_io.cgi">Download now!</a>
+</p> 
+<p>
+View the <a href="upgradeto1_4.html">Release Notes</a> and
+<a href="api-1.4/index.html">JavaDoc API documents</a>
+</p> 
+</subsection>
+
+<subsection name="Older Releases">
+<p>
+For previous releases, see the <a href="http://archive.apache.org/dist/commons/io/">Apache
Archive</a>.
 The JavaDoc API documents are available online:
-</p>
+</p> 
 <ul>
-<li>The <a href="api-release/index.html">current release 1.4</a></li>
-<li>The <a href="api-1.3.2/index.html">previous version 1.3.2</a></li>
-<li>The <a href="api-1.3.1/index.html">previous version 1.3.1</a></li>
-<li>The <a href="api-1.3/index.html">previous version 1.3</a></li>
-<li>The <a href="api-1.2/index.html">previous version 1.2</a></li>
-<li>The <a href="api-1.1/index.html">previous version 1.1</a></li>
-<li>The <a href="apidocs/index.html">latest SVN</a></li>
+<li>The <a href="api-1.3.2/index.html">1.3.2 JavaDoc</a></li>
+<li>The <a href="api-1.3.1/index.html">1.3.1 JavaDoc</a></li>
+<li>The <a href="api-1.3/index.html">1.3 JavaDoc</a></li>
+<li>The <a href="api-1.2/index.html">1.2 JavaDoc</a></li>
+<li>The <a href="api-1.1/index.html">1.1 JavaDoc</a></li>
 </ul>
-<p>
-The <a href="source-repository.html">subversion repository</a> can be
-<a href="http://svn.apache.org/viewvc/commons/proper/io/trunk/">browsed</a>.
-</p>
-</section>
-<!-- ================================================== -->
-<section name="Releases">
-<p>
-The latest version is v1.4. - 
-<a href="http://commons.apache.org/io/download_io.cgi">Download now!</a><br
/>
-The <a href="upgradeto1_4.html">upgrade notes</a> are also available.
+</subsection>
 
-</p>
-<p>
-For previous releases, see the <a href="http://archive.apache.org/dist/commons/io/">Apache
Archive</a>
-</p>
 </section>
 <!-- ================================================== -->
 <section name="Support">

Added: commons/proper/io/trunk/src/site/xdoc/upgradeto2_0.xml
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/site/xdoc/upgradeto2_0.xml?rev=1004394&view=auto
==============================================================================
--- commons/proper/io/trunk/src/site/xdoc/upgradeto2_0.xml (added)
+++ commons/proper/io/trunk/src/site/xdoc/upgradeto2_0.xml Mon Oct  4 20:19:39 2010
@@ -0,0 +1,157 @@
+<?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>Upgrade from 1.4 to 2.0</title>
+  <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+<body>
+
+<section name="Upgrade">
+<p>
+These are the release notes and advice for upgrading Commons-IO from
+version 1.4 to version 2.0.
+<source>
+Commons IO is a package of Java utility classes for java.io's hierarchy.  
+Classes in this package are considered to be so standard and of such high 
+reuse as to justify existence in java.io.
+
+Commons IO contains utility classes, stream implementations, file filters, 
+file comparators and endian transformation classes.
+
+
+Compatibility with 1.4
+----------------------
+Binary compatible - Yes
+
+Source compatible - Yes
+
+Semantic compatible - Yes
+  Check the bug fixes section for semantic bug fixes
+
+Commons IO 2.0 requires a minimum of JDK 1.5
+ (Commons IO 1.4 had a minimum of JDK 1.3) 
+
+
+Deprecations from 1.4
+---------------------
+
+- IOUtils
+  - write(StringBuffer, Writer) in favour of write(CharSequence, Writer)
+  - write(StringBuffer, OutputStream)  in favour of write(CharSequence, OutputStream)
+  - write(StringBuffer, OutputStream, String) in favour of write(CharSequence, OutputStream,
String)
+
+- FileFilterUtils
+  - andFileFilter(IOFileFilter, IOFileFilter) in favour of and(IOFileFilter...) 
+  - orFileFilter(IOFileFilter, IOFileFilter)  in favour of or(IOFileFilter...)
+
+
+Enhancements from 1.4
+---------------------
+
+  * [IO-140] Move minimum Java requirement from JDK 1.3 to JDK 1.5
+             - use Generics
+             - add new CharSequence write() flavour methods to IOUtils and FileUtils
+             - replace StringBuffer with StringBuilder, where appropriate
+             - add new Reader/Writer methods to ProxyReader and ProxyWriter
+             - Annotate with @Override and @Deprecated
+
+  * [IO-178] New BOMInputStream and ByteOrderMark implementations - to detect and optionally
exclude an initial Byte Order mark (BOM)
+  * [IO-197] New BoundedInputStream (copied from from Apache JackRabbit)
+  * [IO-193] New Broken Input and Output streams
+  * [IO-132] New File Listener/Monitor facility
+  * [IO-158] New ReaderInputStream and WriterOutputStream implementations
+  * [IO-139] New StringBuilder Writer implementation
+  * [IO-192] New Tagged Input and Output streams
+  * [IO-177] New Tailer class - simple implementation of the Unix "tail -f" functionality
+  * [IO-162] New XML Stream Reader/Writer implementations (from ROME via plexus-utils)
+
+  * [IO-142] Comparators - add facility to sort file lists/arrays
+  * [IO-186] Comparators - new Composite and Directory File Comparator implementations
+  * [IO-176] DirectoryWalker - add filterDirectoryContents() callback method for filtering
directory contents
+  * [IO-210] FileFilter - new Magic Number FileFilter
+  * [IO-221] FileFilterUtils - add methods for suffix and prefix filters which take an IOCase
object
+  * [IO-232] FileFilterUtils - add method for name filters which take an IOCase object
+  * [IO-229] FileFilterUtils - add varargs and() and or() methods
+  * [IO-198] FileFilterUtils - add ability to apply file filters to collections and arrays
+  * [IO-156] FilenameUtils - add normalize() and normalizeNoEndSeparator() methods which
allow the separator character to be specified
+  * [IO-194] FileSystemUtils - add freeSpaceKb() method with no input arguments
+  * [IO-185] FileSystemUtils - add freeSpaceKb() methods that take a timeout parameter -
fixes freeSpaceWindows() blocks
+  * [IO-155] FileUtils - use NIO to copy files
+  * [IO-168] FileUtils - add new isSymlink() method
+  * [IO-219] FileUtils - throw FileExistsException when moving a file or directory if the
destination already exists
+  * [IO-234] FileUtils - add Methods for retrieving System User/Temp directories/paths
+  * [IO-208] FileUtils - add timeout (connection and read) support for copyURLToFile() method

+  * [IO-238] FileUtils - add sizeOf(File) method
+  * [IO-181] LineIterator now implements Iterable
+  * [IO-224] IOUtils - add closeQuietly(Closeable) and closeQuietly(Socket) methods
+  * [IO-203] IOUtils - add skipFully() method for InputStreams
+  * [IO-137] IOUtils and ByteArrayOutputStream - add toBufferedInputStream() method to avoid
unnecessary array allocation/copy
+  * [IO-195] Proxy streams/Reader/Writer - provide exception handling methods
+  * [IO-211] Proxy Input/Output streams - add pre/post processing support
+  * [IO-242] Proxy Reader/Writer - add pre/post processing support
+
+
+Bug fixes from 1.4
+------------------
+  * [IO-214] ByteArrayOutputStream - fix inconsistent synchronization of fields
+  * [IO-201] Counting Input/Output streams - fix inconsistent synchronization
+  * [IO-159] FileCleaningTracker - fix remove() never returns null
+  * [IO-220] FileCleaningTracker - fix Vector performs badly under load
+  * [IO-167] FilenameUtils - fix case-insensitive string handling in FilenameUtils and FilesystemUtils
+  * [IO-179] FilenameUtils - fix StringIndexOutOfBounds exception in getPathNoEndSeparator()
+  * [IO-248] FilenameUtils - fix getFullPathNoEndSeparator() returns empty while path is
a one level directory
+  * [IO-246] FilenameUtils - fix wildcardMatch gives incorrect results 
+  * [IO-187] FileSystemUtils - fix freeSpaceKb() doesn't work with relative paths on Linux
+  * [IO-160] FileSystemUtils - fix freeSpace() fails on solaris
+  * [IO-209] FileSystemUtils - fix freeSpaceKb() fails to return correct size for a windows
mount point
+  * [IO-163] FileUtils - fix toURLs() using deprecated method of conversion to URL
+  * [IO-168] FileUtils - fix Symbolic links followed when deleting directory
+  * [IO-231] FileUtils - fix wrong exception message generated in isFileNewer() method
+  * [IO-207] FileUtils - fix race condition in forceMkdir() method
+  * [IO-217] FileUtils - fix copyDirectoryToDirectory() makes infinite loops
+  * [IO-166] FileUtils - fix URL decoding in toFile(URL
+  * [IO-190] FileUtils - fix copyDirectory not preserving lastmodified date on sub-directories
+  * [IO-240] FileFilterUtils - ensure cvsFilter and svnFilter are only created once.
+  * [IO-175] IOUtils - fix copyFile() issues with very large files
+  * [IO-191] Improvements from static analysis
+  * [IO-216] LockableFileWriter - delete files quietly when an exception is thrown during
initialization
+  * [IO-243] SwappedDataInputStream readBoolean is inverted
+  * [IO-235] Tests - remove unused YellOnFlushAndCloseOutputStream from CopyUtilsTest
+  * [IO-161] Tests - fix FileCleaningTrackerTestCase hanging
+
+
+Documentation changes from 1.4
+------------------------------
+  * [IO-183 FilenameUtils.getExtension() method documentation improvements
+  * [IO-226 FileUtils.byteCountToDisplaySize() documentation corrections
+  * [IO-205 FileUtils.forceMkdir() documentation improvements
+  * [IO-215 FileUtils copy file/directory improve documentation regarding preserving the
last modified date
+  * [IO-189 HexDump.dump() method documentation improvements
+  * [IO-171 IOCase document that it assumes there are only two OSes: Windows and Unix
+  * [IO-223 IOUtils.copy() documentation corrections
+  * [IO-247 IOUtils.closeQuietly() improve documentation with examples
+  * [IO-202 NotFileFilter documentation corrections
+  * [IO-206 ProxyInputStream - fix misleading parameter names
+  * [IO-212 ProxyInputStream.skip() documentation corrections
+</source>
+</p>
+</section>
+
+</body>
+</document>

Propchange: commons/proper/io/trunk/src/site/xdoc/upgradeto2_0.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: commons/proper/io/trunk/src/site/xdoc/upgradeto2_0.xml
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL



Mime
View raw message