This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch release
in repository https://gitbox.apache.org/repos/asf/commons-cli.git
The following commit(s) were added to refs/heads/release by this push:
new 560bac07 Update site documentation to
https://maven.apache.org/xsd/xdoc-2.0.xsd
560bac07 is described below
commit 560bac07d13eff56c99fb9c259045d8c2b1ae061
Author: Gary D. Gregory <[email protected]>
AuthorDate: Tue Jan 14 16:15:13 2025 -0500
Update site documentation to https://maven.apache.org/xsd/xdoc-2.0.xsd
Doxia 1 to 2 for the new commons-parent 79
---
src/changes/changes.xml | 5 ++-
src/site/xdoc/index.xml | 7 ++--
src/site/xdoc/introduction.xml | 7 ++--
src/site/xdoc/issue-tracking.xml | 14 ++++---
src/site/xdoc/mail-lists.xml | 12 +++---
src/site/xdoc/properties.xml | 7 ++--
src/site/xdoc/release_1_0.xml | 6 ++-
src/site/xdoc/release_1_2.xml | 6 ++-
src/site/xdoc/release_1_3.xml | 6 ++-
src/site/xdoc/release_1_3_1.xml | 6 ++-
src/site/xdoc/release_1_4.xml | 6 ++-
src/site/xdoc/upgrading-1.0-to-1.1.xml | 6 ++-
src/site/xdoc/usage.xml | 70 ++++++++++++++++++----------------
13 files changed, 92 insertions(+), 66 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 9d94b1bd..865c87d6 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -29,7 +29,7 @@
<action type="fix" dev="ggregory" due-to="Dávid Szigecsán">Refactor
default parser test #294.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory">Port to JUnit
5.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory">Generics for
Converter should use Exception not Throwable.</action>
- <action type="fix" dev="ggregory" due-to="Gary Gregory">Pick up
maven-antrun-plugin version from parent POM org.apache:apache.</action>
+ <action type="fix" dev="ggregory" due-to="Gary Gregory">Pick up
maven-antrun-plugin version from parent POM org.apache:apache.</action>
<!-- ADD -->
<action type="add" issue="CLI-339" dev="ggregory" due-to="Claude Warren,
Gary Gregory">Help formatter extension in the new package #314.</action>
<action type="add" dev="ggregory" due-to="Gary
Gregory">CommandLine.Builder implements Supplier<CommandLine>.</action>
@@ -38,7 +38,8 @@
<!-- UPDATE -->
<action type="update" dev="ggregory" due-to="Gary Gregory,
Dependabot">Bump org.apache.commons:commons-parent from 72 to 79 #302, #304,
#310, #315, #320, #327.</action>
<action type="update" dev="ggregory" due-to="Gary Gregory,
Dependabot">[test] Bump commons-io:commons-io from 2.16.1 to 2.18.0 #309,
#337.</action>
- <action type="update" dev="ggregory" due-to="Gary Gregory,
Dependabot">[test] Bump org.apache.commons:commons-text from 1.12.0 to 1.13.0
#344.</action>
+ <action type="update" dev="ggregory" due-to="Gary Gregory,
Dependabot">[test] Bump org.apache.commons:commons-text from 1.12.0 to 1.13.0
#344.</action>
+ <action type="update" dev="ggregory" due-to="Gary Gregory">Update site
documentation to https://maven.apache.org/xsd/xdoc-2.0.xsd.</action>
</release>
<release version="1.9.0" date="2024-08-10" description="This release
contains new features and bug fixes and requires Java 8 or above.">
<!-- ADD -->
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 202a3a8f..89ab52f5 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -17,11 +17,12 @@
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 CLI</title>
- <author email="[email protected]">commons-dev</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
diff --git a/src/site/xdoc/introduction.xml b/src/site/xdoc/introduction.xml
index c90b6738..3bc4d4fd 100644
--- a/src/site/xdoc/introduction.xml
+++ b/src/site/xdoc/introduction.xml
@@ -17,11 +17,12 @@
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>
- <author email="[email protected]">commons-dev</author>
<title>Introducing Apache Commons CLI</title>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
index edcfaf04..01ff5d78 100644
--- a/src/site/xdoc/issue-tracking.xml
+++ b/src/site/xdoc/issue-tracking.xml
@@ -7,7 +7,7 @@ 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
+ https://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,
@@ -41,10 +41,12 @@ 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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Apache Commons CLI Issue tracking</title>
- <author email="[email protected]">Apache Commons Documentation
Team</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
@@ -64,6 +66,7 @@ limitations under the License.
<p>
If you would like to report a bug, or raise an enhancement request with
Apache Commons CLI please do the following:
+ </p>
<ol>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310463&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>
@@ -73,16 +76,15 @@ limitations under the License.
<li>Submit either a <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310463&issuetype=1&priority=4&assignee=-1";>bug
report</a>
or <a
href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310463&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
</ol>
- </p>
<p>
Please also remember these points:
+ </p>
<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 CLI are all unpaid volunteers</li>
</ul>
- </p>
<p>
For more information on creating patches see the
@@ -91,12 +93,12 @@ limitations under the License.
<p>
You may also find these links useful:
+ </p>
<ul>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310463&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Apache Commons CLI bugs</a></li>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310463&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Apache Commons CLI bugs</a></li>
<li><a
href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310463&sorter/field=issuekey&sorter/order=DESC";>All
Apache Commons CLI bugs</a></li>
</ul>
- </p>
</section>
</body>
</document>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index a2f53558..1dbe7b62 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -39,10 +39,12 @@ 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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Apache Commons CLI Mailing Lists</title>
- <author email="[email protected]">Apache Commons Documentation
Team</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
@@ -53,10 +55,10 @@ limitations under the License.
To make it easier for people to only read messages related to
components they are interested in,
the convention in Commons is to prefix the subject line of messages
with the component's name,
for example:
- <ul>
- <li>[cli] Problem with the ...</li>
- </ul>
</p>
+ <ul>
+ <li>[cli] Problem with the ...</li>
+ </ul>
<p>
Questions related to the usage of Apache Commons CLI should be posted
to the
<a
href="https://lists.apache.org/[email protected]";>User List</a>.
diff --git a/src/site/xdoc/properties.xml b/src/site/xdoc/properties.xml
index e5e43f9d..97b22989 100644
--- a/src/site/xdoc/properties.xml
+++ b/src/site/xdoc/properties.xml
@@ -17,11 +17,12 @@
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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
- <author email="[email protected]">commons-dev</author>
<title>Defining Option Properties</title>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
diff --git a/src/site/xdoc/release_1_0.xml b/src/site/xdoc/release_1_0.xml
index 3bceb7e2..bd6ae565 100644
--- a/src/site/xdoc/release_1_0.xml
+++ b/src/site/xdoc/release_1_0.xml
@@ -15,10 +15,12 @@ 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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Release notes for CLI 1.0</title>
- <author email="[email protected]">Commons Documentation Team</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
diff --git a/src/site/xdoc/release_1_2.xml b/src/site/xdoc/release_1_2.xml
index 8f83b7ea..d86b5ec8 100644
--- a/src/site/xdoc/release_1_2.xml
+++ b/src/site/xdoc/release_1_2.xml
@@ -15,10 +15,12 @@ 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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Release notes for CLI 1.2</title>
- <author email="[email protected]">Commons Documentation Team</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
diff --git a/src/site/xdoc/release_1_3.xml b/src/site/xdoc/release_1_3.xml
index 5c2de24a..dc2f35d2 100644
--- a/src/site/xdoc/release_1_3.xml
+++ b/src/site/xdoc/release_1_3.xml
@@ -15,10 +15,12 @@ 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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Release notes for CLI 1.3</title>
- <author email="[email protected]">Commons Documentation Team</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
diff --git a/src/site/xdoc/release_1_3_1.xml b/src/site/xdoc/release_1_3_1.xml
index 3a8d6985..acf03919 100644
--- a/src/site/xdoc/release_1_3_1.xml
+++ b/src/site/xdoc/release_1_3_1.xml
@@ -15,10 +15,12 @@ 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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Release notes for CLI 1.3.1</title>
- <author email="[email protected]">Commons Documentation Team</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
diff --git a/src/site/xdoc/release_1_4.xml b/src/site/xdoc/release_1_4.xml
index 70545f1d..967a5315 100644
--- a/src/site/xdoc/release_1_4.xml
+++ b/src/site/xdoc/release_1_4.xml
@@ -15,10 +15,12 @@ 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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Release notes for CLI 1.4</title>
- <author email="[email protected]">Commons Documentation Team</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
diff --git a/src/site/xdoc/upgrading-1.0-to-1.1.xml
b/src/site/xdoc/upgrading-1.0-to-1.1.xml
index 8071433b..7f6b7ccc 100644
--- a/src/site/xdoc/upgrading-1.0-to-1.1.xml
+++ b/src/site/xdoc/upgrading-1.0-to-1.1.xml
@@ -15,10 +15,12 @@ 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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Upgrading from 1.0 to 1.1</title>
- <author email="[email protected]">Commons Documentation Team</author>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
<!-- ================================================== -->
diff --git a/src/site/xdoc/usage.xml b/src/site/xdoc/usage.xml
index 656f8f1f..bfb16ec8 100644
--- a/src/site/xdoc/usage.xml
+++ b/src/site/xdoc/usage.xml
@@ -17,11 +17,12 @@
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
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
- <author email="[email protected]">commons-dev</author>
<title>Using Apache Commons CLI</title>
+ <author email="[email protected]">Apache Commons Team</author>
</properties>
<body>
@@ -91,7 +92,7 @@ else {
// print the date
}</source>
<p>
- <h4>Note.</h4>
+ <em>Note.</em>
As of version 1.5, the
<code>DefaultParser</code>'s constructor now has an override with
the signature <code>DefaultParser(final boolean
allowPartialMatching)</code>.
@@ -221,9 +222,10 @@ Option find = Option.builder("find")
.hasArgs()
.valueSeparator('=')
.build();</source>
-
+ <p>
The map of properties specified by this option can later be
retrieved by
calling <code>getOptionProperties("D")</code> on the
<code>CommandLine</code>.
+ </p>
</subsection>
<subsection name="Creating the Options">
@@ -418,28 +420,30 @@ public static void main(String[] args) {
} </source>
<p>
The value types natively supported by commons-cli are:
- <ul>
- <li>Object.class - The string value must be the name of a
class with a no argument constructor</li>
- <li>Class.class - The string value must be the name of a
class</li>
- <li>Date.class - The string value must be a date parsable by
<code>new SimpleDateFormat("EEE MMM dd HH:mm:ss zzz yyyy")</code></li>
- <li>File.class - The string value is the name of the file.</li>
- <li>Path.class - The string value is the name of a Path.</li>
- <li>Number.class - The string value is a number representation
can can be converted into an Integer or a Double.</li>
- <li>URL.class - The string value is the textual representation
of a URL</li>
- <li>FileInputStream.class - The string value is passed to
<code>new FileInputStream(s)</code>.</li>
- <li>Long.class - The string value is a valid argument to
<code>Long.parseLong()</code>.</li>
- <li>Integer.class - The string value is a valid argument to
<code>Integer.parseInt()</code>.</li>
- <li>Short.class - The string value is a valid argument to
<code>Short.parseShort()</code>.</li>
- <li>Byte.class - The string value is a valid argument to
<code>Byte.parseByte()</code>.</li>
- <li>Character.class - The string value is either a UTF-8
encoding for a character (e.g. "\\u0124") or the first character from the
String."</li>
- <li>Double.class - The string value is a valid argument to
<code>Double.parseDouble()</code>.</li>
- <li>Float.class - The string value is a valid argument to
<code>Float.parseFloat()</code>.</li>
- <li>BigInteger.class - The string value is a valid argument to
<code>new BigInteger(s)</code>.</li>
- <li>BigDecimal.class - The string value is a valid argument to
<code>new BigDecimal(s)</code>.</li>
- </ul>
- Additional types may be added to the automatic parsing system by
calling <code>TypeHandler.register(Class<T> clazz, Converter<T>
converter)</code>.
- The <code>Class<T></code> can be any defined class. The
converter is a function that takes a <code>String</code> argument and returns
an instance of
- the class. Any exception thrown by the constructor will be caught
and reported as a <code>ParseException</code>
+ </p>
+ <ul>
+ <li>Object.class - The string value must be the name of a class
with a no argument constructor</li>
+ <li>Class.class - The string value must be the name of a class</li>
+ <li>Date.class - The string value must be a date parsable by
<code>new SimpleDateFormat("EEE MMM dd HH:mm:ss zzz yyyy")</code></li>
+ <li>File.class - The string value is the name of the file.</li>
+ <li>Path.class - The string value is the name of a Path.</li>
+ <li>Number.class - The string value is a number representation can
can be converted into an Integer or a Double.</li>
+ <li>URL.class - The string value is the textual representation of
a URL</li>
+ <li>FileInputStream.class - The string value is passed to
<code>new FileInputStream(s)</code>.</li>
+ <li>Long.class - The string value is a valid argument to
<code>Long.parseLong()</code>.</li>
+ <li>Integer.class - The string value is a valid argument to
<code>Integer.parseInt()</code>.</li>
+ <li>Short.class - The string value is a valid argument to
<code>Short.parseShort()</code>.</li>
+ <li>Byte.class - The string value is a valid argument to
<code>Byte.parseByte()</code>.</li>
+ <li>Character.class - The string value is either a UTF-8 encoding
for a character (e.g. "\\u0124") or the first character from the String."</li>
+ <li>Double.class - The string value is a valid argument to
<code>Double.parseDouble()</code>.</li>
+ <li>Float.class - The string value is a valid argument to
<code>Float.parseFloat()</code>.</li>
+ <li>BigInteger.class - The string value is a valid argument to
<code>new BigInteger(s)</code>.</li>
+ <li>BigDecimal.class - The string value is a valid argument to
<code>new BigDecimal(s)</code>.</li>
+ </ul>
+ <p>
+ Additional types may be added to the automatic parsing system by
calling <code>TypeHandler.register(Class<T> clazz, Converter<T>
converter)</code>.
+ The <code>Class<T></code> can be any defined class. The
converter is a function that takes a <code>String</code> argument and returns
an instance of
+ the class. Any exception thrown by the constructor will be caught
and reported as a <code>ParseException</code>
</p>
<p>
Conversions can be specified without using the
<code>TypeHandler</code> class by specifying the converter
@@ -580,11 +584,13 @@ public static void main(String[] args) {
<p>
The display of deprecated options may be changed through the use
of the
<code>HelpFormatter.Builder.setShowDeprecated()</code> method.
- <ul>
- <li>Calling
<code>HelpFormatter.Builder.setShowDeprecated(false)</code> will disable the
"[Deprecated]" tag.</li>
- <li>Calling
<code>HelpFormatter.Builder.setShowDeprecated</code> with a
<code>Function<Option, String></code>
- will use the output of the function as the description
for the option.</li>
- </ul>
+ </p>
+ <ul>
+ <li>Calling
<code>HelpFormatter.Builder.setShowDeprecated(false)</code> will disable the
"[Deprecated]" tag.</li>
+ <li>Calling <code>HelpFormatter.Builder.setShowDeprecated</code>
with a <code>Function<Option, String></code>
+ will use the output of the function as the description for
the option.</li>
+ </ul>
+ <p>
As an example of the second case above, changing the
implementation of <code>doSomething</code> to
<source>
void doSomething(Options options) {
