Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / jacoco / d488b0a4ac03db5b8f6611d7aaf395de7660fe54 / . / org.jacoco.doc / docroot / doc / environment.html
blob: f0abe70a456906fa9a6f749ac21dfd5a43a129c6 [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>
Marc R. Hoffmann17e9aa12012-08-31 20:48:56 +0200[diff] [blame]22 JaCoCo is currently hosted at
23 <a href="https://github.com/jacoco/jacoco">GitHub</a>. This document provides
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame]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>
Marc R. Hoffmannae311b92014-05-01 07:07:10 +0200[diff] [blame]30 JaCoCo development is done with the latest version of
31 <a href="http://www.eclipse.org/">Eclipse</a>. Please make sure to install
32 the <a href="http://www.eclipse.org/m2e/">m2e plug-in</a> to get all
33 dependencies resolved properly.
Marc R. Hoffmannf2a31b92012-05-13 19:01:34 +0000[diff] [blame]34</p>
35
36<p>
37 Project specific Eclipse settings only exist for the following projects. All
38 other projects and test projects link to these settings:
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]39</p>
40
41<ul>
42 <li><code>org.jacoco.core</code></li>
43 <li><code>org.jacoco.core.test</code></li>
44</ul>
45
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]46<h3>JRE/JDK</h3>
47
48<p>
49 The minimum JRE version to execute JaCoCo is Java 1.5. However to guarantee
50 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.
58</p>
59
Marc R. Hoffmannf2a31b92012-05-13 19:01:34 +0000[diff] [blame]60<h3>Source Encoding</h3>
61
62<p>
63 All source files and HTML documents are encoded in UTF-8 unless an alternative
64 encoding is required by the file format specification. For example Java
65 property files are always encoded in ISO-8859-1.
66</p>
67
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]68<h3>Source Control</h3>
69
70<p>
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame]71 The JaCoCo source code is maintained in a Git repository at
Marc R. Hoffmann17e9aa12012-08-31 20:48:56 +0200[diff] [blame]72 <a href="https://github.com/jacoco/jacoco">GitHub</a> and can be cloned from
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]73</p>
74
75<pre>
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame]76 https://github.com/jacoco/jacoco.git
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]77</pre>
78
79<p>
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame]80 The source tree is organized as a plain list of Eclipse projects that can be
81 imported in a Eclipse workspace.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]82</p>
83
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame]84<h3>Issue Tracking</h3>
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]85
86<p>
Marc R. Hoffmann17e9aa12012-08-31 20:48:56 +0200[diff] [blame]87 This GitHub <a href="https://github.com/jacoco/jacoco/issues">issue tracker</a>
88 is used for bug and enhancement tracking.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]89</p>
90
91<h3>Communication</h3>
92
93<p>
94 The development team communicates through a mailing list. The list is closed
95 for non-developers but the archive is
Marc R. Hoffmannbb80b762012-08-29 23:57:58 +0200[diff] [blame]96 <a href="https://groups.google.com/d/forum/jacoco-dev">public</a>.
Evgeny Mandrikov82a92ca2012-01-15 20:25:48 +0000[diff] [blame]97 Please use the <a href="support.html">support channels</a> to get in touch
98 with the development team.
99</p>
100
101</div>
102<div class="footer">
103 <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
104 <a href="license.html">Copyright</a> &copy; @copyright.years@ Mountainminds GmbH &amp; Co. KG and Contributors
105</div>
106
107</body>
108</html>