maven-plugins/clover/xdocs/dirlayout.xml
2003-01-24 03:44:26 +00:00

55 lines
1.7 KiB
XML

<?xml version="1.0"?>
<document>
<properties>
<author email="vmassol@octo.com">Vincent Massol</author>
<title>Maven Clover Plug-in Directory Layout</title>
</properties>
<body>
<section name="Rationale">
<p>
Having a common directory layout would allow for users familiar
with one Maven project to immediately feel at home in another
Maven project. The advantages are analogous to adopting a
site-wide look-and-feel. Common Maven procedures strengthen the
Maven brand.
</p>
<p>
The next two sections document the directory layout expected by
Maven and the directory layout created by Maven. Please try to
conform to this structure as much as possible; however, if you
must these settings can be overridden via properties as
documented in the <a
href="../../start/integrate.html#Properties">Integration</a> document.
</p>
</section>
<section name="Maven-Generated Layout">
<table>
<tr>
<th>Directory name</th>
<th>Content</th>
<th>Comment</th>
</tr>
<tr>
<td>target/clover</td>
<td>Contains instrumented code and clover database.</td>
<td>
This directory is used by the Clover Plug-in as a placeholder for
the instrumented code and also as the location of the Clover
database.
</td>
</tr>
<tr>
<td>target/docs/clover</td>
<td>Contains generated Clover reports.</td>
<td>
Clover generates its HTML reports in this directory.
</td>
</tr>
</table>
</section>
</body>
</document>