Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / jacoco / bb80b76ee5d25c2eaede2f6dcd2a2f581114ec33 / . / org.jacoco.doc / docroot / doc / environment.html
blob: ab5af6a6e53c7af2dc77e2843d5243d9bb3b7cfd [file] [log] [blame]
Marc R. Hoffmanne571f3f2012-05-13 12:18:02 +0000[diff] [blame]1<?xml version="1.0" encoding="UTF-8" ?>
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]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>
Marc R. Hoffmanne571f3f2012-05-13 12:18:02 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <link rel="stylesheet" href=".resources/doc.css" charset="UTF-8" type="text/css" />
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]7 <link rel="shortcut icon" href=".resources/report.gif" type="image/gif" />
8 <title>JaCoCo - Development Environment</title>
9</head>
10<body>
11
12<div class="breadcrumb">
13 <a href="../index.html" class="el_report">JaCoCo</a> &gt;
14 <a href="index.html" class="el_group">Documentation</a> &gt;
15 <span class="el_source">Development Environment</span>
16</div>
17<div id="content">
18
19<h1>Development Environment</h1>
20
21<p>
22 With this version JaCoCo is hosted at
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame^]23 <a href="https://github.com/jacoco/jacoco">Github</a>. This document provides
24 an overview of the local and shared tools used for JaCoCo development.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]25</p>
26
27<h3>IDE</h3>
28
29<p>
30 JaCoCo development is done with the latest Eclipse version 3.7.x. JaCoCo
Marc R. Hoffmannf2a31b92012-05-13 19:01:34 +0000[diff] [blame]31 projects are OSGi bundles, therefore the
32 <a href="http://www.eclipse.org/pde/">PDE</a> feature is required. The JaCoCo
33 Maven plug-in projects require the
34 <a href="http://www.eclipse.org/m2e/">M2E</a> for proper dependency resolution.
35</p>
36
37<p>
38 Project specific Eclipse settings only exist for the following projects. All
39 other projects and test projects link to these settings:
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]40</p>
41
42<ul>
43 <li><code>org.jacoco.core</code></li>
44 <li><code>org.jacoco.core.test</code></li>
45</ul>
46
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]47<h3>JRE/JDK</h3>
48
49<p>
50 The minimum JRE version to execute JaCoCo is Java 1.5. However to guarantee
51 compatibility JaCoCo builds should only be executed against a 1.5 JDK.
52</p>
53
54<h3>Build System</h3>
55
56<p>
57 The build is based on <a href="http://maven.apache.org/">Maven</a>. The
58 JaCoCo <a href="build.html">build</a> requires Maven 3.
59</p>
60
61<h3>Third Party Dependencies</h3>
62
63<p>
64 JaCoCo has dependencies to the following third party bundles:
65</p>
66
67<ul>
68 <li>Apache Ant 1.7.x</li>
69 <li>JUnit 4</li>
70 <li>Objectweb ASM 3.3.x</li>
71</ul>
72
73<p>
74 These bundles are included with the Eclipse 3.7.x PDE feature and are not
75 part of the JaCoCo source tree.
76</p>
77
Marc R. Hoffmannf2a31b92012-05-13 19:01:34 +0000[diff] [blame]78<h3>Source Encoding</h3>
79
80<p>
81 All source files and HTML documents are encoded in UTF-8 unless an alternative
82 encoding is required by the file format specification. For example Java
83 property files are always encoded in ISO-8859-1.
84</p>
85
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]86<h3>Source Control</h3>
87
88<p>
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame^]89 The JaCoCo source code is maintained in a Git repository at
90 <a href="https://github.com/jacoco/jacoco">Github</a> and can be cloned from
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]91</p>
92
93<pre>
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame^]94 https://github.com/jacoco/jacoco.git
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]95</pre>
96
97<p>
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame^]98 The source tree is organized as a plain list of Eclipse projects that can be
99 imported in a Eclipse workspace.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]100</p>
101
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame^]102<h3>Issue Tracking</h3>
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]103
104<p>
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame^]105 This Github <a href="https://github.com/jacoco/jacoco/issues">issue tracker</a>
106 is for bug and enhancement tracking.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]107</p>
108
109<h3>Communication</h3>
110
111<p>
112 The development team communicates through a mailing list. The list is closed
113 for non-developers but the archive is
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame^]114 <a href="https://groups.google.com/d/forum/jacoco-dev">public</a>.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]115 Please use the <a href="support.html">support channels</a> to get in touch
116 with the development team.
117</p>
118
119</div>
120<div class="footer">
121 <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
122 <a href="license.html">Copyright</a> &copy; @copyright.years@ Mountainminds GmbH &amp; Co. KG and Contributors
123</div>
124
125</body>
126</html>