docs: add v2018.1.1 release notes

ffrgb · Aug 28, 2018 · 1ef4eb4 · 1ef4eb4
1 parent b8c81a4
commit 1ef4eb4
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ the future development of Gluon.
 
 Please refrain from using the `master` branch for anything else but development purposes!
 Use the most recent release instead. You can list all releases by running `git tag`
-and switch to one by running `git checkout v2018.1 && make update`.
+and switch to one by running `git checkout v2018.1.1 && make update`.
 
 If you're using the autoupdater, do not autoupdate nodes with anything but releases.
 If you upgrade using random master commits the nodes *will break* eventually.

diff --git a/docs/index.rst b/docs/index.rst
@@ -70,6 +70,7 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre
    :caption: Releases
    :maxdepth: 1
 
+   releases/v2018.1.1
    releases/v2018.1
    releases/v2017.1.8
    releases/v2017.1.7

diff --git a/docs/releases/v2018.1.1.rst b/docs/releases/v2018.1.1.rst
@@ -0,0 +1,54 @@
+Gluon 2018.1.1
+==============
+
+Bugfixes
+~~~~~~~~
+
+* Fix a bug leading to configuration loss on upgrade under certain circumstances
+  (`#1496 <https://github.com/freifunk-gluon/gluon/issues/1496>`_)
+
+  The issue can only occur when upgrading from 2018.1 and there are multiple
+  mirror entries in *site.conf* (specifically, an early failure for one of the
+  mirrors, e.g. during DNS resolution, followed by a successful upgrade from a
+  different mirror triggers the issue).
+
+  This is a regression in Gluon 2018.1.
+
+* Fix next-node ARP issue
+  (`#1488 <https://github.com/freifunk-gluon/gluon/issues/1488>`_)
+
+  A routing table issue led to ARP requests being sent from the next-node IPv4 address, but with
+  a node-specific source MAC address. This could make the next-node IPv4 address unreachable.
+
+  This is a regression in Gluon 2018.1.
+
+* Fix build on hosts with glibc 2.28
+
+  Fixed by various tool upgrades in LEDE (*bison*, *e2fsutils*, ...)
+
+Other changes
+~~~~~~~~~~~~~
+
+* Linux kernel has been updated to v4.4.148
+
+Known issues
+~~~~~~~~~~~~
+
+* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown (`#94 <https://github.com/freifunk-gluon/gluon/issues/94>`_)
+
+  Reducing the TX power in the Advanced Settings is recommended.
+
+* The MAC address of the WAN interface is modified even when Mesh-on-WAN is disabled (`#496 <https://github.com/freifunk-gluon/gluon/issues/496>`_)
+
+  This may lead to issues in environments where a fixed MAC address is expected (like VMware when promicious mode is disallowed).
+
+* Inconsistent respondd API (`#522 <https://github.com/freifunk-gluon/gluon/issues/522>`_)
+
+  The current API is inconsistent and will be replaced eventually. The old API will still be supported for a while.
+
+* Frequent reboots due to out-of-memory or high load due to memory pressure on weak hardware specially in larger meshes
+  (`#1243 <https://github.com/freifunk-gluon/gluon/issues/1243>`_)
+
+  Optimizations in Gluon 2018.1 have significantly improved memory usage.
+  There are still known bugs leading to unreasonably high load that we hope to
+  solve in future releases.
diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst
@@ -8,7 +8,7 @@ Gluon's releases are managed using `Git tags`_. If you are just getting
 started with Gluon we recommend to use the latest stable release of Gluon.
 
 Take a look at the `list of gluon releases`_ and notice the latest release,
-e.g. *v2018.1*. Always get Gluon using git and don't try to download it
+e.g. *v2018.1.1*. Always get Gluon using git and don't try to download it
 as a Zip archive as the archive will be missing version information.
 
 Please keep in mind that there is no "default Gluon" build; a site configuration
@@ -44,7 +44,7 @@ Building the images
 -------------------
 
 To build Gluon, first check out the repository. Replace *RELEASE* with the
-version you'd like to checkout, e.g. *v2018.1*.
+version you'd like to checkout, e.g. *v2018.1.1*.
 
 ::