[MNG-6146] Several small stylistic and spelling improvements to code …

…and documentation Spelling fixes: * system * tokenizer * toolchain * trailing * transitive * unsupported * version * artifact * attachment * codehaus * colleagues * comparison * concurrency * configure * creation * dependency * descriptor * downstream * efficient * e.g. * elements * encountered * encounters * environments * executed * explicitly * happens * hierarchical * hierarchy * ignore * implemented * implementers * independence * indicates * inheritance * inherited * inherits * install * interface * javascript * laziness * management * maven * metadata * mgmt * minimalist * nonexistent * objects * overridden * print * project * properties * recessive * referring * repository * representation * retrieval * retrieve * rigorous * should * spontaneously * subsequent Literal fixes: * use static final values Style fixes: * use the proper term for char U 002D (-) hyphen(-minus) instead of dash This closes apache#100
rmannibucau · Feb 3, 2017 · 1740265 · 1740265
1 parent bd57ec9
commit 1740265
Show file tree

Hide file tree

Showing 127 changed files with 194 additions and 192 deletions.
diff --git a/apache-maven/README.txt b/apache-maven/README.txt
@@ -39,7  39,7 @@
   Installing Maven
   ----------------
 
-  1) Unpack the archive where you would like to store the binaries, eg:
   1) Unpack the archive where you would like to store the binaries, e.g.:
 
     Unix-based operating systems (Linux, Solaris and Mac OS X)
       tar zxvf apache-maven-3.x.y.tar.gz
@@ -48,7  48,7 @@
 
   2) A directory called "apache-maven-3.x.y" will be created.
 
-  3) Add the bin directory to your PATH, eg:
   3) Add the bin directory to your PATH, e.g.:
 
     Unix-based operating systems (Linux, Solaris and Mac OS X)
       export PATH=/usr/local/apache-maven-3.x.y/bin:$PATH

diff --git a/...-artifact/src/main/java/org/apache/maven/artifact/resolver/CyclicDependencyException.java b/...-artifact/src/main/java/org/apache/maven/artifact/resolver/CyclicDependencyException.java
@@ -22,7  22,7 @@
 import org.apache.maven.artifact.Artifact;
 
 /**
- * Indiciates a cycle in the dependency graph.
  * Indicates a cycle in the dependency graph.
  *
  * @author <a href="mailto:[email protected]">Brett Porter</a>
  */

diff --git a/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java b/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java
@@ -33,7  33,7 @@
  *
  * <p>Features:
  * <ul>
- * <li>mixing of '<code>-</code>' (dash) and '<code>.</code>' (dot) separators,</li>
  * <li>mixing of '<code>-</code>' (hyphen) and '<code>.</code>' (dot) separators,</li>
  * <li>transition between characters and digits also constitutes a separator:
  *     <code>1.0alpha1 =&gt; [1, 0, alpha, 1]</code></li>
  * <li>unlimited number of version components,</li>
@@ -50,7  50,7 @@
  *     </ul>
  *     Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive),
  *   </li>
- * <li>a dash usually precedes a qualifier, and is always less important than something preceded with a dot.</li>
  * <li>a hyphen usually precedes a qualifier, and is always less important than something preceded with a dot.</li>
  * </ul></p>
  *
  * @see <a href="https://cwiki.apache.org/confluence/display/MAVENOLD/Versioning">"Versioning" on Maven Wiki</a>

diff --git a/...n-artifact/src/main/java/org/apache/maven/artifact/versioning/DefaultArtifactVersion.java b/...n-artifact/src/main/java/org/apache/maven/artifact/versioning/DefaultArtifactVersion.java
@@ -180,7  180,7 @@ public final void parseVersion( String version )
                     fallback = Pattern.compile( "\\d " ).matcher( qualifier ).matches();
                 }
 
