You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by bw...@apache.org on 2003/08/30 03:01:24 UTC

cvs commit: maven/src/plugins-build/findbugs/src/plugin-resources findbugs.xml

bwalding    2003/08/29 18:01:24

  Modified:    src/plugins-build/findbugs plugin.jelly
  Added:       src/plugins-build/findbugs/src/plugin-resources findbugs.xml
  Log:
  Switched to a text format until FindBugs xml output is more usable.
  
  Revision  Changes    Path
  1.3       +53 -2     maven/src/plugins-build/findbugs/plugin.jelly
  
  Index: plugin.jelly
  ===================================================================
  RCS file: /home/cvs/maven/src/plugins-build/findbugs/plugin.jelly,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- plugin.jelly	29 Aug 2003 23:15:15 -0000	1.2
  +++ plugin.jelly	30 Aug 2003 01:01:24 -0000	1.3
  @@ -22,7 +22,7 @@
     	<findbugs home="${maven.build.dir}/findbugshome"
                 output="text"
                 debug="false"
  -              outputFile="${maven.build.dir}/findbugs.xml">
  +              outputFile="${maven.build.dir}/findbugs-raw-report.txt">
         <sourcePath path="${pom.build.sourceDirectory}"/>
         <class location="${maven.build.dest}"/>
               
  @@ -31,8 +31,59 @@
         </j:forEach>
                 
       </findbugs>
  +    
  +    <!--doc:jsl
  +        input="${maven.build.dir}/findbugs-raw-report.xml"
  +        output="findbugs.xml"
  +        stylesheet="${plugin.resources}/findbugs.jsl"
  +        encoding="${maven.docs.outputencoding}"
  +        outputMode="xml"
  +        prettyPrint="true"/-->
  +        
  +    <j:set var="genDocs" 
  +        value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('maven.gen.docs')}"/>
  +        
  +    <doc:text-xdoc
  +      preamble="
  +            The following document contains the results of
  +            FindBugs - http://www.cs.umd.edu/~pugh/java/bugs/.
  +
  +            This isn't formatted like a pretty CheckStyle / JDepend sheet as the FindBugs XML
  +            output is very terse and does not describe what each error type is.  We have no desire
  +            to hardcode messages against FindBugs, so we'll wait until FindBugs XML output can be modified
  +            to produce easy to use messages.
  +			   "
  +      title="FindBugs Report"
  +      section="FindBugs Results"
  +      output="${genDocs}/findbugs.xml"
  +      inputFile="${maven.build.dir}/findbugs-raw-report.txt"/>
     
     </goal>
  -        
  +  
  +  <!--
  +     ========================================================================
  +       Register the FindBugs report to the "site" plugin.
  +     ========================================================================
  +  -->
  +  <goal name="maven-findbugs-plugin:register">
  +    <j:if test="${sourcesPresent == 'true'}">
  +      <doc:registerReport 
  +        name="FindBugs" 
  +        pluginName="maven-findbugs-plugin"
  +        link="findbugs"
  +        description="Report on bug patterns found in compiled code."/>
  +    </j:if>
  +  </goal>
  +  
  +  <!--
  +     ========================================================================
  +       Deregister the FindBugs report from the "site" plugin.
  +     ========================================================================
  +  -->
  +  <goal name="maven-findbugs-plugin:deregister">
  +    <j:if test="${sourcesPresent == 'true'}">
  +      <doc:deregisterReport name="FindBugs"/>
  +    </j:if>
  +  </goal>
   
   </project>
  
  
  
  1.1                  maven/src/plugins-build/findbugs/src/plugin-resources/findbugs.xml
  
  Index: findbugs.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <title>FindBugs</title>
    </properties>
  
    <body>
  	<section name="FindBugs">
            <p>
              The following document contains the results of
              <a href="http://www.cs.umd.edu/~pugh/java/bugs/">FindBugs</a>.
            </p>
  		  <p>
              This isn't formatted like a pretty CheckStyle / JDepend sheet as the FindBugs XML
              output is very terse and does not describe what each error type is.  We have no desire
              to hardcode messages against FindBugs, so we'll wait until FindBugs XML output can be modified
              to produce easy to use messages.
            </p>
      </section>
  
      <section name="Results">
      <source><![CDATA[
      ${licenseText}
      ]]></source>
      </section>
    </body>
  </document>
  
  
  

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