Test release

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.2.1] - 2024-05-31
+
+### Test release
+
 ## [0.2.0] - 2024-03-07
 
 ### Added

Cargo.toml

@@ -9,7 +9,7 @@ exclude = [
 resolver = "2"
 
 [workspace.package]
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 license = "Apache-2.0 OR MIT"
 repository = "https://github.com/pendulum-project/statime"
@@ -51,7 +51,7 @@ timestamped-socket = "0.2.1"
 
 # our own crates used as dependencies, same version as the workspace version
 # NOTE: keep this part at the bottom of the file, do not change this line
-statime = { version = "0.2.0", path = "./statime" }
+statime = { version = "0.2.1", path = "./statime" }
 
 [profile.release]
 debug = 2

docs/man/statime.8.md

@@ -1,5 +1,5 @@
 <!-- ---
-title: STATIME(8) statime 0.2.0 | statime
+title: STATIME(8) statime 0.2.1 | statime
 --- -->
 
 # NAME

docs/man/statime.toml.5.md

@@ -1,5 +1,5 @@
 <!-- ---
-title: STATIME.TOML(5) statime 0.2.0 | statime
+title: STATIME.TOML(5) statime 0.2.1 | statime
 --- -->
 
 # NAME

docs/precompiled/man/statime.8

@@ -1,28 +1,46 @@
-.\" Automatically generated by Pandoc 3.1.13
+.\" Automatically generated by Pandoc 3.1.1
 .\"
-.TH "STATIME" "8" "" "statime 0.2.0" "statime"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "STATIME" "8" "" "statime 0.2.1" "statime"
+.hy
 .SH NAME
-\f[CR]statime\f[R] \- The Statime PTP daemon for linux
+.PP
+\f[V]statime\f[R] - The Statime PTP daemon for linux
 .SH SYNOPSIS
-\f[CR]statime\f[R] [\f[CR]\-c\f[R] \f[I]path\f[R]]
+.PP
+\f[V]statime\f[R] [\f[V]-c\f[R] \f[I]path\f[R]]
 .PD 0
 .P
 .PD
-\f[CR]statime\f[R] \f[CR]\-h\f[R]
+\f[V]statime\f[R] \f[V]-h\f[R]
 .PD 0
 .P
 .PD
-\f[CR]statime\f[R] \f[CR]\-V\f[R]
+\f[V]statime\f[R] \f[V]-V\f[R]
 .SH DESCRIPTION
+.PP
 \&...
 .SH OPTIONS
 .TP
-\f[CR]\-c\f[R] \f[I]path\f[R], \f[CR]\-\-config\f[R]=\f[I]path\f[R]
+\f[V]-c\f[R] \f[I]path\f[R], \f[V]--config\f[R]=\f[I]path\f[R]
 Path to the configuration file for the statime daemon.
-If not specified this defaults to \f[CR]/etc/statime/statime.toml\f[R].
+If not specified this defaults to \f[V]/etc/statime/statime.toml\f[R].
 .TP
-\f[CR]\-h\f[R], \f[CR]\-\-help\f[R]
+\f[V]-h\f[R], \f[V]--help\f[R]
 Display usage instructions.
 .TP
-\f[CR]\-V\f[R], \f[CR]\-\-version\f[R]
+\f[V]-V\f[R], \f[V]--version\f[R]
 Display version information.

docs/precompiled/man/statime.toml.5

@@ -1,96 +1,110 @@
-.\" Automatically generated by Pandoc 3.1.13
+.\" Automatically generated by Pandoc 3.1.1
 .\"
-.TH "STATIME.TOML" "5" "" "statime 0.2.0" "statime"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "STATIME.TOML" "5" "" "statime 0.2.1" "statime"
+.hy
 .SH NAME
-\f[CR]statime.toml\f[R] \- configuration file for the statime
-ptp\-daemon
+.PP
+\f[V]statime.toml\f[R] - configuration file for the statime ptp-daemon
 .SH DESCRIPTION
-Configuration of ntpd\-rs happens in the \f[CR]statime.toml\f[R]
+.PP
+Configuration of ntpd-rs happens in the \f[V]statime.toml\f[R]
 configuration format.
 The toml format is in lots of ways similar to a simple ini with several
-extensions allowing a json\-like syntax.
+extensions allowing a json-like syntax.
 .PP
 The statime configuration file consists of several sections, each of
-which configures a separate part of the ptp\-daemon process.
+which configures a separate part of the ptp-daemon process.
 Each of the sections is described in the rest of this document.
 Many settings will have defaults, which will be indicated by each
 configuration setting shown.
 .SH CONFIGURATION
 .TP
-\f[CR]identity\f[R] = \f[I]clock identity\f[R] (\f[B]unset\f[R])
+\f[V]identity\f[R] = \f[I]clock identity\f[R] (\f[B]unset\f[R])
 The unique identity of this clock.
-A clock identity is encoded as a 16\-character hexadecimal string, for
-example \f[CR]identity = \[dq]00FFFFFFFFFFFFFB\[dq]\f[R].
+A clock identity is encoded as a 16-character hexadecimal string, for
+example \f[V]identity = \[dq]00FFFFFFFFFFFFFB\[dq]\f[R].
 If unset the clock identity is derived from a MAC address.
 .TP
-\f[CR]domain\f[R] = \f[I]u8\f[R] (\f[B]0\f[R])
+\f[V]domain\f[R] = \f[I]u8\f[R] (\f[B]0\f[R])
 The PTP domain of this instance.
 All instances in domain are synchronized to the Grandmaster Clock of the
 domain, but are not necessarily synchronized to PTP clocks in another
 domain.
 .TP
-\f[CR]sdo\-id\f[R] = \f[I]u12\f[R] (\f[B]0\f[R])
+\f[V]sdo-id\f[R] = \f[I]u12\f[R] (\f[B]0\f[R])
 The \[lq]source domain identity\[rq] of this PTP instance.
-Together with the \f[CR]domain\f[R] it identifies a domain.
+Together with the \f[V]domain\f[R] it identifies a domain.
 .TP
-\f[CR]priority1\f[R] = \f[I]priority\f[R] (\f[B]128\f[R])
+\f[V]priority1\f[R] = \f[I]priority\f[R] (\f[B]128\f[R])
 A tie breaker for the best master clock algorithm in the range
-\f[CR]0..256\f[R].
-\f[CR]0\f[R] being highest priority an \f[CR]255\f[R] the lowest.
+\f[V]0..256\f[R].
+\f[V]0\f[R] being highest priority an \f[V]255\f[R] the lowest.
 .TP
-\f[CR]priority2\f[R] = \f[I]priority\f[R] (\f[B]128\f[R])
+\f[V]priority2\f[R] = \f[I]priority\f[R] (\f[B]128\f[R])
 A tie breaker for the best master clock algorithm in the range
-\f[CR]0..256\f[R].
-\f[CR]0\f[R] being highest priority an \f[CR]255\f[R] the lowest.
-.SS \f[CR][[port]]\f[R]
+\f[V]0..256\f[R].
+\f[V]0\f[R] being highest priority an \f[V]255\f[R] the lowest.
+.SS \f[V][[port]]\f[R]
 .TP
-\f[CR]interface\f[R] = \f[I]interface name\f[R]
+\f[V]interface\f[R] = \f[I]interface name\f[R]
 The network interface of this PTP port.
-For instance \f[CR]\[dq]lo\[dq]\f[R] or \f[CR]\[dq]enp0s31f6\[dq]\f[R]
+For instance \f[V]\[dq]lo\[dq]\f[R] or \f[V]\[dq]enp0s31f6\[dq]\f[R]
 .TP
-\f[CR]announce\-interval\f[R] = \f[I]interval\f[R] (\f[B]1\f[R])
+\f[V]announce-interval\f[R] = \f[I]interval\f[R] (\f[B]1\f[R])
 How often an announce message is sent by a master.
 Defined as an exponent of 2, so a value of 1 means every 2\[ha]1 = 2
 seconds.
 .TP
-\f[CR]sync\-interval\f[R] = \f[I]interval\f[R] (\f[B]0\f[R])
+\f[V]sync-interval\f[R] = \f[I]interval\f[R] (\f[B]0\f[R])
 How often sync message is sent by a master.
 Defined as an exponent of 2, so a value of 0 means every 2\[ha]0 = 1
 seconds.
 .TP
-\f[CR]announce\-receipt\-timeout\f[R] = \f[I]number of announce intervals\f[R] (\f[B]3\f[R])
+\f[V]announce-receipt-timeout\f[R] = \f[I]number of announce intervals\f[R] (\f[B]3\f[R])
 Number of announce intervals to wait for announce messages from other
 masters before the port becomes master itself.
 .TP
-\f[CR]delay\-asymmetry\f[R] = \f[I]nanoseconds\f[R] (\f[B]0\f[R])
-Correct for a difference between slave\-to\-master and master\-to\-slave
+\f[V]delay-asymmetry\f[R] = \f[I]nanoseconds\f[R] (\f[B]0\f[R])
+Correct for a difference between slave-to-master and master-to-slave
 propagation time.
-The value is positive when the slave\-to\-master propagation time is
-longer than the master\-to\-slave propagation time.
+The value is positive when the slave-to-master propagation time is
+longer than the master-to-slave propagation time.
 .TP
-\f[CR]delay\-mechanism\f[R] = \f[I]mechanism\f[R] (\f[B]E2E\f[R])
+\f[V]delay-mechanism\f[R] = \f[I]mechanism\f[R] (\f[B]E2E\f[R])
 Which delay mechanism to use on the port.
-Either \f[CR]\[dq]E2E\[dq]\f[R] for end\-to\-end delay determination, or
-\f[CR]\[dq]P2P\[dq]\f[R] for the peer to peer delay mechanism.
+Either \f[V]\[dq]E2E\[dq]\f[R] for end-to-end delay determination, or
+\f[V]\[dq]P2P\[dq]\f[R] for the peer to peer delay mechanism.
 .TP
-\f[CR]delay\-interval\f[R] = \f[I]interval\f[R] (\f[B]0\f[R])
-How often delay request messages are sent by a slave in end\-to\-end
-mode.
-Currently the only supported delay mechanism is end\-to\-end (E2E).
+\f[V]delay-interval\f[R] = \f[I]interval\f[R] (\f[B]0\f[R])
+How often delay request messages are sent by a slave in end-to-end mode.
+Currently the only supported delay mechanism is end-to-end (E2E).
 Defined as an exponent of 2, so a value of 0 means every 2\[ha]0 = 1
 seconds
 .TP
-\f[CR]master\-only\f[R] = \f[I]bool\f[R] (\f[B]false\f[R])
+\f[V]master-only\f[R] = \f[I]bool\f[R] (\f[B]false\f[R])
 The port is always a master instance, and will never become a slave
 instance.
 .TP
-\f[CR]hardware\-clock\f[R] = \f[I]index\f[R] (\f[B]unset\f[R])
-Index of a hardware clock device, for instance \f[CR]0\f[R] for
-\f[CR]/dev/ptp0\f[R].
+\f[V]hardware-clock\f[R] = \f[I]index\f[R] (\f[B]unset\f[R])
+Index of a hardware clock device, for instance \f[V]0\f[R] for
+\f[V]/dev/ptp0\f[R].
 .TP
-\f[CR]acceptable\-master\-list\f[R] = [ \f[I]clock identity\f[R], .. ] (\f[B]unset\f[R])
+\f[V]acceptable-master-list\f[R] = [ \f[I]clock identity\f[R], .. ] (\f[B]unset\f[R])
 List of clock identities that this port will accept as its master.
-A clock identity is encoded as a 16\-character hexadecimal string, for
-example
-\f[CR]acceptable\-master\-list = [\[dq]00FFFFFFFFFFFFFB\[dq]]\f[R].
+A clock identity is encoded as a 16-character hexadecimal string, for
+example \f[V]acceptable-master-list = [\[dq]00FFFFFFFFFFFFFB\[dq]]\f[R].
 The default is to accept all clock identities.