On Tue, 2004-01-06 at 16:26, Vincent Massol wrote: > The problem is that, as you know, documentation is far from reality... > :-)
That is now the problem of the plugin developers, but I agree it has been a problem in the past. > Just look at existing plugin documentation and you'll see that the > properties.xml files are not a good reflect of reality. OTOH, the > plugin.properties file can only be accurate. It can be off too as there can be properties that aren't used but the same is true of using @tags in the top of jelly.plugin. If you don't care for your plugin it's not going to grow up :-) > Whenever I use a plugin, I never rely on its properties.xml doc. I > always go to the source (i.e the plugin.properties file) as I know it > cannot be wrong. The only thing wrong it can have is not to define a > property as public. > > > > > But it would be nice to have something generate this. How about > > something at the top of a jelly plugin like: > > > > <!-- > > @maven.announcement.version The variable controlling the ann > version. > > --> > > That's still documentation. And as it's not mandatory, plugin writer may > (and will!) still forget adding it. > > > > > And have that create properties.xml files? > > I think we need something more. Making it mandatory for the plugin to > work would be better I think. Currently there is no real way to distinguish between a public property and a private one even though in most cases they are almost always public. I would be all for requiring some structure in the plugin.jelly or project.xml that could be examined by the plugin plugin and not built the plugin if the required structure is missing. You're right that the docs suck and this would be one way to try and enforce it. If there are no public properties then that would have to be explicity stated too. > Any idea? > > Thanks > -Vincent > > > > > > > > Thanks > > > -Vincent > > > > > > > -----Original Message----- > > > > From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > > > > Sent: 06 January 2004 21:49 > > > > To: [EMAIL PROTECTED] > > > > Subject: cvs commit: maven-plugins/announcement plugin.properties > > > > > > > > jvanzyl 2004/01/06 12:48:47 > > > > > > > > Modified: announcement plugin.properties > > > > Log: > > > > o property is gleaned within the plugin using the pom directly. > > > > > > > > Revision Changes Path > > > > 1.2 +1 -1 > maven-plugins/announcement/plugin.properties > > > > > > > > Index: plugin.properties > > > > > =================================================================== > > > > RCS file: > /home/cvs/maven-plugins/announcement/plugin.properties,v > > > > retrieving revision 1.1 > > > > retrieving revision 1.2 > > > > diff -u -r1.1 -r1.2 > > > > --- plugin.properties 16 Nov 2003 22:48:56 -0000 1.1 > > > > +++ plugin.properties 6 Jan 2004 20:48:46 -0000 1.2 > > > > @@ -3,4 +3,4 @@ > > > > # > > > ------------------------------------------------------------------- > > > > > > > > # Version for which to create a release note. > > > > -maven.announcement.version = ${pom.currentVersion} > > > > +## maven.announcement.version = ${pom.currentVersion} > > > > > > > > > > > > > > > > > > > > > --------------------------------------------------------------------- > > > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > > > For additional commands, e-mail: [EMAIL PROTECTED] > > > > > > > > > > > > > --------------------------------------------------------------------- > > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > > For additional commands, e-mail: [EMAIL PROTECTED] > > -- > > jvz. > > > > Jason van Zyl > > [EMAIL PROTECTED] > > http://tambora.zenplex.org > > > > In short, man creates for himself a new religion of a rational > > and technical order to justify his work and to be justified in it. > > > > -- Jacques Ellul, The Technological Society > > > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > For additional commands, e-mail: [EMAIL PROTECTED] > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] -- jvz. Jason van Zyl [EMAIL PROTECTED] http://tambora.zenplex.org In short, man creates for himself a new religion of a rational and technical order to justify his work and to be justified in it. -- Jacques Ellul, The Technological Society --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
