Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@290981 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ltheussl
2005-09-22 17:00:11 +00:00
parent d1115d4dc2
commit 951f290b80
2 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
changes/xdocs/goals.xml
View File

@@ -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>

14
changes/xdocs/index.xml
View File

@@ -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>