Skip to content

Commit 122cd33

Browse files
committed
Update documentation
1 parent 7f2087e commit 122cd33

File tree

3 files changed

+27
-15
lines changed

3 files changed

+27
-15
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11

22
## ThreeTen backport project
3-
JSR-310 provides a new date and time library for JDK 8.
4-
This project is the backport to JDK 7.
3+
JSR-310 provides a new date and time library for Java SE 8.
4+
This project is the backport to Java SE 7.
55

66
The backport is NOT an implementation of JSR-310, as that would require
77
jumping through lots of unnecessary hoops.
88
Instead, this is a simple backport intended to allow users to quickly
9-
use the JSR-310 API on JDK 7.
9+
use the JSR-310 API on Java SE 7.
1010
The backport should be referred to using the "ThreeTen" name.
1111

1212
Active development on JSR-310 is at [OpenJDK](http://openjdk.java.net/):
@@ -16,7 +16,7 @@ That repository used the same BSD 3-clause license as this repository.
1616

1717
Issues should be reported here at GitHub.
1818
Pull requests and issues will only be considered so far as matching the behaviour
19-
of the real JDK 8. Additional requested features will be rejected.
19+
of the real Java SE 8. Additional requested features will be rejected.
2020

2121
#### Building
2222
This project builds using maven.
@@ -30,12 +30,12 @@ Pull requests with later versions of the dat file will be accepted.
3030

3131
#### FAQs
3232

33-
1. What version of JDK 8 does this project map to?
34-
This project currently maps to the M7 milestone.
33+
1. What version of Java SE 8 does this project map to?
34+
This project currently maps to the expected contents of release Java SE 8u20.
3535

3636
2. Will the backport be kept up to date?
37-
There will be a release matching the final JDK 8 version.
38-
There may or may not be further updates between now and then.
37+
There are no plans for further releases.
38+
However if bugs are found, or pull requests received then a release may occur.
3939

4040
3. Is this project derived from OpenJDK?
4141
No. This project is derived from the Reference Implementation previously hosted on GitHub.

RELEASE-NOTES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
ThreeTen backport project release notes
22
=======================================
33

4-
This release corresponds to the OpenJDK M7 milestone
4+
This release of the backport corresponds to Java SE 8u20.

src/site/xdoc/index.xml

+18-6
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111

1212
<section name="ThreeTen Backport">
1313
<p>
14-
ThreeTen-Backport provides a backport of the JDK 8 date-time classes to JDK 7.
14+
ThreeTen-Backport provides a backport of the Java SE 8 date-time classes to Java SE 7.
1515
</p>
1616
<p>
1717
The backport is NOT an implementation of JSR-310, as that would require
1818
jumping through lots of unnecessary hoops.
1919
Instead, this is a simple backport intended to allow users to quickly
20-
use the JSR-310 API on JDK 7.
20+
use the JSR-310 API on Java SE 7.
2121
The backport should be referred to using the "ThreeTen" name.
2222
</p>
2323
<p>
@@ -34,18 +34,30 @@ Various documentation is available:
3434
<li>The <a href="https://github.com/ThreeTen/threetenbp">GitHub</a> source repository</li>
3535
</ul>
3636
</p>
37+
<p>
38+
It should be noted that the API matches that of Java SE 8 except where that is not viable.
39+
Java SE 8 has default and static methods on interfaces which is simulated in the backport
40+
by using an abstract class rather than an interface.
41+
In addition, static query constants are used to simulate method references, for example
42+
use <code>LocalDate.FROM</code> rather than <code>LocalDate::from</code>.
43+
</p>
3744
</section>
3845

3946

4047
<section name="Releases">
4148
<p>
4249
There are no full releases yet!
4350
Release 0.8.1 is the current development release intended for feedback.
44-
The code is fully tested, but there may yet be bugs and the API may yet change.
45-
There should be no great reason why it cannot be used in production if you can cope with future API change.
51+
There should be no great reason why it cannot be used in production at this point.
52+
</p>
53+
<p>
54+
The project runs on Java SE 7 and has no dependencies.
4655
</p>
4756
<p>
48-
The project runs on JDK 8 and has no dependencies.
57+
There are some known issues.
58+
The Hijrah calendar system does not work.
59+
Formatting and parsing often depends on data only available in Java SE 8.
60+
Zone id and text parsing is significantly less powerful.
4961
</p>
5062
<p>
5163
Available in <a href="http://search.maven.org/#artifactdetails|org.threeten|threetenbp|0.8.1|jar">Maven Central</a>.
@@ -62,7 +74,7 @@ To suggest enhancements or contribute, please <a href="https://github.com/ThreeT
6274
Alternatively, use GitHub <a href="https://github.com/ThreeTen/threetenbp/issues">issues</a>.
6375
</p>
6476
<p>
65-
Note that pull requests and issues will only be considered so far as matching the behaviour of JDK 8.
77+
Note that pull requests and issues will only be considered so far as matching the behaviour of Java SE 8.
6678
Additional requested features will be rejected.
6779
</p>
6880
<p>

0 commit comments

Comments
 (0)