You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2008/02/21 22:24:42 UTC

svn commit: r630001 - in /maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site: ./ apt/ apt/examples/ apt/getting-started/ fml/

Author: dennisl
Date: Thu Feb 21 13:24:40 2008
New Revision: 630001

URL: http://svn.apache.org/viewvc?rev=630001&view=rev
Log:
o Fix a couple of typos.

Modified:
    maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/artifact.apt
    maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/complex-mojo-parameters.apt
    maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/multiproject.apt
    maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/repositories.apt
    maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/getting-started/index.apt
    maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/index.apt
    maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/fml/faq.fml
    maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/site.xml

Modified: maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/artifact.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/artifact.apt?rev=630001&r1=630000&r2=630001&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/artifact.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/artifact.apt Thu Feb 21 13:24:40 2008
@@ -106,7 +106,8 @@
      * @param version
      * @param packaging
      */
-    public ProjectInfoPluginArtifactStub( String groupId, String artifactId, String version, String packaging )
+    public ProjectInfoPluginArtifactStub( String groupId, String artifactId,
+                                          String version, String packaging )
     {
         this.groupId = groupId;
         this.artifactId = artifactId;
@@ -204,7 +205,8 @@
     {
         ...
 
-        Artifact artifact = new MyArtifactStub( getGroupId(), getArtifactId(), getVersion(), getPackaging() );
+        Artifact artifact = new MyArtifactStub( getGroupId(), getArtifactId(),
+                                                getVersion(), getPackaging() );
         artifact.setArtifactHandler( new MyArtifactHandlerStub() );
         setArtifact( artifact );
 

Modified: maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/complex-mojo-parameters.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/complex-mojo-parameters.apt?rev=630001&r1=630000&r2=630001&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/complex-mojo-parameters.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/complex-mojo-parameters.apt Thu Feb 21 13:24:40 2008
@@ -25,9 +25,9 @@
 
 Testing Complex Mojo Parameters
 
- <<Note>>: This example improves the {{{../getting-started/index.html}cookbook}} for complex Mojo parameters testing.
+ <<Note>>: This example improves the {{{../getting-started/index.html}cookbook}} for testing complex Mojo parameters.
 
- In a real plugin development, you will use specific Maven objects like <<<MavenProject>>>, <<<localRepository>>> or
+ In real plugin development, you will use specific Maven objects like <<<MavenProject>>>, <<<ArtifactRepository>>> or
  <<<MavenSettings>>>. You could use them by defining stubs.
 
  Suppose that you have the following dependencies in the maven-my-plugin pom:
@@ -90,7 +90,7 @@
 
 * Create Stubs
 
-  You need to create stubs objects to run <<<MyMojoTest#testSomething()>>>. By convention, the package name should
+  You need to create stub objects to run <<<MyMojoTest#testSomething()>>>. By convention, the package name should
   reflect the stubs, i.e. in our case <<<org.apache.maven.plugin.my.stubs>>>.
 
 -----
@@ -159,7 +159,7 @@
 }
 -----
 
-* Configuring <<<project-to-test>>> pom
+* Configure <<<project-to-test>>> pom
 
 -----
 <project>
@@ -169,11 +169,11 @@
       <plugin>
         <artifactId>maven-my-plugin</artifactId>
         <configuration>
-          <!-- Specify where this pom will be outputted files -->
+          <!-- Specify where this pom will output files -->
           <outputDirectory>target/test-harness/project-to-test</outputDirectory>
 
-          <!-- By default <<<${basedir}/target/local-repo", where basedir refer
-              to the basedir of maven-my-plugin. -->
+          <!-- By default <<<${basedir}/target/local-repo", where basedir refers
+               to the basedir of maven-my-plugin. -->
           <localRepository>${localRepository}</localRepository>
           <!-- The defined stubs -->
           <project implementation="org.apache.maven.plugin.my.stubs.MyProjectStub"/>

Modified: maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/multiproject.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/multiproject.apt?rev=630001&r1=630000&r2=630001&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/multiproject.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/multiproject.apt Thu Feb 21 13:24:40 2008
@@ -41,7 +41,7 @@
 }
 ------
 
