From bbefa79cffc2ba04d1c18edd5ab0917d91da788a Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Thu, 7 Aug 2025 07:02:54 +0100 Subject: [PATCH] Grammar fixes --- .../org/apache/maven/scm/CommandParameters.java | 6 +++--- .../java/org/apache/maven/scm/ScmFileStatus.java | 4 ++-- .../main/java/org/apache/maven/scm/ScmResult.java | 4 ++-- .../command/remoteinfo/RemoteInfoScmResult.java | 4 ++-- .../maven/scm/manager/AbstractScmManager.java | 4 ++-- .../org/apache/maven/scm/manager/ScmManager.java | 14 +++++++------- .../org/apache/maven/scm/provider/ScmProvider.java | 6 +++--- .../maven/scm/provider/ScmProviderRepository.java | 2 +- .../org/apache/maven/scm/plugin/BootstrapMojo.java | 2 +- maven-scm-plugin/src/site/markdown/usage.md | 2 +- .../provider/hg/command/HgCommandConstants.java | 2 +- .../scm/provider/git/sshd/git/pack/README.txt | 2 +- .../scm/provider/git/jgit/command/JGitUtils.java | 3 +-- .../java/org/apache/maven/scm/ScmTckTestCase.java | 2 +- src/site/markdown/authentication.md | 2 +- src/site/markdown/guide/index.md | 4 ++-- src/site/markdown/guide/new_provider.md | 2 +- src/site/markdown/guide/usage.md | 2 +- src/site/markdown/scm-commands.md | 4 ++-- src/site/markdown/scm-url-format.md | 4 ++-- 20 files changed, 37 insertions(+), 38 deletions(-) diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameters.java b/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameters.java index 8711ab257..3bf81f8ce 100644 --- a/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameters.java +++ b/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameters.java @@ -98,9 +98,9 @@ public int getInt(CommandParameter parameter) throws ScmException { /** * Return the parameter value as int or the default value if it doesn't exist. * - * @param parameter The parameter - * @param defaultValue The defaultValue - * @return The parameter value as a int + * @param parameter the parameter + * @param defaultValue the default value + * @return the parameter value as an int * @throws ScmException if the value is in the wrong type */ public int getInt(CommandParameter parameter, int defaultValue) throws ScmException { diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileStatus.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileStatus.java index 3ca51b704..af1f39de1 100644 --- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileStatus.java +++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileStatus.java @@ -27,8 +27,8 @@ *

*

* There are two types of status defined in this class:
- * 1) Status: Changes in the working tree, not yet committed to the repository eg. MODIFIED
- * 2) Transaction: The file is part of some transaction with the repository eg. CHECKED_IN + * 1) Status: Changes in the working tree, not yet committed to the repository e.g. MODIFIED
+ * 2) Transaction: The file is part of some transaction with the repository e.g. CHECKED_IN *

