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 2007/03/02 00:25:57 UTC

svn commit: r513511 - /maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt

Author: dennisl
Date: Thu Mar  1 13:29:32 2007
New Revision: 513511

URL: http://svn.apache.org/viewvc?view=rev&rev=513511
Log:
o Fix typos.
o Add some formating.

Modified:
    maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt

Modified: maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt?view=diff&rev=513511&r1=513510&r2=513511
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt Thu Mar  1 13:29:32 2007
@@ -9,7 +9,7 @@
 
 Usage
 
- Below are the different goals and configuration of the Help plugin.
+ Below are the different goals and configurations of the Help plugin.
 
 * The <<<help:active-profiles>>> Mojo
 
@@ -17,7 +17,7 @@
   For each project in the build session, it will output a list of profiles which have been applied to that project, along
   with the source of the profile (POM, settings.xml, or profiles.xml).
 
-  Optionally, the output parameter can be specified to divert this output to a file.
+  Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
 
   You can execute this mojo using the following command:
 
@@ -30,7 +30,7 @@
   The <<<dependencies>>> mojo is used to view the dependency hierarchy of the project currently being built.
   It will output the resolved tree of dependencies that the Maven build process actually uses.
 
-  Optionally, the output parameter can be specified to divert this output to a file.
+  Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
 
   You can execute this mojo using the following command:
 
@@ -42,11 +42,11 @@
 
   The <<<describe>>> mojo is used to discover information about Maven plugins. Given a plugin prefix or groupId, artifactId,
   and optionally version, the mojo will lookup that plugin and output details about it. If the user also specifies
-  which mojo to describe, the <<describe>> mojo will limit output to the details of that mojo, including parameters.
+  which mojo to describe, the <<<describe>>> mojo will limit output to the details of that mojo, including parameters.
 
-  Optionally, the output parameter can be specified to divert this output to a file.
+  Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
 
-  This mojo requires either the groupId and artifactId parameters or the plugin parameter to be specified:
+  This mojo requires either the <<<groupId>>> and <<<artifactId>>> parameters or the <<<plugin>>> parameter to be specified:
 
 +-----+
 mvn help:describe -DgroupId=org.somewhere
@@ -56,10 +56,10 @@
  or
 
 +-----+
-mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0
+mvn help:describe -Dplugin=org.somewhere:some-plugin:0.0.0
 +-----+
 
- (NOTE: version is always optional here.)
+ <<NOTE:>> <<<version>>> is always optional here.
 
 * The <<<help:effective-pom>>> Mojo
 
@@ -67,12 +67,12 @@
   and active profiles. It provides a useful way of removing the guesswork about just what ends up in the POM that Maven uses
   to build your project. It will iterate over all projects in the current build session, printing the effective POM for each.
 
-  Optionally, the output parameter can be specified to divert this output to a file.
+  Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
 
-  The mojo can be executedd using the following command:
+  The mojo can be executed using the following command:
 
 +-----+
-mvn help:effective-profiles -Doutput=/path/to/file
+mvn help:effective-pom -Doutput=/path/to/file
 +-----+
 
 * The <<<help:effective-settings>>> Mojo
@@ -80,9 +80,9 @@
   The <<<effective-settings>>> mojo is used to view the Settings that Maven actually uses to run the build. This Settings
   instance is a result of merging the global file with the user's file, with the user's file taking precedence.
 
-  Optionally, the output parameter can be specified to divert this output to a file.
+  Optionally, the <<<output>>> parameter can be specified to divert this output to a file.
 
-  The mojo can be executedd using the following command:
+  The mojo can be executed using the following command:
 
 +-----+
 mvn help:effective-settings -Doutput=/path/to/file