You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2025/06/29 12:28:53 UTC
(maven-gpg-plugin) branch spell created (now fb7f763)
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a change to branch spell
in repository https://gitbox.apache.org/repos/asf/maven-gpg-plugin.git
at fb7f763 Copy edit parameter descriptions
This branch includes the following new commits:
new fb7f763 Copy edit parameter descriptions
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(maven-gpg-plugin) 01/01: Copy edit parameter descriptions
Posted by el...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch spell
in repository https://gitbox.apache.org/repos/asf/maven-gpg-plugin.git
commit fb7f76370e3ff1791efb22f7738724d789ee3f9c
Author: Elliotte Rusty Harold <el...@ibiblio.org>
AuthorDate: Sun Jun 29 08:28:36 2025 -0400
Copy edit parameter descriptions
---
.../java/org/apache/maven/plugins/gpg/AbstractGpgMojo.java | 12 ++++++------
.../java/org/apache/maven/plugins/gpg/FilesCollector.java | 2 +-
.../org/apache/maven/plugins/gpg/SignAndDeployFileMojo.java | 6 +++---
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/gpg/AbstractGpgMojo.java b/src/main/java/org/apache/maven/plugins/gpg/AbstractGpgMojo.java
index e1c9a23..271921e 100644
--- a/src/main/java/org/apache/maven/plugins/gpg/AbstractGpgMojo.java
+++ b/src/main/java/org/apache/maven/plugins/gpg/AbstractGpgMojo.java
@@ -45,7 +45,7 @@ public abstract class AbstractGpgMojo extends AbstractMojo {
public static final String DEFAULT_ENV_MAVEN_GPG_PASSPHRASE = "MAVEN_GPG_PASSPHRASE";
/**
- * BC Signer only: The comma separate list of Unix Domain Socket paths, to use to communicate with GnuPG agent.
+ * BC Signer only: The comma separated list of Unix Domain Socket paths, to use to communicate with GnuPG agent.
* If relative, they are resolved against user home directory.
*
* @since 3.2.0
@@ -118,7 +118,7 @@ public abstract class AbstractGpgMojo extends AbstractMojo {
* The passphrase to use when signing. If not given, look up the value under Maven
* settings using server id at 'passphraseServerKey' configuration. <em>Do not use this parameter, it leaks
* sensitive data. Passphrase should be provided only via gpg-agent or via env variable.
- * If parameter {@link #bestPractices} set to {@code true}, plugin fails when this parameter is configured.</em>
+ * If parameter {@link #bestPractices} is set to {@code true}, the plugin fails when this parameter is configured.</em>
*
* @deprecated Do not use this configuration, it may leak sensitive information. Rely on gpg-agent or env
* variables instead.
@@ -128,10 +128,10 @@ public abstract class AbstractGpgMojo extends AbstractMojo {
private String passphrase;
/**
- * Server id to lookup the passphrase under Maven settings. <em>Do not use this parameter, it leaks
+ * Server id to look up the passphrase under Maven settings. <em>Do not use this parameter. It leaks
* sensitive data. Passphrase should be provided only via gpg-agent or via env variable.
- * If parameter {@link #bestPractices} set to {@code true}, plugin fails when this parameter is configured.</em>
- * Is programatically defaulted to {@link #GPG_PASSPHRASE}.
+ * If the parameter {@link #bestPractices} is set to {@code true}, the plugin fails when this parameter is configured.</em>
+ * Programmatically defaults to {@link #GPG_PASSPHRASE}.
*
* @since 1.6
* @deprecated Do not use this configuration, it may leak sensitive information. Rely on gpg-agent or env
@@ -214,7 +214,7 @@ public abstract class AbstractGpgMojo extends AbstractMojo {
private String publicKeyring;
/**
- * GPG Signer only: The lock mode to use when invoking gpg. By default no lock mode will be specified. Valid
+ * GPG Signer only: The lock mode to use when invoking gpg. By default, no lock mode will be specified. Valid
* values are {@code once}, {@code multiple} and {@code never}. The lock mode gets translated into the
* corresponding {@code --lock-___} command line argument. Improper usage of this option may lead to data and
* key corruption.
diff --git a/src/main/java/org/apache/maven/plugins/gpg/FilesCollector.java b/src/main/java/org/apache/maven/plugins/gpg/FilesCollector.java
index 8f35a92..55c6101 100644
--- a/src/main/java/org/apache/maven/plugins/gpg/FilesCollector.java
+++ b/src/main/java/org/apache/maven/plugins/gpg/FilesCollector.java
@@ -126,7 +126,7 @@ public class FilesCollector {
}
/**
- * Tests whether or not a name matches at least one exclude pattern.
+ * Tests whether a name matches at least one exclude pattern.
*
* @param artifact the artifact to match. Must not be <code>null</code>.
* @return <code>true</code> when the name matches at least one exclude pattern, or <code>false</code>
diff --git a/src/main/java/org/apache/maven/plugins/gpg/SignAndDeployFileMojo.java b/src/main/java/org/apache/maven/plugins/gpg/SignAndDeployFileMojo.java
index cbe0205..76edaa3 100644
--- a/src/main/java/org/apache/maven/plugins/gpg/SignAndDeployFileMojo.java
+++ b/src/main/java/org/apache/maven/plugins/gpg/SignAndDeployFileMojo.java
@@ -166,21 +166,21 @@ public class SignAndDeployFileMojo extends AbstractGpgMojo {
private int retryFailedDeploymentCount;
/**
- * A comma separated list of types for each of the extra side artifacts to deploy. If there is a mis-match in
+ * A comma separated list of types for each of the extra side artifacts to deploy. If there is a mismatch in
* the number of entries in {@link #files} or {@link #classifiers}, then an error will be raised.
*/
@Parameter(property = "types")
private String types;
/**
- * A comma separated list of classifiers for each of the extra side artifacts to deploy. If there is a mis-match in
+ * A comma separated list of classifiers for each of the extra side artifacts to deploy. If there is a mismatch in
* the number of entries in {@link #files} or {@link #types}, then an error will be raised.
*/
@Parameter(property = "classifiers")
private String classifiers;
/**
- * A comma separated list of files for each of the extra side artifacts to deploy. If there is a mis-match in
+ * A comma separated list of files for each of the extra side artifacts to deploy. If there is a mismatch in
* the number of entries in {@link #types} or {@link #classifiers}, then an error will be raised.
*/
@Parameter(property = "files")