This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 7c379680 Typos and grammar (#1213)
7c379680 is described below
commit 7c379680adba4cd904fa737fb8b57500bfd6de94
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Fri Jan 2 10:54:51 2026 +0000
Typos and grammar (#1213)
---
.../maven/plugins/site/deploy/AbstractDeployMojo.java | 14 +++++++-------
.../maven/plugins/site/deploy/SiteStageDeployMojo.java | 2 +-
.../site/descriptor/AbstractSiteDescriptorMojo.java | 4 ++--
.../plugins/site/descriptor/SiteDescriptorAttachMojo.java | 2 +-
.../maven/plugins/site/render/ReportDocumentRenderer.java | 4 ++--
.../org/apache/maven/plugins/site/render/SiteMojo.java | 2 +-
6 files changed, 14 insertions(+), 14 deletions(-)
diff --git
a/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java
b/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java
index f280cdd0..7419cb01 100644
--- a/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/deploy/AbstractDeployMojo.java
@@ -73,7 +73,7 @@ public abstract class AbstractDeployMojo extends
AbstractSiteMojo {
private File inputDirectory;
/**
- * Whether to run the "chmod" command on the remote site after the deploy.
+ * Whether to run the "chmod" command on the remote site after deploying.
* Defaults to "true".
*
* @since 2.1
@@ -150,8 +150,8 @@ public abstract class AbstractDeployMojo extends
AbstractSiteMojo {
* Make sure the given URL ends with a slash.
*
* @param url a String
- * @return if url already ends with '/' it is returned unchanged.
- * Otherwise a '/' character is appended.
+ * @return if url already ends with '/', it is returned unchanged.
+ * Otherwise, a '/' character is appended.
*/
protected static String appendSlash(final String url) {
if (url.endsWith("/")) {
@@ -191,8 +191,8 @@ public abstract class AbstractDeployMojo extends
AbstractSiteMojo {
protected abstract String determineTopDistributionManagementSiteUrl()
throws MojoExecutionException;
/**
- * Get the site used for deployment, with its id to look up credential
settings and the target URL for the deploy.
- * This should be a top-level URL, ie above modules and locale
sub-directories. Each deploy mojo
+ * Get the site used for deployment, with its id to look up credential
settings and the target URL for deploying.
+ * This should be a top-level URL, that is, above modules and locale
subdirectories. Each deploy mojo
* can tweak algorithm to determine this deploy site by implementing
determineDeploySite().
*
* @return the site for deployment
@@ -234,9 +234,9 @@ public abstract class AbstractDeployMojo extends
AbstractSiteMojo {
*
* @param repository the repository to deploy to.
* This needs to contain a valid, non-null {@link
Repository#getId() id}
- * to look up credentials for the deploy, and a valid,
non-null
+ * to look up credentials for deploying, and a valid,
non-null
* {@link Repository#getUrl() scm url} to deploy to.
- * @throws MojoExecutionException if the deploy fails.
+ * @throws MojoExecutionException if the deployment fails
*/
private void deployTo(final Repository repository) throws
MojoExecutionException {
if (!inputDirectory.exists()) {
diff --git
a/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.java
b/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.java
index 8a0c3848..c05eae55 100644
---
a/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.java
+++
b/src/main/java/org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.java
@@ -63,7 +63,7 @@ public class SiteStageDeployMojo extends AbstractStagingMojo {
private String stagingSiteURL;
/**
- * The identifier of the site where the staged site will be deployed. This
id will be used to lookup a
+ * The identifier of the site where the staged site will be deployed. This
id will be used to look up a
* corresponding <code><server></code> entry from the
<code>settings.xml</code>. If a matching
* <code><server></code> entry is found, its configured credentials
will be used for authentication.
* <p/>
diff --git
a/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
b/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
index 38e8960b..4f84a7d6 100644
---
a/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
+++
b/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
@@ -59,9 +59,9 @@ public abstract class AbstractSiteDescriptorMojo extends
AbstractSiteMojo {
protected List<RemoteRepository> remoteProjectRepositories;
/**
- * Directory containing the <code>site.xml</code> file and the source for
hand written docs (one directory
+ * Directory containing the <code>site.xml</code> file and the source for
handwritten docs (one directory
* per Doxia-source-supported markup types):
- * see <a href="/doxia/references/index.html">Doxia Markup Languages
References</a>).
+ * see <a href="/doxia/references/index.html">Doxia Markup Languages
References</a>.
*
* @since 2.3
*/
diff --git
a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java
b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java
index 0924e1cc..e23bb63d 100644
---
a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java
+++
b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java
@@ -38,7 +38,7 @@ import org.codehaus.plexus.util.FileUtils;
* <p>For Maven-2.x this is enabled by default only when the project has
<code>pom</code> packaging since it will be
* used by modules inheriting, but this can be enabled for other projects
packaging if needed.</p>
* <p>This default execution has been removed from the built-in lifecycle of
Maven 3.x for <code>pom</code>-projects.
- * Users that actually use those projects to provide a common site descriptor
for sub modules will need to explicitly
+ * Users that actually use those projects to provide a common site descriptor
for submodules will need to explicitly
* define this goal execution to restore the intended behavior.</p>
*
* @author <a href="mailto:[email protected]";>Brett Porter</a>
diff --git
a/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java
b/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java
index 93c540e2..26f04ec9 100644
---
a/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java
+++
b/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java
@@ -185,7 +185,7 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
// main sink
SiteRendererSink mainSink = new SiteRendererSink(docRenderingContext);
- // sink factory, for multi-page reports that need sub-sinks
+ // sink factory, for multipage reports that need sub-sinks
MultiPageSinkFactory multiPageSinkFactory = new
MultiPageSinkFactory(report, docRenderingContext);
ClassLoader originalClassLoader =
Thread.currentThread().getContextClassLoader();
@@ -229,7 +229,7 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
// render main sink document content
siteRenderer.mergeDocumentIntoSite(writer, mainSink,
siteRenderingContext);
- // render sub-sinks, eventually created by multi-page reports
+ // render sub-sinks, eventually created by multipage reports
List<MultiPageSubSink> sinks = multiPageSinkFactory.sinks();
log.debug("Multipage report: " + sinks.size() + " subreports");
diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
index ea8f171a..14c86500 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
@@ -54,7 +54,7 @@ import static
org.apache.maven.shared.utils.logging.MessageUtils.buffer;
/**
* Generates the site for a single project.
* <p>
- * Note that links between module sites in a multi module build will
<b>not</b> work, since local build directory
+ * Note that links between module sites in a multimodule build will
<strong>not</strong> work, since local build directory
* structure doesn't match deployed site.
* </p>
*
