Merge pull request #83 from bxparks/develop

merge v1.8.2 into master

Author: bxparks

CHANGELOG.md

@@ -1,9 +1,15 @@
 # Changelog
 
 * Unreleased
+* 1.8.2 (2021-10-28, TZDB 2021e)
+    * Update to TZDB 2021e.
+        * https://mm.icann.org/pipermail/tz-announce/2021-October/000069.html
+        * Palestine will fall back 10-29 (not 10-30) at 01:00.
 * 1.8.1 (2021-10-18, TZDB 2021d)
     * Add `make -C examples/MemoryBenchmark epoxy` to GitHub actions.
     * Upgrade to TZDB 2021d.
+        * https://mm.icann.org/pipermail/tz-announce/2021-October/000068.html
+        * Fiji suspends DST for the 2021/2022 season.
 * 1.8.0 (2021-10-15, TZDB 2021c)
     * **Breaking Change**: Move clock classes under `ace_time::clock` and
       implementation classes under `ace_time::hw` to the new

DEVELOPER.md

@@ -574,6 +574,12 @@ available.
         * `$ make`
         * `$ ./ExtendedHinnantDateTest.out | grep failed`
         * There should be no failures.
+* Update the zoneinfo files for AceTimePython (needed by BasicAcetzTest and
+  ExtendedAcetzTest):
+    * ``zonedbpy`
+        * `$ cd AceTimePython/src/acetime/zonedbpy`
+        * Edit the `Makefile` and update the `TZ_VERSION`.
+        * `$ make`
 * Verify that the `AceTime` library and the `AceTimePython` library agree with
   each other using the same TZDB version. This requires going into the
   [AceTimeValidation](https://github.com/bxparks/AceTimeValidation) project.
@@ -602,11 +608,6 @@ available.
         * `$ cd src/ace_time/zonedbx`
         * Edit the `Makefile` and update the `TZ_VERSION`.
         * `$ make`
-* Update the zoneinfo files for AceTimePython:
-    * ``zonedbpy`
-        * `$ cd AceTimePython/src/acetime/zonedbpy`
-        * Edit the `Makefile` and update the `TZ_VERSION`.
-        * `$ make`
 * Update CHANGELOGs
     * AceTime/CHANGELOG.md
     * AceTimePython/CHANGELOG.md
@@ -649,17 +650,17 @@ tests will fail until the underlying timezone database of the OS is updated.
     * Go to https://github.com/bxparks/AceTime.
     * Create a Pull Request from `develop` to `master`.
     * Approve and merge the PR.
-* Create a new Release of AceTime.
-    * Go to https://github.com/bxparks/AceTime
+* Create a new Release of AceTimePython.
+    * Go to https://github.com/bxparks/AceTimePython
     * Click on "Releases"
     * Click on "Draft a new release"
     * Enter a tag version (e.g. `v1.2`), targeting the `master` branch.
     * Enter the release title.
     * Enter the release notes. I normally just copy and paste the latest changes
       from `CHANGELOG.md`.
     * Click Publish release.
-* Create a new Release of AceTimePython.
-    * Go to https://github.com/bxparks/AceTimePython
+* Create a new Release of AceTime.
+    * Go to https://github.com/bxparks/AceTime
     * Click on "Releases"
     * Click on "Draft a new release"
     * Enter a tag version (e.g. `v1.2`), targeting the `master` branch.

MIGRATING.md

