commit 1f01f86d34dce89c4a165e0a473585af5ab049f5
author Marc R. Hoffmann <hoffmann@mountainminds.com> Wed Jan 12 21:58:34 2011 +0000
committer Marc R. Hoffmann <hoffmann@mountainminds.com> Wed Jan 12 21:58:34 2011 +0000
tree c0adb11a3214b30173765e7ea2efbc59ffded9c8
parent 5ace6cbc54896c578ee876138a6742f39596674c

Trac #137: Provide example for report filtering, remove pathid reference from examples. 

org.jacoco.doc/docroot/doc/ant.html

diff --git a/org.jacoco.doc/docroot/doc/ant.html b/org.jacoco.doc/docroot/doc/ant.html
index 9ac7ebc..d2328de 100644
--- a/org.jacoco.doc/docroot/doc/ant.html
+++ b/org.jacoco.doc/docroot/doc/ant.html
@@ -423,7 +423,7 @@
 <span class="nr">    6</span>			

 <span class="nr">    7</span>    &lt;structure name="Example Project"&gt;

 <span class="nr">    8</span>        &lt;classfiles&gt;

-<span class="nr">    9</span>            &lt;fileset dir="bin"/&gt;

+<span class="nr">    9</span>            &lt;fileset dir="classes"/&gt;

 <span class="nr">   10</span>        &lt;/classfiles&gt;

 <span class="nr">   11</span>        &lt;sourcefiles encoding="UTF-8"&gt;

 <span class="nr">   12</span>            &lt;fileset dir="src"/&gt;

@@ -470,30 +470,44 @@
 </ul>

 

 <p>

-  The structure can be refined with a hierarchy of <code>group</code> elements.

-  This way the coverage report can reflect different modules of a software

-  project. For each group element the corresponding class and source files can

-  be specified separately. For example, the build script of JaCoCo itself

-  contains the following declaration to separate the different bundles in the

-  report (see the <a href="../coverage/index.html">resulting report</a>): 

+  Note that the <code>classfiles</code> and <code>sourcefiles</code> elements

+  accept any

+  <a href="http://ant.apache.org/manual/Types/resources.html#collection">Ant

+  resource collection</a>. Therefore also filtering the class file set is

+  possible and allows to narrow the scope of the report, for example: 

 </p>

 

 <pre class="source lang-xml">

-<span class="nr">    1</span>&lt;structure name="JaCoCo"&gt;

-<span class="nr">    2</span>    &lt;group name="org.jacoco.core"&gt;

+<span class="nr">    1</span>&lt;classfiles&gt;

+<span class="nr">    2</span>    &lt;fileset dir="classes"&gt;

+<span class="nr">    3</span>        &lt;include name="org/jacoco/examples/important/**/*.class" /&gt;

+<span class="nr">    4</span>    &lt;/fileset&gt;

+<span class="nr">    5</span>&lt;/classfiles&gt;

+</pre>

+

+<p>

+  The structure can be refined with a hierarchy of <code>group</code> elements.

+  This way the coverage report can reflect different modules of a software

+  project. For each group element the corresponding class and source files can

+  be specified separately. For example: 

+</p>

+

+<pre class="source lang-xml">

+<span class="nr">    1</span>&lt;structure name="Example Project"&gt;

+<span class="nr">    2</span>    &lt;group name="Server"&gt;

 <span class="nr">    3</span>        &lt;classfiles&gt;

-<span class="nr">    4</span>            &lt;path refid="bundle-org.jacoco.core"/&gt;

+<span class="nr">    4</span>            &lt;fileset dir="${workspace.dir}/org.jacoco.example.server/classes"/&gt;

 <span class="nr">    5</span>        &lt;/classfiles&gt;

 <span class="nr">    6</span>        &lt;sourcefiles&gt;

-<span class="nr">    7</span>            &lt;fileset dir="${workspace.dir}/org.jacoco.core/src"/&gt;

+<span class="nr">    7</span>            &lt;fileset dir="${workspace.dir}/org.jacoco.example.server/src"/&gt;

 <span class="nr">    8</span>        &lt;/sourcefiles&gt;

 <span class="nr">    9</span>    &lt;/group&gt;

-<span class="nr">   10</span>    &lt;group name="org.jacoco.report"&gt;

+<span class="nr">   10</span>    &lt;group name="Client"&gt;

 <span class="nr">   11</span>        &lt;classfiles&gt;

-<span class="nr">   12</span>            &lt;path refid="bundle-org.jacoco.report"/&gt;

+<span class="nr">   12</span>            &lt;fileset dir="${workspace.dir}/org.jacoco.example.client/classes"/&gt;

 <span class="nr">   13</span>        &lt;/classfiles&gt;

 <span class="nr">   14</span>        &lt;sourcefiles&gt;

-<span class="nr">   15</span>            &lt;fileset dir="${workspace.dir}/org.jacoco.report/src"/&gt;

+<span class="nr">   15</span>            &lt;fileset dir="${workspace.dir}/org.jacoco.example.client/src"/&gt;

 <span class="nr">   16</span>        &lt;/sourcefiles&gt;

 <span class="nr">   17</span>    &lt;/group&gt;

 <span class="nr">   18</span>