You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2022/08/30 12:32:13 UTC
[commons-release-plugin] branch master updated: Fix minor typos (#131)
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-release-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 7020e31 Fix minor typos (#131)
7020e31 is described below
commit 7020e31c9dc80b183f159c07f07f511b3656f5ae
Author: Marc Wrobel <ma...@gmail.com>
AuthorDate: Tue Aug 30 14:32:09 2022 +0200
Fix minor typos (#131)
---
RELEASE-NOTES.txt | 4 ++--
src/changes/changes.xml | 2 +-
.../release/plugin/mojos/CommonsDistributionDetachmentMojo.java | 2 +-
.../release/plugin/mojos/CommonsDistributionStagingMojo.java | 2 +-
.../commons/release/plugin/mojos/CommonsSiteCompressionMojo.java | 6 +++---
.../commons/release/plugin/mojos/CommonsStagingCleanupMojo.java | 6 +++---
.../java/org/apache/commons/release/plugin/mojos/package-info.java | 2 +-
.../commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java | 2 +-
.../org/apache/commons/release/plugin/velocity/package-info.java | 5 ++---
src/main/resources/signature-validator.sh | 2 +-
src/site/xdoc/index.xml | 2 +-
src/site/xdoc/mail-lists.xml | 2 +-
src/site/xdoc/vote-txt.xml | 2 +-
13 files changed, 19 insertions(+), 20 deletions(-)
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 3a284ac..8fa6023 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -50,7 +50,7 @@ o Bump taglist-maven-plugin from 2.4 to 3.0.0 #100. Thanks to
Historical list of changes: https://commons.apache.org/proper/commons-release-plugin//changes-report.html
For complete information on Apache Commons Release Plugin, including instructions on how to submit bug reports,
-patches, or suggestions for improvement, see the Apache Apache Commons Release Plugin website:
+patches, or suggestions for improvement, see the Apache Commons Release Plugin website:
https://commons.apache.org/proper/commons-release-plugin/
@@ -145,7 +145,7 @@ Changes in this version include:
NEW FEATURES
============
-o COMMONSSITE-123: introduce configuration parameter to perfom distribution checkin using Maven settings server credentials
+o COMMONSSITE-123: introduce configuration parameter to perform distribution checkin using Maven settings server credentials
FIXED BUGS
==========
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 12d4996..8e93544 100755
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -106,7 +106,7 @@
<action type="fix" dev="chtompki">ReadmeHtmlVelocityDelegate, bcel's artifactId != commons-bcel, but is just bcel</action>
<action type="update" dev="ggregory">Drop sha-256 and leave sha-512 only</action>
<action type="update" dev="ggregory">commons.jacoco.version: 0.8.0 -> 0.8.2; java 11 compatibility</action>
- <action issue="COMMONSSITE-123" type="add" dev="mbenson">introduce configuration parameter to perfom distribution checkin using Maven settings server credentials</action>
+ <action issue="COMMONSSITE-123" type="add" dev="mbenson">introduce configuration parameter to perform distribution checkin using Maven settings server credentials</action>
<action issue="COMMONSSITE-122" type="fix" dev="mbenson">stage-distributions mojo assumes site directory has basename 'site'</action>
</release>
diff --git a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java
index 2daa666..868ef9f 100755
--- a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java
+++ b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java
@@ -270,7 +270,7 @@ public class CommonsDistributionDetachmentMojo extends AbstractMojo {
/**
* Generates the unique artifact key for storage in our sha512 map. For example,
- * commons-test-1.4-src.tar.gz should have it's name as the key.
+ * commons-test-1.4-src.tar.gz should have its name as the key.
*
* @param artifact the {@link Artifact} that we wish to generate a key for.
* @return the generated key
diff --git a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java
index e067e80..21a7077 100755
--- a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java
+++ b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java
@@ -105,7 +105,7 @@ public class CommonsDistributionStagingMojo extends AbstractMojo {
private File workingDirectory;
/**
- * The location to which to checkout the dist subversion repository under our working directory, which
+ * The location to which to check out the dist subversion repository under our working directory, which
* was given above.
*/
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm",
diff --git a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.java b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.java
index d7c91d3..ba26ee6 100755
--- a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.java
+++ b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.java
@@ -65,7 +65,7 @@ public class CommonsSiteCompressionMojo extends AbstractMojo {
private File siteDirectory;
/**
- * The url of the subversion repository to which we wish the artifacts to be staged. Typicallly
+ * The url of the subversion repository to which we wish the artifacts to be staged. Typically
* this would need to be of the form:
* <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the
* substring <code>https</code> is a requirement.
@@ -119,7 +119,7 @@ public class CommonsSiteCompressionMojo extends AbstractMojo {
}
/**
- * By default this method iterates across the <code>target/site</code> directory and adds all of the files
+ * By default this method iterates across the <code>target/site</code> directory and adds all the files
* to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.
*
* @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.
@@ -136,7 +136,7 @@ public class CommonsSiteCompressionMojo extends AbstractMojo {
}
/**
- * A helper method for writing all of the files in our <code>fileList</code> to a <code>site.zip</code> file
+ * A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file
* in the <code>workingDirectory</code>.
*
* @param outputDirectory is a {@link File} representing the place to put the site.zip file.
diff --git a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.java b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.java
index c9a89ae..eec5548 100644
--- a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.java
+++ b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.java
@@ -45,8 +45,8 @@ import java.util.Arrays;
import java.util.List;
/**
- * This class checks out the dev distribution location, checkes whether anything exists in the
- * distribution location, and if it is non-empty it deletes all of the resources there.
+ * This class checks out the dev distribution location, checks whether anything exists in the
+ * distribution location, and if it is non-empty it deletes all the resources there.
*
* @author chtompki
* @since 1.6
@@ -73,7 +73,7 @@ public class CommonsStagingCleanupMojo extends AbstractMojo {
/**
* The location to which to checkout the dist subversion repository under our working directory, which
- * was given above. We then do an SVN delete on all of the directories in this repository.
+ * was given above. We then do an SVN delete on all the directories in this repository.
*/
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm-cleanup",
property = "commons.distCleanupDirectory")
diff --git a/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java b/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java
index 6c463a2..950e6c2 100755
--- a/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java
+++ b/src/main/java/org/apache/commons/release/plugin/mojos/package-info.java
@@ -15,7 +15,7 @@
* limitations under the License.
*/
/**
- * This package contains all of the maven mojos for the commons-release-plugin. Currently
+ * This package contains all the maven mojos for the commons-release-plugin. Currently
* this only has the following mojos:
* <ul>
* <li>{@link org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo},</li>
diff --git a/src/main/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java b/src/main/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java
index 8e2042d..34cc0b8 100755
--- a/src/main/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java
+++ b/src/main/java/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.java
@@ -32,7 +32,7 @@ import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
*/
public class HeaderHtmlVelocityDelegate {
- /** The location of the velocity tempate for this class. */
+ /** The location of the velocity template for this class. */
private static final String TEMPLATE = "resources/org/apache/commons/release/plugin/velocity/HEADER.vm";
/** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */
diff --git a/src/main/java/org/apache/commons/release/plugin/velocity/package-info.java b/src/main/java/org/apache/commons/release/plugin/velocity/package-info.java
index 6983ad6..d3f9de0 100755
--- a/src/main/java/org/apache/commons/release/plugin/velocity/package-info.java
+++ b/src/main/java/org/apache/commons/release/plugin/velocity/package-info.java
@@ -17,12 +17,11 @@
/**
* Contains classes that take our velocity templates and render's them to a {@link java.io.Writer}
* class.
- *
- * The main reason for velocity tempates are to fill out the
+ * <p>
+ * The main reason for velocity templates are to fill out the following files that get deployed alongside:
* <ul>
* <li><code>HEADER.html</code></li>
* <li><code>README.html</code></li>
* </ul>
- * That get deployed along side
*/
package org.apache.commons.release.plugin.velocity;
diff --git a/src/main/resources/signature-validator.sh b/src/main/resources/signature-validator.sh
index df27d84..f90c4fc 100644
--- a/src/main/resources/signature-validator.sh
+++ b/src/main/resources/signature-validator.sh
@@ -30,7 +30,7 @@
#
# From here you run ./signature-validation.sh and it will create a directory "artifacts-for-validation-deletable-post-validation
# in which all of the binaries generated by a release are copied and then it checks to see that all of the signatures and hashes
-# are infact correct for the artifacts.
+# are in fact correct for the artifacts.
#
###########
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 4411344..392e9ab 100755
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -42,7 +42,7 @@
for detaching distribution artifacts (i.e. all <code>tar.gz</code> artifacts and
signatures as well as all <code>.zip</code> artifacts and signatures), creating
a <code>site.zip</code> file, and staging all of those artifacts in a subversion
- repository (for the most part a sub directory of
+ repository (for the most part a subdirectory of
<a href="https://dist.apache.org/repos/dist/dev/commons/">https://dist.apache.org/repos/dist/dev/commons/</a>.
It can, however, stage to any subversion repository.
</p>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index d37f068..014eb32 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -158,7 +158,7 @@ limitations under the License.
<td>
<strong>Commons Commits List</strong>
<br /><br />
- Only for e-mails automatically generated by the <a href="scm.html">source control</a> sytem.
+ Only for e-mails automatically generated by the <a href="scm.html">source control</a> system.
<br /><br />
</td>
<td><a href="mailto:commits-subscribe@commons.apache.org">Subscribe</a></td>
diff --git a/src/site/xdoc/vote-txt.xml b/src/site/xdoc/vote-txt.xml
index 7b2df2a..fe0ad00 100755
--- a/src/site/xdoc/vote-txt.xml
+++ b/src/site/xdoc/vote-txt.xml
@@ -40,7 +40,7 @@
<p>
This goal uses the following:
<ul>
- <li>The goal is mapped to the ant script/target using the <code>vote-txt</code> mojo defintion in the
+ <li>The goal is mapped to the ant script/target using the <code>vote-txt</code> mojo definition in the
<a href="http://svn.apache.org/repos/asf/commons/proper/commons-release-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml">generate-xdocs.mojos.xml</a> mapping document</li>
<li>Executes the <code>vote-txt</code> target in
<a href="http://svn.apache.org/repos/asf/commons/proper/commons-release-plugin/trunk/src/main/scripts/generate-xdocs.build.xml">generate-xdocs.build.xml</a>