- To test a Mojo in a multiproject area, you need to define several stubs, i.e. for the main test project and his modules.
+ To test a Mojo in a multiproject area, you need to define several stubs, i.e. for the main test project and its modules.
 
 * Create Stubs
 
@@ -99,7 +99,7 @@
 }
 -----
 
-* Configuring <<<project-to-test>>> pom
+* Configure <<<project-to-test>>> pom
 
 -----
 <project>

Modified: maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/repositories.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/repositories.apt?rev=630001&r1=630000&r2=630001&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/repositories.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/examples/repositories.apt Thu Feb 21 13:24:40 2008
@@ -25,10 +25,10 @@
 
 Testing Using Repositories
 
- <<Note>>: This example improves the {{{../getting-started/index.html}cookbook}} for repositories testing.
+ <<Note>>: This example improves the {{{../getting-started/index.html}cookbook}} for testing repositories.
 
- Developing Maven plugin needs often to have to play with repositories. Suppose that the MyMojo needs
- to download artifacts in your local repository, i.e.:
+ When developing a Maven plugin you often need to play with repositories. Suppose that the MyMojo needs
+ to download artifacts into your local repository, i.e.:
 
 -----
 public class MyMojo
@@ -108,7 +108,7 @@
 }
 -----
 
-* Configuring <<<project-to-test>>> pom
+* Configure <<<project-to-test>>> pom
 
 -----
 <project>
@@ -118,11 +118,11 @@
       <plugin>
         <artifactId>maven-my-plugin</artifactId>
         <configuration>
-          <!-- Specify where this pom will be outputted files -->
+          <!-- Specify where this pom will output files -->
           <outputDirectory>${basedir}/target/test-harness/project-to-test</outputDirectory>
 
-          <!-- By default <<<${basedir}/target/local-repo", where basedir refer
-              to the basedir of maven-my-plugin. -->
+          <!-- By default <<<${basedir}/target/local-repo", where basedir refers
+               to the basedir of maven-my-plugin. -->
           <localRepository>${localRepository}</localRepository>
           <!-- The defined stub -->
           <project implementation="org.apache.maven.plugin.my.stubs.MyProjectStub"/>

Modified: maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/getting-started/index.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/getting-started/index.apt?rev=630001&r1=630000&r2=630001&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/getting-started/index.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/getting-started/index.apt Thu Feb 21 13:24:40 2008
@@ -30,7 +30,7 @@
 
 * Prerequisites
 
- We suppose that you had already created a plugin. In this cookbook, we make reference on <<<MyMojo>>> from
+ We assume that you have already created a plugin. In this cookbook, we make reference to <<<MyMojo>>> in
  <<<maven-my-plugin>>> which is generated by the Maven Archetype Plugin, i.e.:
 
 -----
@@ -58,9 +58,9 @@
 
 * Recipe
 
-** Added <<<maven-plugin-testing-harness>>> dependency
+** Add <<<maven-plugin-testing-harness>>> dependency
 
- As usually, just add <<<maven-plugin-testing-harness>>> as following in your pom. Be sure to specify <<<test>>> scope.
+ As usual, just add <<<maven-plugin-testing-harness>>> as following in your pom. Be sure to specify <<<test>>> scope.
 
 -----
 <project>
@@ -80,7 +80,7 @@
 ** Create a <<<MyMojoTest>>>
 
  Create a <<<MyMojoTest>>> (by convention) class in <<<src/test/java/org/apache/maven/plugin/my>>> directory.
- This class should extends <<<AbstractMojoTestCase>>> from <<<maven-plugin-testing-harness>>>.
+ This class should extend <<<AbstractMojoTestCase>>> from <<<maven-plugin-testing-harness>>>.
 
 -----
 public class MyMojoTest
