svn commit: r422112 - in /maven/sandbox/plugins/maven-changes-plugin/src/site: apt/howto.apt apt/usage.apt site.xml

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn commit: r422112 - in /maven/sandbox/plugins/maven-changes-plugin/src/site: apt/howto.apt apt/usage.apt site.xml

Dennis Lundberg-2
Author: dennisl
Date: Fri Jul 14 17:15:47 2006
New Revision: 422112

URL: http://svn.apache.org/viewvc?rev=422112&view=rev
Log:
Use standard file names
Fix typos and add formating

Added:
    maven/sandbox/plugins/maven-changes-plugin/src/site/apt/usage.apt   (contents, props changed)
      - copied, changed from r421707, maven/sandbox/plugins/maven-changes-plugin/src/site/apt/howto.apt
Removed:
    maven/sandbox/plugins/maven-changes-plugin/src/site/apt/howto.apt
Modified:
    maven/sandbox/plugins/maven-changes-plugin/src/site/site.xml

Copied: maven/sandbox/plugins/maven-changes-plugin/src/site/apt/usage.apt (from r421707, maven/sandbox/plugins/maven-changes-plugin/src/site/apt/howto.apt)
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-changes-plugin/src/site/apt/usage.apt?p2=maven/sandbox/plugins/maven-changes-plugin/src/site/apt/usage.apt&p1=maven/sandbox/plugins/maven-changes-plugin/src/site/apt/howto.apt&r1=421707&r2=422112&rev=422112&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-changes-plugin/src/site/apt/howto.apt (original)
+++ maven/sandbox/plugins/maven-changes-plugin/src/site/apt/usage.apt Fri Jul 14 17:15:47 2006
@@ -1,11 +1,20 @@
-Maven 2 Changes Plugin
+ ------
+ Usage
+ ------
+ Johnny R. Ruiz III
+ Allan Ramirez
+ ------
+ 2 September 2005
+ ------
 
- This plugin is for creation of Changes Report, Jira Report, and Announcement text file.  
+Usage
 
-*How to Generate Changes Report
+ This plugin is used to create a Changes Report, a Jira Report and an Announcement text file.
+
+*How to Generate the Changes Report
 
- In order to use this plugin, simply create a changes.xml file under the src/changes/ directory.
- Here's an example of a typical changes.xml, showing the syntax:
+ In order to use this plugin, simply create a <<<changes.xml>>> file under the <<<src/changes/>>> directory.
+ Here's an example of a typical <<<changes.xml>>>, showing the syntax:
 
 -------------------
 <document>
@@ -25,7 +34,9 @@
       <action dev="jruiz" type="add">
         Added additional documentation on how to configure the plugin.
       </action>
-      <action dev="aramirez" type="fix" issue="MPJIRA-11"> Enable retrieving component-specific issues</action>
+      <action dev="aramirez" type="fix" issue="MPJIRA-11">
+        Enable retrieving component-specific issues.
+      </action>
       <action dev="jruiz" type="remove" due-to="Allan Ramirez" due-to-email="[hidden email]">
         The element type " link " must be terminated by the matching end-tag.
         Deleted the erroneous code.
@@ -35,164 +46,163 @@
 </document>
 -------------------
 
-  The following attributes are supported for the <release> element:
+  The following attributes are supported for the <<<\<release\>>>> element:
 
 *--------------------+--------------*------------------------------------------------------------------------------------------+
 <<Attribute>>        | <<Optional>> | <<Description>>
 *--------------------+--------------*------------------------------------------------------------------------------------------+
-version              | Required     |  Name of the version for which to describe the changes. For each change, add a nested
-                     |              |  <action> element as described below.
+version              | Required     |  Name of the version in which the changes occur. For each change, add a nested <<<\<action\>>>> element as described below.
 *--------------------+--------------*------------------------------------------------------------------------------------------+
-date                 | Required     |  Date at which the version was released. You can use a free form comment such as
-                     |              |  "in CVS" for unreleased versions.
+date                 | Required     |  Date at which the version was released. You can use a free form comment such as "in SVN" for unreleased versions.
 *--------------------+--------------*------------------------------------------------------------------------------------------+
-desc                 | Optional     |  Summary of comments describing the changes in a release.
+desc                 | Optional     |  Summary describing the changes in a release.
 *--------------------+--------------*------------------------------------------------------------------------------------------+
 
