You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by br...@apache.org on 2017/09/30 14:34:52 UTC
[4/5] commons-io git commit: Update site for Release 2.6
Update site for Release 2.6
Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/192771d7
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/192771d7
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/192771d7
Branch: refs/heads/release
Commit: 192771d7ed40acf4259e9e80d72bf99301787097
Parents: 3075f1d
Author: Benedikt Ritter <br...@apache.org>
Authored: Sat Sep 30 16:31:30 2017 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Sat Sep 30 16:33:00 2017 +0200
----------------------------------------------------------------------
src/changes/changes.xml | 2 +-
src/site/site.xml | 3 +
src/site/xdoc/index.xml | 35 ++++++--
src/site/xdoc/upgradeto2_6.xml | 156 ++++++++++++++++++++++++++++++++++++
4 files changed, 189 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-io/blob/192771d7/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index a1d39a7..00dc1c6 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -46,7 +46,7 @@ The <action> type attribute can be add,update,fix,remove.
<body>
<!-- The release date is the date RC is cut -->
- <release version="2.6" date="2017-MM-DD" description="New features and bug fixes.">
+ <release version="2.6" date="2017-09-30" description="Java 7 required, Java 9 supported.">
<action issue="IO-551" dev="britter" type="add">
Add Automatic-Module-Name MANIFEST entry for Java 9 compatibility
</action>
http://git-wip-us.apache.org/repos/asf/commons-io/blob/192771d7/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index 8ac3aee..3c92886 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -28,7 +28,10 @@
<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 2.6" href="/javadocs/api-release/index.html"/>
+ <item name="Javadoc 2.5" href="/javadocs/api-2.5/index.html"/>
<item name="Javadoc 2.4" href="/javadocs/api-2.4/index.html"/>
+ <item name="Javadoc 2.3" href="/javadocs/api-2.3/index.html"/>
<item name="Javadoc 2.2" href="/javadocs/api-2.2/index.html"/>
<item name="Javadoc 1.4" href="/javadocs/api-1.4/index.html"/>
</menu>
http://git-wip-us.apache.org/repos/asf/commons-io/blob/192771d7/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 7a1f160..e4dfc1a 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -47,29 +47,52 @@ There are six main areas included:
<!-- ================================================== -->
<section name="Releases">
- <subsection name="Commons IO 2.5 (requires JDK 1.6+)">
+ <subsection name="Commons IO 2.6 (requires JDK 1.7+)">
<p>
- Commons IO 2.5 is the latest version and requires a minimum of JDK 1.6 -
+ Commons IO 2.6 is the latest version and requires a minimum of JDK 1.7 -
<a href="http://commons.apache.org/io/download_io.cgi">Download now!</a>
</p>
<p>
View the
- <a href="upgradeto2_5.html">Release Notes</a>
+ <a href="upgradeto2_6.html">Release Notes</a>
and
<a href="javadocs/api-release/index.html">JavaDoc API documents</a>
</p>
</subsection>
+ <subsection name="Commons IO 2.5 (requires JDK 1.6+)">
+ <p>
+ Commons IO 2.5 requires a minimum of JDK 1.6 -
+ <a href="http://commons.apache.org/io/download_io.cgi">Download now!</a>
+ </p>
+ <p>
+ View the
+ <a href="upgradeto2_5.html">Release Notes</a>
+ and
+ <a href="javadocs/api-2.5/index.html">JavaDoc API documents</a>
+ </p>
+ </subsection>
<subsection name="Commons IO 2.4 (requires JDK 1.6+)">
<p>
Commons IO 2.4 requires a minimum of JDK 1.6 -
<a href="http://commons.apache.org/io/download_io.cgi">Download now!</a>
-</p>
+</p>
<p>
View the <a href="upgradeto2_4.html">Release Notes</a> and
-<a href="javadocs/api-release/index.html">JavaDoc API documents</a>
-</p>
+<a href="javadocs/api-2.4/index.html">JavaDoc API documents</a>
+</p>
+</subsection>
+
+ <subsection name="Commons IO 2.3 (requires JDK 1.6+)">
+<p>
+ Commons IO 2.3 requires a minimum of JDK 1.6 -
+<a href="http://commons.apache.org/io/download_io.cgi">Download now!</a>
+</p>
+<p>
+View the <a href="upgradeto2_3.html">Release Notes</a> and
+<a href="javadocs/api-2.3/index.html">JavaDoc API documents</a>
+</p>
</subsection>
<subsection name="Commons IO 2.2 (requires JDK 1.5+)">
http://git-wip-us.apache.org/repos/asf/commons-io/blob/192771d7/src/site/xdoc/upgradeto2_6.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/upgradeto2_6.xml b/src/site/xdoc/upgradeto2_6.xml
new file mode 100644
index 0000000..d2ef300
--- /dev/null
+++ b/src/site/xdoc/upgradeto2_6.xml
@@ -0,0 +1,156 @@
+<?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 2.5 to 2.6</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 Apache Commons IO from
+ version 2.5 to version 2.6
+ <source>
+ Apache Commons IO is a package of Java utility classes like java.io.
+ Classes in this package are considered to be so standard and of such high
+ reuse as to justify existence in java.io.
+
+ The Apache Commons IO library contains utility classes, stream implementations,
+ file filters, file comparators, endian transformation classes, and much more.
+
+ Apache Commons IO 2.6 requires at least Java 7 to build and run.
+
+
+ DEPRECATIONS
+ ============
+
+ All closeQuietly overloads in org.apache.commons.io.IOUtils have been
+ deprecated. Use the try-with-resources statement or handle suppressed
+ exceptions manually.
+
+ The class org.apache.commons.io.FileSystemUtils has been deprecated.
+ Use equivalent methods in java.nio.file.FileStore instead, e.g.
+ Files.getFileStore(Paths.get("/home")).getUsableSpace() or iterate over
+ FileSystems.getDefault().getFileStores().
+
+
+ COMPATIBILITY WITH JAVA 9
+ ==================
+
+ The MANIFEST.MF now contains an additional entry:
+
+ Automatic-Module-Name: org.apache.commons.io
+
+ This should make it possible to use Commons IO 2.6 as a module in the Java 9
+ module system. For more information see the corresponding issue:
+
+ https://issues.apache.org/jira/browse/IO-551
+
+ Building Commons IO 2.6 should work out of the box with the latest Java 9
+ release. Please report any Java 9 related issues at:
+
+ https://issues.apache.org/jira/browse/IO
+
+
+ NEW FEATURES
+ ============
+
+ o IO-551: Add Automatic-Module-Name MANIFEST entry for Java 9 compatibility.
+ o IO-367: Add convenience methods for copyToDirectory. Thanks to James Sawle.
+ o IO-493: Add infinite circular input stream. Thanks to Piotr Turski.
+ o IO-507: Add a ByteOrderUtils class.
+ o IO-518: Add ObservableInputStream.
+ o IO-519: Add MessageDigestCalculatingInputStream.
+ o IO-513: Add convenience methods for reading class path resources.
+ Thanks to Behrang Saeedzadeh.
+
+ FIXED BUGS
+ ==========
+
+ o IO-550: Documentation issue, fix 404 Javadoc issues in the description page.
+ Thanks to Jimi Adrian.
+ o IO-442: Javadoc contradictory for FileFilterUtils.ageFileFilter(cutoff) and
+ the filter it constructs: AgeFileFilter(cutoff).
+ Thanks to Simon Robinson.
+ o IO-534: FileUtilTestCase.testForceDeleteDir() should not delete testDirectory
+ parent.
+ o IO-528: Fix Tailer.run race condition runaway logging. Thanks to Dave Moten.
+ o IO-483: getPrefixLength return -1 if unix file contains colon.
+ Thanks to Marko Vasic.
+ o IO-520: FileUtilsTestCase#testContentEqualsIgnoreEOL fails on Windows.
+ o IO-516: .gitattributes not correctly applied. Thanks to Jason Pyeron.
+ o IO-515: Allow Specifying Initial Buffer Size of DeferredFileOutputStream.
+ Thanks to Brett Lounsbury, Gary Gregory.
+ o IO-512: ThresholdingOutputStream.thresholdReached() results in
+ FileNotFoundException. Thanks to Ralf Hauser.
+ o IO-511: After a few unit tests, a few newly created directories not cleaned
+ completely. Thanks to Ahmet Celik.
+ o IO-502: Exceptions are suppressed incorrectly when copying files.
+ Thanks to Christian Schulte.
+ o IO-503: Update platform requirement to Java 7.
+ o IO-537: BOMInputStream shouldn't sort array of BOMs in-place.
+ Thanks to Borys Zibrov.
+
+ CHANGES
+ =======
+
+ o IO-542: FileUtils#readFileToByteArray: optimize reading of files with known
+ size. Thanks to Ilmars Poikans.
+ o IO-547: Throw a IllegalArgumentException instead of NullPointerException in
+ FileSystemUtils.freeSpaceWindows(). Thanks to Nikhil Shinde,
+ Michael Ernst, Gary Greory.
+ o IO-506: Deprecate methods FileSystemUtils.freeSpaceKb().
+ Thanks to Christian Schulte.
+ o IO-505: Make LineIterator implement Closeable to support try-with-resources
+ statements. Thanks to Christian Schulte.
+ o IO-504: Deprecated of all IOUtils.closeQuietly() methods and use
+ try-with-resources internally. Thanks to Christian Schulte.
+
+ REMOVED
+ =======
+
+ o IO-514: Remove org.apache.commons.io.Java7Support.
+
+ COMPATIBILITY WITH OLDER VERSIONS
+ =================================
+
+ Compatibility with 2.5:
+ Binary compatible: Yes.
+ Source compatible: Yes.
+ Semantic compatible: Yes.
+
+ Compatibility with 2.6 and 1.4:
+ Binary compatible: Yes.
+ Source compatible: No, see the rare case in
+ https://issues.apache.org/jira/browse/IO-318.
+ Semantic compatible: No, see the rare case in
+ https://issues.apache.org/jira/browse/IO-318.
+
+ Commons IO 2.6 requires JDK 1.7 or later.
+ Commons IO 2.5 requires JDK 1.6 or later.
+ Commons IO 2.4 requires JDK 1.6 or later.
+ Commons IO 2.3 requires JDK 1.6 or later.
+ Commons IO 2.2 requires JDK 1.5 or later.
+ Commons IO 1.4 requires JDK 1.3 or later.
+ </source>
+ </p>
+ </section>
+
+ </body>
+</document>