-                // string tokenzier won't detect these and ignores them
                 // string tokenizer won't detect these and ignores them
                 if ( part1.contains( ".." ) || part1.startsWith( "." ) || part1.endsWith( "." ) )
                 {
                     fallback = true;

diff --git a/maven-compat/pom.xml b/maven-compat/pom.xml
@@ -34,7  34,7 @@ under the License.
   <description>Maven2 classes maintained as compatibility layer.</description>
 
   <properties>
-    <checkstyle.failOnViolation>false</checkstyle.failOnViolation><!-- lazyness for code that will disappear in future... -->
     <checkstyle.failOnViolation>false</checkstyle.failOnViolation><!-- laziness for code that will disappear in future... -->
   </properties>
 
   <dependencies>

diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/installer/ArtifactInstaller.java b/maven-compat/src/main/java/org/apache/maven/artifact/installer/ArtifactInstaller.java
@@ -40,7  40,7 @@ public interface ArtifactInstaller
      * @param artifact the artifact definition
      * @param localRepository the local repository to install into
      * @throws ArtifactInstallationException if an error occurred installing the artifact
-     * @deprecated to be removed before 2.0 after the instlal/deploy plugins use the alternate
      * @deprecated to be removed before 2.0 after the install/deploy plugins use the alternate
      *             method
      */
     @Deprecated

diff --git a/...compat/src/main/java/org/apache/maven/artifact/resolver/ResolutionListenerForDepMgmt.java b/...compat/src/main/java/org/apache/maven/artifact/resolver/ResolutionListenerForDepMgmt.java
@@ -24,7  24,7 @@
 /**
  * Do not use!
  * <p/>
- * Should only be implmemented by DebugResolutionListener.  Remove this
  * Should only be implemented by DebugResolutionListener.  Remove this
  * when the ResolutionListener interface deprecation of the manageArtifact
  * method (and the [yet to be done] addition of these methods to that
  * interface) has had a chance to propagate to all interested plugins.

diff --git a/maven-compat/src/main/java/org/apache/maven/profiles/DefaultProfileManager.java b/maven-compat/src/main/java/org/apache/maven/profiles/DefaultProfileManager.java
@@ -62,7  62,7 @@ public class DefaultProfileManager
 
     /**
      * @deprecated without passing in the system properties, the SystemPropertiesProfileActivator will not work
-     *             correctly in embedded envirnments.
      *             correctly in embedded environments.
      */
     public DefaultProfileManager( PlexusContainer container )
     {

diff --git a/.../src/main/java/org/apache/maven/project/inheritance/DefaultModelInheritanceAssembler.java b/.../src/main/java/org/apache/maven/project/inheritance/DefaultModelInheritanceAssembler.java
@@ -230,7  230,7 @@ private void assembleModelInheritance( Model child, Model parent, String childPa
             }
         }
 
-        assembleDistributionInheritence( child, parent, childPathAdjustment, appendPaths );
         assembleDistributionInheritance( child, parent, childPathAdjustment, appendPaths );
 
         // issueManagement
         if ( child.getIssueManagement() == null )
@@ -569,7  569,7 @@ private void assembleBuildInheritance( Model child, Model parent )
         }
     }
 
