blob: 2334e0ee11494089005c7d08765f0e8b35902bf4 [file] [log] [blame]
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +00001<?xml version="1.0" encoding="ISO-8859-1" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
4<head>
5 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
6 <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
Marc R. Hoffmannd7d2f752010-05-06 21:12:31 +00007 <link rel="shortcut icon" href=".resources/report.gif" type="image/gif" />
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +00008 <title>JaCoCo - Development Environment</title>
9</head>
10<body>
11
12<div class="breadcrumb">
Marc R. Hoffmannd7d2f752010-05-06 21:12:31 +000013 <a href="../index.html" class="el_report">JaCoCo</a> &gt;
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +000014 <a href="index.html" class="el_group">Documentation</a> &gt;
15 <span class="el_source">Development Environment</span>
16</div>
Marc R. Hoffmann17be2692010-02-02 05:44:47 +000017<div id="content">
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +000018
19<h1>Development Environment</h1>
20
21<p>
22 With this version JaCoCo is hosted at
23 <a href="http://www.sourceforge.net/">SourceForge</a> as part of the
24 <a href="http://www.sourceforge.net/projects/eclemma">EclEmma project</a>.
25 This document provides an overview of the local and shared tools used for
26 JaCoCo development.
27</p>
28
29<h3>IDE</h3>
30
31<p>
Marc R. Hoffmannabfa65d2012-01-12 19:52:58 +000032 JaCoCo development is done with the latest Eclipse version 3.7.x. JaCoCo
Marc R. Hoffmann776ffee2011-03-10 18:40:10 +000033 projects are OSGi bundles, therefore the PDE feature is required. Project
34 specific Eclipse settings exist for the projects
35</p>
36
37<ul>
38 <li><code>org.jacoco.core</code></li>
39 <li><code>org.jacoco.core.test</code></li>
40</ul>
41
42<p>
43 All other projects and test projects link to these settings.
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +000044</p>
45
Marc R. Hoffmann0c25a7e2009-10-13 17:56:00 +000046<h3>JRE/JDK</h3>
47
48<p>
49 The minimum JRE version to execute JaCoCo is Java 1.5. However to guarantee
Marc R. Hoffmannabfa65d2012-01-12 19:52:58 +000050 compatibility JaCoCo builds should only be executed against a 1.5 JDK.
51</p>
52
53<h3>Build System</h3>
54
55<p>
56 The build is based on <a href="http://maven.apache.org/">Maven</a>. The
57 JaCoCo <a href="build.html">build</a> requires Maven 3.
Marc R. Hoffmann0c25a7e2009-10-13 17:56:00 +000058</p>
59
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +000060<h3>Third Party Dependencies</h3>
61
62<p>
Marc R. Hoffmannadcf1432010-06-23 06:40:16 +000063 JaCoCo has dependencies to the following third party bundles:
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +000064</p>
65
66<ul>
Marc R. Hoffmannadcf1432010-06-23 06:40:16 +000067 <li>Apache Ant 1.7.x</li>
68 <li>JUnit 4</li>
Marc R. Hoffmannabfa65d2012-01-12 19:52:58 +000069 <li>Objectweb ASM 3.3.x</li>
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +000070</ul>
71
Marc R. Hoffmannadcf1432010-06-23 06:40:16 +000072<p>
Marc R. Hoffmannabfa65d2012-01-12 19:52:58 +000073 These bundles are included with the Eclipse 3.7.x PDE feature and are not
74 part of the JaCoCo source tree.
Marc R. Hoffmannadcf1432010-06-23 06:40:16 +000075</p>
76
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +000077<h3>Source Control</h3>
78
79<p>
80 The JaCoCo source code is maintained in a subversion repository at
Marc R. Hoffmann5daa8262009-10-13 19:35:45 +000081</p>
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +000082
83<pre>
84 https://eclemma.svn.sourceforge.net/svnroot/eclemma/jacoco
85</pre>
86
87<p>
88 You will find the latest version as several Eclipse projects in the
89 <code>trunk</code> folder. You might also browse the source code online via our
90 <a href="http://eclemma.svn.sourceforge.net/viewvc/eclemma/jacoco/">ViewVC</a>
91 or <a href="https://sourceforge.net/apps/trac/eclemma/browser/jacoco">Trac</a>
92 web interface.
93</p>
94
95<h3>Planning</h3>
96
97<p>
98 A <a href="https://sourceforge.net/apps/trac/eclemma">Trac Instance</a> is
99 used for milestone planning and task tracking.
100</p>
101
102<h3>Communication</h3>
103
104<p>
105 The development team communicates through a mailing list. The list is closed
106 for non-developers but the archive is
107 <a href="https://sourceforge.net/mailarchive/forum.php?forum_name=eclemma-jacoco-dev">public</a>.
108 Please use the <a href="support.html">support channels</a> to get in touch
109 with the development team.
110</p>
111
Marc R. Hoffmann17be2692010-02-02 05:44:47 +0000112</div>
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +0000113<div class="footer">
Marc R. Hoffmannb623ffb2010-05-06 19:48:08 +0000114 <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
Marc R. Hoffmanndf6ff962010-04-09 15:31:22 +0000115 <a href="license.html">Copyright</a> &copy; @copyright.years@ Mountainminds GmbH &amp; Co. KG and Contributors
Marc R. Hoffmann45ff60e2009-10-09 09:28:30 +0000116</div>
117
118</body>
119</html>