-  The following attributes are supported for the <action> element:
+  The following attributes are supported for the <<<\<action\>>>> element:
   
 *--------------------+--------------*------------------------------------------------------------------------------------------+
 <<Attribute>>        | <<Optional>> | <<Description>>
 *--------------------+--------------*------------------------------------------------------------------------------------------+
-dev                  | Required     |  Name of developer who committed the change. This must be the name of the developer as
-                     |              |  described in the developers section of the POM (project.xml file).
+dev                  | Required     |  Name of developer who committed the change. This must be the name of the developer as described in the developers section of the <<<pom.xml>>> file.
 *--------------------+--------------*------------------------------------------------------------------------------------------+
-type                 | Required     |  Type of change. There are four valid values: add, fix, remove, update.
+type                 | Required     |  Type of change. There are four valid values: <add>, <fix>, <remove>, <update>.
 *--------------------+--------------*------------------------------------------------------------------------------------------+
-issue                | Optional     |  Id of the issue related to this change. This is the id in your bug tracking system.
-                     |              |  The Changes plugin will generate a URL out of this id. The URL is constructed by using
-                     |              |  the maven.changes.issue.template property. See the page for more details.
+issue                | Optional     |  Id of the issue related to this change. This is the id in your issue tracking system.
+                     |              |  The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the <<<link_template>>> parameter. See the {{{changes-report-mojo.html}changes-report mojo}} for more details.
 *--------------------+--------------*------------------------------------------------------------------------------------------+
-due-to               | Optional     |  Name of the person to be credited for this change. To be used when a patch is
-                     |              |  submitted by a non-committer.
+due-to               | Optional     |  Name of the person to be credited for this change. This can be used when a patch is submitted by a non-committer.
 *--------------------+--------------*------------------------------------------------------------------------------------------+
 due-to-email         | Optional     |  Email of the person to be credited for this change.
 *--------------------+--------------*------------------------------------------------------------------------------------------+
 
 
-  To generate the report, from your project pom.xml insert the changes plugin in  \<reporting\> section
+  To generate the changes report, insert the changes plugin in the <<<\<reporting\>>>> section of your project <<<pom.xml>>>
 
 -------------------
 <project>
-    ...
-    <reporting>
-      <plugins>
-        <plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-changes-plugin</artifactId>
-            <reportSets>
-              <reportSet>
-                <reports>
-                  <report>changes-report</report>
-                </reports>
-              </reportSet>
-           </reportSets>
-        </plugin>
-      </plugins>
-    </reporting>
-    ...
+  ...
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changes-plugin</artifactId>
+          <reportSets>
+            <reportSet>
+              <reports>
+                <report>changes-report</report>
+              </reports>
+            </reportSet>
+         </reportSets>
+      </plugin>
+    </plugins>
+  </reporting>
+  ...
 </project>
 -------------------  
   
   and execute the site goal to generate the report.
 
 -------------------
-mvn site:site
+mvn site
 -------------------
 
 
-*How to Generate Jira Report
+*How to Generate the Jira Report
 
-  Note:  To use Jira Report, issueManagement section in pom.xml of the project must be configured.
+  <<Note:>> To use the Jira Report, the <<<\<issueManagement\>>>> section in the <<<pom.xml>>> of the project must be configured.
 
-  Sample code inside your pom.xml
+  Sample code inside your <<<pom.xml>>>:
   
 -------------------
-    ...
-    <issueManagement>
-        <url>http://jira.codehaus.org/BrowseProject.jspa?id=10450</url>
-    </issueManagement>
-    ...
+<project>
+  ...
+  <issueManagement>
+    <url>http://jira.codehaus.org/BrowseProject.jspa?id=10450</url>
+  </issueManagement>
+  ...
+</project>
 -------------------
 
 
-  To generate the report, from your project pom.xml insert the changes plugin in  \<reporting\> section
+  To generate the Jira report, insert the changes plugin in the <<<\<reporting\>>>> section of your project <<<pom.xml>>>
 
 -------------------
 <project>
