This is an automated email from the ASF dual-hosted git repository.
sebb 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 377b35a1 Regenerate docs using commons-build
377b35a1 is described below
commit 377b35a143e39b4f56f5064e0daf5cd74e384e1c
Author: Sebb <s...@apache.org>
AuthorDate: Wed Jan 15 20:15:19 2025 +0000
Regenerate docs using commons-build
---
CONTRIBUTING.md | 9 +-
NOTICE.txt | 10 +-
README.md | 8 +-
src/site/xdoc/issue-tracking.xml | 204 +++++++++++++++++++--------------------
4 files changed, 115 insertions(+), 116 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c0684bf3..b4c77d21 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,9 +41,8 @@
Contributing to Apache Commons Net
======================
-You have found a bug or you have an idea for a cool new feature? Contributing
code is a great way to give something back to
-the open source community. Before you dig right into the code there are a few
guidelines that we need contributors to
-follow so that we can have a chance of keeping on top of things.
+Have you found a bug or have an idea for a cool new feature? Contributing code
is a great way to give something back to the open-source community.
+Before you dig right into the code, we need contributors to follow a few
guidelines to have a chance of keeping on top of things.
Getting Started
---------------
@@ -62,7 +61,7 @@ Making Changes
+ Create a _topic branch_ for your isolated work.
* Usually you should base your branch on the `master` branch.
- * A good topic branch name can be the JIRA bug id plus a keyword, e.g.
`NET-123-InputStream`.
+ * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.
`NET-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.
@@ -72,7 +71,7 @@ Making 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.
++ Run all the tests with `mvn clean verify` to ensure nothing else was
accidentally broken.
Making Trivial Changes
----------------------
diff --git a/NOTICE.txt b/NOTICE.txt
index 01de6848..bce36284 100644
--- a/NOTICE.txt
+++ b/NOTICE.txt
@@ -1,5 +1,5 @@
-Apache Commons Net
-Copyright 2001-2025 The Apache Software Foundation
-
-This product includes software developed at
-The Apache Software Foundation (https://www.apache.org/).
+Apache Commons Net
+Copyright 2001-2025 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (https://www.apache.org/).
diff --git a/README.md b/README.md
index a7c12486..c42974b0 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Apache Commons Net
[](https://github.com/apache/commons-net/actions/workflows/maven.yml)
[](https://search.maven.org/artifact/commons-net/commons-net)
-[](https://javadoc.io/doc/commons-net/commons-net/3.11.1)
+[](https://javadoc.io/doc/commons-net/commons-net/3.12.0)
[](https://github.com/apache/commons-net/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-net)
@@ -63,20 +63,20 @@ Getting the latest release
--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-net/download_net.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>commons-net</groupId>
<artifactId>commons-net</artifactId>
- <version>3.11.1</version>
+ <version>3.12.0</version>
</dependency>
```
Building
--------
-Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index e0abc2ef..113aa6c4 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -1,102 +1,102 @@
-<?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.
--->
-<!--
- +======================================================================+
- |**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
- |**** ****|
- +======================================================================+
- | TEMPLATE FILE: issue-tracking-template.xml |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build:jira-page |
- | |
- | 2) Set the following properties in the component's pom: |
- | - commons.jira.id (required, alphabetic, upper case) |
- | - commons.jira.pid (required, numeric) |
- | |
- | 3) Example Properties |
- | |
- | <properties> |
- | <commons.jira.id>MATH</commons.jira.id> |
- | <commons.jira.pid>12310485</commons.jira.pid> |
- | </properties> |
- | |
- +======================================================================+
--->
-<document>
- <properties>
- <title>Apache Commons Net Issue tracking</title>
- <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
- </properties>
- <body>
-
- <section name="Apache Commons Net Issue tracking">
- <p>
- Apache Commons Net uses <a href="https://issues.apache.org/jira/";>ASF
JIRA</a> for tracking issues.
- See the <a href="https://issues.apache.org/jira/browse/NET";>Apache
Commons Net JIRA project page</a>.
- </p>
-
- <p>
- 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="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
- Apache Commons Net please do the following:
- <ol>
- <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310487&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="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310487&issuetype=1&priority=4&assignee=-1";>bug
report</a>
- or <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310487&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
- </ol>
- </p>
-
- <p>
- Please also remember these points:
- <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 Apache Commons Net are all unpaid volunteers</li>
- </ul>
- </p>
-
- <p>
- For more information on creating patches see the
- <a href="https://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
- </p>
-
- <p>
- You may also find these links useful:
- <ul>
- <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310487&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Apache Commons Net bugs</a></li>
- <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310487&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Apache Commons Net bugs</a></li>
- <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310487&sorter/field=issuekey&sorter/order=DESC";>All
Apache Commons Net bugs</a></li>
- </ul>
- </p>
- </section>
- </body>
-</document>
+<?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.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: issue-tracking-template.xml |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons-build:jira-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.jira.id (required, alphabetic, upper case) |
+ | - commons.jira.pid (required, numeric) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.jira.id>MATH</commons.jira.id> |
+ | <commons.jira.pid>12310485</commons.jira.pid> |
+ | </properties> |
+ | |
+ +======================================================================+
+-->
+<document>
+ <properties>
+ <title>Apache Commons Net Issue tracking</title>
+ <author email="d...@commons.apache.org">Apache Commons Documentation
Team</author>
+ </properties>
+ <body>
+
+ <section name="Apache Commons Net Issue tracking">
+ <p>
+ Apache Commons Net uses <a href="https://issues.apache.org/jira/";>ASF
JIRA</a> for tracking issues.
+ See the <a href="https://issues.apache.org/jira/browse/NET";>Apache
Commons Net JIRA project page</a>.
+ </p>
+
+ <p>
+ 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="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
+ Apache Commons Net please do the following:
+ <ol>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310487&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="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310487&issuetype=1&priority=4&assignee=-1";>bug
report</a>
+ or <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310487&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
+ </ol>
+ </p>
+
+ <p>
+ Please also remember these points:
+ <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 Apache Commons Net are all unpaid volunteers</li>
+ </ul>
+ </p>
+
+ <p>
+ For more information on creating patches see the
+ <a href="https://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
+ </p>
+
+ <p>
+ You may also find these links useful:
+ <ul>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310487&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Apache Commons Net bugs</a></li>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310487&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Apache Commons Net bugs</a></li>
+ <li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310487&sorter/field=issuekey&sorter/order=DESC";>All
Apache Commons Net bugs</a></li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>
