Skip to content

Commit

Permalink
Fix minor typos
Browse files Browse the repository at this point in the history
Fix various minor typos in :

- project documentations,
- javadoc and comments,
- test files.
  • Loading branch information
marcwrobel authored and michael-o committed Jul 18, 2022
1 parent 8ff8ebc commit 5ce5591
Show file tree
Hide file tree
Showing 78 changed files with 113 additions and 114 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/maven_build_itself.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
tar -xzf ${{ env.TAR_BALL }} -C "$temp_dir" --strip 1
maven_bin_dir=$temp_dir/bin
if [ -d $maven_bin_dir ]; then
echo "tar.gz file \"${{ env.TAR_BALL }}\" succesfully extracted in temporarily directory \"$temp_dir.\""
echo "tar.gz file \"${{ env.TAR_BALL }}\" successfully extracted in temporarily directory \"$temp_dir.\""
echo "TEMP_MAVEN_BIN_DIR=$maven_bin_dir" >> $GITHUB_ENV
else
echo "$maven_bin_dir does not exist."
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This directory contains Jansi native libraries extracted from Jansi JAR.

You can add your own build for platforms not natively supported by Jansi.
See here [1] on how to compile for your platform and and here [2] how libraries
See here [1] on how to compile for your platform and here [2] how libraries
follow Jansi's directory and filename conventions.

[1] https://github.com/fusesource/jansi/tree/master/src/main/native
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

/**
* Exception thrown when the identity of an artifact can not be established,
* eg. one of groupId, artifactId, version or type is null.
* e.g. one of groupId, artifactId, version or type is null.
*/
public class InvalidArtifactRTException
extends RuntimeException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public Authentication( String userName, String password )
}

/**
* Username used to login to the host
* Username used to log in to the host
*/
private String username;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public MultipleArtifactsNotFoundException( Artifact originatingArtifact,
}

/**
* Create an instance of the exception with allrequired information.
* Create an instance of the exception with all required information.
*
* @param originatingArtifact the artifact that was being resolved
* @param resolvedArtifacts artifacts that could be resolved
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public void setHost( String host )
}

/**
* Get user's password used to login to proxy server.
* Get user's password used to log in to proxy server.
*
* @return user's password at proxy host
*/
Expand All @@ -103,7 +103,7 @@ public String getPassword()
/**
* Set the user's password for the proxy server.
*
* @param password password to use to login to a proxy server
* @param password password to use to log in to a proxy server
*/
public void setPassword( String password )
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

