You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Dave Sag (JIRA)" <ji...@codehaus.org> on 2006/02/28 14:42:35 UTC

[jira] Created: (MPMD-19) upadte PMD plugin docs

upadte PMD plugin docs
----------------------

         Key: MPMD-19
         URL: http://jira.codehaus.org/browse/MPMD-19
     Project: Maven 2.x Pmd Plugin
        Type: Improvement

    Versions: 2.0-alpha-2    
 Environment: docs
    Reporter: Dave Sag


The docs for the PMD plugin are lacking.

see http://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html

could you list html as the default in the default column of the format row, and fill out the rest of the docs please


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MPMD-19) upadte PMD plugin docs

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MPMD-19?page=comments#action_59667 ] 

Brett Porter commented on MPMD-19:
----------------------------------

since you have estimated this will only take 10 minutes, perhaps you'd be able to supply a patch?

> upadte PMD plugin docs
> ----------------------
>
>          Key: MPMD-19
>          URL: http://jira.codehaus.org/browse/MPMD-19
>      Project: Maven 2.x Pmd Plugin
>         Type: Improvement

>     Versions: 2.0-alpha-2
>  Environment: docs
>     Reporter: Dave Sag

>
> Original Estimate: 10 minutes
>         Remaining: 10 minutes
>
> The docs for the PMD plugin are lacking.
> see http://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html
> could you list html as the default in the default column of the format row, and fill out the rest of the docs please

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MPMD-19) Update PMD plugin docs

Posted by "Dave Sag (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MPMD-19?page=comments#action_59678 ] 

Dave Sag commented on MPMD-19:
------------------------------

looking closer at that 'how to' page I can see how to generate a report within the 'site' phase but i can't see anything about generating the xml in the build phase.

i need the xml before the verify phase as qalab takes the xml as an input.  currently we are using our own custom hacked together pmd plugin to do this but i;d rather use the real one.

not having access to the src here, perhaps you could tell me, can i configure the pmd mojo to run in the build phase and generate the xml - how do i specify what the xml file will be called, and where it will go?

if i generate the xml in the build phase does PMD have to run again in the site phase to get me the html report  integrated into my site, or will it just use the data from the xml output?

cheers dave


> Update PMD plugin docs
> ----------------------
>
>          Key: MPMD-19
>          URL: http://jira.codehaus.org/browse/MPMD-19
>      Project: Maven 2.x Pmd Plugin
>         Type: Improvement

>     Versions: 2.0-alpha-2
>  Environment: docs
>     Reporter: Dave Sag

>
> Original Estimate: 10 minutes
>         Remaining: 10 minutes
>
> The docs for the PMD plugin are lacking.
> see http://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html
> could you list html as the default in the default column of the format row, and fill out the rest of the docs please

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MPMD-19) Update PMD plugin docs

Posted by "Mike Perham (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MPMD-19?page=all ]

Mike Perham updated MPMD-19:
----------------------------

    Summary: Update PMD plugin docs  (was: upadte PMD plugin docs)

Did you see the howto page?  Does this not cover your needs?

http://maven.apache.org/plugins/maven-pmd-plugin/howto.html

> Update PMD plugin docs
> ----------------------
>
>          Key: MPMD-19
>          URL: http://jira.codehaus.org/browse/MPMD-19
>      Project: Maven 2.x Pmd Plugin
>         Type: Improvement

>     Versions: 2.0-alpha-2
>  Environment: docs
>     Reporter: Dave Sag

>
> Original Estimate: 10 minutes
>         Remaining: 10 minutes
>
> The docs for the PMD plugin are lacking.
> see http://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html
> could you list html as the default in the default column of the format row, and fill out the rest of the docs please

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MPMD-19) upadte PMD plugin docs

Posted by "Dave Sag (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MPMD-19?page=comments#action_59662 ] 

Dave Sag commented on MPMD-19:
------------------------------

also there is no documentation at all for this mojo on the how to apply different rulesets.

> upadte PMD plugin docs
> ----------------------
>
>          Key: MPMD-19
>          URL: http://jira.codehaus.org/browse/MPMD-19
>      Project: Maven 2.x Pmd Plugin
>         Type: Improvement

>     Versions: 2.0-alpha-2
>  Environment: docs
>     Reporter: Dave Sag

>
> Original Estimate: 10 minutes
>         Remaining: 10 minutes
>
> The docs for the PMD plugin are lacking.
> see http://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html
> could you list html as the default in the default column of the format row, and fill out the rest of the docs please

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MPMD-19) upadte PMD plugin docs

Posted by "Dave Sag (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MPMD-19?page=comments#action_59664 ] 

Dave Sag commented on MPMD-19:
------------------------------

maybe this could be addressed as part of this issue: http://jira.codehaus.org/browse/MNGBOOK-82

> upadte PMD plugin docs
> ----------------------
>
>          Key: MPMD-19
>          URL: http://jira.codehaus.org/browse/MPMD-19
>      Project: Maven 2.x Pmd Plugin
>         Type: Improvement

>     Versions: 2.0-alpha-2
>  Environment: docs
>     Reporter: Dave Sag

>
> Original Estimate: 10 minutes
>         Remaining: 10 minutes
>
> The docs for the PMD plugin are lacking.
> see http://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html
> could you list html as the default in the default column of the format row, and fill out the rest of the docs please

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MPMD-19) Update PMD plugin docs

Posted by "Dave Sag (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MPMD-19?page=comments#action_59675 ] 

Dave Sag commented on MPMD-19:
------------------------------

hey brett - my 10mts estimate was for someone who actually knew what the docs should say.  i figure whoever wrote it would be able to add those docs in a few minutes.  unfortunately i can't check out from svn while at work, and i also am not familiar enough with the src to know what the options mean - that's why i was looking for docs.

mike - no i hadn't seen that page before.  it looks useful, but does not remove the need to tidy up the documentation of the mojo fields i'd say.  eg for the uninitiated - i had no idea what the cpd goal did vs the pmd goal. (i knmow now but a short intro paragraph (lifted from the src anyway) would be useful.

more generally what is missing from the plugin docs as well is what the version, artifact and group ids are.  i usually find myself wading through ibiblio to work out what the correct details are when first adding a new plugin to my pom.xml


> Update PMD plugin docs
> ----------------------
>
>          Key: MPMD-19
>          URL: http://jira.codehaus.org/browse/MPMD-19
>      Project: Maven 2.x Pmd Plugin
>         Type: Improvement

>     Versions: 2.0-alpha-2
>  Environment: docs
>     Reporter: Dave Sag

>
> Original Estimate: 10 minutes
>         Remaining: 10 minutes
>
> The docs for the PMD plugin are lacking.
> see http://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html
> could you list html as the default in the default column of the format row, and fill out the rest of the docs please

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org