[jboss-cvs] JBossAS SVN: r94034 - in projects/jboss-jca/trunk/doc: userguide/en/modules and 1 other directory.

[jboss-cvs-commits at lists.jboss.org]

Author: jesper.pedersen
Date: 2009-09-25 16:06:30 -0400 (Fri, 25 Sep 2009)
New Revision: 94034

Modified:
   projects/jboss-jca/trunk/doc/developerguide/en/modules/testing.xml
   projects/jboss-jca/trunk/doc/userguide/en/modules/troubleshooting.xml
Log:
Minor documentation updates about testing

Modified: projects/jboss-jca/trunk/doc/developerguide/en/modules/testing.xml
===================================================================
--- projects/jboss-jca/trunk/doc/developerguide/en/modules/testing.xml	2009-09-25 19:57:37 UTC (rev 94033)
+++ projects/jboss-jca/trunk/doc/developerguide/en/modules/testing.xml	2009-09-25 20:06:30 UTC (rev 94034)
@@ -97,10 +97,21 @@
 
       <para>This allows for easier readability and a consistent feel of the project.</para>
 
+      <para>The goal is to have zero errors in the report. The checkstyle report is generated
+        using</para>
+
+      <programlisting>
+ant checkstyle
+      </programlisting>
+
+      <para>The report is generated into</para>
+
+      <programlisting>
+reports/checkstyle
+      </programlisting>
+
       <para>The home of checkstyle is located here: <ulink url="http://checkstyle.sourceforge.net/"/>.</para>
 
-      <para>The goal is to have zero errors in the report.</para>
-
     </section>
 
     <section id="findbugs">
@@ -110,10 +121,21 @@
 
       <para>This tool helps lower of the number of bugs found in the JBoss JCA project.</para>
 
+      <para>The goal is to have zero errors in the report and as few exclusions in the filter as possible.
+        The findbugs report is generated using</para>
+
+      <programlisting>
+ant findbugs
+      </programlisting>
+
+      <para>The report is generated into</para>
+
+      <programlisting>
+reports/findbugs
+      </programlisting>
+
       <para>The home of findbugs is located here: <ulink url="http://findbugs.sourceforge.net/"/>.</para>
 
-      <para>The goal is to have zero errors in the report and as few exclusions in the filter as possible.</para>
-
     </section>
 
     <section id="cobertura">
@@ -123,10 +145,21 @@
 
       <para>The reports that the tool provides makes sure that the JBoss JCA project has the correct test coverage.</para>
 
+      <para>The goal is to have as high code coverage as possible in all areas. The Cobertura report is
+        generated using</para>
+
+      <programlisting>
+ant cobertura
+      </programlisting>
+
+      <para>The report is generated into</para>
+
+      <programlisting>
+reports/cobertura
+      </programlisting>
+
       <para>The home of Cobertura is located here: <ulink url="http://cobertura.sourceforge.net/"/>.</para>
 
-      <para>The goal is to have as high code coverage as possible in all areas.</para>
-
     </section>
 
   </section>

Modified: projects/jboss-jca/trunk/doc/userguide/en/modules/troubleshooting.xml
===================================================================
--- projects/jboss-jca/trunk/doc/userguide/en/modules/troubleshooting.xml	2009-09-25 19:57:37 UTC (rev 94033)
+++ projects/jboss-jca/trunk/doc/userguide/en/modules/troubleshooting.xml	2009-09-25 20:06:30 UTC (rev 94034)
@@ -20,7 +20,7 @@
 
       <para>There are a couple of steps to get a feature included</para>
 
-      <para>First, you should create a new thread in our development forum where you describe the feature and its design and
+      <para>First, you should create a new thread in our development forum where you describe the feature, its design and
         implementation.</para>
 
       <para>Once there is an agreement on the feature and the design you should proceed with creating the patch.</para>
@@ -52,7 +52,7 @@
         </listitem>
       </orderedlist>
 
-      <para>Then done, create a JIRA task (Patch) in our JIRA environment. See the developer guide for
+      <para>when done, create a JIRA task (Patch) in our JIRA environment. See the developer guide for
         additional details.</para>
 
       <para>Happy Coding !</para>