/**
* This class is an abstraction of the location from/to resources can be
* transfered.
* transferred.
*
* @author <a href="[email protected]">Michal Maczka </a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
import org.eclipse.aether.RepositorySystemSession;

// This class needs to stick around because it was exposed the the remote resources plugin started using it instead of
// This class needs to stick around because it was exposed the remote resources plugin started using it instead of
// getting the repositories from the project.

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -633,7 +633,7 @@ public void putRemoteFile( ArtifactRepository repository, File source, String re
// We do this in here so we can checksum the artifact metadata too, otherwise it could be metadata itself
for ( String extension : checksums.keySet() )
{
// TODO shouldn't need a file intermediatary - improve wagon to take a stream
// TODO shouldn't need a file intermediary - improve wagon to take a stream
File temp = File.createTempFile( "maven-artifact", null );
temp.deleteOnExit();
FileUtils.fileWrite( temp.getAbsolutePath(), "UTF-8", sums.get( extension ) );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ else if ( url.startsWith( "file:" ) && !url.startsWith( "file://" ) )
// So now we have an url of the form file://<path>

// We want to eliminate any relative path nonsense and lock down the path so we
// need to fully resolve it before any sub-modules use the path. This can happen
// need to fully resolve it before any submodules use the path. This can happen
// when you are using a custom settings.xml that contains a relative path entry
// for the local repository setting.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ private void recurse( ArtifactResolutionResult result, ResolutionNode node,
Artifact resetArtifact = resetNodes[j].getArtifact();

// MNG-2123: if the previous node was not a range, then it wouldn't have any available
// versions. We just clobbered the selected version above. (why? i have no idea.)
// versions. We just clobbered the selected version above. (why? I have no idea.)
// So since we are here and this is ranges we must go figure out the version (for a
// third time...)
if ( resetArtifact.getVersion() == null && resetArtifact.getVersionRange() != null )
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public interface ArtifactTransformation
String ROLE = ArtifactTransformation.class.getName();

/**
* Take in a artifact and return the transformed artifact for locating in the remote repository. If no
* Take in an artifact and return the transformed artifact for locating in the remote repository. If no
* transformation has occurred the original artifact is returned.
*
* @param artifact Artifact to be transformed.
Expand All @@ -47,7 +47,7 @@ void transformForResolve( Artifact artifact, RepositoryRequest request )
throws ArtifactResolutionException, ArtifactNotFoundException;

/**
* Take in a artifact and return the transformed artifact for locating in the remote repository. If no
* Take in an artifact and return the transformed artifact for locating in the remote repository. If no
* transformation has occurred the original artifact is returned.
*
* @param artifact Artifact to be transformed.
Expand All @@ -60,7 +60,7 @@ void transformForResolve( Artifact artifact,
throws ArtifactResolutionException, ArtifactNotFoundException;

/**
* Take in a artifact and return the transformed artifact for locating in the local repository. If no
* Take in an artifact and return the transformed artifact for locating in the local repository. If no
* transformation has occurred the original artifact is returned.
*
* @param artifact Artifact to be transformed.
Expand All @@ -71,7 +71,7 @@ void transformForInstall( Artifact artifact,
throws ArtifactInstallationException;

/**
* Take in a artifact and return the transformed artifact for distributing to remote repository. If no
* Take in an artifact and return the transformed artifact for distributing to remote repository. If no
* transformation has occurred the original artifact is returned.
*
* @param artifact Artifact to be transformed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public interface ArtifactTransformationManager
String ROLE = ArtifactTransformationManager.class.getName();

/**
* Take in a artifact and return the transformed artifact for locating in the remote repository. If no
* Take in an artifact and return the transformed artifact for locating in the remote repository. If no
* transformation has occurred the original artifact is returned.
*
* @param artifact Artifact to be transformed.
Expand All @@ -47,7 +47,7 @@ void transformForResolve( Artifact artifact, RepositoryRequest request )
throws ArtifactResolutionException, ArtifactNotFoundException;

/**
* Take in a artifact and return the transformed artifact for locating in the remote repository. If no
* Take in an artifact and return the transformed artifact for locating in the remote repository. If no
* transformation has occurred the original artifact is returned.
*
* @param artifact Artifact to be transformed.
Expand All @@ -59,7 +59,7 @@ void transformForResolve( Artifact artifact, List<ArtifactRepository> remoteRepo
throws ArtifactResolutionException, ArtifactNotFoundException;

/**
* Take in a artifact and return the transformed artifact for locating in the local repository. If no
* Take in an artifact and return the transformed artifact for locating in the local repository. If no
* transformation has occurred the original artifact is returned.
*
* @param artifact Artifact to be transformed.
Expand All @@ -69,7 +69,7 @@ void transformForInstall( Artifact artifact, ArtifactRepository localRepository
throws ArtifactInstallationException;

/**
* Take in a artifact and return the transformed artifact for distributing to a remote repository. If no
* Take in an artifact and return the transformed artifact for distributing to a remote repository. If no
* transformation has occurred the original artifact is returned.
*
* @param artifact Artifact to be transformed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public class ArtifactMetadata
protected String classifier;

/**
* explanation: why this MD was chosen over it's siblings
* explanation: why this MD was chosen over its siblings
* in the resulting structure (classpath for now)
*/
protected String why;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import org.apache.maven.artifact.ArtifactScopeEnum;

