You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by di...@apache.org on 2002/11/30 00:30:49 UTC
cvs commit: jakarta-turbine-maven/src/plugins-build/cactus plugin.jelly
dion 2002/11/29 15:30:49
Modified: src/plugins-build/j2ee plugin.jelly
src/plugins-build/antlr plugin.jelly
src/plugins-build/plexus plugin.jelly
src/plugins-build/aptdoc plugin.jelly
src/plugins-build/j2ee/appserver tomcat-4.x.jelly
src/plugins-build/cactus plugin.jelly
Log:
Add missing goal descriptions
Revision Changes Path
1.15 +5 -3 jakarta-turbine-maven/src/plugins-build/j2ee/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/plugin.jelly,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- plugin.jelly 24 Oct 2002 12:41:02 -0000 1.14
+++ plugin.jelly 29 Nov 2002 23:30:48 -0000 1.15
@@ -21,7 +21,7 @@
<!--==================================================================-->
<!-- B E G I N C O R E P R O C E S S I N G -->
<!--==================================================================-->
- <goal name="appserver:init">
+ <goal name="appserver:init" description="Begin core processing">
<condition property="maven.appserver.started">
<http url="${maven.appserver.url}" />
@@ -93,7 +93,8 @@
<!-- specific when using pre and post goals and sometimes there may -->
<!-- be custom implementations of reinstall -->
<goal name="appserver:reinstall"
- prereqs="appserver:init,appserver:install-${maven.appserver.fullname}" />
+ prereqs="appserver:init,appserver:install-${maven.appserver.fullname}"
+ description="Re-install an appserver" />
<!--==================================================================-->
<!-- S T A R T -->
@@ -142,7 +143,8 @@
<!-- the purpose of this target is to allow the user to be very -->
<!-- when using pre and post goals -->
<goal name="appserver:restart"
- prereqs="appserver:init,appserver:start-${maven.appserver.fullname}" />
+ prereqs="appserver:init,appserver:start-${maven.appserver.fullname}"
+ description="Restart an appserver instance" />
<!--==================================================================-->
<!-- S T O P -->
1.5 +3 -1 jakarta-turbine-maven/src/plugins-build/antlr/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/antlr/plugin.jelly,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- plugin.jelly 22 Oct 2002 00:23:56 -0000 1.4
+++ plugin.jelly 29 Nov 2002 23:30:48 -0000 1.5
@@ -7,13 +7,15 @@
<j:set var="antlrSrcDir" value="${maven.antlr.src.dir}"/>
- <goal name="antlr:prepare-filesystem">
+ <goal name="antlr:prepare-filesystem"
+ description="Make any necessary directories for antlr processing">
<j:if test="${!antlrSrcDir.equals('MAVEN_ANTLR_SRC_DIR_NOT_SET')}">
<mkdir dir="${maven.build.dir}/antlr"/>
</j:if>
</goal>
<goal name="antlr:generate"
+ description="Generate source from antlr grammars"
prereqs="antlr:prepare-filesystem">
<j:if test="${!antlrSrcDir.equals('MAVEN_ANTLR_SRC_DIR_NOT_SET')}">
1.2 +5 -3 jakarta-turbine-maven/src/plugins-build/plexus/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/plexus/plugin.jelly,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- plugin.jelly 18 Nov 2002 22:28:02 -0000 1.1
+++ plugin.jelly 29 Nov 2002 23:30:48 -0000 1.2
@@ -46,7 +46,7 @@
<!-- B U I L D C O M P O N E N T S -->
<!-- ===================================================================== -->
- <goal name="build-components">
+ <goal name="build-components" description="build components">
<maven:maven
basedir="${basedir}/component-builds"
@@ -61,7 +61,8 @@
<!-- G E N E R A T E L A U N C H E R C O N F I G U R A T I O N -->
<!-- ===================================================================== -->
- <goal name="launcherConfiguration" prereqs="init-texen-tag">
+ <goal name="launcherConfiguration" prereqs="init-texen-tag"
+ description="Generate launcher configuration">
<texen:generate
controlTemplate="${maven.plexus.launcherConfigurationTemplate}"
outputDirectory="${maven.plexus.conf}"
@@ -75,7 +76,8 @@
<!-- G E N E R A T E S T A R T E R S C R I P T -->
<!-- ===================================================================== -->
- <goal name="script" prereqs="init-texen-tag">
+ <goal name="script" prereqs="init-texen-tag"
+ description="Generate starter script">
<texen:generate
controlTemplate="plexus.vm"
outputDirectory="${maven.plexus.bin}"
1.4 +2 -1 jakarta-turbine-maven/src/plugins-build/aptdoc/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/aptdoc/plugin.jelly,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- plugin.jelly 21 Oct 2002 19:27:43 -0000 1.3
+++ plugin.jelly 29 Nov 2002 23:30:48 -0000 1.4
@@ -18,7 +18,8 @@
method="doExecute" />
</define:taglib>
- <goal name="apt:generate" prereqs="xdoc:generate-from-pom">
+ <goal name="apt:generate" prereqs="xdoc:generate-from-pom"
+ description="Generate docs in APT format">
<j:set var="srcDir" value="${maven.aptdoc.src.dir}"/>
1.3 +6 -3 jakarta-turbine-maven/src/plugins-build/j2ee/appserver/tomcat-4.x.jelly
Index: tomcat-4.x.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/appserver/tomcat-4.x.jelly,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- tomcat-4.x.jelly 19 Jul 2002 01:34:36 -0000 1.2
+++ tomcat-4.x.jelly 29 Nov 2002 23:30:48 -0000 1.3
@@ -12,7 +12,8 @@
Install and configure Tomcat 4.0 instance
========================================================================
-->
- <goal name="appserver:install-tomcat-4.x">
+ <goal name="appserver:install-tomcat-4.x"
+ description="install and configure a tomcat 4.0 instance">
<!-- Create common directories and copy configuration files -->
<mkdir dir="${maven.appserver.dir}/conf"/>
@@ -34,7 +35,8 @@
Start Tomcat 4.0
========================================================================
-->
- <goal name="appserver:start-tomcat-4.x">
+ <goal name="appserver:start-tomcat-4.x"
+ description="Start Tomcat 4.0">
<java classname="org.apache.catalina.startup.Bootstrap" fork="yes"
dir="${maven.appserver.dir}">
<classpath>
@@ -54,7 +56,8 @@
Stop Tomcat 4.0
========================================================================
-->
- <goal name="appserver:stop-tomcat-4.x">
+ <goal name="appserver:stop-tomcat-4.x"
+ description="Stop Tomcat 4.0">
<java classname="org.apache.catalina.startup.Bootstrap" fork="yes"
dir="${maven.appserver.dir}">
<classpath>
1.22 +6 -4 jakarta-turbine-maven/src/plugins-build/cactus/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/cactus/plugin.jelly,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- plugin.jelly 12 Nov 2002 22:33:07 -0000 1.21
+++ plugin.jelly 29 Nov 2002 23:30:48 -0000 1.22
@@ -24,7 +24,7 @@
Initialization. Creates objects useful for several goals.
========================================================================
-->
- <goal name="cactus:init">
+ <goal name="cactus:init" description="Creates objects useful for several goals">
<taskdef name="junit"
classname="org.apache.tools.ant.taskdefs.optional.junit.JUnitTask"/>
@@ -56,7 +56,8 @@
Compile Cactus tests.
========================================================================
-->
- <goal name="cactus:compile" prereqs="java:compile">
+ <goal name="cactus:compile" prereqs="java:compile"
+ description="Compile Cactus tests">
<mkdir dir="${maven.cactus.build.dir}"/>
<mkdir dir="${maven.cactus.classes.dir}"/>
@@ -87,7 +88,7 @@
classes to either the project war or the project webapp).
========================================================================
-->
- <goal name="cactus:webapp">
+ <goal name="cactus:webapp" description="Create the Cactus webapp">
<available file="${maven.cactus.prewar.dir}/${pom.id}.war"
property="maven.cactus.prewar.exists"/>
@@ -136,7 +137,8 @@
and the webapp elements needed by Cactus.
========================================================================
-->
- <goal name="cactus:merge-webxml" prereqs="init-dvsl-tag">
+ <goal name="cactus:merge-webxml" prereqs="init-dvsl-tag"
+ description="Generate a web.xml which is the merge betweem the user project web.xml and the webapp elements needed by Cactus">
<available file="${maven.war.webxml}"
property="maven.cactus.webxml.exists"/>
RE: cvs commit: jakarta-turbine-maven/src/plugins-build/cactus plugin.jelly
Posted by di...@multitask.com.au.
Is everyone else happy with this?
I can easily implement it.
--
dIon Gillard, Multitask Consulting
Blog: http://www.freeroller.net/page/dion/Weblog
Work: http://www.multitask.com.au
"Vincent Massol" <vm...@octo.com>
01/12/2002 10:14 AM
Please respond to
"Turbine Maven Developers List" <tu...@jakarta.apache.org>
To
"'Turbine Maven Developers List'" <tu...@jakarta.apache.org>
cc
Subject
RE: cvs commit: jakarta-turbine-maven/src/plugins-build/cactus
plugin.jelly
> -----Original Message-----
> From: dion@multitask.com.au [mailto:dion@multitask.com.au]
> Sent: 30 November 2002 23:06
> To: Turbine Maven Developers List
> Subject: RE: cvs commit:
jakarta-turbine-maven/src/plugins-build/cactus
> plugin.jelly
>
> "Vincent Massol" <vm...@octo.com> wrote on 30/11/2002 10:25:41 PM:
>
> > Hi dIon,
> >
> > I've been away for some time so I may be missing a few things. Could
you
> > explain to me why you have made public goals which were private by
> > design (at least for the cactus plugin)? Is there some new rule that
> > says that all goals must be public? If so, what's the rationale? I
did
> > not want to expose them as they are subject to changes (not part of
the
> > plugin GPI - Goal Progamming Interface ;-) ).
>
> AFAIK, they weren't private.
They were (there is no other way to signal this ATM). This is true at
least for all the plugins I have written.
> They just kept coming up as 'undocumented
> goals' when I ran maven -g.
yeah, and I had suggested in the past that they don't get listed but
somehow it did not make it...
>
> So they were listed at the end of the goals, in the most visible place
to
> me. I was trying to get the documentation up to scratch, so that they
were
> all documented.
That's a nice goal (pun intended).
>
> If you think they need to be marked as Private somehow, lets find a
way.
> Either:
> a) Undocumented goals don't get listed in maven -g,
+1. I really don't see why they should. That will also force "public"
goals to be documented.
> b) The description has a special 'Private' at the front, or
> c) <Insert your suggestion here>
>
> Votes?
Thanks
-Vincent
> --
> dIon Gillard, Multitask Consulting
> Blog: http://www.freeroller.net/page/dion/Weblog
> Work: http://www.multitask.com.au
>
>
>
> --
> To unsubscribe, e-mail: <mailto:turbine-maven-dev-
> unsubscribe@jakarta.apache.org>
> For additional commands, e-mail: <mailto:turbine-maven-dev-
> help@jakarta.apache.org>
--
To unsubscribe, e-mail: <
mailto:turbine-maven-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <
mailto:turbine-maven-dev-help@jakarta.apache.org>
ForwardSourceID:NT00093B36
RE: cvs commit: jakarta-turbine-maven/src/plugins-build/cactus plugin.jelly
Posted by Vincent Massol <vm...@octo.com>.
> -----Original Message-----
> From: dion@multitask.com.au [mailto:dion@multitask.com.au]
> Sent: 30 November 2002 23:06
> To: Turbine Maven Developers List
> Subject: RE: cvs commit:
jakarta-turbine-maven/src/plugins-build/cactus
> plugin.jelly
>
> "Vincent Massol" <vm...@octo.com> wrote on 30/11/2002 10:25:41 PM:
>
> > Hi dIon,
> >
> > I've been away for some time so I may be missing a few things. Could
you
> > explain to me why you have made public goals which were private by
> > design (at least for the cactus plugin)? Is there some new rule that
> > says that all goals must be public? If so, what's the rationale? I
did
> > not want to expose them as they are subject to changes (not part of
the
> > plugin GPI - Goal Progamming Interface ;-) ).
>
> AFAIK, they weren't private.
They were (there is no other way to signal this ATM). This is true at
least for all the plugins I have written.
> They just kept coming up as 'undocumented
> goals' when I ran maven -g.
yeah, and I had suggested in the past that they don't get listed but
somehow it did not make it...
>
> So they were listed at the end of the goals, in the most visible place
to
> me. I was trying to get the documentation up to scratch, so that they
were
> all documented.
That's a nice goal (pun intended).
>
> If you think they need to be marked as Private somehow, lets find a
way.
> Either:
> a) Undocumented goals don't get listed in maven -g,
+1. I really don't see why they should. That will also force "public"
goals to be documented.
> b) The description has a special 'Private' at the front, or
> c) <Insert your suggestion here>
>
> Votes?
Thanks
-Vincent
> --
> dIon Gillard, Multitask Consulting
> Blog: http://www.freeroller.net/page/dion/Weblog
> Work: http://www.multitask.com.au
>
>
>
> --
> To unsubscribe, e-mail: <mailto:turbine-maven-dev-
> unsubscribe@jakarta.apache.org>
> For additional commands, e-mail: <mailto:turbine-maven-dev-
> help@jakarta.apache.org>
RE: cvs commit: jakarta-turbine-maven/src/plugins-build/cactus plugin.jelly
Posted by di...@multitask.com.au.
"Vincent Massol" <vm...@octo.com> wrote on 30/11/2002 10:25:41 PM:
> Hi dIon,
>
> I've been away for some time so I may be missing a few things. Could you
> explain to me why you have made public goals which were private by
> design (at least for the cactus plugin)? Is there some new rule that
> says that all goals must be public? If so, what's the rationale? I did
> not want to expose them as they are subject to changes (not part of the
> plugin GPI - Goal Progamming Interface ;-) ).
AFAIK, they weren't private. They just kept coming up as 'undocumented
goals' when I ran maven -g.
So they were listed at the end of the goals, in the most visible place to
me. I was trying to get the documentation up to scratch, so that they were
all documented.
If you think they need to be marked as Private somehow, lets find a way.
Either:
a) Undocumented goals don't get listed in maven -g,
b) The description has a special 'Private' at the front, or
c) <Insert your suggestion here>
Votes?
--
dIon Gillard, Multitask Consulting
Blog: http://www.freeroller.net/page/dion/Weblog
Work: http://www.multitask.com.au
RE: cvs commit: jakarta-turbine-maven/src/plugins-build/cactus plugin.jelly
Posted by Vincent Massol <vm...@octo.com>.
Hi dIon,
I've been away for some time so I may be missing a few things. Could you
explain to me why you have made public goals which were private by
design (at least for the cactus plugin)? Is there some new rule that
says that all goals must be public? If so, what's the rationale? I did
not want to expose them as they are subject to changes (not part of the
plugin GPI - Goal Progamming Interface ;-) ).
Thanks
-Vincent
> -----Original Message-----
> From: dion@apache.org [mailto:dion@apache.org]
> Sent: 29 November 2002 23:31
> To: jakarta-turbine-maven-cvs@apache.org
> Subject: cvs commit: jakarta-turbine-maven/src/plugins-build/cactus
> plugin.jelly
[snip]
> - <goal name="cactus:init">
> + <goal name="cactus:init" description="Creates objects useful for
> several goals">
[snip]
> - <goal name="cactus:compile" prereqs="java:compile">
> + <goal name="cactus:compile" prereqs="java:compile"
> + description="Compile Cactus tests">
[snip]
> - <goal name="cactus:webapp">
> + <goal name="cactus:webapp" description="Create the Cactus
webapp">
[snip]
> - <goal name="cactus:merge-webxml" prereqs="init-dvsl-tag">
> + <goal name="cactus:merge-webxml" prereqs="init-dvsl-tag"
> + description="Generate a web.xml which is the merge betweem the
user
> project web.xml and the webapp elements needed by Cactus">