Update docs for new commons.release.2.binary.suffix property, version and optional parameters
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/commons-build-plugin/trunk@912187 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/scripts/generate-xdocs.mojos.xml b/src/main/scripts/generate-xdocs.mojos.xml
index 6690984..5852d47 100644
--- a/src/main/scripts/generate-xdocs.mojos.xml
+++ b/src/main/scripts/generate-xdocs.mojos.xml
@@ -130,7 +130,7 @@
<parameter>
<name>commons.binary.suffix</name>
<property>commons.binary.suffix</property>
- <required>true</required>
+ <required>false</required>
<readonly>false</readonly>
<defaultValue>${commons.binary.suffix}</defaultValue>
<type>java.lang.String</type>
@@ -166,7 +166,7 @@
<parameter>
<name>commons.release.2.binary.suffix</name>
<property>commons.release.2.binary.suffix</property>
- <required>true</required>
+ <required>false</required>
<readonly>false</readonly>
<defaultValue>${commons.release.2.binary.suffix}</defaultValue>
<type>java.lang.String</type>
diff --git a/src/site/xdoc/copy-javadoc-files-mojo.xml b/src/site/xdoc/copy-javadoc-files-mojo.xml
index 64d8324..9a3d627 100644
--- a/src/site/xdoc/copy-javadoc-files-mojo.xml
+++ b/src/site/xdoc/copy-javadoc-files-mojo.xml
@@ -26,7 +26,7 @@
<body>
<section name="commons:copy-javadoc-files">
<p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.2-SNAPSHOT:copy-javadoc-files</p>
+ <p>org.apache.commons:commons-build-plugin:1.2:copy-javadoc-files</p>
<p><strong>Description</strong>:</p>
<div>Commons Build: Copy NOTICE and LICENSE files to -javadoc.jar</div>
<p><strong>Attributes</strong>:</p>
diff --git a/src/site/xdoc/download-page-mojo.xml b/src/site/xdoc/download-page-mojo.xml
index 93f400f..63820a7 100644
--- a/src/site/xdoc/download-page-mojo.xml
+++ b/src/site/xdoc/download-page-mojo.xml
@@ -26,7 +26,7 @@
<body>
<section name="commons:download-page">
<p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.2-SNAPSHOT:download-page</p>
+ <p>org.apache.commons:commons-build-plugin:1.2:download-page</p>
<p><strong>Description</strong>:</p>
<div>Commons Build Ant Mojo: Generate Download page</div>
<p><strong>Attributes</strong>:</p>
@@ -49,12 +49,6 @@
<td>The version of the latest release of the project.<br/><strong>Default value is</strong>: <code>${commons.release.version}</code>.</td>
</tr>
<tr>
- <td><strong><a href="#commons.binary.suffix">commons.binary.suffix</a></strong></td>
- <td><code>String</code></td>
- <td><code>-</code></td>
- <td>The suffix for the binary distro.<br/><strong>Default value is</strong>: <code>${commons.binary.suffix}</code>.</td>
- </tr>
- <tr>
<td><strong><a href="#basedir">basedir</a></strong></td>
<td><code>File</code></td>
<td><code>-</code></td>
@@ -71,6 +65,12 @@
<th>Description</th>
</tr>
<tr>
+ <td><strong><a href="#commons.binary.suffix">commons.binary.suffix</a></strong></td>
+ <td><code>String</code></td>
+ <td><code>-</code></td>
+ <td>The suffix for the binary distro.<br/><strong>Default value is</strong>: <code>${commons.binary.suffix}</code>.</td>
+ </tr>
+ <tr>
<td><strong><a href="#commons.release.desc">commons.release.desc</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
@@ -89,6 +89,12 @@
<td>Alternative Release Title or Description.<br/><strong>Default value is</strong>: <code>${commons.release.2.desc}</code>.</td>
</tr>
<tr>
+ <td><strong><a href="#commons.release.2.binary.suffix">commons.release.2.binary.suffix</a></strong></td>
+ <td><code>String</code></td>
+ <td><code>-</code></td>
+ <td>The suffix for the alternative release binary distro.<br/><strong>Default value is</strong>: <code>${commons.release.2.binary.suffix}</code>.</td>
+ </tr>
+ <tr>
<td><strong><a href="#messageLevel">messageLevel</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
@@ -103,6 +109,12 @@
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>${commons.release.version}</code></li>
+ </ul><hr/><p><strong><a name="commons.binary.suffix">commons.binary.suffix</a>:</strong></p>
+ <div>The suffix for the binary distro.</div>
+ <ul>
+ <li><strong>Type</strong>: <code>java.lang.String</code></li>
+ <li><strong>Required</strong>: <code>No</code></li>
+ <li><strong>Default</strong>: <code>${commons.binary.suffix}</code></li>
</ul><hr/><p><strong><a name="commons.release.desc">commons.release.desc</a>:</strong></p>
<div>Release Title or Description.</div>
<ul>
@@ -121,12 +133,12 @@
<li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>${commons.release.2.desc}</code></li>
- </ul><hr/><p><strong><a name="commons.binary.suffix">commons.binary.suffix</a>:</strong></p>
- <div>The suffix for the binary distro.</div>
+ </ul><hr/><p><strong><a name="commons.release.2.binary.suffix">commons.release.2.binary.suffix</a>:</strong></p>
+ <div>The suffix for the alternative release binary distro.</div>
<ul>
<li><strong>Type</strong>: <code>java.lang.String</code></li>
- <li><strong>Required</strong>: <code>Yes</code></li>
- <li><strong>Default</strong>: <code>${commons.binary.suffix}</code></li>
+ <li><strong>Required</strong>: <code>No</code></li>
+ <li><strong>Default</strong>: <code>${commons.release.2.binary.suffix}</code></li>
</ul><hr/><p><strong><a name="basedir">basedir</a>:</strong></p>
<div>The base directory from which to execute the Ant script.</div>
<ul>
diff --git a/src/site/xdoc/download-page.xml b/src/site/xdoc/download-page.xml
index a94f5cb..b8b8501 100644
--- a/src/site/xdoc/download-page.xml
+++ b/src/site/xdoc/download-page.xml
@@ -93,6 +93,8 @@
<ul>
<li><b>commons.release.2.version</b> - The version number of the alternative release of the component</li>
<li><b>commons.release.2.desc</b> - (<i>optional</i>) Additional text to append to the section name of the alternative release</li>
+ <li><b>commons.release.2.binary.suffix</b> - (<i>optional - defaults to <code>-bin</code></i>) The suffix for the alternative
+ binary release (some components use "-bin", others have no suffix)</li>
</ul>
</p>
<p>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index db9e901..86173ca 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -59,7 +59,7 @@
<plugin>
<groupId>org.apache.commons</groupId>
<artifactId>commons-build-plugin</artifactId>
- <version>1.0</version>
+ <version>1.2</version>
</plugin>
]]></source>
</p>
diff --git a/src/site/xdoc/jira-page-mojo.xml b/src/site/xdoc/jira-page-mojo.xml
index 30a067f..78d16b3 100644
--- a/src/site/xdoc/jira-page-mojo.xml
+++ b/src/site/xdoc/jira-page-mojo.xml
@@ -26,7 +26,7 @@
<body>
<section name="commons:jira-page">
<p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.2-SNAPSHOT:jira-page</p>
+ <p>org.apache.commons:commons-build-plugin:1.2:jira-page</p>
<p><strong>Description</strong>:</p>
<div>Commons Build Ant Mojo: Generate Issue Tracking page</div>
<p><strong>Attributes</strong>:</p>
diff --git a/src/site/xdoc/sandbox-jira-page-mojo.xml b/src/site/xdoc/sandbox-jira-page-mojo.xml
index a65dcfc..b6c332f 100644
--- a/src/site/xdoc/sandbox-jira-page-mojo.xml
+++ b/src/site/xdoc/sandbox-jira-page-mojo.xml
@@ -26,7 +26,7 @@
<body>
<section name="commons:sandbox-jira-page">
<p><strong>Full name</strong>:</p>
- <p>org.apache.commons:commons-build-plugin:1.2-SNAPSHOT:sandbox-jira-page</p>
+ <p>org.apache.commons:commons-build-plugin:1.2:sandbox-jira-page</p>
<p><strong>Description</strong>:</p>
<div>Commons Build Ant Mojo: Generate Sandbox Issue Tracking page</div>
<p><strong>Attributes</strong>:</p>
