You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by GitBox <gi...@apache.org> on 2022/08/01 23:09:22 UTC
[GitHub] [commons-collections] kinow commented on a diff in pull request #325: Fix links in javadoc and documentations
kinow commented on code in PR #325:
URL: https://github.com/apache/commons-collections/pull/325#discussion_r934981890
##########
RELEASE-NOTES.txt:
##########
@@ -347,4 +347,4 @@ o COLLECTIONS-217: Calling "setValue(Object)" on any Entry returned by a "Flat3
For complete information on Apache Commons Collections, including instructions on how to submit bug reports,
patches, or suggestions for improvement, see the Apache Commons Collections website:
-https://commons.apache.org/collections/
+https://commons.apache.org/proper/commons-collections/
Review Comment:
:+1: less one hop to reach the page.
Note, however, that this file is automatically re-generated by the commons-release-plugin: https://github.com/apache/commons-release-plugin/blob/3a0a64db33251d5a3bc808790d140f7db7347157/src/changes/release-notes.vm
A release-manager follows steps defined in this page, which includes other commands that generate this and other files: https://commons.apache.org/releases/prepare.html
##########
src/site/xdoc/pick.xml:
##########
@@ -112,66 +112,66 @@ The <a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/
<h3>Map interface</h3>
<p>
-The <a href="http://java.sun.com/j2se/1.4/docs/api/java/util/Map.html">Map</a> interface and implementations in both the JDK and Commons Collections allow you to lookup data from a key to a value. This is one of the most powerful interfaces in the JDK, however it is very difficult to implement. These are the available implementations:
+The <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html">Map</a> interface and implementations in both the JDK and Commons Collections allow you to lookup data from a key to a value. This is one of the most powerful interfaces in the JDK, however it is very difficult to implement. These are the available implementations:
<table>
<tr>
-<td><a href="http://java.sun.com/j2se/1.4/docs/api/java/util/HashMap.html">HashMap</a> (JDK)</td>
+<td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html">HashMap</a> (JDK)</td>
<td>This map is the most commonly used and fastest implementation. It is suitable for most situations and can store any object. Objects are stored in any order, and the order may change over time.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/HashedMap.html">HashedMap</a></td>
-<td>The Commons Collections hash map implementation which is very similar in design to HashMap, but also supports easy iteration via a <a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/MapIterator.html">MapIterator</a>. This implementation is also designed to be subclassed. Use this map if you want to use the extra iterator, or to subclass. Otherwise, there is no advantage (or disadvantage) compared to the JDK HashMap.</td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/HashedMap.html">HashedMap</a></td>
+<td>The Commons Collections hash map implementation which is very similar in design to HashMap, but also supports easy iteration via a <a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/MapIterator.html">MapIterator</a>. This implementation is also designed to be subclassed. Use this map if you want to use the extra iterator, or to subclass. Otherwise, there is no advantage (or disadvantage) compared to the JDK HashMap.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/IdentityMap.html">IdentityMap</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/IdentityMap.html">IdentityMap</a></td>
<td>This map operates exactly as per HashedMap but compares keys and values using == not .equals().</td>
</tr>
<tr>
-<td><a href="http://java.sun.com/j2se/1.4/docs/api/java/util/IdentityHashMap.html">IdentityHashMap</a> (JDK)</td>
+<td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/IdentityHashMap.html">IdentityHashMap</a> (JDK)</td>
<td>This map operates exactly as per HashMap but compares keys and values using == not .equals().</td>
</tr>
<tr>
-<td><a href="http://java.sun.com/j2se/1.4/docs/api/java/util/TreeMap.html">TreeMap</a> (JDK)</td>
-<td>This map ensures that the keys are always sorted, and iteration order is consistent. All keys must implement <a href="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</a>, unless a comparator is supplied. This map should be used if you need the map to be sorted.</td>
+<td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/TreeMap.html">TreeMap</a> (JDK)</td>
+<td>This map ensures that the keys are always sorted, and iteration order is consistent. All keys must implement <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html">Comparable</a>, unless a comparator is supplied. This map should be used if you need the map to be sorted.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/LinkedMap.html">LinkedMap</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/LinkedMap.html">LinkedMap</a></td>
<td>This map maintains the order that each object is added to the map. When the map is viewed via an iterator, the insertion order will be seen. This map should be used if you need to retain the insertion order.</td>
</tr>
<tr>
-<td><a href="http://java.sun.com/j2se/1.4/docs/api/java/util/LinkedHashMap.html">LinkedHashMap</a> (JDK)</td>
+<td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashMap.html">LinkedHashMap</a> (JDK)</td>
<td>This map, available from JDK 1.4, maintains the order that each object is added to the map. When the map is viewed via an iterator, the insertion order will be seen. Commons collections' LinkedMap provides the same functionality for JDK1.2 onwards and provides a MapIterator.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/ListOrderedMap.html">ListOrderedMap</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/ListOrderedMap.html">ListOrderedMap</a></td>
<td>This map decorates another map to maintains the order that each object is added to the map. The order is maintained using a list. This map should be used if you need to retain the insertion order but you also need the special features of another map.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/LRUMap.html">LRUMap</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/LRUMap.html">LRUMap</a></td>
<td>This map places a maximum size limit on the map and removes the least recently used (LRU) key-value when it is full. This map should be used for caches where you want to limit the maximum memory size used, and are happy with the least recently used algorithm for removals.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/ReferenceMap.html">ReferenceMap</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/ReferenceMap.html">ReferenceMap</a></td>
<td>This map enables keys and values to be garbage collected whilst still held in the map. This can be useful for building memory sensitive caches. This map should be used for caches where you want to allow garbage collection from the map.</td>
</tr>
<tr>
-<td><a href="http://java.sun.com/j2se/1.4/docs/api/java/util/WeakHashMap.html">WeakHashMap</a> (JDK)</td>
+<td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/WeakHashMap.html">WeakHashMap</a> (JDK)</td>
<td>This map stores each key-value pair with a key that can be garbage collected. This can be useful for building memory sensitive caches. ReferenceMap provides the same functionality but with much more flexibility.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/ReferenceIdentityMap.html">ReferenceIdentityMap</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/ReferenceIdentityMap.html">ReferenceIdentityMap</a></td>
<td>This map operates exactly as per ReferenceMap but compares keys and values using == not .equals().</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/SingletonMap.html">SingletonMap</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/SingletonMap.html">SingletonMap</a></td>
<td>This map is restricted to storing one key-value pair. It may contain no more than and no less than one pair. It provides a MapIterator. This map should be used if you want to return one key-value pair and must use the Map interface.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/Flat3Map.html">Flat3Map</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/Flat3Map.html">Flat3Map</a></td>
<td>This map is optimised to store one, two or three key-value pairs and outperforms HashMap at these sizes. For size four and above performance is about 5% slower than HashMap. This map also has good garbage collection characteristics when below size four. It provides a MapIterator. This map should be used if are 99% sure that the map will be size three or less.</td>
</tr>
<tr>
-<td><a href="https://commons.apache.org/collections/apidocs-COLLECTIONS_3_1/org/apache/commons/collections/map/StaticBucketMap.html">StaticBucketMap</a></td>
+<td><a href="https://javadoc.io/doc/commons-collections/commons-collections/3.1/org/apache/commons/collections/map/StaticBucketMap.html">StaticBucketMap</a></td>
Review Comment:
I think an alternative here would be to fix the apache.org link. The javadoc.io is maintained externally, and I'm not sure if it'd be available in the long run. The link to report issues leads to an account of a single GitHub user, i.e. bus-factor=1 for reporting issues & maintenance.
##########
src/site/xdoc/download_collections.xml:
##########
@@ -208,27 +208,27 @@ limitations under the License.
<table>
<tr>
<td><a href="[preferred]/commons/collections/binaries/commons-collections-3.2.2-bin.tar.gz">commons-collections-3.2.2-bin.tar.gz</a></td>
- <td><a href="https://www.apache.org/dist/commons/collections/binaries/commons-collections-3.2.2-bin.tar.gz.sha256">sha256</a></td>
- <td><a href="https://www.apache.org/dist/commons/collections/binaries/commons-collections-3.2.2-bin.tar.gz.asc">pgp</a></td>
+ <td><a href="https://downloads.apache.org/commons/collections/binaries/commons-collections-3.2.2-bin.tar.gz.sha256">sha256</a></td>
+ <td><a href="https://downloads.apache.org/commons/collections/binaries/commons-collections-3.2.2-bin.tar.gz.asc">pgp</a></td>
</tr>
<tr>
<td><a href="[preferred]/commons/collections/binaries/commons-collections-3.2.2-bin.zip">commons-collections-3.2.2-bin.zip</a></td>
- <td><a href="https://www.apache.org/dist/commons/collections/binaries/commons-collections-3.2.2-bin.zip.sha256">sha256</a></td>
- <td><a href="https://www.apache.org/dist/commons/collections/binaries/commons-collections-3.2.2-bin.zip.asc">pgp</a></td>
+ <td><a href="https://downloads.apache.org/commons/collections/binaries/commons-collections-3.2.2-bin.zip.sha256">sha256</a></td>
+ <td><a href="https://downloads.apache.org/commons/collections/binaries/commons-collections-3.2.2-bin.zip.asc">pgp</a></td>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
<td><a href="[preferred]/commons/collections/source/commons-collections-3.2.2-src.tar.gz">commons-collections-3.2.2-src.tar.gz</a></td>
- <td><a href="https://www.apache.org/dist/commons/collections/source/commons-collections-3.2.2-src.tar.gz.sha256">sha256</a></td>
- <td><a href="https://www.apache.org/dist/commons/collections/source/commons-collections-3.2.2-src.tar.gz.asc">pgp</a></td>
+ <td><a href="https://downloads.apache.org/commons/collections/source/commons-collections-3.2.2-src.tar.gz.sha256">sha256</a></td>
+ <td><a href="https://downloads.apache.org/commons/collections/source/commons-collections-3.2.2-src.tar.gz.asc">pgp</a></td>
</tr>
<tr>
<td><a href="[preferred]/commons/collections/source/commons-collections-3.2.2-src.zip">commons-collections-3.2.2-src.zip</a></td>
- <td><a href="https://www.apache.org/dist/commons/collections/source/commons-collections-3.2.2-src.zip.sha256">sha256</a></td>
- <td><a href="https://www.apache.org/dist/commons/collections/source/commons-collections-3.2.2-src.zip.asc">pgp</a></td>
+ <td><a href="https://downloads.apache.org/commons/collections/source/commons-collections-3.2.2-src.zip.sha256">sha256</a></td>
+ <td><a href="https://downloads.apache.org/commons/collections/source/commons-collections-3.2.2-src.zip.asc">pgp</a></td>
Review Comment:
The old links appear to still work, but maybe it's fine to update this file manually.
It is automatically generated by the commons-build-plugin: https://github.com/apache/commons-build-plugin/tree/master/src/main/resources/commons-xdoc-templates
##########
README.md:
##########
@@ -46,15 +46,15 @@ Apache Commons Collections
[](https://travis-ci.org/apache/commons-collections)
[](https://coveralls.io/r/apache/commons-collections)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-collections4/)
-[](https://javadoc.io/doc/org.apache.commons/commons-collections4/4.4)
+[](https://commons.apache.org/proper/commons-collections/javadocs/api-4.4/)
The Apache Commons Collections package contains types that extend and augment the Java Collections Framework.
Documentation
-------------
-More information can be found on the [Apache Commons Collections homepage](https://commons.apache.org/proper/commons-collections).
-The [Javadoc](https://commons.apache.org/proper/commons-collections/apidocs) can be browsed.
+More information can be found on the [Apache Commons Collections homepage](https://commons.apache.org/proper/commons-collections/).
+The [Javadoc](https://commons.apache.org/proper/commons-collections/apidocs/) can be browsed.
Review Comment:
I believe this file is generated automatically by the commons plug-ins.
##########
README.md:
##########
@@ -46,15 +46,15 @@ Apache Commons Collections
[](https://travis-ci.org/apache/commons-collections)
[](https://coveralls.io/r/apache/commons-collections)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-collections4/)
-[](https://javadoc.io/doc/org.apache.commons/commons-collections4/4.4)
+[](https://commons.apache.org/proper/commons-collections/javadocs/api-4.4/)
Review Comment:
:+1: better to use the apache.org link whenever possible. Thanks!
##########
CONTRIBUTING.md:
##########
@@ -106,8 +106,8 @@ Additional Resources
+ [Contributing patches](https://commons.apache.org/patches.html)
+ [Apache Commons Collections JIRA project page][jira]
+ [Contributor License Agreement][cla]
-+ [General GitHub documentation](https://help.github.com/)
-+ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/)
++ [General GitHub documentation](https://docs.github.com/en)
++ [GitHub pull request documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
+ `#apache-commons` IRC channel on `irc.freenode.net`
Review Comment:
This file is automatically re-generated by the commons-build-plugin, where I believe the links are also incorrect.
It means that even if we merge this commit, during the next release these files will be overwritten bringing back the same old links :+1: : https://github.com/apache/commons-build-plugin/blob/master/src/main/resources/commons-xdoc-templates/contributing-md-template.md
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org