From c118767768d411de44f5e1f09d25ca4e1055eed2 Mon Sep 17 00:00:00 2001 From: Paul Donald Date: Fri, 24 Oct 2025 03:52:11 +0200 Subject: [PATCH 1/7] doc: spelling and formatting fixes updates ptp4l man page Signed-off-by: Paul Donald --- ptp4l.8 | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/ptp4l.8 b/ptp4l.8 index 0b8be682..98c252ba 100644 --- a/ptp4l.8 +++ b/ptp4l.8 @@ -198,7 +198,7 @@ The default is 2. .B cmlds.port Specifies the port number of local Common Mean Link Delay Service from which to accept delay measurements. The range of valid port numbers -is one to 65535, but the special value zero configures the port number +is one to 65535, but the special value "0" configures the port number of the port requesting the measurements. The default is 0, meaning the requesting port number. @@ -244,7 +244,7 @@ The default is 1.0 (i.e. +/- 100% of the mean time interval). .TP .B delay_response_timeout The number of delay response messages that may go missing before -triggering a synchronization fault. Setting this option to zero will +triggering a synchronization fault. Setting this option to "0" will disable the delay response timeout. The default is 0 or disabled. @@ -328,7 +328,7 @@ need to calculate offset from client. The default is 0 (disabled). .B inhibit_multicast_service Some unicast mode profiles insist that no multicast message are ever transmitted. Setting this option inhibits multicast transmission. -The default is 0 (mutlicast enabled). +The default is 0 (multicast enabled). .TP .B logAnnounceInterval @@ -460,7 +460,7 @@ The default is "none". .B profileIdentity The profile identity is a 6-octet array in the clock description referencing the PTP profile currently configured on the port. This value -should reflect the identitifers assigned to each profile. Allowed values +should reflect the identifiers assigned to each profile. Allowed values are of the form 00:00:00:00:00:00. If the default 00:00:00:00:00:00 is used or if not set at all, the profileIdentity will be detected from the configuration or set to the Default @@ -524,7 +524,7 @@ The default is -1 (disabled). The number of sync/follow up messages that may go missing before triggering a Best Master Clock election. This option is used for running in gPTP mode according to the 802.1AS-2011 standard. Setting -this option to zero will disable the sync message timeout. +this option to "0" will disable the sync message timeout. The default is 0 or disabled. .TP @@ -759,7 +759,7 @@ When the client and server are operating at different interface rates, delay asymmetry caused by different interface rates needs to be compensated for. The server sends its interface rate using interface rate TLV as per G.8275.2 Annex D. -The default is 0 (does not support interface rate tlv). +The default is 0 (does not support interface rate TLV). .TP .B hwts_filter @@ -884,7 +884,7 @@ The default is \-0.3. .B pi_proportional_norm_max The kp_norm_max constant in the formula used to set the proportional constant of the PI controller from the sync interval. -The default is 0.7 +The default is 0.7. .TP .B pi_proportional_scale @@ -1012,7 +1012,7 @@ square (RMS), maximum absolute offset, frequency offset mean and standard deviation, and path delay mean and standard deviation. The units are nanoseconds and parts per billion (ppb). If there is only one clock update in the interval, the sample will be printed instead of the statistics. The -messages are printed at the LOG_INFO level. +messages are printed at the "LOG_INFO" level. The default is 0 (1 second). .TP @@ -1031,9 +1031,9 @@ advertised when the clock becomes grand master. .TP .B time_stamping -The time stamping method to be used. The allowed values are hardware, -software, legacy, onestep, and p2p1step. -The default is hardware. +The time stamping method to be used. The allowed values are "hardware", +"software", "legacy", "onestep", and "p2p1step". +The default is "hardware". .TP .B twoStepFlag @@ -1172,7 +1172,7 @@ value is 3. .TP .B allow_mutable This option allows for mutable correction fields if on path -authentication tlv support is not possible. This option is NOT +authentication TLV support is not possible. This option is NOT recommended as it leaves the correction field unprotected. The default value is 0 (disabled). From 1a0c98d1eceabc04e9d968de24e64754d67a7334 Mon Sep 17 00:00:00 2001 From: Paul Donald Date: Fri, 24 Oct 2025 03:54:47 +0200 Subject: [PATCH 2/7] doc: spelling and formatting fixes updates README Signed-off-by: Paul Donald --- README.org | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index c6793155..6db69041 100644 --- a/README.org +++ b/README.org @@ -145,7 +145,7 @@ Hardware Receive Filter Modes: none 3. In order to install the programs and man pages into /usr/local, run the 'make install' target. You can change the installation - directories by setttings the variables prefix, sbindir, mandir, + directories by settings the variables prefix, sbindir, mandir, and man8dir on the make command line. * Getting Involved @@ -180,7 +180,7 @@ Hardware Receive Filter Modes: none need to understand why you did what you did. 4. *Sign-Off* each commit, so the changes can be properly attributed to - you and you explicitely give your agreement for distribution under + you and you explicitly give your agreement for distribution under linuxptp's license. Signing-off is as simple as: #+BEGIN_EXAMPLE From bbe674482193f71be22a25c1b003a38bd01f6094 Mon Sep 17 00:00:00 2001 From: Paul Donald Date: Fri, 24 Oct 2025 03:55:59 +0200 Subject: [PATCH 3/7] doc: spelling and formatting fixes updates timemaster manpage Signed-off-by: Paul Donald --- timemaster.8 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/timemaster.8 b/timemaster.8 index bc0b5b64..5ec174cc 100644 --- a/timemaster.8 +++ b/timemaster.8 @@ -297,7 +297,7 @@ the \fBntpd\fR SHM refclock driver have owner-only access. Other segments are created with world access, which allows any user on the system to write to the segments and disrupt or take control over the synchronization of the clock. In 4.2.8p1 the access was made configurable with the mode option, which is set -by \fBtimemaster\fR for owner-ownly access. +by \fBtimemaster\fR for owner-only access. The shortest polling interval for all sources is 3 (8 seconds). From 1700a6b788a6ae4ff9cf82e0391c1977d4818473 Mon Sep 17 00:00:00 2001 From: Paul Donald Date: Fri, 24 Oct 2025 03:57:23 +0200 Subject: [PATCH 4/7] doc: spelling and formatting fixes updates ts2phc manpage Signed-off-by: Paul Donald --- ts2phc.8 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ts2phc.8 b/ts2phc.8 index 92562d01..128817bf 100644 --- a/ts2phc.8 +++ b/ts2phc.8 @@ -121,7 +121,7 @@ command line option. .B active_key_id Used in conjunction with \fBspp\fR and \fBsa_file\fR directives to specify which key from the \fBspp\fR defined Security Association -should be used for outbound icv calculations. All Security Assocations +should be used for outbound icv calculations. All Security Associations are read from the file specified by \fBsa_file\fR. Requires \fBspp\fR and \fBsa_file\fR directives. Must be in the range of 1 to 2^32-1, inclusive. The default is 0 (disabled). @@ -271,8 +271,8 @@ The default is 0.0. .TP .B spp Specifies the security parameters pointer for the desired security association -to be used for authentication tlv support. If specified, the port owning the -spp will attempt to attach (outbound) and check (inbound) authentication tlvs +to be used for authentication TLV support. If specified, the port owning the +spp will attempt to attach (outbound) and check (inbound) authentication TLVs for all messages in accordance to the corresponding security association sourced via the \fBsa_file\fR directive. Not compatible with one step ports. Must be in the range of -1 to 255, inclusive. The default is -1 (disabled). @@ -345,7 +345,7 @@ with this rate to match the sinks. The supported range is 1 to 128. The rate should divide 1 billion to avoid a loss of precision due to rounding of the pulse period to nanoseconds. If using the generic (system clock) or NMEA ToD source, the higher the pulse rate, the more accurate and stable the ToD source -needs to be to prevent mislabeled pulses (causing large clock errors), and also +needs to be to prevent mislabelled pulses (causing large clock errors), and also errors in the edge detection if \fBts2phc.extts_polarity\fR is set to "both". The default is 1 pulse per second (1PPS). From 4a9831d43ae83cc80e0dc279b84a2b75a475a1ea Mon Sep 17 00:00:00 2001 From: Paul Donald Date: Fri, 24 Oct 2025 03:58:12 +0200 Subject: [PATCH 5/7] doc: spelling and formatting fixes updates tz2alt manpage Signed-off-by: Paul Donald --- tz2alt.8 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tz2alt.8 b/tz2alt.8 index cb33de25..7d96d400 100644 --- a/tz2alt.8 +++ b/tz2alt.8 @@ -76,7 +76,7 @@ starting with # are ignored. .B active_key_id Used in conjunction with \fBspp\fR and \fBsa_file\fR directives to specify which key from the \fBspp\fR defined Security Association -should be used for outbound icv calculations. All Security Assocations +should be used for outbound icv calculations. All Security Associations are read from the file specified by \fBsa_file\fR. Requires \fBspp\fR and \fBsa_file\fR directives. Must be in the range of 1 to 2^32-1, inclusive. The default is 0 (disabled). @@ -119,8 +119,8 @@ The default is an empty string. (disabled). .TP .B spp Specifies the security parameters pointer for the desired security association -to be used for authentication tlv support. If specified, the port owning the -spp will attempt to attach (outbound) and check (inbound) authentication tlvs +to be used for authentication TLV support. If specified, the port owning the +spp will attempt to attach (outbound) and check (inbound) authentication TLVs for all messages in accordance to the corresponding security association sourced via the \fBsa_file\fR directive. Not compatible with one step ports. Must be in the range of -1 to 255, inclusive. The default is -1 (disabled). From 678d09e2058da8f42247e17459ee08c8a7de9897 Mon Sep 17 00:00:00 2001 From: Paul Donald Date: Fri, 24 Oct 2025 04:01:17 +0200 Subject: [PATCH 6/7] doc: spelling and formatting fixes updates phc2sys manpage Signed-off-by: Paul Donald --- phc2sys.8 | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/phc2sys.8 b/phc2sys.8 index 80d009f9..8888cc65 100644 --- a/phc2sys.8 +++ b/phc2sys.8 @@ -280,7 +280,7 @@ sets the program options. This is the only used option. .B active_key_id Used in conjunction with \fBspp\fR and \fBsa_file\fR directives to specify which key from the \fBspp\fR defined Security Association -should be used for outbound icv calculations. All Security Assocations +should be used for outbound icv calculations. All Security Associations are read from the file specified by \fBsa_file\fR. Requires \fBspp\fR and \fBsa_file\fR directives. Must be in the range of 1 to 2^32-1, inclusive. The default is 0 (disabled). @@ -406,8 +406,8 @@ Same as option .TP .B spp Specifies the security parameters pointer for the desired security association -to be used for authentication tlv support. If specified, the port owning the -spp will attempt to attach (outbound) and check (inbound) authentication tlvs +to be used for authentication TLV support. If specified, the port owning the +spp will attempt to attach (outbound) and check (inbound) authentication TLVs for all messages in accordance to the corresponding security association sourced via the \fBsa_file\fR directive. Not compatible with one step ports. Must be in the range of -1 to 255, inclusive. The default is -1 (disabled). @@ -462,7 +462,7 @@ is in effect or from command line when .B \-O is supplied. Failure to maintain the correct offset can result in the local system clock being offset some whole number of seconds from the -domain server's clock when in client mode, or incorect PTP time +domain server's clock when in client mode, or incorrect PTP time announced to the network in case the host is the domain server. .SH EXAMPLES @@ -538,7 +538,7 @@ phc2sys, is specified to a non-default value in the configuration file (p.e., for ptp4l), then this non-default value applies also for phc2sys. This might be not what is expected. -It is recommended to use seperate configuration files for ptp4l and +It is recommended to use separate configuration files for ptp4l and phc2sys in order to avoid any unexpected behavior. .SH SEE ALSO From 22fbd94f119495dd70660c13c66ce1e23d1125dc Mon Sep 17 00:00:00 2001 From: Paul Donald Date: Fri, 24 Oct 2025 04:01:28 +0200 Subject: [PATCH 7/7] doc: spelling and formatting fixes updates phc_ctl manpage Signed-off-by: Paul Donald --- phc_ctl.8 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/phc_ctl.8 b/phc_ctl.8 index b10566ea..34616768 100644 --- a/phc_ctl.8 +++ b/phc_ctl.8 @@ -14,7 +14,7 @@ control of the device. For general control of PHC clock devices, .B phc2sys (8) should be preferred. - may be either CLOCK_REALTIME, any /dev/ptpX device, or any ethernet + may be either CLOCK_REALTIME, any /dev/ptpX device, or any Ethernet device which supports ethtool's get_ts_info ioctl. .SH OPTIONS