| Marc R. Hoffmann | e571f3f | 2012-05-13 12:18:02 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8" ?> |
| Evgeny Mandrikov | 82a92ca | 2012-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. Hoffmann | e571f3f | 2012-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 Mandrikov | 82a92ca | 2012-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> > |
| 14 | <a href="index.html" class="el_group">Documentation</a> > |
| 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 |
| 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> |
| 32 | JaCoCo development is done with the latest Eclipse version 3.7.x. JaCoCo |
| Marc R. Hoffmann | f2a31b9 | 2012-05-13 19:01:34 +0000 | [diff] [blame^] | 33 | projects are OSGi bundles, therefore the |
| 34 | <a href="http://www.eclipse.org/pde/">PDE</a> feature is required. The JaCoCo |
| 35 | Maven plug-in projects require the |
| 36 | <a href="http://www.eclipse.org/m2e/">M2E</a> for proper dependency resolution. |
| 37 | </p> |
| 38 | |
| 39 | <p> |
| 40 | Project specific Eclipse settings only exist for the following projects. All |
| 41 | other projects and test projects link to these settings: |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 42 | </p> |
| 43 | |
| 44 | <ul> |
| 45 | <li><code>org.jacoco.core</code></li> |
| 46 | <li><code>org.jacoco.core.test</code></li> |
| 47 | </ul> |
| 48 | |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 49 | <h3>JRE/JDK</h3> |
| 50 | |
| 51 | <p> |
| 52 | The minimum JRE version to execute JaCoCo is Java 1.5. However to guarantee |
| 53 | compatibility JaCoCo builds should only be executed against a 1.5 JDK. |
| 54 | </p> |
| 55 | |
| 56 | <h3>Build System</h3> |
| 57 | |
| 58 | <p> |
| 59 | The build is based on <a href="http://maven.apache.org/">Maven</a>. The |
| 60 | JaCoCo <a href="build.html">build</a> requires Maven 3. |
| 61 | </p> |
| 62 | |
| 63 | <h3>Third Party Dependencies</h3> |
| 64 | |
| 65 | <p> |
| 66 | JaCoCo has dependencies to the following third party bundles: |
| 67 | </p> |
| 68 | |
| 69 | <ul> |
| 70 | <li>Apache Ant 1.7.x</li> |
| 71 | <li>JUnit 4</li> |
| 72 | <li>Objectweb ASM 3.3.x</li> |
| 73 | </ul> |
| 74 | |
| 75 | <p> |
| 76 | These bundles are included with the Eclipse 3.7.x PDE feature and are not |
| 77 | part of the JaCoCo source tree. |
| 78 | </p> |
| 79 | |
| Marc R. Hoffmann | f2a31b9 | 2012-05-13 19:01:34 +0000 | [diff] [blame^] | 80 | <h3>Source Encoding</h3> |
| 81 | |
| 82 | <p> |
| 83 | All source files and HTML documents are encoded in UTF-8 unless an alternative |
| 84 | encoding is required by the file format specification. For example Java |
| 85 | property files are always encoded in ISO-8859-1. |
| 86 | </p> |
| 87 | |
| Evgeny Mandrikov | 82a92ca | 2012-01-15 20:25:48 +0000 | [diff] [blame] | 88 | <h3>Source Control</h3> |
| 89 | |
| 90 | <p> |
| 91 | The JaCoCo source code is maintained in a subversion repository at |
| 92 | </p> |
| 93 | |
| 94 | <pre> |
| 95 | https://eclemma.svn.sourceforge.net/svnroot/eclemma/jacoco |
| 96 | </pre> |
| 97 | |
| 98 | <p> |
| 99 | You will find the latest version as several Eclipse projects in the |
| 100 | <code>trunk</code> folder. You might also browse the source code online via our |
| 101 | <a href="http://eclemma.svn.sourceforge.net/viewvc/eclemma/jacoco/">ViewVC</a> |
| 102 | or <a href="https://sourceforge.net/apps/trac/eclemma/browser/jacoco">Trac</a> |
| 103 | web interface. |
| 104 | </p> |
| 105 | |
| 106 | <h3>Planning</h3> |
| 107 | |
| 108 | <p> |
| 109 | A <a href="https://sourceforge.net/apps/trac/eclemma">Trac Instance</a> is |
| 110 | used for milestone planning and task tracking. |
| 111 | </p> |
| 112 | |
| 113 | <h3>Communication</h3> |
| 114 | |
| 115 | <p> |
| 116 | The development team communicates through a mailing list. The list is closed |
| 117 | for non-developers but the archive is |
| 118 | <a href="https://sourceforge.net/mailarchive/forum.php?forum_name=eclemma-jacoco-dev">public</a>. |
| 119 | Please use the <a href="support.html">support channels</a> to get in touch |
| 120 | with the development team. |
| 121 | </p> |
| 122 | |
| 123 | </div> |
| 124 | <div class="footer"> |
| 125 | <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span> |
| 126 | <a href="license.html">Copyright</a> © @copyright.years@ Mountainminds GmbH & Co. KG and Contributors |
| 127 | </div> |
| 128 | |
| 129 | </body> |
| 130 | </html> |