* * @author Trygve Laugstøl diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmResult.java index 229675091..32f6af401 100644 --- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmResult.java +++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmResult.java @@ -46,7 +46,7 @@ public class ScmResult implements Serializable { * Copy constructor. *

* Typically used from derived classes when wrapping a ScmResult - * into a specific type eg. AddScmResult + * into a specific type e.g. AddScmResult * * @param scmResult not null */ @@ -87,7 +87,7 @@ public boolean isSuccess() { /** * @return A message from the provider. On success this would typically be null or - * an empty string. On failure it would be the error message from the provider + * an empty string. On failure, it would be the error message from the provider */ public String getProviderMessage() { return providerMessage; diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/remoteinfo/RemoteInfoScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/remoteinfo/RemoteInfoScmResult.java index 9320be673..7992877b2 100644 --- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/remoteinfo/RemoteInfoScmResult.java +++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/remoteinfo/RemoteInfoScmResult.java @@ -31,13 +31,13 @@ public class RemoteInfoScmResult extends ScmResult { private static final long serialVersionUID = -5571403202068311222L; /** - * depending on scm informations can be different + * depending on scm, information can be different * svn: branch name / remote url */ private Map branches = new HashMap<>(); /** - * depending on scm informations can be different + * depending on scm, information can be different * svn: branch name / remote url */ private Map tags = new HashMap<>(); diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/AbstractScmManager.java b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/AbstractScmManager.java index 7df90d2c6..ecae795f2 100644 --- a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/AbstractScmManager.java +++ b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/AbstractScmManager.java @@ -81,7 +81,7 @@ protected void setScmProviders(Map providers) { } /** - * @param providerType the type of SCM, eg. svn, git + * @param providerType the type of SCM, e.g. svn, git * @param provider the provider that will be used for that SCM type * @deprecated use {@link #setScmProvider(String, ScmProvider)} instead */ @@ -94,7 +94,7 @@ protected void addScmProvider(String providerType, ScmProvider provider) { * Set a provider to be used for a type of SCM. * If there was already a designed provider for that type it will be replaced. * - * @param providerType the type of SCM, eg. svn, git + * @param providerType the type of SCM, e.g. svn, git * @param provider the provider that will be used for that SCM type */ @Override diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java index abb7ea6e6..ad651c54f 100644 --- a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java +++ b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java @@ -63,7 +63,7 @@ public interface ScmManager { // ---------------------------------------------------------------------- /** - * Generate a SCMRepository from a SCM url. + * Generate a SCMRepository from an SCM URL. * * @param scmUrl the scm url * @return The scm repository @@ -102,7 +102,7 @@ ScmRepository makeProviderScmRepository(String providerType, File path) * Set a provider to be used for a type of SCM. If there was already a designed provider for that type it will be * replaced. * - * @param providerType the type of SCM, eg. svn, git + * @param providerType the type of SCM, e.g. svn, git * @param provider the provider that will be used for that SCM type */ void setScmProvider(String providerType, ScmProvider provider); @@ -110,8 +110,8 @@ ScmRepository makeProviderScmRepository(String providerType, File path) /** * Set the provider implementation * - * @param providerType The provider type, eg. git - * @param providerImplementation The provider implementation (the role-hint of the provider), eg. git, + * @param providerType The provider type, e.g. git + * @param providerImplementation The provider implementation (the role-hint of the provider), e.g. git, * svn */ void setScmProviderImplementation(String providerType, String providerImplementation); @@ -378,9 +378,9 @@ DiffScmResult diff( throws ScmException; /** - * Make a file editable. This is used in source control systems where you look at read-only files and you need to - * make them not read-only anymore before you can edit them. This can also mean that no other user in the system can - * make the file not read-only anymore. + * Make a file editable. This is used in source control systems where you look at read-only files, and you need to + * make them writable before you can edit them. This can also mean that no other user in the system can + * make the file writable. * * @param repository the source control system * @param fileSet the files to make editable diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java index 9418af67c..c8829022d 100644 --- a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java +++ b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java @@ -865,9 +865,9 @@ UpdateScmResult update( throws ScmException; /** - * Make a file editable. This is used in source control systems where you look at read-only files - * and you need to make them not read-only anymore before you can edit them. This can also mean - * that no other user in the system can make the file not read-only anymore. + * Make a file editable. This is used in source control systems where you look at read-only files, + * and you need to make them writable before you can edit them. This can also mean + * that no other user in the system can make the file writable. * * @param repository the source control system * @param fileSet the files to make editable diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepository.java b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepository.java index ff16e74b7..aa0599dc3 100644 --- a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepository.java +++ b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepository.java @@ -165,7 +165,7 @@ public void setPersistCheckout(boolean persistCheckout) { /** * Get a {@link ScmProviderRepository} that represents the parent folder in the repository. - * Useful when the repository does not exist yet and we need to create it from the parent. + * Useful when the repository does not exist yet, and we need to create it from the parent. * * @return the parent repository * @throws UnsupportedOperationException unless overridden by subclass diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java index b8a76a9b8..6cd7d9c39 100644 --- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java +++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java @@ -158,7 +158,7 @@ private void runGoals(String relativePathProjectDirectory) throws MojoExecutionE /** * Determines the path of the working directory. By default, this is the checkout directory. For some SCMs, - * the project root directory is not the checkout directory itself, but a SCM-specific subdirectory. The + * the project root directory is not the checkout directory itself, but an SCM-specific subdirectory. The * build can furthermore optionally be executed in a subdirectory of this project directory, in case. * * @param checkoutDirectory diff --git a/maven-scm-plugin/src/site/markdown/usage.md b/maven-scm-plugin/src/site/markdown/usage.md index d43b27c92..453edd782 100644 --- a/maven-scm-plugin/src/site/markdown/usage.md +++ b/maven-scm-plugin/src/site/markdown/usage.md @@ -61,7 +61,7 @@ Check the [Maven SCM list](http://maven.apache.org/scm/scms-overview.html) for t # Committing and updating changes through Maven -Assuming that SCM has been configured in the `pom.xml` and the project directory is managed by a SCM, invoking the checkin goal in the SCM will start the commit process for all configured sources in your `pom.xml`. +Assuming that SCM has been configured in the `pom.xml` and the project directory is managed by an SCM, invoking the checkin goal in the SCM will start the commit process for all configured sources in your `pom.xml`. **The files should be added beforehand by an external scm client.** diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgCommandConstants.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgCommandConstants.java index 416f60c29..741480cf1 100644 --- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgCommandConstants.java +++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgCommandConstants.java @@ -22,7 +22,7 @@ * Available/Used hg commands. *

* These commands do not necessarily correspond to the SCM API. - * Eg. "check in" is translated to be "commit" and "push". + * e.g. "check in" is translated to be "commit" and "push". * * @author thurner rupert */ diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/README.txt b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/README.txt index 1a27a1ac0..616060a96 100644 --- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/README.txt +++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/README.txt @@ -1,5 +1,5 @@ This is just a minimum fork of https://github.com/apache/mina-sshd/tree/sshd-2.11.0/sshd-git/src/main/java/org/apache/sshd/git/pack to include the patch https://github.com/apache/mina-sshd/pull/794. -Otherwise the SSH server cannot be used on Windows as it leaves files open. +Otherwise, the SSH server cannot be used on Windows as it leaves files open. TODO: Remove once a Mina SSHD release is available that includes this patch. \ No newline at end of file diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java index 17a0e6664..eb1a30769 100644 --- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java +++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java @@ -129,8 +129,7 @@ public static ProgressMonitor getMonitor() { * * @param git the instance to configure (only in memory, not saved) * @param repository the repo config to be used - * @return {@link CredentialsProvider} in case there are credentials - * informations configured in the repository. + * @return {@link CredentialsProvider} in case credential information is configured in the repository. */ public static CredentialsProvider prepareSession(Git git, GitScmProviderRepository repository) { StoredConfig config = git.getRepository().getConfig(); diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTckTestCase.java b/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTckTestCase.java index d48d13a80..078a1deec 100644 --- a/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTckTestCase.java +++ b/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTckTestCase.java @@ -43,7 +43,7 @@ /** * Base class for all TcK tests. *

- * Basically all it does is to setup a default test enviroment + * Basically all it does is to set up a default test enviroment * common for all tck tests. The default setup includes: *

    *
  1. Delete all default locations (working copy, updating copy etc)
    2. diff --git a/src/site/markdown/authentication.md b/src/site/markdown/authentication.md index 7b2e07801..ac1245b04 100644 --- a/src/site/markdown/authentication.md +++ b/src/site/markdown/authentication.md @@ -40,7 +40,7 @@ There are multiple ways how the authentication can be configured. They are liste ### Implicit -Most SCM providers have built-in authentication configuration means. On demand they will interactively ask for credentials (in case Maven is not running in batch mode and the credentials are not yet known) and persist those throughout the session or even longer. Often one can also configure the credentials in advance in dedicated files. +Most SCM providers have built-in authentication configuration means. On demand, they will interactively ask for credentials (in case Maven is not running in batch mode and the credentials are not yet known) and persist those throughout the session or even longer. Often one can also configure the credentials in advance in dedicated files. - [Subversion Credentials](https://svnbook.red-bean.com/en/1.8/svn.serverconfig.netmodel.html#svn.serverconfig.netmodel.creds) - [Git Credentials](https://git-scm.com/docs/gitcredentials) diff --git a/src/site/markdown/guide/index.md b/src/site/markdown/guide/index.md index 41325c4b4..a717513b3 100644 --- a/src/site/markdown/guide/index.md +++ b/src/site/markdown/guide/index.md @@ -25,9 +25,9 @@ date: 2007-03-12 ## [How to use Maven SCM in my application?](./usage.html) -This [document](./usage.html) describe API usage for a SCM client. +This [document](./usage.html) describes API usage for a SCM client. ## [How to write a new SCM provider?](./new_provider.html) -This [document](./new_provider.html) describe step by step the implementation of a new SCM provider. +This [document](./new_provider.html) describse step by step the implementation of a new SCM provider. diff --git a/src/site/markdown/guide/new_provider.md b/src/site/markdown/guide/new_provider.md index b69214e10..8ae091362 100644 --- a/src/site/markdown/guide/new_provider.md +++ b/src/site/markdown/guide/new_provider.md @@ -94,7 +94,7 @@ public class MyScmProviderRepository } ``` -Before you add more information to this class, you can look at the `ScmProviderRepository` sub-classes, if they are already implemented. +Before you add more information to this class, you can look at the `ScmProviderRepository` subclasses, if they are already implemented. ## Create the Provider class diff --git a/src/site/markdown/guide/usage.md b/src/site/markdown/guide/usage.md index 8a4054578..e8e5ab440 100644 --- a/src/site/markdown/guide/usage.md +++ b/src/site/markdown/guide/usage.md @@ -78,7 +78,7 @@ public class MyApp } ``` -## Run a SCM command +## Run an SCM command Before you call a command, the SCM manager needs an `ScmRepository`. This object contains all the information about the SCM connection. diff --git a/src/site/markdown/scm-commands.md b/src/site/markdown/scm-commands.md index 0053e6e86..521ed200c 100644 --- a/src/site/markdown/scm-commands.md +++ b/src/site/markdown/scm-commands.md @@ -23,7 +23,7 @@ date: 2005-12-01 # Maven SCM Commands -Maven SCM uses a exposes a fixed set of commands for it users. The providers for each SCM must implements those commands through the `ScmProvider` interface. This is an overview of all the commands: +Maven SCM exposes a fixed set of commands. The providers for each SCM must implement those commands through the `ScmProvider` interface. This is an overview of all the commands: ## Add @@ -43,7 +43,7 @@ Copy \(part of\) the contents of the source control system to a certain location ## Edit -Mark a file as editable with the source control system. This is used in source control systems where you look at read-only files and you need to make them not read-only anymore before you can edit them. In some scm's this means that no other user can then do an edit at the same time. +Mark a file as editable with the source control system. This is used in source control systems where you look at read-only files, and you need to make them writable before you can edit them. In some scm's this means that no other user can then do an edit at the same time. ## Diff diff --git a/src/site/markdown/scm-url-format.md b/src/site/markdown/scm-url-format.md index e44b06df0..163d41125 100644 --- a/src/site/markdown/scm-url-format.md +++ b/src/site/markdown/scm-url-format.md @@ -25,13 +25,13 @@ date: 2005-06-05 ## SCM URL -The general format for a SCM URL is +The general format for an SCM URL is ``` scm: ``` -As delimiter you can use either colon `:` or a pipe `|`, if you use a colon for one of the variables \(e.g. a Windows path\). +For a delimiter, you can use either colon `:` or a pipe `|`, if you use a colon for one of the variables \(e.g. a Windows path\). For information about supported provider IDs and the provider-specific part, see the appropriate [SCM implementation](./scms-overview.html).