dion 2002/09/29 08:35:28
Modified: src/plugins-build/activity project.xml project.properties
plugin.jelly
src/plugins-build/activity/xdocs properties.xml index.xml
Added: src/plugins-build/activity/xdocs changes.xml
Log:
Added more detail to docs
Revision Changes Path
1.11 +2 -1 jakarta-turbine-maven/src/plugins-build/activity/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/activity/project.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- project.xml 15 Sep 2002 15:55:23 -0000 1.10
+++ project.xml 29 Sep 2002 15:35:28 -0000 1.11
@@ -4,7 +4,7 @@
<pomVersion>3</pomVersion>
<id>maven-activity-plugin</id>
<name>Maven Activity Plug-in</name>
- <currentVersion>1.1</currentVersion>
+ <currentVersion>1.2-SNAPSHOT</currentVersion>
<organization>
<name>Apache Software Foundation</name>
<url>http://jakarta.apache.org/</url>
@@ -41,6 +41,7 @@
<organization>Multitask Consulting</organization>
<roles>
<role>Java Developer</role>
+ <role>Documentation</role>
</roles>
</developer>
<developer>
1.3 +0 -2
jakarta-turbine-maven/src/plugins-build/activity/project.properties
Index: project.properties
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/plugins-build/activity/project.properties,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- project.properties 15 Sep 2002 16:56:45 -0000 1.2
+++ project.properties 29 Sep 2002 15:35:28 -0000 1.3
@@ -1,6 +1,4 @@
# -------------------------------------------------------------------
# P R O J E C T P R O P E R T I E S
# -------------------------------------------------------------------
-
-#maven.jarResources.basedir = src
maven.xdoc.date=left
1.10 +1 -1 jakarta-turbine-maven/src/plugins-build/activity/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/activity/plugin.jelly,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- plugin.jelly 7 Sep 2002 15:49:04 -0000 1.9
+++ plugin.jelly 29 Sep 2002 15:35:28 -0000 1.10
@@ -28,7 +28,7 @@
/>
</define:taglib>
- <mkdir dir="${maven.build.dir}/generated-xdocs"/>
+ <mkdir dir="${maven.gen.docs}"/>
<changelog:changelog
projectDescriptor="project.xml"
1.3 +41 -0
jakarta-turbine-maven/src/plugins-build/activity/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/plugins-build/activity/xdocs/properties.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- properties.xml 15 Aug 2002 06:59:44 -0000 1.2
+++ properties.xml 29 Sep 2002 15:35:28 -0000 1.3
@@ -4,12 +4,18 @@
<properties>
<title>Properties</title>
<author email="[EMAIL PROTECTED]">St�phane MOR</author>
+ <author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<section name="Activity Properties">
<table>
<tr>
+ <th>Property name</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
<td>maven.activitylog.range</td>
<td>Yes</td>
<td>
@@ -31,6 +37,41 @@
The default value is <a
href="../apidocs/org/apache/maven/cvslib/CvsChangeLogFactory.html">
org.apache.maven.cvslib.CvsChangeLogFactory</a>.
+ </td>
+ </tr>
+ </table>
+ </section>
+ <section name="Other properties">
+ <table>
+ <tr>
+ <th>Property name</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>maven.build.dir</td>
+ <td>Yes</td>
+ <td>
+ Defaults to <code>${basedir}/target</code>, this property
+ is used as the directory to store the generated change log files
+ in xml format, before being transformed into the standard xdoc format
+ </td>
+ </tr>
+ <tr>
+ <td>maven.docs.outputencoding</td>
+ <td>Yes</td>
+ <td>
+ Defaults to <code>ISO-8859-1</code>. This property specifies
+ the encoding of the generated xml documents.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.mode.online</td>
+ <td>No</td>
+ <td>
+ Set by Maven based on command line arguments, this property
+ defaults to true, and is used to check if Maven has network
+ connectivity to the SCM repository
</td>
</tr>
</table>
1.2 +8 -3 jakarta-turbine-maven/src/plugins-build/activity/xdocs/index.xml
Index: index.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/plugins-build/activity/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 4 Aug 2002 14:51:00 -0000 1.1
+++ index.xml 29 Sep 2002 15:35:28 -0000 1.2
@@ -10,9 +10,14 @@
<section name="Maven Activity Plug-in">
<p>
This plugin generates a file activity report and a developer
- activity report. Currently this uses CVS semantics but can easily
- be made to use other SCMs when we get the commons-scm project
- off the ground.
+ activity report. Currently this uses CVS semantics but there are
+ classes available that produce the reports for Subversion and
+ StarTeam.
+ </p>
+ <p>
+ The reports are only produced if Maven is considered to be running
+ 'online' as defined by the <code>${maven.mode.online}</code>
+ property
</p>
</section>
</body>
1.1
jakarta-turbine-maven/src/plugins-build/activity/xdocs/changes.xml
Index: changes.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Changes</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<releases>
<release version="1.2" date="in CVS">
<action dev="dion" type="add">
Added more documentation on properties and supported SCM systems
</action>
</release>
</releases>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