/**
* Helper class to conver an Md Graph into some form of a classpath
* Helper class to convert a metadata Graph into some form of a classpath
*
* @author <a href="[email protected]">Oleg Gusakov</a>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ public MetadataGraph resolveConflicts( MetadataGraph graph, ArtifactScopeEnum sc
final MetadataGraphEdge edge = cleanEdges( v, ins, requestedScope );

if ( edge == null )
{ // no edges - don't need this vertex any more
{ // no edges - don't need this vertex anymore
if ( entry.equals( v ) )
{ // unless it's an entry point.
// currently processing the entry point - it should not have any entry incident edges
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public class MetadataResolutionResult
MetadataTreeNode treeRoot;

/**
* these components are are initialized on demand by
* these components are initialized on demand by
* explicit call of the initTreeProcessing()
*/
ClasspathTransformation classpathTransformation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ under the License.
If false, flags the system to skip prompting the user for any information, or holding up the build
waiting for any input.
NOTE: It's also possible to switch to batch (ie. non-interactive) mode using the '-B' command-line option.
NOTE: It's also possible to switch to batch (i.e. non-interactive) mode using the '-B' command-line option.
]]></description>
</expression>
</expressions>
</paramdoc>
</paramdoc>
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@

import javax.inject.Inject;

// It would be cool if there was a hook that i could use to setup a test environment.
// I want to setup a local/remote repositories for testing but i don't want to have
// to change them when i change the layout of the repositories. So i want to generate
// the structure i want to test by using the artifact handler manager which dictates
// It would be cool if there was a hook that I could use to set up a test environment.
// I want to set up a local/remote repositories for testing but I don't want to have
// to change them when I change the layout of the repositories. So I want to generate
// the structure I want to test by using the artifact handler manager which dictates
// the layout used for a particular artifact type.

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import org.apache.maven.wagon.resource.Resource;

/**
* Wagon used for test cases that annotates some methods. Note that this is not a thread-safe implementation.
* Wagon used for test cases that annotate some methods. Note that this is not a thread-safe implementation.
*/
public class TestFileWagon
extends FileWagon
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

