aboutsummaryrefslogtreecommitdiff
path: root/org.jacoco.doc/docroot
diff options
context:
space:
mode:
authorMarc R. Hoffmann <hoffmann@mountainminds.com>2014-07-08 20:59:54 +0200
committerMarc R. Hoffmann <hoffmann@mountainminds.com>2014-07-08 20:59:54 +0200
commit5c23016d5e9afd7f1cff0f80e691dbb6b734e55b (patch)
tree02e320f0324d4c182635adc5a9d4c58103271b60 /org.jacoco.doc/docroot
parentd488b0a4ac03db5b8f6611d7aaf395de7660fe54 (diff)
downloadjacoco-5c23016d5e9afd7f1cff0f80e691dbb6b734e55b.tar.gz
FAQ and dev environment updates.
Diffstat (limited to 'org.jacoco.doc/docroot')
-rw-r--r--org.jacoco.doc/docroot/doc/environment.html41
-rw-r--r--org.jacoco.doc/docroot/doc/faq.html2
2 files changed, 32 insertions, 11 deletions
diff --git a/org.jacoco.doc/docroot/doc/environment.html b/org.jacoco.doc/docroot/doc/environment.html
index f0abe70a..1e6da540 100644
--- a/org.jacoco.doc/docroot/doc/environment.html
+++ b/org.jacoco.doc/docroot/doc/environment.html
@@ -46,25 +46,46 @@
<h3>JRE/JDK</h3>
<p>
- The minimum JRE version to execute JaCoCo is Java 1.5. However to guarantee
- compatibility JaCoCo builds should only be executed against a 1.5 JDK.
+ The minimum JRE version to execute JaCoCo is Java 1.5. To guarantee
+ compatibility JaCoCo builds should always be executed against Java 1.5 JDK. In
+ addition we run builds with 1.6, 1.7 and 1.8 JDKs.
</p>
-<h3>Build System</h3>
+<h3>Build</h3>
<p>
- The build is based on <a href="http://maven.apache.org/">Maven</a>. The
- JaCoCo <a href="build.html">build</a> requires Maven 3.
+ The JaCoCo build is based on <a href="http://maven.apache.org/">Maven 3</a>.
+ We have a <a href="https://jacoco.ci.cloudbees.com/">continuous build</a>
+ which is kindly provided by <a href="http://www.cloudbees.com/">CloudBees</a>.
+ Continuous builds from the master branch are directly published to the
+ <a href="repo.html">snapshot repository</a>.
</p>
-<h3>Source Encoding</h3>
-
<p>
- All source files and HTML documents are encoded in UTF-8 unless an alternative
- encoding is required by the file format specification. For example Java
- property files are always encoded in ISO-8859-1.
+ We do also use
+ <a href="http://nemo.sonarqube.org/dashboard/index/org.jacoco:org.jacoco.build">continuous inspection</a>
+ with <a href="http://www.sonarqube.org/">SonarQube</a>.
</p>
+<h3>Source Rules</h3>
+
+<ul>
+ <li>
+ <b>Encoding:</b> All source files and HTML documents are encoded in UTF-8
+ unless an alternative encoding is required by the file format specification.
+ For example Java property files are always encoded in ISO-8859-1.
+ </li>
+ <li>
+ <b>Formatting:</b> The Eclipse project settings define auto-formatter
+ settings for all Java classes. Make sure you apply the Eclipse formatter to
+ source files before committing.
+ </li>
+ <li>
+ <b>Warnings:</b> The Eclipse project settings define several compiler
+ warnings. JaCoCo projects must not show any Eclipse warnings.
+ </li>
+</ul>
+
<h3>Source Control</h3>
<p>
diff --git a/org.jacoco.doc/docroot/doc/faq.html b/org.jacoco.doc/docroot/doc/faq.html
index 55276bb0..c86244be 100644
--- a/org.jacoco.doc/docroot/doc/faq.html
+++ b/org.jacoco.doc/docroot/doc/faq.html
@@ -31,7 +31,7 @@
<h3>What Java versions are supported by JaCoCo?</h3>
<p>
- JaCoCo supports Java class files from version 1.0 to 1.7. However the minimum
+ JaCoCo supports Java class files from version 1.0 to 1.8. However the minimum
JRE version required by the JaCoCo runtime (e.g. the agent) and the JaCoCo
tools is 1.5. Also note that class files under test from version 1.6 and above
have to contain valid stackmap frames.