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/10/20 06:24:05 UTC
[1/6] commons-io git commit: Update download page in preparation for
2.6 release
Repository: commons-io
Updated Branches:
refs/heads/master 5f8807995 -> 14a80bc4d
Update download page in preparation for 2.6 release
Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/a246ac80
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/a246ac80
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/a246ac80
Branch: refs/heads/master
Commit: a246ac809581b422fd18b4de086ebf120dd6ae8f
Parents: 5f88079
Author: Benedikt Ritter <br...@apache.org>
Authored: Wed Sep 27 21:57:35 2017 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Sat Oct 14 14:00:44 2017 +0200
----------------------------------------------------------------------
src/site/xdoc/download_io.xml | 60 ++++++++++++++++++++++++--------------
1 file changed, 38 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-io/blob/a246ac80/src/site/xdoc/download_io.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/download_io.xml b/src/site/xdoc/download_io.xml
index bbb2565..b8718d8 100644
--- a/src/site/xdoc/download_io.xml
+++ b/src/site/xdoc/download_io.xml
@@ -31,10 +31,21 @@ limitations under the License.
| 2) Set the following properties in the component's pom: |
| - commons.componentid (required, alphabetic, lower case) |
| - commons.release.version (required) |
- | - commons.binary.suffix (optional) |
+ | - commons.release.name (required) |
+ | - commons.binary.suffix (optional) |
| (defaults to "-bin", set to "" for pre-maven2 releases) |
+ | - commons.release.desc (optional) |
+ | - commons.release.subdir (optional) |
+ | |
+ | - commons.release.2/3.version (conditional) |
+ | - commons.release.2/3.name (conditional) |
+ | - commons.release.2/3.binary.suffix (optional) |
+ | - commons.release.2/3.desc (optional) |
+ | - commons.release.2/3.subdir (optional) |
| |
| 3) Example Properties |
+ | (commons.release.name inherited by parent: |
+ | ${project.artifactId}-${commons.release.version} |
| |
| <properties> |
| <commons.componentid>math</commons.componentid> |
@@ -46,17 +57,17 @@ limitations under the License.
<document>
<properties>
<title>Download Apache Commons IO</title>
- <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
</properties>
<body>
<section name="Download Apache Commons IO">
<subsection name="Using a Mirror">
<p>
We recommend you use a mirror to download our release
- builds, but you <strong>must</strong> verify the integrity of
+ builds, but you <strong>must</strong> <a href="http://www.apache.org/info/verification.html">verify the integrity</a> of
the downloaded files using signatures downloaded from our main
distribution directories. Recent releases (48 hours) may not yet
- be available from the mirrors.
+ be available from all the mirrors.
</p>
<p>
@@ -88,39 +99,44 @@ limitations under the License.
</form>
<p>
- The <a href="http://www.apache.org/dist/commons/KEYS">KEYS</a>
- link links to the code signing keys used to sign the product.
- The <code>PGP</code> link downloads the OpenPGP compatible signature from our main site.
- The <code>MD5</code> link downloads the checksum from the main site.
+ It is essential that you
+ <a href="https://www.apache.org/info/verification.html">verify the integrity</a>
+ of downloaded files, preferably using the <code>PGP</code> signature (<code>*.asc</code> files);
+ failing that using the <code>MD5</code> hash (<code>*.md5</code> checksum files).
+ </p>
+ <p>
+ The <a href="https://www.apache.org/dist/commons/KEYS">KEYS</a>
+ file contains the public PGP keys used by Apache Commons developers
+ to sign releases.
</p>
</subsection>
</section>
- <section name="Apache Commons IO 2.5 (requires JDK 1.6+)">
+ <section name="Apache Commons IO 2.6 (requires JDK 1.7+)">
<subsection name="Binaries">
<table>
<tr>
- <td><a href="[preferred]/commons/io/binaries/commons-io-2.5-bin.tar.gz">commons-io-2.5-bin.tar.gz</a></td>
- <td><a href="http://www.apache.org/dist/commons/io/binaries/commons-io-2.5-bin.tar.gz.md5">md5</a></td>
- <td><a href="http://www.apache.org/dist/commons/io/binaries/commons-io-2.5-bin.tar.gz.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/io/binaries/commons-io-2.6-bin.tar.gz">commons-io-2.6-bin.tar.gz</a></td>
+ <td><a href="https://www.apache.org/dist/commons/io/binaries/commons-io-2.6-bin.tar.gz.md5">md5</a></td>
+ <td><a href="https://www.apache.org/dist/commons/io/binaries/commons-io-2.6-bin.tar.gz.asc">pgp</a></td>
</tr>
<tr>
- <td><a href="[preferred]/commons/io/binaries/commons-io-2.5-bin.zip">commons-io-2.5-bin.zip</a></td>
- <td><a href="http://www.apache.org/dist/commons/io/binaries/commons-io-2.5-bin.zip.md5">md5</a></td>
- <td><a href="http://www.apache.org/dist/commons/io/binaries/commons-io-2.5-bin.zip.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/io/binaries/commons-io-2.6-bin.zip">commons-io-2.6-bin.zip</a></td>
+ <td><a href="https://www.apache.org/dist/commons/io/binaries/commons-io-2.6-bin.zip.md5">md5</a></td>
+ <td><a href="https://www.apache.org/dist/commons/io/binaries/commons-io-2.6-bin.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
- <td><a href="[preferred]/commons/io/source/commons-io-2.5-src.tar.gz">commons-io-2.5-src.tar.gz</a></td>
- <td><a href="http://www.apache.org/dist/commons/io/source/commons-io-2.5-src.tar.gz.md5">md5</a></td>
- <td><a href="http://www.apache.org/dist/commons/io/source/commons-io-2.5-src.tar.gz.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/io/source/commons-io-2.6-src.tar.gz">commons-io-2.6-src.tar.gz</a></td>
+ <td><a href="https://www.apache.org/dist/commons/io/source/commons-io-2.6-src.tar.gz.md5">md5</a></td>
+ <td><a href="https://www.apache.org/dist/commons/io/source/commons-io-2.6-src.tar.gz.asc">pgp</a></td>
</tr>
<tr>
- <td><a href="[preferred]/commons/io/source/commons-io-2.5-src.zip">commons-io-2.5-src.zip</a></td>
- <td><a href="http://www.apache.org/dist/commons/io/source/commons-io-2.5-src.zip.md5">md5</a></td>
- <td><a href="http://www.apache.org/dist/commons/io/source/commons-io-2.5-src.zip.asc">pgp</a></td>
+ <td><a href="[preferred]/commons/io/source/commons-io-2.6-src.zip">commons-io-2.6-src.zip</a></td>
+ <td><a href="https://www.apache.org/dist/commons/io/source/commons-io-2.6-src.zip.md5">md5</a></td>
+ <td><a href="https://www.apache.org/dist/commons/io/source/commons-io-2.6-src.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
@@ -131,7 +147,7 @@ limitations under the License.
</p>
<ul>
<li class="download"><a href="[preferred]/commons/io/">browse download area</a></li>
- <li><a href="http://archive.apache.org/dist/commons/io/">archives...</a></li>
+ <li><a href="https://archive.apache.org/dist/commons/io/">archives...</a></li>
</ul>
</section>
</body>
[3/6] commons-io git commit: Prepare release notes for Commons IO 2.6
Posted by br...@apache.org.
Prepare release notes for Commons IO 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/84a5fcfb
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/84a5fcfb
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/84a5fcfb
Branch: refs/heads/master
Commit: 84a5fcfb48254e1e97a3fc22d30830387476f79c
Parents: a246ac8
Author: Benedikt Ritter <br...@apache.org>
Authored: Sat Sep 30 16:17:35 2017 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Sat Oct 14 14:04:01 2017 +0200
----------------------------------------------------------------------
RELEASE-NOTES.txt | 133 ++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 125 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-io/blob/84a5fcfb/RELEASE-NOTES.txt
----------------------------------------------------------------------
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 5c0b936..db0bffb 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -1,16 +1,133 @@
-
-Apache Commons IO
-Version 2.5
-Release Notes
+ Apache Commons IO
+ Version 2.6
+ Release Notes
INTRODUCTION:
-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
+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.
+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-546: ClosedOutputStream#flush should throw. Thanks to Tomas Celaya.
+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-553: Make code style of hasBOM() consistent with getBOMCharsetName().
+ Thanks to Michael Ernst.
+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.
==============================================================================
Apache Commons IO Version 2.5
[5/6] commons-io git commit: Update version numbers for Commons IO
release 2.6
Posted by br...@apache.org.
Update version numbers for Commons IO 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/2ae025fe
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/2ae025fe
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/2ae025fe
Branch: refs/heads/master
Commit: 2ae025fe5c4a7d2046c53072b0898e37a079fe62
Parents: 651ad03
Author: Benedikt Ritter <br...@apache.org>
Authored: Sat Sep 30 16:33:46 2017 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Sun Oct 15 11:54:18 2017 +0200
----------------------------------------------------------------------
pom.xml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-io/blob/2ae025fe/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index d1dd3e8..754225f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -24,7 +24,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
- <version>2.6-SNAPSHOT</version>
+ <version>2.6</version>
<name>Apache Commons IO</name>
<inceptionYear>2002</inceptionYear>
@@ -52,6 +52,7 @@ file comparators, endian transformation classes, and much more.
<connection>scm:git:http://git-wip-us.apache.org/repos/asf/commons-io.git</connection>
<developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/commons-io.git</developerConnection>
<url>https://git-wip-us.apache.org/repos/asf?p=commons-io.git</url>
+ <tag>commons-io-2.6</tag>
</scm>
<developers>
[2/6] commons-io git commit: Update auto generated files
Posted by br...@apache.org.
Update auto generated files
Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/78fc6c76
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/78fc6c76
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/78fc6c76
Branch: refs/heads/master
Commit: 78fc6c76d47aebb97ca625eb8f3f71be9176111d
Parents: 84a5fcf
Author: Benedikt Ritter <br...@apache.org>
Authored: Sat Sep 30 16:19:56 2017 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Sat Oct 14 14:04:01 2017 +0200
----------------------------------------------------------------------
CONTRIBUTING.md | 40 +++++++++++++++++++++++++----------
README.md | 22 +++++++++++--------
src/site/xdoc/issue-tracking.xml | 30 +++++++++++++-------------
3 files changed, 57 insertions(+), 35 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-io/blob/78fc6c76/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 11e9dd7..bd76d94 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -51,47 +51,65 @@ Getting Started
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
+ If you're planning to implement a new feature it makes sense to discuss you're changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons IO's scope.
-+ Submit a ticket for your issue, assuming one does not already exist.
++ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
+ Clearly describe the issue including steps to reproduce when it is a bug.
+ Make sure you fill in the earliest version that you know has the issue.
-+ Fork the repository on GitHub.
++ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-),
+[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository.
Making Changes
--------------
-+ Create a topic branch from where you want to base your work (this is usually the master/trunk branch).
++ Create a _topic branch_ for your isolated work.
+ * Usually you should base your branch on the `master` or `trunk` branch.
+ * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `IO-123-InputStream`.
+ * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
+ Make commits of logical units.
+ * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
+ * e.g. `IO-123: Close input stream earlier`
+ Respect the original code style:
+ Only use spaces for indentation.
- + Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
- + Check for unnecessary whitespace with git diff --check before committing.
-+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
-+ Make sure you have added the necessary tests for your changes.
+ + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first.
+ + Check for unnecessary whitespace with `git diff` -- check before committing.
++ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
Making Trivial Changes
----------------------
+The JIRA tickets are used to generate the changelog for the next release.
+
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.
+
Submitting Changes
------------------
-+ Sign the [Contributor License Agreement][cla] if you haven't already.
++ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already.
+ * Note that small patches & typical bug fixes do not require a CLA as
+ clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions)
+ covers them.
+ Push your changes to a topic branch in your fork of the repository.
-+ Submit a pull request to the repository in the apache organization.
++ Submit a _Pull Request_ to the corresponding repository in the `apache` organization.
+ * Verify _Files Changed_ shows only your intended changes and does not
+ include additional files like `target/*.class`
+ Update your JIRA ticket and include a link to the pull request in the ticket.
+If you prefer to not use GitHub, then you can instead use
+`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue.
+
+
Additional Resources
--------------------
+ [Contributing patches](https://commons.apache.org/patches.html)
-+ [Apache Commons IO JIRA project page](https://issues.apache.org/jira/browse/IO)
++ [Apache Commons IO JIRA project page][jira]
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.net`
[cla]:https://www.apache.org/licenses/#clas
+[jira]:https://issues.apache.org/jira/browse/IO
http://git-wip-us.apache.org/repos/asf/commons-io/blob/78fc6c76/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index fc28d5f..3417ae4 100644
--- a/README.md
+++ b/README.md
@@ -44,15 +44,17 @@ Apache Commons IO
===================
[](https://travis-ci.org/apache/commons-io)
-[](https://coveralls.io/github/apache/commons-io?branch=master)
+[](https://coveralls.io/r/apache/commons-io)
+[](https://maven-badges.herokuapp.com/maven-central/commons-io/commons-io/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
-The Apache Commons IO library contains utility classes, stream implementations, file filters,
+The Apache Commons IO library contains utility classes, stream implementations, file filters,
file comparators, endian transformation classes, and much more.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-io).
+More information can be found on the [Apache Commons IO homepage](https://commons.apache.org/proper/commons-io).
The [JavaDoc](https://commons.apache.org/proper/commons-io/javadocs/api-release) can be browsed.
Questions related to the usage of Apache Commons IO should be posted to the [user mailing list][ml].
@@ -66,14 +68,14 @@ Alternatively you can pull it from the central Maven repositories:
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
- <version>2.5</version>
+ <version>2.6</version>
</dependency>
```
Contributing
------------
-We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ Respect the code style.
@@ -85,7 +87,9 @@ You can learn more about contributing via GitHub in our [contribution guidelines
License
-------
-Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt).
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
Donations
---------
@@ -94,9 +98,9 @@ You like Apache Commons IO? Then [donate back to the ASF](https://www.apache.org
Additional Resources
--------------------
-+ [Apache Commons IO Homepage](https://commons.apache.org/proper/commons-io/)
-+ [Apache Commons IO Bugtracker (JIRA)](https://issues.apache.org/jira/browse/IO)
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/IO)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ #apachecommons IRC channel on freenode.org
++ `#apache-commons` IRC channel on `irc.freenode.org`
[ml]:https://commons.apache.org/mail-lists.html
http://git-wip-us.apache.org/repos/asf/commons-io/blob/78fc6c76/src/site/xdoc/issue-tracking.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index 9e05944..6b0c6d6 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -43,35 +43,35 @@ limitations under the License.
-->
<document>
<properties>
- <title>Commons IO Issue tracking</title>
- <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ <title>Apache Commons IO Issue tracking</title>
+ <author email="dev@commons.apache.org">Apache Commons Documentation Team</author>
</properties>
<body>
- <section name="Commons IO Issue tracking">
+ <section name="Apache Commons IO Issue tracking">
<p>
- Commons IO uses <a href="http://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
- See the <a href="http://issues.apache.org/jira/browse/IO">Commons IO JIRA project page</a>.
+ Apache Commons IO uses <a href="https://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
+ See the <a href="https://issues.apache.org/jira/browse/IO">Apache Commons IO JIRA project page</a>.
</p>
<p>
- To use JIRA you may need to <a href="http://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a>
+ To use JIRA you may need to <a href="https://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a>
(if you have previously created/updated Commons issues using Bugzilla an account will have been automatically
- created and you can use the <a href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a>
+ created and you can use the <a href="https://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a>
page to get a new password).
</p>
<p>
If you would like to report a bug, or raise an enhancement request with
- Commons IO please do the following:
+ Apache Commons IO please do the following:
<ol>
- <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
+ <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search existing open bugs</a>.
If you find your issue listed then please add a comment with your details.</li>
<li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
You may find your issue or idea has already been discussed.</li>
<li>Decide if your issue is a bug or an enhancement.</li>
- <li>Submit either a <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&issuetype=1&priority=4&assignee=-1">bug report</a>
- or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
+ <li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&issuetype=1&priority=4&assignee=-1">bug report</a>
+ or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310477&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li>
</ol>
</p>
@@ -80,7 +80,7 @@ limitations under the License.
<ul>
<li>the more information you provide, the better we can help you</li>
<li>test cases are vital, particularly for any proposed enhancements</li>
- <li>the developers of Commons IO are all unpaid volunteers</li>
+ <li>the developers of Apache Commons IO are all unpaid volunteers</li>
</ul>
</p>
@@ -92,9 +92,9 @@ limitations under the License.
<p>
You may also find these links useful:
<ul>
- <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Commons IO bugs</a></li>
- <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Commons IO bugs</a></li>
- <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC">All Commons IO bugs</a></li>
+ <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All Open Apache Commons IO bugs</a></li>
+ <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Apache Commons IO bugs</a></li>
+ <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310477&sorter/field=issuekey&sorter/order=DESC">All Apache Commons IO bugs</a></li>
</ul>
</p>
</section>
[4/6] commons-io git commit: Update site for Release 2.6
Posted by br...@apache.org.
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/651ad03a
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/651ad03a
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/651ad03a
Branch: refs/heads/master
Commit: 651ad03ac546303af3ecb884af7f005d7b1598a4
Parents: 78fc6c7
Author: Benedikt Ritter <br...@apache.org>
Authored: Sat Sep 30 16:31:30 2017 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Sun Oct 15 11:54:18 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/651ad03a/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 1628982..feb8bc2 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-10-15" description="Java 7 required, Java 9 supported.">
<action issue="IO-553" dev="britter" type="update" due-to="Michael Ernst">
Make code style of hasBOM() consistent with getBOMCharsetName()
</action>
http://git-wip-us.apache.org/repos/asf/commons-io/blob/651ad03a/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/651ad03a/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/651ad03a/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>
[6/6] commons-io git commit: Bump to next development version
Posted by br...@apache.org.
Bump to next development version
Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/14a80bc4
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/14a80bc4
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/14a80bc4
Branch: refs/heads/master
Commit: 14a80bc4daa3f6f2d63dbc36ffc0b3e526febe69
Parents: 2ae025f
Author: Benedikt Ritter <br...@apache.org>
Authored: Fri Oct 20 08:23:16 2017 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Fri Oct 20 08:23:16 2017 +0200
----------------------------------------------------------------------
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-io/blob/14a80bc4/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 754225f..bf15f59 100644
--- a/pom.xml
+++ b/pom.xml
@@ -24,7 +24,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
- <version>2.6</version>
+ <version>2.7-SNAPSHOT</version>
<name>Apache Commons IO</name>
<inceptionYear>2002</inceptionYear>