/**
* A test which demonstrates maven's recursive inheritance where
* a distinct value is taken from each parent contributing to the
* a distinct value is taken from each parent contributing to
* the final model of the project being assembled. There is no
* overriding going on amongst the models being used in this test:
* each model in the lineage is providing a value that is not present
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

/**
* A test which demonstrates maven's recursive inheritance where
* a distinct value is taken from each parent contributing to the
* a distinct value is taken from each parent contributing to
* the final model of the project being assembled. There is no
* overriding going on amongst the models being used in this test:
* each model in the lineage is providing a value that is not present
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

/**
* A test which demonstrates maven's recursive inheritance where
* a distinct value is taken from each parent contributing to the
* a distinct value is taken from each parent contributing to
* the final model of the project being assembled. There is no
* overriding going on amongst the models being used in this test:
* each model in the lineage is providing a value that is not present
Expand Down
2 changes: 1 addition & 1 deletion maven-core/lifecycle-executor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ We have a lifecycle mapping for the packaging of *jar* below. You see that for t
</lifecycles>
</configuration>

We need to turn this list of phases into a set of plugin objects that have an xml representation like the following:
We need to turn this list of phases into a set of plugin objects that have an XML representation like the following:

<plugins>
<plugin>
Expand Down
16 changes: 8 additions & 8 deletions maven-core/plugin-manager.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ TODO
- jar
- hooks for loading

- i could make an annotation that marked another class as its plugin discoverer, i could just add it to the
the component descriptor and when it's loaded we can add the discoverer, that would be simpler. i could
- I could make an annotation that marked another class as its plugin discoverer, I could just add it to
the component descriptor and when it's loaded we can add the discoverer, that would be simpler. I could
also do this with the lister as well
i'l
// 1 the metadata -> model plugin/mojo descriptor
Expand All @@ -51,8 +51,8 @@ i'l
* h2. Concerns for the plugin manager
*
* h3. resolving the dependencies of a plugin - these could be resolved remotely at runtime or, -
* they could be resolved from a local repository - i think we need a simple dependency model here
* that is more mercury related and not Maven related i.e no POMs - workspace resolver - we need
* they could be resolved from a local repository - I think we need a simple dependency model here
* that is more mercury related and not Maven related i.e. no POMs - workspace resolver - we need
* tools to pre-populate this repository
*
* h3. create an isolated classloader
Expand All @@ -71,7 +71,7 @@ i'l
*
* - nexus - the plugin class - UI to contribute - what JS to hook into the UI - what resources to
* load into the UI - having packed or unpacked plugins, and positioning resources if necessary -
* maven can work out of the classloader, nexus plugins probably couldn't given the js and image
* maven can work out of the classloader, nexus plugins probably couldn't give the js and image
* resources
*
* We need to look at Maven, and Nexus as use cases and figure out what each of them needs to be
Expand Down Expand Up @@ -103,7 +103,7 @@ h4. Working with POMs during development

During the development of a plugin we would want to make it easy for a developer to create a plugin which means we would allow the direct use of a POM to state the dependencies of a given plugin and any tooling we created would be responsible for turning the dependency information in the POM into plugin metadata which described the dependencies of the plugin.

We are looking at using Mercury for the resolution and retrieval of the plugin dependencies so during development we would translate the POMs into dependency information that Mercury can understand, and in production we would have the pre-digested format that Mercury could utilize to resolve and retrieve dependencies. We need to be careful that we are using Mercury during development and production so that we don’t get in the situation where Maven 2.x is resolving different then Mercury is. We can still leverage POMs during development but we need to make sure Mercury is doing the work.
We are looking at using Mercury for the resolution and retrieval of the plugin dependencies so during development we would translate the POMs into dependency information that Mercury can understand, and in production we would have the pre-digested format that Mercury could utilize to resolve and retrieve dependencies. We need to be careful that we are using Mercury during development and production so that we don’t get in the situation where Maven 2.x is resolving differently than Mercury is. We can still leverage POMs during development but we need to make sure Mercury is doing the work.

With respect to development inside an IDE the workspace from which we would like to resolve and retrieve dependencies is a read-only local repository to Mercury which is put at the front-end of the search order of any repository that Mercury will consult for artifacts.

Expand Down Expand Up @@ -133,7 +133,7 @@ I still need to do some work here to figure out how a dispatching to a particula

In the short term we are working with the model where the URI maps to a resource, and the resource itself is a Plexus component which can itself have a reference to the host application in order to perform its work. This may not occur in the first versions of the plugin API but a resource needs to simply become the mapping mechanism by which parameters are taken from the REST side of the application and mapped into a method call within a given Plexus component. Whether that be the core Nexus application or a component provided by a plugin.

At the very least in the short term the resource needs to know how to lookup the component that is required to perform the work. This needs to be made simple, for the time being we can write and test plugins working in the same realm until we get complete isolation working.
At the very least in the short term the resource needs to know how to look up the component that is required to perform the work. This needs to be made simple, for the time being we can write and test plugins working in the same realm until we get complete isolation working.

h3. Plugins need a specific metadata model

Expand Down Expand Up @@ -168,7 +168,7 @@ The plugin metadata:
* what JS to hook into the UI
* what resources to load into the UI
* having packed or unpacked plugins, and positioning resources if necessary
* maven can work out of the classloader, nexus plugins probably couldn't given the js and image resources
* maven can work out of the classloader, nexus plugins probably couldn't give the js and image resources

h3. Other issues

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import java.io.IOException;

/**
* Signals a failure to parse the metadata due to invalid syntax (e.g. non-wellformed XML or unknown elements).
* Signals a failure to parse the metadata due to invalid syntax (e.g. non well formed XML or unknown elements).
*
* @author Benjamin Bentmann
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public interface BeanConfigurationRequest
* Sets the configuration to unmarshal into the bean. The configuration should be taken from
* {@link org.apache.maven.model.ConfigurationContainer#getConfiguration()} or a similar source.
* If {@code element} is not {@code null}, child configuration element with the specified name will
* be unmarshaled.
* be unmarshalled.
*
* @param configuration The configuration to unmarshal, may be {@code null}.
* @param element Configuration element name to unmarshal or {@code null} to unmarshal entire configuration.
Expand Down
Loading

0 comments on commit 5ce5591

Please sign in to comment.