You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2018/07/07 17:33:49 UTC
commons-collections git commit: Prepare for release 4.2 and clean up
some docs.
Repository: commons-collections
Updated Branches:
refs/heads/master 8cbe86755 -> d42cb86f2
Prepare for release 4.2 and clean up some docs.
Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-collections/commit/d42cb86f
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/d42cb86f
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/d42cb86f
Branch: refs/heads/master
Commit: d42cb86f2f1f8fe1c40e0308b450b39074a03d08
Parents: 8cbe867
Author: Gary Gregory <ga...@gmail.com>
Authored: Sat Jul 7 11:33:47 2018 -0600
Committer: Gary Gregory <ga...@gmail.com>
Committed: Sat Jul 7 11:33:47 2018 -0600
----------------------------------------------------------------------
src/site/site.xml | 17 ++++++----
src/site/xdoc/history.xml | 21 ++++++++----
src/site/xdoc/index.xml | 6 ++--
src/site/xdoc/release_3_2.xml | 16 ++++-----
src/site/xdoc/release_3_2_1.xml | 16 ++++-----
src/site/xdoc/release_3_2_2.xml | 12 +++----
src/site/xdoc/release_4_0.xml | 6 ++--
src/site/xdoc/release_4_1.xml | 6 ++--
src/site/xdoc/release_4_2.xml | 65 ++++++++++++++++++++++++++++++++++++
9 files changed, 121 insertions(+), 44 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index 1c98ed8..f69573a 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -29,12 +29,17 @@
<item name="Security Reports" href="/security-reports.html"/>
<item name="Users guide" href="/userguide.html"/>
<item name="History" href="/history.html"/>
- <item name="Release Notes v4.1" href="/release_4_1.html"/>
- <item name="Release Notes v4.0" href="/release_4_0.html"/>
- <item name="Release Notes v3.2.2" href="/release_3_2_2.html"/>
- <item name="Javadoc v4.1" href="/javadocs/api-release/index.html"/>
- <item name="Javadoc v4.0" href="/javadocs/api-4.0/index.html"/>
- <item name="Javadoc v3.2.2" href="/javadocs/api-3.2.2/index.html"/>
+ <item name="Release Notes 4.2" href="/release_4_2.html"/>
+ <item name="Release Notes 4.1" href="/release_4_1.html"/>
+ <item name="Release Notes 4.0" href="/release_4_0.html"/>
+ <item name="Release Notes 3.2.2" href="/release_3_2_2.html"/>
+ <item name="Release Notes 3.2.1" href="/release_3_2_1.html"/>
+ <item name="Release Notes 3.2" href="/release_3_2.html"/>
+ <item name="Javadoc current" href="/apidocs/index.html"/>
+ <item name="Javadoc 4.2" href="/javadocs/api-4.2/index.html"/>
+ <item name="Javadoc 4.1" href="/javadocs/api-4.1/index.html"/>
+ <item name="Javadoc 4.0" href="/javadocs/api-4.0/index.html"/>
+ <item name="Javadoc 3.2.2" href="/javadocs/api-3.2.2/index.html"/>
</menu>
<menu name="Development">
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/xdoc/history.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/history.xml b/src/site/xdoc/history.xml
index bb1becc..d8e1203 100644
--- a/src/site/xdoc/history.xml
+++ b/src/site/xdoc/history.xml
@@ -83,13 +83,13 @@ Of course, backwards compatibility has been retained during all transitions usin
</p>
<p>
-<b>Collections 2.1.1</b> was a patch release to v2.1.
-Unfortunately, v3.0 created a <a href="compatibility.html">binary incompatibility</a> in the IteratorUtils class.
-This patch was created as a work around, enabling v2.1.1 to be compatible with v3.1.
+<b>Collections 2.1.1</b> was a patch release to version 2.1.
+Unfortunately, version 3.0 created a <a href="compatibility.html">binary incompatibility</a> in the IteratorUtils class.
+This patch was created as a work around, enabling 2.1.1 to be compatible with 3.1.
</p>
<p>
-<b>Collections 3.1</b> fixed some bugs in v3.0 and adds a few new enhancements.
+<b>Collections 3.1</b> fixed some bugs in 3.0 and adds a few new enhancements.
The most notable change is a new list implementation, TreeList, that is well balanced for insertions and removals at any index.
Other changes included more classes implementing Serializable and a ReferenceIdentityMap.
</p>
@@ -100,7 +100,7 @@ Notably MultiValueMap is a new more flexible implementation of MultiHashMap.
</p>
<p>
-<b>Collections 3.2.1</b> Re-packaged v3.2 release which is OSGi enabled.
+<b>Collections 3.2.1</b> Re-packaged 3.2 release which is OSGi enabled.
</p>
<p>
@@ -113,7 +113,7 @@ PrototypeCloneFactory, PrototypeSerializationFactory, WhileClosure. Fixes COLLEC
<p>
<b>Collections 4.0</b> represented a major revamp of collections by supporting
-new language features introduced with Java 1.5, mainly support for generics.
+new language features introduced with Java 5, mainly support for generics.
</p>
<p>
New interfaces Put, Get and Trie were added, whereas the Buffer interface has
@@ -122,7 +122,7 @@ an implementation of a Patricia Trie.
</p>
<p>
-<b>Collections 4.1</b> fixed some bugs in v4.0 and adds a few new enhancements.
+<b>Collections 4.1</b> fixes some bugs in 4.0 and adds a few new enhancements.
The most notable changes are new interfaces MultiSet (a replacement for the Bag
interface which is fully compliant to the general Collection contract) and
MultiValuedMapList (a replacement for the MultiMap interface) as well as fluent
@@ -133,6 +133,13 @@ Additionally, serialization support for unsafe classes in the functor package
has been completely removed (see entry for Collections 3.2.2 for more details).
</p>
+<p>
+<b>Collections 4.2</b> fixes some bugs in 4.1 and adds a few new enhancements:
+Updates the platform requirement from Java 6 to 7,
+adds Automatic-Module-Name MANIFEST entry for Java 9 compatibility, and
+adds a few new APIs.
+</p>
+
</section>
</body>
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index ec5a200..56957a2 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -57,7 +57,7 @@ as are various <a href="project-reports.html">project reports</a>.
The Javadoc API documents are available online:
</p>
<ul>
-<li>The <a href="javadocs/api-release/index.html">current release 4.1</a></li>
+<li>The <a href="javadocs/api-release/index.html">current release 4.2</a></li>
<li>The latest 3.x release - <a href="javadocs/api-3.2.2/index.html">version 3.2.2</a></li>
<li>The latest 2.x release - <a href="javadocs/api-2.1.1/index.html">version 2.1.1</a></li>
<li>The <a href="apidocs/index.html">latest SVN</a></li>
@@ -71,9 +71,9 @@ The <a href="source-repository.html">git repository</a> can be
<!-- ================================================== -->
<section name="Releases">
<p>
-The latest version is v4.1 -
+The latest version is 4.2 -
<a href="http://commons.apache.org/collections/download_collections.cgi">Download now!</a><br />
-It is built for Java 1.6+ and the <a href="release_4_1.html">release notes</a> are also available.
+It is built for Java 7 and later, and the <a href="release_4_2.html">release notes</a> are also available.
</p>
<p>
For previous releases, see the <a href="http://archive.apache.org/dist/commons/collections/">Apache Archive</a>
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/xdoc/release_3_2.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/release_3_2.xml b/src/site/xdoc/release_3_2.xml
index d5be71e..3ba5054 100644
--- a/src/site/xdoc/release_3_2.xml
+++ b/src/site/xdoc/release_3_2.xml
@@ -17,20 +17,20 @@
-->
<document>
<properties>
- <title>Release notes for v3.2</title>
+ <title>Release notes for version 3.2</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
-<section name="Release notes for v3.2">
+<section name="Release notes for version 3.2">
<p>
-These are the release notes for Commons Collections v3.2:
+These are the release notes for Commons Collections 3.2:
</p>
<hr />
<p>
Commons collections is a project to develop and maintain collection classes
based on and inspired by the JDK collection framework.
-This project is JDK1.2 compatible, and does not use JDK1.5 generics.
+This project is Java 1.2 compatible, and does not use Java 5 generics.
</p>
<p>
This release adds various new classes and fixes a number of bugs.
@@ -40,19 +40,19 @@ All feedback should be directed to commons-user at jakarta.apache.org.
<center><h3>COMPATIBILITY</h3></center>
<p>
-This release is fully source and binary compatible with v3.1.
+This release is fully source and binary compatible with 3.1.
(Checks performed using JDiff and Clirr, thanks).
-Please check the bug fixes to ensure you weren't relying on the behaviour of a bug.
+Please check the bug fixes to ensure you weren't relying on the behavior of a bug.
</p>
<p>
There are two new <i>deprecations</i>:<br />
-BeanMap is now deprecated and will be removed in v4.0.
+BeanMap is now deprecated and will be removed in 4.0.
The class is now available in commons-beanutils (full jar version).
This change was made to ensure that all bean related collections were in one place (ie. beanutils).
If this causes major headaches to anyone please contact commons-dev at jakarta.apache.org.
</p>
<p>
-MultiHashMap is now deprecated and will be removed in v4.0.
+MultiHashMap is now deprecated and will be removed in 4.0.
The class is now available as MultiValueMap in the map subpackage.
This new version of the class is a decorator and can wrap maps other than HashMap
making it much more flexible.
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/xdoc/release_3_2_1.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/release_3_2_1.xml b/src/site/xdoc/release_3_2_1.xml
index 0342abd..394bf7e 100644
--- a/src/site/xdoc/release_3_2_1.xml
+++ b/src/site/xdoc/release_3_2_1.xml
@@ -17,31 +17,31 @@
-->
<document>
<properties>
- <title>Release notes for v3.2.1</title>
+ <title>Release notes for version 3.2.1</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
-<section name="Release notes for v3.2.1">
+<section name="Release notes for version 3.2.1">
<p>
-These are the release notes for Commons Collections v3.2.1:
+These are the release notes for Commons Collections 3.2.1:
</p>
-<hr />
+<hr/>
<p>
Commons collections is a project to develop and maintain collection classes
based on and inspired by the JDK collection framework.
-This project is JDK1.2 compatible, and does not use JDK1.5 generics.
+This project is Java 1.2 compatible, and does not use Java 5 generics.
</p>
<p>
-This v3.2.1 release is simply a re-packaging of the v3.2 release, with appropriate
+This 3.2.1 release is simply a re-packaging of the 3.2 release, with appropriate
OSGi meta data added to the jar's manifest file.
</p>
<hr />
<center><h3>COMPATIBILITY</h3></center>
<p>
-This release is fully source and binary compatible with v3.2. For changes since the
-v3.1 see the <a href="release_3_2.html">v3.2 Release Notes</a>.
+Release 3.2.1 is fully source and binary compatible with 3.2. For changes since version
+3.1 see the <a href="release_3_2.html">3.2 Release Notes</a>.
</p>
</section>
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/xdoc/release_3_2_2.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/release_3_2_2.xml b/src/site/xdoc/release_3_2_2.xml
index d0c07d9..47f50b2 100644
--- a/src/site/xdoc/release_3_2_2.xml
+++ b/src/site/xdoc/release_3_2_2.xml
@@ -17,20 +17,20 @@
-->
<document>
<properties>
- <title>Release notes for v3.2.2</title>
+ <title>Release notes for version 3.2.2</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
-<section name="Release notes for v3.2.2">
+<section name="Release notes for version 3.2.2">
<hr />
<p>
Commons collections is a project to develop and maintain collection classes
based on and inspired by the JDK collection framework.
-This project is JDK 1.3 compatible, and does not use JDK 1.5 generics.
+This project is Java 1.3 compatible, and does not use Java 5 generics.
</p>
<p>
-This v3.2.2 release is a bugfix release, fixing several bugs present in the previous
+This 3.2.2 release is a bugfix release, fixing several bugs present in the previous
releases of the 3.2 branch. Additionally, this release provides a mitigation for a
known remote code exploitation via the standard java object serialization mechanism.
By default, serialization support for unsafe classes in the functor package is
@@ -43,8 +43,8 @@ All users are strongly encouraged to updated to this release.
<h3>Compatibility</h3>
<p>
-This release is fully source and binary compatible with v3.2. For changes since the
-v3.1 see the <a href="release_3_2.html">v3.2 Release Notes</a>. Note that the method
+This release is fully source and binary compatible with 3.2. For changes since the
+3.1 release see the <a href="release_3_2.html">3.2 Release Notes</a>. Note that the method
'protected java.util.Set createSetBasedOnList(java.util.Set, java.util.List)' has been
added.
</p>
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/xdoc/release_4_0.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/release_4_0.xml b/src/site/xdoc/release_4_0.xml
index ef196b6..447f878 100644
--- a/src/site/xdoc/release_4_0.xml
+++ b/src/site/xdoc/release_4_0.xml
@@ -17,12 +17,12 @@
-->
<document>
<properties>
- <title>Release notes for v4.0</title>
+ <title>Release notes for version 4.0</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
-<section name="Release notes for v4.0">
+<section name="Release notes for version 4.0">
<hr />
<p>
Commons collections is a project to develop and maintain collection classes based on and inspired
@@ -278,7 +278,7 @@ have changed.
</ul>
<p>
-For complete information on all changes for this release, please refer to the <a href="changes-report.html">Changelog</a>.
+For a full list of changes in this release, refer to the <a href="changes-report.html#a4.0">Change report</a>.
</p>
</section>
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/xdoc/release_4_1.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/release_4_1.xml b/src/site/xdoc/release_4_1.xml
index f6a8690..8a16f20 100644
--- a/src/site/xdoc/release_4_1.xml
+++ b/src/site/xdoc/release_4_1.xml
@@ -17,19 +17,19 @@
-->
<document>
<properties>
- <title>Release notes for v4.1</title>
+ <title>Release notes for version 4.1</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
-<section name="Release notes for v4.1">
+<section name="Release notes for version 4.1">
<hr />
<p>
Apache Commons Collections is a project to develop and maintain collection
classes based on and inspired by the JDK collection framework.
</p>
<p>
-This v4.1 release is a minor and security release, fixing several bugs present in
+This 4.1 release is a minor and security release, fixing several bugs present in
previous releases of the 4.X branch. Additionally, this release provides a mitigation
for a known remote code exploitation via the standard java object serialization
mechanism. Serialization support for unsafe classes in the functor package has been
http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d42cb86f/src/site/xdoc/release_4_2.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/release_4_2.xml b/src/site/xdoc/release_4_2.xml
new file mode 100644
index 0000000..13d0097
--- /dev/null
+++ b/src/site/xdoc/release_4_2.xml
@@ -0,0 +1,65 @@
+<?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>Release notes for v4.2</title>
+ <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+<body>
+
+<section name="Release notes for version 4.2">
+<hr />
+<p>
+Apache Commons Collections is a project to develop and maintain collection
+classes based on and inspired by the JDK collection framework.
+</p>
+<p>
+This 4.2 release is a minor and updates the platform requirement from Java 6 to 7.
+This release fixes several bugs present in previous releases of the 4.X branch.
+</p>
+<p>
+All users are strongly encouraged to updated to this release.
+</p>
+
+<h3>Compatibility</h3>
+<ul>
+ <li>Java 7 or later is now required (version 4.1 required Java 6)</li>
+ <li>This release is source and binary compatible with the 4.0 release
+ of Commons Collections with the exception that some classes in the functor
+ package do not implement the Serializable interface anymore (see COLLECTIONS-580)</li>
+</ul>
+
+<center><h3>Major changes since 4.1</h3></center>
+<ul>
+<li>Updates the platform requirement from Java 6 to 7</li>
+<li>Add Automatic-Module-Name MANIFEST entry for Java 9 compatibility</li>
+<li>Added a few new APIs.</li>
+</ul>
+
+<h3>Security Changes</h3>
+<p>
+None.
+</p>
+
+<p>
+For a full list of changes in this release, refer to the <a href="changes-report.html#a4.2">Change report</a>.
+</p>
+</section>
+
+</body>
+</document>