This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-io.git
commit 022246bc2cfcd1d38226b0fe654990c9d24e60eb Author: Gary Gregory <[email protected]> AuthorDate: Sat Sep 5 21:21:22 2020 -0400 Prepare for release. --- src/changes/changes.xml | 2 +- .../org/apache/commons/io/function/package.html | 2 +- src/site/site.xml | 3 +- src/site/xdoc/bestpractices.xml | 2 +- src/site/xdoc/description.xml | 24 ++++---- src/site/xdoc/index.xml | 66 +++++++++++++++++----- 6 files changed, 68 insertions(+), 31 deletions(-) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index ff9c476..b563c1f 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.8.0" date="2020-MM-DD" description="Java 8 required."> + <release version="2.8.0" date="2020-09-05" description="Java 8 required."> <action dev="ggregory" type="add" due-to="Gary Gregory"> Add org.apache.commons.io.input.CircularInputStream. </action> diff --git a/src/main/java/org/apache/commons/io/function/package.html b/src/main/java/org/apache/commons/io/function/package.html index f358609..23017f7 100644 --- a/src/main/java/org/apache/commons/io/function/package.html +++ b/src/main/java/org/apache/commons/io/function/package.html @@ -18,7 +18,7 @@ limitations under the License. <html> <body> <p> -IO-only related functional interfaces provide target types for lambda expressions and method references. +This package defines IO-only related functional interfaces for lambda expressions and method references. </p> </body> </html> diff --git a/src/site/site.xml b/src/site/site.xml index a83c680..312c1bb 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -28,7 +28,7 @@ <item name="Download" href="https://commons.apache.org/io/download_io.cgi"/> <item name="User guide" href="/description.html"/> <item name="Best practices" href="/bestpractices.html"/> - <item name="Javadoc" href="/javadocs/api-release/index.html"/> + <item name="Javadoc" href="/apidocs/index.html"/> <item name="Javadoc Archive" href="https://javadoc.io/doc/commons-io/commons-io/latest/index.html"/> </menu> @@ -40,7 +40,6 @@ <item name="Tasks" href="/tasks.html"/> <item name="Proposal" href="/proposal.html"/> <item name="Source repository" href="/scm.html"/> - <item name="Javadoc (GIT latest)" href="apidocs/index.html"/> </menu> </body> diff --git a/src/site/xdoc/bestpractices.xml b/src/site/xdoc/bestpractices.xml index a4382df..9420603 100644 --- a/src/site/xdoc/bestpractices.xml +++ b/src/site/xdoc/bestpractices.xml @@ -49,7 +49,7 @@ limitations under the License. <p> <i> Version 1.1 of commons-io now includes a dedicated filename - handling class - <a href="javadocs/api-release/index.html?org/apache/commons/io/FilenameUtils.html">FilenameUtils</a>. + handling class - <a href="apidocs/index.html?org/apache/commons/io/FilenameUtils.html">FilenameUtils</a>. This does handle many of these filename issues, however we still recommend, wherever possible, that you use java.io.File objects. </i> diff --git a/src/site/xdoc/description.xml b/src/site/xdoc/description.xml index a506bce..0ddccca 100644 --- a/src/site/xdoc/description.xml +++ b/src/site/xdoc/description.xml @@ -35,14 +35,14 @@ limitations under the License. <p> For a more detailed descriptions, take a look at the - <a href="api-release/index.html">javadocs</a>. + <a href="api-release/index.html">Javadocs</a>. </p> </section> <section name="Utility classes"> <subsection name="IOUtils"> <p> - <a href="javadocs/api-release/index.html?org/apache/commons/io/IOUtils.html">IOUtils</a> + <a href="apidocs/index.html?org/apache/commons/io/IOUtils.html">IOUtils</a> contains utility methods dealing with reading, writing and copying. The methods work on InputStream, OutputStream, Reader and Writer. </p> @@ -92,7 +92,7 @@ limitations under the License. <subsection name="FileUtils"> <p> - The <a href="javadocs/api-release/index.html?org/apache/commons/io/FileUtils.html">FileUtils</a> + The <a href="apidocs/index.html?org/apache/commons/io/FileUtils.html">FileUtils</a> class contains utility methods for working with File objects. These include reading, writing, copying and comparing files. </p> @@ -106,7 +106,7 @@ limitations under the License. <subsection name="FilenameUtils"> <p> - The <a href="javadocs/api-release/index.html?org/apache/commons/io/FilenameUtils.html">FilenameUtils</a> + The <a href="apidocs/index.html?org/apache/commons/io/FilenameUtils.html">FilenameUtils</a> class contains utility methods for working with filenames <i>without</i> using File objects. The class aims to be consistent between Unix and Windows, to aid transitions between these @@ -123,7 +123,7 @@ limitations under the License. <subsection name="FileSystemUtils"> <p> - The <a href="javadocs/api-release/index.html?org/apache/commons/io/FileSystemUtils.html">FileSystemUtils</a> + The <a href="apidocs/index.html?org/apache/commons/io/FileSystemUtils.html">FileSystemUtils</a> class contains utility methods for working with the file system to access functionality not supported by the JDK. @@ -155,13 +155,13 @@ limitations under the License. <ul> <li> - The <a href="javadocs/api-release/index.html?org/apache/commons/io/EndianUtils.html">EndianUtils</a> + The <a href="apidocs/index.html?org/apache/commons/io/EndianUtils.html">EndianUtils</a> class contains static methods for swapping the Endian-ness of Java primitives and streams. </li> <li> - The <a href="javadocs/api-release/index.html?org/apache/commons/io/input/SwappedDataInputStream.html">SwappedDataInputStream</a> + The <a href="apidocs/index.html?org/apache/commons/io/input/SwappedDataInputStream.html">SwappedDataInputStream</a> class is an implementation of the <code>DataInput</code> interface. With this, one can read data from files of non-native Endian-ness. </li> @@ -199,7 +199,7 @@ limitations under the License. <p> The <code>org.apache.commons.io.filefilter</code> package defines an interface - (<a href="javadocs/api-release/index.html?org/apache/commons/io/filefilter/IOFileFilter.html">IOFileFilter</a>) + (<a href="apidocs/index.html?org/apache/commons/io/filefilter/IOFileFilter.html">IOFileFilter</a>) that combines both <code>java.io.FileFilter</code> and <code>java.io.FilenameFilter</code>. Besides that the package offers a series of ready-to-use @@ -211,7 +211,7 @@ limitations under the License. </p> <p> See the - <a href="javadocs/api-release/index.html?org/apache/commons/io/filefilter/package-summary.html">filefilter</a> + <a href="apidocs/index.html?org/apache/commons/io/filefilter/package-summary.html">filefilter</a> package javadoc for more details. </p> </section> @@ -226,7 +226,7 @@ limitations under the License. </p> <p> See the - <a href="javadocs/api-release/index.html?org/apache/commons/io/comparator/package-summary.html">comparator</a> + <a href="apidocs/index.html?org/apache/commons/io/comparator/package-summary.html">comparator</a> package javadoc for more details. </p> </section> @@ -248,8 +248,8 @@ limitations under the License. </p> <p> See the - <a href="javadocs/api-release/index.html?org/apache/commons/io/input/package-summary.html">input</a> or - <a href="javadocs/api-release/index.html?org/apache/commons/io/output/package-summary.html">output</a> + <a href="apidocs/index.html?org/apache/commons/io/input/package-summary.html">input</a> or + <a href="apidocs/index.html?org/apache/commons/io/output/package-summary.html">output</a> package javadoc for more details. </p> </section> diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 7d71cf6..0a12af4 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -28,21 +28,59 @@ Commons IO is a library of utilities to assist with developing IO functionality. </p> <p> There are six main areas included: +</p> <ul> -<li><a href="javadocs/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="javadocs/api-release/index.html?org/apache/commons/io/input/package-summary.html">Input</a> - - useful Input Stream and Reader implementations</li> -<li><a href="javadocs/api-release/index.html?org/apache/commons/io/output/package-summary.html">Output</a> - - useful Output Stream and Writer implementations</li> -<li><a href="javadocs/api-release/index.html?org/apache/commons/io/filefilter/package-summary.html">Filters</a> - - various implementations of file filters</li> -<li><a href="javadocs/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="javadocs/api-release/index.html?org/apache/commons/io/monitor/package-summary.html">File Monitor</a> - - a component for monitoring file system events</li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/package-summary.html">io</a> + - This package defines utility classes for working with streams, readers, writers and files. + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/comparator/package-summary.html">comparator</a> + - This package provides various Comparator implementations for Files. + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/file/package-summary.html">file</a> + - This package provides extensions in the realm of java.nio.file. + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/filefilter/package-summary.html">filefilter</a> + - This package defines an interface (IOFileFilter) that combines both FileFilter and FilenameFilter. + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/function/package-summary.html">function</a> + - This package defines IO-only related functional interfaces for lambda expressions and method references. + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/input/package-summary.html">input</a> + - This package provides implementations of input classes, such as InputStream and Reader. + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/input/buffer/package-summary.html">input.buffer</a> + - This package provides implementations of buffered input classes, such as CircularBufferInputStream and PeekableInputStream. + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/monitor/package-summary.html">monitor</a> + - This package provides a component for monitoring file system events (directory and file create, update and delete events). + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/output/package-summary.html">output</a> + - This package provides implementations of output classes, such as OutputStream and Writer. + </li> + <li> + <a + href="apidocs/index.html?org/apache/commons/io/serialization/package-summary.html">serialization</a> + - This package provides a framework for controlling the deserialization of classes. + </li> </ul> -</p> </section> <!-- ================================================== --> <section name="Releases"> @@ -56,7 +94,7 @@ There are six main areas included: View the <a href="changes-report.html">Release Notes</a> and - <a href="javadocs/api-release/index.html">Javadoc API documents</a> + <a href="apidocs/index.html">Javadoc API documents</a> </p> </subsection>