-    private void assembleDistributionInheritence( Model child, Model parent, String childPathAdjustment,
     private void assembleDistributionInheritance( Model child, Model parent, String childPathAdjustment,
                                                   boolean appendPaths )
     {
         if ( parent.getDistributionManagement() != null )

diff --git a/...-compat/src/main/java/org/apache/maven/project/inheritance/ModelInheritanceAssembler.java b/...-compat/src/main/java/org/apache/maven/project/inheritance/ModelInheritanceAssembler.java
@@ -35,7  35,7 @@ public interface ModelInheritanceAssembler
 
     void assembleModelInheritance( Model child, Model parent );
 
-    void assembleBuildInheritance( Build childBuild, Build parentBuild, boolean handleAsInheriance );
     void assembleBuildInheritance( Build childBuild, Build parentBuild, boolean handleAsInheritance );
 
     void copyModel( Model dest, Model source );
 }
diff --git a/...main/java/org/apache/maven/repository/legacy/resolver/DefaultLegacyArtifactCollector.java b/...main/java/org/apache/maven/repository/legacy/resolver/DefaultLegacyArtifactCollector.java
@@ -477,7  477,7 @@ private void recurse( ArtifactResolutionResult result, ResolutionNode node,
                                     manageArtifact( child, managedVersions, listeners );
 
                                     // Also, we need to ensure that any exclusions it presents are
-                                    // added to the artifact before we retrive the metadata
                                     // added to the artifact before we retrieve the metadata
                                     // for the artifact; otherwise we may end up with unwanted
                                     // dependencies.
                                     Artifact ma = managedVersions.get( childKey );
@@ -691,7  691,7 @@ boolean checkScopeUpdate( ResolutionNode farthest, ResolutionNode nearest, List<
         {
             fireEvent( ResolutionListener.UPDATE_SCOPE, listeners, nearest, farthestArtifact );
 
-            // previously we cloned the artifact, but it is more effecient to just update the artifactScope
             // previously we cloned the artifact, but it is more efficient to just update the artifactScope
             // if problems are later discovered that the original object needs its original artifactScope value, 
             // cloning may
             // again be appropriate

diff --git a/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraphVertex.java b/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraphVertex.java
@@ -31,7  31,7 @@ public class MetadataGraphVertex
 {
     ArtifactMetadata md;
 
-    // indications to use these in comparrison
     // indications to use these in comparison
     private boolean compareVersion = false;
     private boolean compareScope   = false;
 

diff --git a/maven-compat/src/main/mdo/profiles.mdo b/maven-compat/src/main/mdo/profiles.mdo
@@ -187,7  187,7 @@ under the License.
       <version>1.0.0</version>
       <description><![CDATA[
          Repository contains the information needed
-         for establishing connections with remote repoistory
          for establishing connections with remote repository
       ]]></description>
       <fields>
         <field>
@@ -249,7  249,7 @@ under the License.
       <superClass>RepositoryBase</superClass>
       <version>1.0.0</version>
       <description>
-        Repository contains the information needed for establishing connections with remote repoistory
         Repository contains the information needed for establishing connections with remote repository
       </description>
       <fields>
         <field>

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t00/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t00/ProjectInheritanceTest.java
@@ -42,7  42,7 @@ public class ProjectInheritanceTest
     // p3 inherits from p2
     // p2 inherits from p1
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t01/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t01/ProjectInheritanceTest.java
@@ -38,7  38,7 @@ public class ProjectInheritanceTest
     // p3 inherits from p2
     // p2 inherits from p1
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t02/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t02/ProjectInheritanceTest.java
@@ -49,7  49,7 @@ public class ProjectInheritanceTest
     // p3 inherits from p2
     // p2 inherits from p1
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t03/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t03/ProjectInheritanceTest.java
@@ -41,7  41,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t04/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t04/ProjectInheritanceTest.java
@@ -39,7  39,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t05/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t05/ProjectInheritanceTest.java
@@ -37,7  37,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t06/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t06/ProjectInheritanceTest.java
@@ -38,7  38,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t07/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t07/ProjectInheritanceTest.java
@@ -37,7  37,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t08/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t08/ProjectInheritanceTest.java
@@ -38,7  38,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java
@@ -36,7  36,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t10/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t10/ProjectInheritanceTest.java
@@ -27,7  27,7 @@
 import org.apache.maven.project.inheritance.AbstractProjectInheritanceTestCase;
 
 /**
- * Verifies scope inheritence of direct and transitive dependencies.
  * Verifies scope inheritance of direct and transitive dependencies.
  *
  * Should show three behaviors:
  *
@@ -44,7  44,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...compat/src/test/java/org/apache/maven/project/inheritance/t11/ProjectInheritanceTest.java b/...compat/src/test/java/org/apache/maven/project/inheritance/t11/ProjectInheritanceTest.java
@@ -25,7  25,7 @@
 import org.apache.maven.project.inheritance.AbstractProjectInheritanceTestCase;
 
 /**
- * Verifies scope of root project is preserved regardless of parent depenedency management.
  * Verifies scope of root project is preserved regardless of parent dependency management.
  *
  * @author <a href="mailto:[email protected]">Patrick Schneider</a>
  * @see <a href="https://issues.apache.org/jira/browse/MNG-2919">MNG-2919</a>
@@ -36,7  36,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/...pat/src/test/java/org/apache/maven/project/inheritance/t12scm/ProjectInheritanceTest.java b/...pat/src/test/java/org/apache/maven/project/inheritance/t12scm/ProjectInheritanceTest.java
@@ -35,7  35,7 @@ public class ProjectInheritanceTest
     // ----------------------------------------------------------------------
     //
     // p1 inherits from p0
-    // p0 inhertis from super model
     // p0 inherits from super model
     //
     // or we can show it graphically as:
     //

diff --git a/maven-core/lifecycle-executor.txt b/maven-core/lifecycle-executor.txt
@@ -57,7  57,7 @@ We need this form so that the model builder can make the first pass at merging.
   .
 </plugins>
 
-Once we have the version of the plugins the appropriate call to the plugin manager can be made to get the MojoDescriptor for the goal that needs to be run. In the MojoDescriptor we are interested in the <configuration/> element and <parameters/> element. From these elements we need to make a component configuration for the MojoExecution. The actual DOM like structure we create is of type PlexusConfiguration and is the type we use with the ComponentConfigurator to initialize fields in a Plexus component. Typically this is done within Plexus with the configuration supplied with component configuration, but in Maven we take configuration values from the POM. So we have to use the ComponentConfigurator outside of Plexus in order to configurure the Maven Mojo which is just a Plexus component. We can use the information from the MojoDescriptor along with the merged configuration information that is now present in the POM to create the complete PlexusConfiguration used to populate values in the Maven Mojo.
 Once we have the version of the plugins the appropriate call to the plugin manager can be made to get the MojoDescriptor for the goal that needs to be run. In the MojoDescriptor we are interested in the <configuration/> element and <parameters/> element. From these elements we need to make a component configuration for the MojoExecution. The actual DOM like structure we create is of type PlexusConfiguration and is the type we use with the ComponentConfigurator to initialize fields in a Plexus component. Typically this is done within Plexus with the configuration supplied with component configuration, but in Maven we take configuration values from the POM. So we have to use the ComponentConfigurator outside of Plexus in order to configure the Maven Mojo which is just a Plexus component. We can use the information from the MojoDescriptor along with the merged configuration information that is now present in the POM to create the complete PlexusConfiguration used to populate values in the Maven Mojo.
 
 foreach configuration element:
  - if read only and being set squawk

diff --git a/maven-core/plugin-manager.txt b/maven-core/plugin-manager.txt
@@ -140,7  140,7 @@ h3. Plugins need a specific metadata model
 Each application will have its own model for plugins. Much of this model will be common across applications but there will always be issues specific to a particular applications’s plugins. Some of the issues that need to be taken into consideration:
 
 * Plugin dependencies
-* Plugin resources like Javascript files or images
 * Plugin resources like JavaScript files or images
 * Configuration metadata and default configuration values
 * Extension points that plugins might expose
 

diff --git a/maven-core/src/main/java/org/apache/maven/artifact/repository/MavenArtifactRepository.java b/maven-core/src/main/java/org/apache/maven/artifact/repository/MavenArtifactRepository.java
@@ -213,7  213,7 @@ public void setUrl( String url )
      * Return the protocol name.
      * <br/>
      * E.g: for input
-     * <code>http://www.codehause.org</code> this method will return <code>http</code>
      * <code>http://www.codehaus.org</code> this method will return <code>http</code>
      *
      * @param url the url
      * @return the host name

diff --git a/maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java b/maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java
@@ -37,7  37,7 @@
  *
  * @author Jason van Zyl
  * @TODO carlos: all these possible has*Exceptions and get*Exceptions methods make the clients too
- *       complex requiring a long list of checks, need to create a parent/interfact/encapsulation
  *       complex requiring a long list of checks, need to create a parent/interface/encapsulation
  *       for the types of exceptions
  */
 public class ArtifactResolutionResult

diff --git a/maven-core/src/main/java/org/apache/maven/configuration/DefaultBeanConfigurationRequest.java b/maven-core/src/main/java/org/apache/maven/configuration/DefaultBeanConfigurationRequest.java
@@ -137,10  137,10 @@ private Plugin findPlugin( Model model, String groupId, String artifactId )
                     }
                 }
 
-                PluginManagement mngt = build.getPluginManagement();
-                if ( mngt != null )
                 PluginManagement mgmt = build.getPluginManagement();
                 if ( mgmt != null )
                 {
-                    for ( Plugin plugin : mngt.getPlugins() )
                     for ( Plugin plugin : mgmt.getPlugins() )
                     {
                         if ( groupId.equals( plugin.getGroupId() ) && artifactId.equals( plugin.getArtifactId() ) )
                         {

diff --git a/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java b/maven-core/src/main/java/org/apache/maven/eventspy/EventSpy.java
@@ -24,7  24,7 @@
 /**
  * A core extension to monitor Maven's execution. Typically, such an extension gets loaded into Maven by specifying the
  * system property {@code maven.ext.class.path} on the command line. As soon as dependency injection is setup, Maven
- * looks up all implementators of this interface and calls their {@link #init(Context)} method. <em>Note:</em>
  * looks up all implementers of this interface and calls their {@link #init(Context)} method. <em>Note:</em>
  * Implementors are strongly advised to inherit from {@link AbstractEventSpy} instead of directly implementing this
  * interface.
  * @since 3.0.2

diff --git a/...src/main/java/org/apache/maven/internal/aether/DefaultRepositorySystemSessionFactory.java b/...src/main/java/org/apache/maven/internal/aether/DefaultRepositorySystemSessionFactory.java
@@ -121,8  121,10 @@ else if ( request.isUpdateSnapshots() )
         }
 
         int errorPolicy = 0;
-        errorPolicy |= request.isCacheNotFound() ? ResolutionErrorPolicy.CACHE_NOT_FOUND : 0;
-        errorPolicy |= request.isCacheTransferError() ? ResolutionErrorPolicy.CACHE_TRANSFER_ERROR : 0;
         errorPolicy |= request.isCacheNotFound() ? ResolutionErrorPolicy.CACHE_NOT_FOUND
             : ResolutionErrorPolicy.CACHE_DISABLED;
         errorPolicy |= request.isCacheTransferError() ? ResolutionErrorPolicy.CACHE_TRANSFER_ERROR
             : ResolutionErrorPolicy.CACHE_DISABLED;
         session.setResolutionErrorPolicy(
             new SimpleResolutionErrorPolicy( errorPolicy, errorPolicy | ResolutionErrorPolicy.CACHE_NOT_FOUND ) );
 

diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/GoalTask.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/GoalTask.java
@@ -22,7  22,7 @@
 /**
  * A task that is a goal
  * <p/>
- * TODO: From a concurrecy perspective, this class is not good. The combination of mutable/immutable state is not nice
  * TODO: From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice
  *
  * @since 3.0
  * @author Benjamin Bentmann

diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/TaskSegment.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/TaskSegment.java
@@ -69,5  69,5 @@ public boolean isAggregating()
         return aggregating;
     }
 
-    // TODO: Consider throwing UnsupprtedSomething on hashCode/equals
     // TODO: Consider throwing UnsupportedSomething on hashCode/equals
 }