You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by lt...@apache.org on 2005/09/22 19:00:13 UTC

svn commit: r290981 - in /maven/maven-1/plugins/trunk/changes/xdocs: goals.xml index.xml

Author: ltheussl
Date: Thu Sep 22 10:00:11 2005
New Revision: 290981

URL: http://svn.apache.org/viewcvs?rev=290981&view=rev
Log:
Update documentation

Modified:
    maven/maven-1/plugins/trunk/changes/xdocs/goals.xml
    maven/maven-1/plugins/trunk/changes/xdocs/index.xml

Modified: maven/maven-1/plugins/trunk/changes/xdocs/goals.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/changes/xdocs/goals.xml?rev=290981&r1=290980&r2=290981&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/changes/xdocs/goals.xml (original)
+++ maven/maven-1/plugins/trunk/changes/xdocs/goals.xml Thu Sep 22 10:00:11 2005
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!-- 
 /*
- * Copyright 2001-2004 The Apache Software Foundation.
+ * Copyright 2001-2005 The Apache Software Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,20 +26,24 @@
 
   <body>
     <section name="Goals">
-      <p>
-        This plugin is called automatically by the
-        <code>site</code> plugin when it generates the project
-        web site.
-      </p>
       <table>
         <tr><th>Goal</th><th>Description</th></tr>
         <tr>
-          <td>report</td>
+          <td>maven-changes-plugin:register</td>
+          <td>Register the changes plugin with <code>xdoc</code>.</td>
+        </tr>
+        <tr>
+          <td>maven-changes-plugin:deregister</td>
+          <td>Deregister the changes plugin.</td>
+        </tr>
+        <tr>
+          <td>changes:report</td>
           <td>
-            Generate the Changes reports showing the difference between
+            Generate the Changes report showing the difference between
             project releases.
           </td>
         </tr>
+
       </table>
     </section>
  </body>

Modified: maven/maven-1/plugins/trunk/changes/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/changes/xdocs/index.xml?rev=290981&r1=290980&r2=290981&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/changes/xdocs/index.xml (original)
+++ maven/maven-1/plugins/trunk/changes/xdocs/index.xml Thu Sep 22 10:00:11 2005
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!-- 
 /*
- * Copyright 2001-2004 The Apache Software Foundation.
+ * Copyright 2001-2005 The Apache Software Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,15 @@
     </section>
     <section name="Using the plugin">
       <p>
-        In order to use this plugin, simply create a <code>changes.xml</code>
+        In order to use this plugin, you should add the following
+        to the <code>reports</code> section of your <code>project.xml</code>:
+      </p>
+      <source><![CDATA[
+<reports>
+  <report>maven-changes-plugin</report>
+<reports>
+]]></source>
+      <p> Then you have to create a <code>changes.xml</code>
         file in your <code>xdocs</code> directory. Here's an example of a
         typical <code>changes.xml</code>, showing the syntax:
       </p>
@@ -51,7 +59,7 @@
       </action>              
     </release>
 
-    <release version="1.0" date="2003-06-05">
+    <release version="1.0" date="2003-06-05" description ="First stable release.">
       <action dev="vmassol" type="add">
         Added blah blah.
       </action>              



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org