aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2024-01-18 09:38:29 +0100
committerMatthias P. Braendli <matthias.braendli@mpb.li>2024-01-18 09:38:29 +0100
commite805eda6acf2a838c52d3e3b5f39e11f6160f124 (patch)
treeb705605fb21af694c5beb918c48c3f213bf03b43 /doc
parentf327f5968857ab0cc93b0569272e29a89e22af37 (diff)
downloaddabmux-e805eda6acf2a838c52d3e3b5f39e11f6160f124.tar.gz
dabmux-e805eda6acf2a838c52d3e3b5f39e11f6160f124.tar.bz2
dabmux-e805eda6acf2a838c52d3e3b5f39e11f6160f124.zip
Update doc for TAI bulletin handling
Diffstat (limited to 'doc')
-rw-r--r--doc/TIMESTAMPS.rst1
-rw-r--r--doc/example.mux19
2 files changed, 13 insertions, 7 deletions
diff --git a/doc/TIMESTAMPS.rst b/doc/TIMESTAMPS.rst
index d9c3563..7f48b58 100644
--- a/doc/TIMESTAMPS.rst
+++ b/doc/TIMESTAMPS.rst
@@ -13,7 +13,6 @@ The following table tries to summarise the differences.
| Later than v2.3.1 | t_frame = t_tx = t_mux + tist_offset | negative, meaning delay before t_tx | Something larger than mod processing time |
+-----------------------------+----------------------------------------------+-------------------------------------+-----------------------------------------------+
-For historical reasons, ODR-DabMod decodes absolute timestamp from MNSC, not from “EDI seconds”.
The edilib tool decodes both EDI timestamp and MNSC, and can be used to verify both are identical.
Issues in ODR-DabMux v2.3.1
diff --git a/doc/example.mux b/doc/example.mux
index 9a5686b..383a2ab 100644
--- a/doc/example.mux
+++ b/doc/example.mux
@@ -36,18 +36,21 @@ general {
; This also enables time encoding using the MNSC.
;
; When TIST is enabled, and either EDI or a ZMQ output with metadata is used,
- ; ODR-DabMux will download leap-second information from the IETF website,
- ; and cache it locally in /var/tmp. It will refresh the data by itself
- ; before it expires.
+ ; ODR-DabMux will download the leap-second information bulletin,
+ ; and cache it locally in /var/tmp.
+ ; It will refresh the bulletin by itself before it expires. If that fails,
+ ; ODR-DabMux will continue running with the current TAI-UTC clock offset.
;
; If it cannot load this information, ODR-DabMux cannot start up!
;
; If your system doesn't have access to internet, you have to take care
; to create the file before ODR-DabMux startup. Get it from
- ; http://www.ietf.org/timezones/data/leap-seconds.list
+ ; https://raw.githubusercontent.com/eggert/tz/master/leap-seconds.list
; and save it to
; /var/tmp/odr-dabmux-leap-seconds.cache
- ; Refresh the file before expiry otherwise ODR-DabMux will abort!
+ ;
+ ; ODR-DabMux will start up even with an expired bulletin in cache, but will
+ ; output a warning.
;
; Use the RC interface 'get clocktai expiry' command to check how long
; your file is still valid.
@@ -60,7 +63,11 @@ general {
; The URLs used to fetch the TAI bulletin can be overridden if needed.
; URLs are given as a pipe-separated list, and the default value is:
- ;tai_clock_bulletins "https://www.ietf.org/timezones/data/leap-seconds.list|https://raw.githubusercontent.com/eggert/tz/master/leap-seconds.list"
+ ;tai_clock_bulletins "https://raw.githubusercontent.com/eggert/tz/master/leap-seconds.list"
+ ;
+ ; Through RC, use `set clocktai url <LIST_OF_URLS>` to change the URLs used to download the bulletin
+ ; during runtime.
+ ; You may also override the bulletin using `set clocktai tai_utc_offset 37` to set a TAI-UTC offset manually.
;
; You may also use a file:// URL if you take care of updating the file
; yourself and store it locally.