improve text

docs/man/statime.toml.x.md → docs/man/statime.toml.5.md

@@ -1,10 +1,10 @@
 <!-- ---
-title: STATIME.TOML(x) statime-linux 1.0.0 | statime-linux
+title: STATIME.TOML(5) statime 1.0.0 | statime
 --- -->
 
 # NAME
 
-`statime.toml` - configuration file for the statime-linux ptp-daemon
+`statime.toml` - configuration file for the statime ptp-daemon
 
 # DESCRIPTION
 
@@ -19,70 +19,58 @@ will be indicated by each configuration setting shown.
 
 # CONFIGURATION
 
-
-#[derive(Deserialize, Debug, Clone, PartialEq, Eq)]
-#[serde(rename_all = "kebab-case", deny_unknown_fields)]
-pub struct Config {
-    #[serde(
-        default = "default_loglevel",
-        deserialize_with = "deserialize_loglevel"
-    )]
-    pub loglevel: log::LevelFilter,
-    #[serde(default = "default_sdo_id")]
-    pub sdo_id: u16,
-    #[serde(default = "default_domain")]
-    pub domain: u8,
-    #[serde(rename = "port")]
-    pub ports: Vec<PortConfig>,
-}
-
-
 `identity` = *clock identity* (**unset**)
-:   The identity of this clock. 
-    A clock identity is encoded as a 16-character hexadecimal string, for example 
-    `identity = "00FFFFFFFFFFFFFB"`
+:   The unique identity of this clock.
+    A clock identity is encoded as a 16-character hexadecimal string, for example
+    `identity = "00FFFFFFFFFFFFFB"`. 
+    If unset the clock identity is derived from a MAC address. 
 
-`domain` = *priority* (**0**)
-:   The PTP domain of this instance. All instances in domain are synchronized to the Grandmaster 
+`domain` = *u8* (**0**)
+:   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.
 
+`sdo_id` = *u12* (**0**)
+:   The "source domain identity" of this PTP instance. Together with the `domain` it identifies a domain.
+
 `priority1` = *priority* (**128**)
 :   A tie breaker for the best master clock algorithm in the range `0..256`.
 
 `priority2` = *priority* (**128**)
 :   A tie breaker for the best master clock algorithm in the range `0..256`.
 
-## `[[port]]` 
+## `[[port]]`
 
 `interface` = *interface name*
 :   The network interface of this PTP port. For instance `"lo"` or `"enp0s31f6"`
 
 `announce_interval` = *interval* (**1**)
 :   How often an announce message is sent by a master.
-    Defined as an exponent of 2, so a value of 1 means every 2^1 = 2 seconds
+    Defined as an exponent of 2, so a value of 1 means every 2^1 = 2 seconds.
 
 `sync_interval` = *interval* (**0**)
-:   How often a sync message is sent. 
-    Defined as an exponent of 2, so a value of 0 means every 2^0 = 1 seconds
+:   How often sync message is sent by a master.
+    Defined as an exponent of 2, so a value of 0 means every 2^0 = 1 seconds.
 
 `announce_receipt_timeout` = *number of announce intervals* (**3**)
-:   Number of announce intervals to wait before the port becomes master 
+:   Number of announce intervals to wait for announce messages from other masters before the port becomes master itself.
 
 `delay_asymmetry` = *nanoseconds* (**0**)
-:   The value is positive when the slave-to-master propagation time is longer than the master-to-slave propagation time.
+:   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.
 
 `delay_mechanism` = *interval* (**0**)
-:   Currently the only supported delay mechanism is E2E.
+:   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^0 = 1 seconds
 
 `master_only` = *bool* (**false**)
-:   The port is always a master instance
+:   The port is always a master instance, and will never become a slave instance.
 
 `hardware_clock` = *path* (**unset**)
-:   Path to a hardware clock device, for instance ` "/dev/ptp0"` 
+:   Path to a hardware clock device, for instance `"/dev/ptp0"`.
 
 `acceptable_master_list` = [ *clock identity*, .. ] (**unset**)
 :   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 
-    `acceptable_master_list = ["00FFFFFFFFFFFFFB"]`
-
+    A clock identity is encoded as a 16-character hexadecimal string, for example
+    `acceptable_master_list = ["00FFFFFFFFFFFFFB"]`.
+    The default is to accept all clock identities.

utils/generate-man.sh

@@ -4,7 +4,7 @@ set -eo pipefail
 
 docs_dir="docs/man"
 output_dir="${1:-"docs/precompiled/man"}"
-files=("statime.8")
+files=("statime.8", "statime.toml.5")
 
 mkdir -p "$output_dir"