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-net.git
The following commit(s) were added to refs/heads/master by this push:
new 004ec62f Port from Doxia 1 to 2
new ce3bd3ad Merge branch 'master' of
https://gitbox.apache.org/repos/asf/commons-net
004ec62f is described below
commit 004ec62f8bff6b3085e3cffc9add4298c4939a1b
Author: Gary Gregory <[email protected]>
AuthorDate: Thu Jan 23 11:05:02 2025 -0500
Port from Doxia 1 to 2
---
src/site/xdoc/code-standards.xml | 11 +++++----
src/site/xdoc/faq.xml | 5 ++--
src/site/xdoc/index.xml | 22 ++++++++++-------
src/site/xdoc/migration.xml | 26 +++++++++++++-------
src/site/xdoc/security.xml | 30 ++++++++++++-----------
src/site/xdoc/tasks.xml | 51 +++++++++++++++++++---------------------
6 files changed, 80 insertions(+), 65 deletions(-)
diff --git a/src/site/xdoc/code-standards.xml b/src/site/xdoc/code-standards.xml
index 24b782ed..74911f72 100644
--- a/src/site/xdoc/code-standards.xml
+++ b/src/site/xdoc/code-standards.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Coding Standards</title>
<author email="[email protected]">Jon S. Stevens</author>
@@ -54,7 +55,7 @@ Java Coding Conventions</a>.
for one line statements. Examples:
</p>
-<source test=""><![CDATA[
+<source><![CDATA[
if ( foo )
{
// code here
@@ -84,7 +85,7 @@ while ( true )
preference is to not include them. Both of the following are okay:
</p>
-<source test=""><![CDATA[
+<source><![CDATA[
if (foo)
or
@@ -149,7 +150,7 @@ import org.apache.foo.*;
import org.apache.bar.*;
]]></source>
-<hr noshade="true" size="1"/>
+<hr noshade="noshade" size="1"/>
<p>
X/Emacs users might appreciate this in their .emacs file.
diff --git a/src/site/xdoc/faq.xml b/src/site/xdoc/faq.xml
index 8447bfed..e682025b 100644
--- a/src/site/xdoc/faq.xml
+++ b/src/site/xdoc/faq.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>FAQ - Frequently Asked Questions</title>
<author email="[email protected]">Apache Commons User Mailing
List</author>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 4b28dd30..4cc3fbda 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -15,8 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Overview</title>
<author email="[email protected]">Apache Commons Documentation
Team</author>
@@ -40,8 +41,9 @@
</p>
</section>
<section name="Features">
- <p>
- Supported protocols include:
+ <p>
+ Supported protocols include:
+ </p>
<ul>
<li>FTP/FTPS</li>
<li>FTP over HTTP (experimental)</li>
@@ -59,7 +61,6 @@
<li>Discard</li>
<li>NTP/SNTP</li>
</ul>
- </p>
</section>
<section name="Background">
<p>
@@ -80,14 +81,19 @@
Commons NET includes several working sample applications that you
can use.
Source files are included in the source (and binary) archives, and
a compiled jar is provided.
</p>
+ <p>
To use one of the sample applications, ensure that the example and
main jars are both in the same directory.
Then run the class as per the following example:
- <pre>java -jar [path/]commons-net-examples-3.8.0.jar
FTPClientExample [parameters]</pre>
+ </p>
+ <pre>java -jar [path/]commons-net-examples-3.8.0.jar FTPClientExample
[parameters]</pre>
+ <p>
This uses the helper application which supports shorthand class
names.
- <br/>
+ </p>
+ <p>
Alternatively, ensure that the example and main jars are on the
classpath.
Then invoke the class directly, for example:
- <pre>java -cp commons-net-examples-3.8.0.jar;commons-net-3.8.0.jar
examples/ftp/FTPClientExample [parameters]</pre>
+ </p>
+ <pre>java -cp commons-net-examples-3.8.0.jar;commons-net-3.8.0.jar
examples/ftp/FTPClientExample [parameters]</pre>
<subsection name="FTP (package: examples/ftp)">
<ul>
diff --git a/src/site/xdoc/migration.xml b/src/site/xdoc/migration.xml
index f377673a..56c6c7bb 100644
--- a/src/site/xdoc/migration.xml
+++ b/src/site/xdoc/migration.xml
@@ -5,7 +5,9 @@
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>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Apache Commons Net Migration How-to</title>
<author email="[email protected]">Jeffrey D. Brekke, Gary Gregory</author>
@@ -66,9 +68,11 @@
</p>
<p>
Several obsolete/unused constants have been removed.
- <br />
+ </p>
+ <p>
(Such changes do not affect binary code, because compilers are
required to localise constants).
- <br />
+ </p>
+ <p>
The
<a href="clirr-report.html">clirr report</a>
shows which constants have been removed.
@@ -76,14 +80,18 @@
</p>
<p>
Also, some throws clauses have been removed from methods which did not
actually throw them.
- <br />
+ </p>
+ <p>
Throws clauses are not part of method signatures, so do not affect
binary compatibility.
- <br />
+ </p>
+ <p>
The following public methods no longer throw IOException:
- <ul>
- <li>TelnetClient#addOptionHandler(TelnetOptionHandler)</li>
- <li>TelnetClient#deleteOptionHandler(int)</li>
- </ul>
+ </p>
+ <ul>
+ <li>TelnetClient#addOptionHandler(TelnetOptionHandler)</li>
+ <li>TelnetClient#deleteOptionHandler(int)</li>
+ </ul>
+ <p>
Source code using these methods will need to be updated.
</p>
</section>
diff --git a/src/site/xdoc/security.xml b/src/site/xdoc/security.xml
index 05f57280..b781b7ad 100644
--- a/src/site/xdoc/security.xml
+++ b/src/site/xdoc/security.xml
@@ -6,7 +6,9 @@
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>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Apache Commons Text Security Reports</title>
<author email="[email protected]">Commons Team</author>
@@ -62,20 +64,20 @@
<p>
Credit: Apache Commons would like to thank ZeddYu Lu for
reporting this issue.
</p>
- <p>
+ <p>
References:
- <ul>
- <li>
- <a
href="https://lists.apache.org/thread/o6yn9r9x6s94v97264hmgol1sf48mvx7";>Announcement
on [email protected]</a>
- </li>
- <li>
- <a
href="https://www.openwall.com/lists/oss-security/2022/12/03/1";>Announcement on
oss-security</a>
- </li>
- <li>
- <a
href="https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-37533";>Advisory
on cve.org</a>
- </li>
- </ul>
- </p>
+ </p>
+ <ul>
+ <li>
+ <a
href="https://lists.apache.org/thread/o6yn9r9x6s94v97264hmgol1sf48mvx7";>Announcement
on [email protected]</a>
+ </li>
+ <li>
+ <a
href="https://www.openwall.com/lists/oss-security/2022/12/03/1";>Announcement on
oss-security</a>
+ </li>
+ <li>
+ <a
href="https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-37533";>Advisory
on cve.org</a>
+ </li>
+ </ul>
</subsection>
</section>
</body>
diff --git a/src/site/xdoc/tasks.xml b/src/site/xdoc/tasks.xml
index 8b3ca594..28c8f9b9 100644
--- a/src/site/xdoc/tasks.xml
+++ b/src/site/xdoc/tasks.xml
@@ -15,40 +15,37 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Tasks</title>
<author email="[email protected]">Jeffrey D. Brekke</author>
<author email="[email protected]">Rory Winston</author>
</properties>
-
<body>
<section name="Wishlist">
- <p>
- <ul>
- <li>Add more unit tests, and implement mock servers for testing</li>
- <li>
- Convert code to specified coding standards. Checkstyle report
provided.
- </li>
- <li>
- Clean out any classes that don't belong in this project. Probably
classes from
- org.apache.commons.net.util and org.apache.commons.net.io could be
moved to their corresponding commons projects.
- </li>
- <li>
- Parse the client/server interactions without creating so many
- strings. Many operations are slow because of this.
- </li>
- <li>
- Add ESMTP and more extended NNTP commands.
- </li>
- <li>
- Make NNTPClient.listNewsgroups() and NNTPClient.listNewNews()
- more efficient. Don't preparse into lots of little objects.
- </li>
- <li>FTP proxy support</li>
- </ul>
- </p>
+ <ul>
+ <li>Add more unit tests, and implement mock servers for testing</li>
+ <li>
+ Convert code to specified coding standards. Checkstyle report
provided.
+ </li>
+ <li>
+ Clean out any classes that don't belong in this project. Probably
classes from
+ org.apache.commons.net.util and org.apache.commons.net.io could be
moved to their corresponding commons projects.
+ </li>
+ <li>
+ Parse the client/server interactions without creating so many
+ strings. Many operations are slow because of this.
+ </li>
+ <li>
+ Add ESMTP and more extended NNTP commands.
+ </li>
+ <li>
+ Make NNTPClient.listNewsgroups() and NNTPClient.listNewNews()
+ more efficient. Don't preparse into lots of little objects.
+ </li>
+ <li>FTP proxy support</li>
+ </ul>
</section>
</body>
</document>