@@ -131,7 +131,7 @@
 
 ** Configuring <<<project-to-test>>> pom
 
-  Just create a pom as usual. The names for groupId and artifactId don't really care since this project will not be deployed.
+  Just create a pom as usual. The names for groupId and artifactId don't really matter since this project will not be deployed.
 
 -----
 <project xmlns="http://maven.apache.org/POM/4.0.0"
@@ -181,6 +181,6 @@
 
  [[1]] {{{http://maven.apache.org/guides/plugin/guide-java-plugin-development.html}Guide to Developing Java Plugins}}
 
- [[2]] {{{http://maven.apache.org/guides/mini/guide-configuring-plugins.html}Guide to Configuring Plug-ins}}
+ [[2]] {{{http://maven.apache.org/guides/mini/guide-configuring-plugins.html}Guide to Configuring Plugins}}
 
  []

Modified: maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/index.apt?rev=630001&r1=630000&r2=630001&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/index.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/apt/index.apt Thu Feb 21 13:24:40 2008
@@ -25,9 +25,9 @@
 
 Maven Plugin Testing Mechanism
 
- The Maven Plugin Testing Harness provides mechanisms to manage tests on Mojo, i.e. by pre-constructing the
+ The Maven Plugin Testing Harness provides mechanisms to manage tests on Mojos, i.e. by pre-constructing the
  {{{http://plexus.codehaus.org}Plexus}} components, providing stub objects for Maven functionality such as projects,
- and populating fields from an XML file that resembles the Plugin configuration in the POM.
+ and populating fields from an XML file that resembles the plugin configuration in the POM.
 
  The best way to start is to read the cookbook {{{getting-started/index.html}How to use Maven Plugin Testing Harness}}.
 

Modified: maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/fml/faq.fml?rev=630001&r1=630000&r2=630001&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/fml/faq.fml (original)
+++ maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/fml/faq.fml Thu Feb 21 13:24:40 2008
@@ -38,19 +38,19 @@
       <question>What kind of unit tests are supported?</question>
       <answer>
         <p>
-          <dl>
+          <dl>
             <dt>TestCase from JUnit</dt>
             <dd>You could use the <a href="http://junit.org/">JUnit framework</a> to test your plugin in
               the same way you'd write any other JUnit test cases, i.e. by writing a test class which extends
               <i>TestCase</i>.</dd>
             <dt>TestCase from Plexus</dt>
             <dd>Mojos are written to take specific advantage of the <a href="http://plexus.codehaus.org/">Plexus</a>
-              container. If you need Plexus container services, you could write your class wich extends <i>PlexusTestCase</i>,
+              container. If you need Plexus container services, you could write your class which extends <i>PlexusTestCase</i>,
               instead of <i>TestCase</i>.</dd>
             <dt>TestCase from Testing Harness</dt>
             <dd>If you need to inject Maven objects into your mojo, you could use the <i>maven-plugin-testing-harness</i>.
               The <i>maven-plugin-testing-harness</i> is explicitly intended to test the
-              <i>org.apache.maven.reporting.AbstractMavenReport#execute()</i> implementation.</dd>
+              <i>org.apache.maven.reporting.AbstractMavenReport#execute()</i> implementation.</dd>
           </dl>
         </p>
       </answer>

Modified: maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/site.xml?rev=630001&r1=630000&r2=630001&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/site.xml (original)
+++ maven/plugin-tools/trunk/maven-plugin-testing-harness/src/site/site.xml Thu Feb 21 13:24:40 2008
@@ -23,7 +23,7 @@
   <body>
     <menu name="Overview">
       <item name="Introduction" href="index.html"/>
-      <item name="Getting Start" href="/getting-started/index.html"/>
+      <item name="Getting Started" href="/getting-started/index.html"/>
       <item name="FAQ" href="/faq.html"/>
     </menu>