-    ...
-    <reporting>
-      <plugins>
-        <plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-changes-plugin</artifactId>
-          <version>2.0-beta-1-SNAPSHOT</version>
-            <reportSets>
-              <reportSet>
-                <reports>
-                  <report>jira-report</report>
-                </reports>
-              </reportSet>
-           </reportSets>
-        </plugin>
-      </plugins>
-    </reporting>
-    ...
+  ...
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changes-plugin</artifactId>
+        <reportSets>
+          <reportSet>
+            <reports>
+              <report>jira-report</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+    </plugins>
+  </reporting>
+  ...
 </project>
 -------------------  
   
   and execute the site goal to generate the report.
 
 -------------------
-mvn site:site
+mvn site
 -------------------
 
 
 *How to generate and send the Announcement in Email
 
-  In your project pom, insert this segment.
+  In your project <<<pom.xml>>>, insert this segment:
 
 -------------------
-...    
-<build>    
+<project>
+  ...
+  <build>
     <plugins>
-        <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-changes-plugin</artifactId>
-            <executions>
-                <execution>
-                    <goals>
-                        <goal>announcement-generate</goal>
-                    </goals>
-                    <id>announcement-generate</id>
-                </execution>
-                <execution>
-                    <goals>
-                        <goal>announcement-mail</goal>
-                    </goals>
-                    <id>announcement-mail</id>
-                </execution>
-            </executions>
-            <configuration>
-        <smtpHost>mail.yourhost.com</smtpHost>
-        <smtpPort implementation="java.lang.Integer">25</smtpPort>
-        <toAddresses>
-    <toAddress implementation="java.lang.String">[hidden email]</toAddress>
-    <toAddress implementation="java.lang.String">[hidden email]</toAddress>
-        </toAddresses>
-            </configuration>
-        </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changes-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>announcement-generate</goal>
+            </goals>
+            <id>announcement-generate</id>
+          </execution>
+          <execution>
+            <goals>
+              <goal>announcement-mail</goal>
+            </goals>
+            <id>announcement-mail</id>
+          </execution>
+        </executions>
+        <configuration>
+          <smtpHost>mail.yourhost.com</smtpHost>
+          <smtpPort implementation="java.lang.Integer">25</smtpPort>
+          <toAddresses>
+            <toAddress implementation="java.lang.String">[hidden email]</toAddress>
+            <toAddress implementation="java.lang.String">[hidden email]</toAddress>
+          </toAddresses>
+        </configuration>
+      </plugin>
     </plugins>
-<build>
+  </build>
+  ...
+</project>
 -------------------
 
-  You can generate the announcement by executing the command below.
+  You can generate the announcement by executing the command below:
 
 -------------------
 mvn changes:announcement-generate
 -------------------
 
-  Same goes for mailing the generating announcement.
+  This is how you mail the generated announcement:
 
 -------------------
 mvn changes:announcement-mail
@@ -202,24 +212,26 @@
 *Authentication support
 
   If the smtp host needs authentication, you can provide your username and password
-  in the \<configuration\> section
+  in the <<<\<configuration\>>>> section
 
 -------------------
-<build>
-    ...
+<project>
+  ...
+  <build>
     <plugins>
-        ...
- <plugin>
-    ...
-    <configuration>
-        <smtpHost>mail.yourhost.com</smtpHost>
-        <smtpPort implementation="java.lang.Integer">25</smtpPort>
-
- <username>[hidden email]</username>
- <password>somepassword</password>
-
- ...
-
-    </configuration>
-    ...
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changes-plugin</artifactId>
+        <configuration>
+          <smtpHost>mail.yourhost.com</smtpHost>
+          <smtpPort implementation="java.lang.Integer">25</smtpPort>
+          <username>[hidden email]</username>
+          <password>somepassword</password>
+          ...
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+  ...
+</project>
 -------------------

Propchange: maven/sandbox/plugins/maven-changes-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/plugins/maven-changes-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Modified: maven/sandbox/plugins/maven-changes-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-changes-plugin/src/site/site.xml?rev=422112&r1=422111&r2=422112&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-changes-plugin/src/site/site.xml (original)
+++ maven/sandbox/plugins/maven-changes-plugin/src/site/site.xml Fri Jul 14 17:15:47 2006
@@ -34,7 +34,7 @@
 
     <menu name="Overview">
       <item name="Goals" href="plugin-info.html"/>
-      <item name="Usage" href="howto.html"/>
+      <item name="Usage" href="usage.html"/>
       <item name="Sample Changes Report" href="changes-report.html"/>
       <item name="Sample Jira Report" href="jira-report.html"/>
     </menu>