docs: update release notes for 3.1.5

LWJGL · Nov 21, 2017 · eb007cc · eb007cc
1 parent f303dee
commit eb007cc
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 37 deletions.
diff --git a/doc/notes/3.1.4.md b/doc/notes/3.1.4.md
@@ -40,4 +40,10 @@ This build includes the following changes:
 - Fixed `MemoryStack` debugging when a try-with-resources block does not inline the call to `AutoCloseable::close`.
     * Supports Java 9 try-with-resources, which generates a synthetic `$closeResource` method.
     * Supports Kotlin's `T.use`, which uses the `kotlin.AutoCloseable::closeFinally` extension function.
-- Fixed build number lookup from the jar manifest.
+- Fixed build number lookup from the jar manifest.
+
+#### Known Issues
+
+- The Maven `3.1.4` build was compiled with a JDK 9 boot classpath, making it incompatible with JDK 8 because of the covariant return types in `java.nio`
+classes, introduced with [JDK-4774077](https://bugs.openjdk.java.net/browse/JDK-4774077).
+    * The website and github binaries have been fixed.
diff --git a/doc/notes/3.1.5.md b/doc/notes/3.1.5.md
@@ -1,6 +1,6 @@
 ### 3.1.5
 
-_Not Released Yet_
+_Released 2017 Nov 22_
 
 This build includes the following changes:
 

diff --git a/doc/notes/README.md b/doc/notes/README.md
@@ -4,7 +4,8 @@
 
 ### Version History
 
-* 2017-11-19 [3.1.4](3.1.4.md) (latest)
+* 2017-11-22 [3.1.5](3.1.5.md) (latest)
+* 2017-11-19 [3.1.4](3.1.4.md)
 * 2017-09-22 [3.1.3](3.1.3.md)
 * 2017-05-15 [3.1.2](3.1.2.md)
 * 2016-12-27 [3.1.1](3.1.1.md)

diff --git a/doc/notes/full.md b/doc/notes/full.md
@@ -1,3 +1,26 @@
+### 3.1.5
+
+_Released 2017 Nov 22_
+
+This build includes the following changes:
+
+#### Bindings
+
+- Added [AMD Tootle](https://github.com/GPUOpen-Tools/amd-tootle) bindings.
+    * Only the software rasterizer is supported.
+
+#### Fixes
+
+- Fixed various javadoc links.
+- par: Parsing of floating point values in L-systems is now locale-insensitive. 
+- stb: Fixed buffer checks to account for row stride, when specified.
+- Generator: Fixed auto-size transformations by non-constant expressions.
+
+#### Breaking Changes
+
+- Removed array overloads from the LZ4 & ODBC bindings.
+    * They were added by mistake in LWJGL `3.1.4`.
+
 ### 3.1.4
 
 _Released 2017 Nov 19_
@@ -42,6 +65,12 @@ This build includes the following changes:
     * Supports Kotlin's `T.use`, which uses the `kotlin.AutoCloseable::closeFinally` extension function.
 - Fixed build number lookup from the jar manifest.
 
+#### Known Issues
+
+- The Maven `3.1.4` build was compiled with a JDK 9 boot classpath, making it incompatible with JDK 8 because of the covariant return types in `java.nio`
+classes, introduced with [JDK-4774077](https://bugs.openjdk.java.net/browse/JDK-4774077).
+    * The website and github binaries have been fixed.
+
 ### 3.1.3
 
 _Released 2017 Sep 22_

diff --git a/doc/notes/latest.md b/doc/notes/latest.md
@@ -1,43 +1,22 @@
-### 3.1.4
+### 3.1.5
 
-_Released 2017 Nov 19_
+_Released 2017 Nov 22_
 
 This build includes the following changes:
 
 #### Bindings
 
-- Added [LZ4](http://lz4.github.io/lz4/) bindings.
-- Added [NanoSVG](https://github.com/memononen/nanosvg) to the existing `NanoVG` bindings.
-- Added [ODBC](https://docs.microsoft.com/en-us/sql/odbc/microsoft-open-database-connectivity-odbc) bindings.
-- Added [Remotery](https://github.com/Celtoys/Remotery) bindings.
-- Added [Zstandard](http://facebook.github.io/zstd/) bindings.
-- bgfx: Updated to API version 55 (up from 48)
-- glfw: Updated to pre-release 3.3.0 version (up from 3.3.0 pre-release):
-    * Support for transparent window framebuffers (`GLFW_TRANSPARENT_FRAMEBUFFER` window hint)
-    * Support for whole window opacity (`glfwGetWindowOpacity` and `glfwSetWindowOpacity`)
-    * Support for content scale queries (`glfwGetMonitorContentScale` and `glfwGetWindowContentScale`)
-    * Linux: Added support for the experimental Wayland backend. Enable with `-Dorg.lwjgl.glfw.libname=glfw_wayland`.
-- LibOVR: Updated to 1.20.0 (up from 1.18.0)
-- Nuklear: Updated to 2.00.4 (up from 2.00.2)
-- tinyfiledialogs: Updated to 3.2.4 (up from 3.0.5)
-- Vulkan: Updated to 1.0.65 (up from 1.0.61)
-- Yoga: Updated to 1.7.0 (up from 1.6.0)
-
-#### Improvements
-
-- Replaced `Automatic-Module-Name` with explicit JPMS modules.
-    * Enables applications using LWJGL to be bundled in custom run-time images with the `jlink` tool.
-- lmdb: Significantly improved incremental growth performance on Windows.
-    * Granularity of mapped memory commits increased from `4KB` (page size) to `2MB`.
-    * This is an unofficial patch of `ITS#8324`.
+- Added [AMD Tootle](https://github.com/GPUOpen-Tools/amd-tootle) bindings.
+    * Only the software rasterizer is supported.
 
 #### Fixes
 
-- EGL: Fixed nullability of `eglMakeCurrent` arguments.
-- OpenVR: Fixed mapping of Vulkan forward declarations.
-- Fixed native library resource discovery when running LWJGL as JPMS modules.
-- Fixed invalid size calculation in `<StructType>.malloc(capacity)` methods.
-- Fixed `MemoryStack` debugging when a try-with-resources block does not inline the call to `AutoCloseable::close`.
-    * Supports Java 9 try-with-resources, which generates a synthetic `$closeResource` method.
-    * Supports Kotlin's `T.use`, which uses the `kotlin.AutoCloseable::closeFinally` extension function.
-- Fixed build number lookup from the jar manifest.
+- Fixed various javadoc links.
+- par: Parsing of floating point values in L-systems is now locale-insensitive. 
+- stb: Fixed buffer checks to account for row stride, when specified.
+- Generator: Fixed auto-size transformations by non-constant expressions.
+
+#### Breaking Changes
+
+- Removed array overloads from the LZ4 & ODBC bindings.
+    * They were added by mistake in LWJGL `3.1.4`.