Skip to content

Grammar fixes #1291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
* </p>
* <p>
* There are two types of status defined in this class: <br>
* 1) Status: Changes in the working tree, not yet committed to the repository eg. MODIFIED <br>
* 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 <br>
* 2) Transaction: The file is part of some transaction with the repository e.g. CHECKED_IN
* </p>
*
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public class ScmResult implements Serializable {
* Copy constructor.
* <p>
* 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
*/
Expand Down Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<String, String> branches = new HashMap<>();

/**
* depending on scm informations can be different
* depending on scm, information can be different
* svn: branch name / remote url
*/
private Map<String, String> tags = new HashMap<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ protected void setScmProviders(Map<String, ScmProvider> providers) {
}

/**
* @param providerType the type of SCM, eg. <code>svn</code>, <code>git</code>
* @param providerType the type of SCM, e.g. <code>svn</code>, <code>git</code>
* @param provider the provider that will be used for that SCM type
* @deprecated use {@link #setScmProvider(String, ScmProvider)} instead
*/
Expand All @@ -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. <code>svn</code>, <code>git</code>
* @param providerType the type of SCM, e.g. <code>svn</code>, <code>git</code>
* @param provider the provider that will be used for that SCM type
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -102,16 +102,16 @@ 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. <code>svn</code>, <code>git</code>
* @param providerType the type of SCM, e.g. <code>svn</code>, <code>git</code>
* @param provider the provider that will be used for that SCM type
*/
void setScmProvider(String providerType, ScmProvider provider);

/**
* Set the provider implementation
*
* @param providerType The provider type, eg. <code>git</code>
* @param providerImplementation The provider implementation (the role-hint of the provider), eg. <code>git</code>,
* @param providerType The provider type, e.g. <code>git</code>
* @param providerImplementation The provider implementation (the role-hint of the provider), e.g. <code>git</code>,
* <code>svn</code>
*/
void setScmProviderImplementation(String providerType, String providerImplementation);
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion maven-scm-plugin/src/site/markdown/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* Available/Used hg commands.
* <p>
* 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 <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
/**
* Base class for all TcK tests.
* <p>
* 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:
* <ol>
* <li>Delete all default locations (working copy, updating copy etc)</li>
Expand Down
2 changes: 1 addition & 1 deletion src/site/markdown/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions src/site/markdown/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

2 changes: 1 addition & 1 deletion src/site/markdown/guide/new_provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/site/markdown/guide/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions src/site/markdown/scm-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ date: 2005-12-01
<!-- under the License.-->
# 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

Expand All @@ -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&apos;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&apos;s this means that no other user can then do an edit at the same time.

## Diff

Expand Down
4 changes: 2 additions & 2 deletions src/site/markdown/scm-url-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<provider id><delimiter><provider-specific part>
```

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).

Expand Down
Loading