You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by fuvo <vf...@webde.de> on 2006/10/05 17:00:00 UTC
[mvn] clover-plugin documentation is very annoying
Hello,
I just try to find out if mvn now meets our requirements (availibilty of the
reports). The last 2 hours I tried to get the maven-clover-plugin to work,
but wherever I placed my clover-license I got the message, that it has
already expired.
I searched the ng, read the documentation and did everything as it has been
described in the docs. After a few hours I found out (by reading the code)
that I have to use
<licenseFile>...</licenseFile>
instead of
<licenseLocation>${basedir}/src/test/clover/myclover.license</licenseLocation>
(from the docs)
THAT is really annoying! Wrong documentation is by far more useless than no
documentation.
Maybe it would help to use a specific version of the maven-clover-plugin in
the examples.
Maybe this post can save someones time
Sorry for this post but this has really upset me :(
regards,
Volker
--
View this message in context: http://www.nabble.com/-mvn--clover-plugin-documentation-is-very-annoying-tf2389157.html#a6660694
Sent from the Maven - Users mailing list archive at Nabble.com.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE: [mvn] clover-plugin documentation is very annoying
Posted by Vincent Massol <vi...@massol.net>.
> -----Original Message-----
> From: fuvo [mailto:vf@webde.de]
> Sent: jeudi 5 octobre 2006 19:10
> To: users@maven.apache.org
> Subject: RE: [mvn] clover-plugin documentation is very annoying
>
>
> Hi Vincent,
>
> >Which version of the plugin are you using?
>
> Like in the examples I didn't set a special version. Now, I just tried it
> with setting version to 2.2 and it works as you said it would. Which
> version
> is used when no version is set?
My understanding is that Maven will always use the latest released version
if you don't have the plugin installed locally (this is BTW the information
in
http://repo1.maven.org/maven2/org/apache/maven/plugins/maven-clover-plugin/m
aven-metadata.xml).
The only thing I could think of is that you had installed and used the m2
Clover plugin in the past (and older version of it) and that you have not
asked Maven2 to update to the latest version (mvn -cpu).
In the past I remember Maven2 was prompting you whenever it was finding a
new version of a plugin. I haven't seen this behavior for a while so I guess
it's been disabled by default.
In any case it's a good idea to specify the version of the plugin you wish
to use. Note that you can use ranges to specify, for example, that you want
to use version 2.2 or greater of the Clover plugin (I don't have the syntax
in my head but something like <version>[2.2,)</version>).
Thanks
-Vincent
___________________________________________________________________________
D�couvrez un nouveau moyen de poser toutes vos questions quel que soit le sujet !
Yahoo! Questions/R�ponses pour partager vos connaissances, vos opinions et vos exp�riences.
http://fr.answers.yahoo.com
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE: [mvn] clover-plugin documentation is very annoying
Posted by fuvo <vf...@webde.de>.
Hi Vincent,
>Which version of the plugin are you using?
Like in the examples I didn't set a special version. Now, I just tried it
with setting version to 2.2 and it works as you said it would. Which version
is used when no version is set?
regards, Volker
--
View this message in context: http://www.nabble.com/-mvn--clover-plugin-documentation-is-very-annoying-tf2389157.html#a6664059
Sent from the Maven - Users mailing list archive at Nabble.com.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE: [mvn] clover-plugin documentation is very annoying
Posted by Vincent Massol <vi...@massol.net>.
> -----Original Message-----
> From: fuvo [mailto:vf@webde.de]
> Sent: jeudi 5 octobre 2006 17:28
> To: users@maven.apache.org
> Subject: RE: [mvn] clover-plugin documentation is very annoying
>
>
> Hi Vincent,
>
> sorry, sometimes its better to sleep over something ;-) - sorry for that
> post.
Don't worry! :-)
[snip]
> >All that said, it's possible that there's a bug and that the
> licenseLocation
> >doesn't work with v2.2 of the plugin. If that's true please raise it as
> a
> >bug in JIRA but in any case it won't be a documentation bug as the
> >licenseLocation is the defined way to do it...
>
> I'm not sure - I think it's not only me using the clover plugin. During
> searching the ng i wondered if I'm the only one with this problem. I try
> it
> later again.
Which version of the plugin are you using?
Thanks
-Vincent
___________________________________________________________________________
Yahoo! Mail r�invente le mail ! D�couvrez le nouveau Yahoo! Mail et son interface r�volutionnaire.
http://fr.mail.yahoo.com
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE: [mvn] clover-plugin documentation is very annoying
Posted by fuvo <vf...@webde.de>.
Hi Vincent,
sorry, sometimes its better to sleep over something ;-) - sorry for that
post.
>Both the documentation and code are correct AFAIK. The correct way is to
use
>licenseLocation as licenseFile has been deprecated (see
>http://maven.apache.org/plugins/maven-clover-plugin/instrument-mojo.html
>which mentions the deprecation as of Clover plugin v2.1).
hm, then I have no idea why it didn't work for me...
>When a documentation error is found the correct approach is to create a
JIRA
>issue for the project and mention it there so that it can be fixed.
right, sorry
>> Maybe this post can save someones time
>Actually it'll make them loose lots of time as what you've mentioned is not
>correct and you'll confuse them now and for eternity (as it'll be indexed
by
>google). Too bad you've now documented it because bad documentation is
worse
>than no documentation !!!! :-)
good point :-) (In fact, just after posting I read some more of the code and
found the deprecation warning (which confused me more))
>All that said, it's possible that there's a bug and that the
licenseLocation
>doesn't work with v2.2 of the plugin. If that's true please raise it as a
>bug in JIRA but in any case it won't be a documentation bug as the
>licenseLocation is the defined way to do it...
I'm not sure - I think it's not only me using the clover plugin. During
searching the ng i wondered if I'm the only one with this problem. I try it
later again.
regards,
Volker
___________________________________________________________________________
D?couvrez un nouveau moyen de poser toutes vos questions quel que soit le
sujet !
Yahoo! Questions/R?ponses pour partager vos connaissances, vos opinions et
vos exp?riences.
http://fr.answers.yahoo.com
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
--
View this message in context: http://www.nabble.com/-mvn--clover-plugin-documentation-is-very-annoying-tf2389157.html#a6661427
Sent from the Maven - Users mailing list archive at Nabble.com.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
RE: [mvn] clover-plugin documentation is very annoying
Posted by Vincent Massol <vi...@massol.net>.
Hi Volker,
> -----Original Message-----
> From: fuvo [mailto:vf@webde.de]
> Sent: jeudi 5 octobre 2006 17:00
> To: users@maven.apache.org
> Subject: [mvn] clover-plugin documentation is very annoying
>
>
> Hello,
>
> I just try to find out if mvn now meets our requirements (availibilty of
> the
> reports). The last 2 hours I tried to get the maven-clover-plugin to work,
> but wherever I placed my clover-license I got the message, that it has
> already expired.
>
> I searched the ng, read the documentation and did everything as it has
> been
> described in the docs. After a few hours I found out (by reading the code)
> that I have to use
>
> <licenseFile>...</licenseFile>
Both the documentation and code are correct AFAIK. The correct way is to use
licenseLocation as licenseFile has been deprecated (see
http://maven.apache.org/plugins/maven-clover-plugin/instrument-mojo.html
which mentions the deprecation as of Clover plugin v2.1).
The web site is for the latest version of the plugin (currently v2.2).
> instead of
>
> <licenseLocation>${basedir}/src/test/clover/myclover.license</licenseLocat
> ion>
> (from the docs)
>
> THAT is really annoying! Wrong documentation is by far more useless than
> no
> documentation.
Then I guess you won't like the Clover plugin compared to lots of other
plugins as it has lots of documentation and thus has a higher risk than
other plugin to have errors in it.... :-) You'll love all the other plugins
with no documentation though as they have no documentation errors... :-)
When a documentation error is found the correct approach is to create a JIRA
issue for the project and mention it there so that it can be fixed.
> Maybe it would help to use a specific version of the maven-clover-plugin
> in
> the examples.
This something that we do badly indeed:
1) The web site SHOULD display the version of the plugin it is
documentation. This is a regression from Maven 1.x where we had this.
2) The web site should propose documentation for the different releases of
the said plugin so that someone who wants to read the doc for v2.1 of the
Clover plugin can.
> Maybe this post can save someones time
Actually it'll make them loose lots of time as what you've mentioned is not
correct and you'll confuse them now and for eternity (as it'll be indexed by
google). Too bad you've now documented it because bad documentation is worse
than no documentation !!!! :-)
All that said, it's possible that there's a bug and that the licenseLocation
doesn't work with v2.2 of the plugin. If that's true please raise it as a
bug in JIRA but in any case it won't be a documentation bug as the
licenseLocation is the defined way to do it...
> Sorry for this post but this has really upset me :(
I can see that... :-)
Thanks
-Vincent
___________________________________________________________________________
D�couvrez un nouveau moyen de poser toutes vos questions quel que soit le sujet !
Yahoo! Questions/R�ponses pour partager vos connaissances, vos opinions et vos exp�riences.
http://fr.answers.yahoo.com
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org