@@ -19,14 +19,14 @@ Three breaking changes were made from v1.7.5 to v1.8.0:
 2) The `DS3231Clock` class was converted into a template class to replace a
    direct dependency to the I2C `<Wire.h>` library with an indirect dependency
    to the [AceWire](https://github.com/bxparks/AceWire) library. This reduces
-   the flash memory consumption by at least 1300 bytes on AVR for applications
-   which use only the AceTime portion of the library, and increases the
-   flexibility of the `DS3231Clock` class.
-3) Support for *thin links* was moved out of `BasicZoneManager` and
-   `ExtendedZoneManager` into the new `BasicLinkManager` and
-   `ExtendedLinkManager`. This simplifies the ZoneManagers, and reduces the
-   flash memory consumption of applications which do not use this feature by
-   200-500 bytes.
+   the flash memory consumption between 1300-2500 bytes on AVR processor
+   on applications which use only the AceTime portion of the library, and
+   increases the flexibility of the `DS3231Clock` class.
+3) Support for [thin links](USER_GUIDE.md#ThinLinks) was moved out of
+   `BasicZoneManager` and `ExtendedZoneManager` into the new `BasicLinkManager`
+   and `ExtendedLinkManager` classes. This simplifies the ZoneManagers, and
+   reduces the flash memory consumption of applications which do not use this
+   feature by 200-500 bytes.
 
 The following subsections show how to migrate client application from
 AceTime v1.7.5 to AceTime v1.8.0.
@@ -160,9 +160,9 @@ instead.
 <a name="MigratingToLinkManagers"></a>
 ### Migrating to LinkManagers
 
-In v1.7.5, thin links were activated by adding the `kLinkRegistrySize` and
-`kLinkRegistry` parameters to the constructor of `BasicZoneManager` and
-`ExtendedZoneManager`, like this:
+In v1.7.5, [thin links](USER_GUIDE.md#ThinLinks) were activated by adding the
+`kLinkRegistrySize` and `kLinkRegistry` parameters to the constructor of
+`BasicZoneManager` and `ExtendedZoneManager`, like this:
 
 ```C++
 BasicZoneManager zoneManager(
@@ -206,5 +206,6 @@ TimeZone findTimeZone(uint32_t zoneId) {
 }
 ```
 
-See the [Thin Links](USER_GUIDE.md#ThinLinks) section in the User Guide for
-additional information.
+This change allows the ZoneManagers to provide a consistent API for some
+upcoming features, and prevents unnecessary flash consumption (200-500 bytes) if
+the client application does not use the thin link feature.

README.md

@@ -41,7 +41,7 @@ This library can be an alternative to the Arduino Time
 (https://github.com/PaulStoffregen/Time) and Arduino Timezone
 (https://github.com/JChristensen/Timezone) libraries.
 
-**Version**: 1.8.1 (2021-10-18, TZDB version 2021d)
+**Version**: 1.8.2 (2021-10-28, TZDB version 2021e)
 
 **Changelog**: [CHANGELOG.md](CHANGELOG.md)
 
@@ -959,14 +959,14 @@ get some time to take a closer look in the future.
 <a name="FeedbackAndSupport"></a>
 ## Feedback and Support
 
-If you have any questions, comments and other support questions about how to
-use this library, please use the
-[GitHub Discussions](https://github.com/bxparks/AceTime/discussions)
-for this project. If you have bug reports or feature requests, please file a
-ticket in [GitHub Issues](https://github.com/bxparks/AceTime/issues).
-I'd love to hear about how this software and its documentation can be improved.
-I can't promise that I will incorporate everything, but I will give your ideas
-serious consideration.
+If you have any questions, comments, or feature requests for this library,
+please use the [GitHub
+Discussions](https://github.com/bxparks/AceTime/discussions) for this project.
+If you have bug reports, please file a ticket in [GitHub
+Issues](https://github.com/bxparks/AceTime/issues). Feature requests should go
+into Discussions first because they often have alternative solutions which are
+useful to remain visible, instead of disappearing from the default view of the
+Issue tracker after the ticket is closed.
 
 Please refrain from emailing me directly unless the content is sensitive. The
 problem with email is that I cannot reference the email conversation when other

USER_GUIDE.md

@@ -4,7 +4,7 @@ The primary purpose of AceTime classes is to convert between an integer
 representing the number of seconds since Epoch (2000-01-01T00:00:00 UTC) to
 human-readable components in different timezones.
 
-**Version**: 1.8.1 (2021-10-18, TZDB 2021d)
+**Version**: 1.8.2 (2021-10-28, TZDB 2021e)
 
 **Related Documents**:
 

library.properties

@@ -1,5 +1,5 @@
 name=AceTime
-version=1.8.1
+version=1.8.2
 author=Brian T. Park <[email protected]>
 maintainer=Brian T. Park <[email protected]>
 sentence=Date, time, timezone classes for Arduino supporting the full IANA TZ Database to convert epoch seconds to date and time components in different time zones.

src/AceTime.h

@@ -67,7 +67,7 @@
 #include "ace_time/time_period_mutation.h"
 
 // Version format: xxyyzz == "xx.yy.zz"
-#define ACE_TIME_VERSION 10801
-#define ACE_TIME_VERSION_STRING "1.8.1"
+#define ACE_TIME_VERSION 10802
+#define ACE_TIME_VERSION_STRING "1.8.2"
 
 #endif

src/ace_time/zonedb/Makefile

@@ -2,7 +2,7 @@ TARGETS := zone_infos.cpp zone_infos.h zone_policies.cpp zone_policies.h
 
 TOOLS := $(abspath ../../../../AceTimeTools)
 
-TZ_VERSION := 2021d
+TZ_VERSION := 2021e
 START_YEAR := 2000
 UNTIL_YEAR := 2050
 

src/ace_time/zonedb/zone_infos.cpp

@@ -3,7 +3,7 @@
 //   $ /home/brian/src/AceTimeTools/src/acetimetools/tzcompiler.py
 //     --input_dir /home/brian/dev/tz
 //     --output_dir /home/brian/src/AceTime/src/ace_time/zonedb
-//     --tz_version 2021d
+//     --tz_version 2021e
 //     --action zonedb
 //     --language arduino
 //     --scope basic
@@ -22,7 +22,7 @@
 //   northamerica
 //   southamerica
 //
-// from https://github.com/eggert/tz/releases/tag/2021d
+// from https://github.com/eggert/tz/releases/tag/2021e
 //
 // Zones: 258
 // Links: 193
@@ -52,7 +52,7 @@ namespace zonedb {
 // ZoneContext (should not be in PROGMEM)
 //---------------------------------------------------------------------------
 
-const char kTzDatabaseVersion[] = "2021d";
+const char kTzDatabaseVersion[] = "2021e";
 
 const char* const kFragments[] = {
 /*\x00*/ nullptr,

src/ace_time/zonedb/zone_infos.h

@@ -3,7 +3,7 @@
 //   $ /home/brian/src/AceTimeTools/src/acetimetools/tzcompiler.py
 //     --input_dir /home/brian/dev/tz
 //     --output_dir /home/brian/src/AceTime/src/ace_time/zonedb
-//     --tz_version 2021d
+//     --tz_version 2021e
 //     --action zonedb
 //     --language arduino
 //     --scope basic
@@ -22,7 +22,7 @@
 //   northamerica
 //   southamerica
 //
-// from https://github.com/eggert/tz/releases/tag/2021d
+// from https://github.com/eggert/tz/releases/tag/2021e
 //
 // DO NOT EDIT