From 15c471642eb1eb83fa8d656cd939c7274d32e736 Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Wed, 26 Dec 2018 16:34:58 +0100 Subject: [PATCH] docs: add Gluon v2018.1.4 release notes --- README.md | 2 +- docs/index.rst | 1 + docs/releases/v2018.1.4.rst | 49 +++++++++++++++++++++++++++++++++++ docs/user/getting_started.rst | 4 +-- 4 files changed, 53 insertions(+), 3 deletions(-) create mode 100644 docs/releases/v2018.1.4.rst diff --git a/README.md b/README.md index 147d6dfd..7be4fd1e 100644 --- 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.3 && make update`. +and switch to one by running `git checkout v2018.1.4 && 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 index 12107a9d..68f392ba 100644 --- 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.4 releases/v2018.1.3 releases/v2018.1.2 releases/v2018.1.1 diff --git a/docs/releases/v2018.1.4.rst b/docs/releases/v2018.1.4.rst new file mode 100644 index 00000000..e9597288 --- /dev/null +++ b/docs/releases/v2018.1.4.rst @@ -0,0 +1,49 @@ +Gluon 2018.1.4 +============== + +Bugfixes +~~~~~~~~ + +* Fix regression in autoupdater version comparison function + + Due to a regression in Gluon 2018.1, the autoupdater would incorrectly + consider certain version strings equal and not attempt to upgrade. + In particular, any string and its prefix were considered equal when the + prefix did not end with a digit. For example, the following relations were + not evaluated correctly: + + * ``1.0`` < ``1.0.1`` + * ``1.0~pre`` < ``1.0`` + +* Fix unintended difference between autoupdater version comparison and dpkg/opkg + + Alphanumeric characters were considered less than end-of-string, when the + intended bahaviour (as implemented by dpkg and opkg) is that only ``~`` is + less than end-of-string. This broke relations like the following: + + * ``1.0`` < ``1.0a`` + * ``1.0a`` < ``1.0ab`` + * ``1.0a`` < ``1.0a1`` + + +Known issues +~~~~~~~~~~~~ + +* Default TX power on many Ubiquiti devices is too high, correct offsets are unknown (`#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 `_) + + 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 `_) + + 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 `_) + + 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 index da9ec20b..0a236e54 100644 --- 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.3*. Always get Gluon using git and don't try to download it +e.g. *v2018.1.4*. 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.3*. +version you'd like to checkout, e.g. *v2018.1.4*. ::