PR: MPJDIFF-8

Submitted by: Phil Steitz
improve documentation


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@267522 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
brett 2005-09-04 00:16:27 +00:00
parent 1cb5ef7f8e
commit 8ab09dd26d
3 changed files with 19 additions and 8 deletions

View File

@ -17,7 +17,7 @@
# -------------------------------------------------------------------
# P L U G I N P R O P E R I E S
# -------------------------------------------------------------------
# jdiff plugin. use any valid cvs labels to compare between
# jdiff plugin. use any valid tag names to compare between
# or 'CURRENT' to compare against your current filesystem.
# -------------------------------------------------------------------
maven.jdiff.old.tag=CURRENT

View File

@ -20,7 +20,7 @@
<document>
<properties>
<title>Maven NSIS Plug-in</title>
<title>Maven JDIff Plug-in</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
@ -29,7 +29,8 @@
<subsection name="Overview of the Maven JDiff Plugin Documentation">
<p>
This plugin is used to generate an API difference report between two
versions of code.
versions of code. See the <a href="http://www.jdiff.org/">JDiff home
page</a> for more information on JDiff.
</p>
<table>
<tr><th>Document</th><th>Description</th></tr>

View File

@ -35,16 +35,26 @@
<td>maven.jdiff.old.tag</td>
<td>Yes</td>
<td>
<p>Default value is
<code>CURRENT</code>.</p>
The scm tag of the sources for the "old" API. The default value
<code>CURRENT</code>. When set to the default value, the files in
${pom.build.sourceDirectory} are used as the "old" sources;
otherwise the scm plugin is used to check out the tag, using
${pom.repository.connection}, the tag name and other <a href=
"http://maven.apache.org/reference/plugins/scm/properties.html">
scm plugin properties</a>.
</td>
</tr>
<tr>
<td>maven.jdiff.new.tag</td>
<td>Yes</td>
<td>
<p>Default value is
<code>HEAD</code>.</p>
The scm tag of the sources for the "new" API. The default value
<code>HEAD</code>. When set to "CURRENT", the files in
${pom.build.sourceDirectory} are used as the "new" sources;
otherwise the scm plugin is used to check out the tag, using
${pom.repository.connection}, the tag name and other <a href=
"http://maven.apache.org/reference/plugins/scm/properties.html">
scm plugin properties</a>.
</td>
</tr>
</table>