while packaging linuxptp for debian, we found a few minor spelling errors: cmf.c: prints MANAGMENT instead of MANAGEMENT
manpages (ptp4l.8, timemaster.8): confuses minus- and hyphen-signs. in groff, the '-' is rendered as a hyphen, if we want a real minus we need to write '\-'. mostly the manpages are correct, but there are some exceptions (e.g. "-128", where we really want a minus) attached are two git patches that fix these problems. mgfards IOhannes PS: i hope it is ok to use this list for these kind of messages; but there is no bug tracker on the sf page; and there are no other mailing lists announced. btw, if i click on [1] i am directed to [2], which gives me a 403-error; maybe the "support" section could be made a bit more welcoming :-) [1] https://sourceforge.net/projects/linuxptp/support [2] https://sourceforge.net/p/linuxptp/mailman
From 640f42ae7c622375208e51bd7b5eb5cb14945fd1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?IOhannes=20m=20zm=C3=B6lnig?= <[email protected]> Date: Tue, 2 Jun 2015 15:58:11 +0200 Subject: [PATCH 1/2] fixed spelling: "MANAGEMENT" rather than "MANAGMENT" --- pmc.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pmc.c b/pmc.c index d58e190..366c093 100644 --- a/pmc.c +++ b/pmc.c @@ -211,9 +211,9 @@ static void pmc_show(struct ptp_message *msg, FILE *fp) } tlv = (struct TLV *) msg->management.suffix; if (tlv->type == TLV_MANAGEMENT) { - fprintf(fp, "MANAGMENT "); + fprintf(fp, "MANAGEMENT "); } else if (tlv->type == TLV_MANAGEMENT_ERROR_STATUS) { - fprintf(fp, "MANAGMENT_ERROR_STATUS "); + fprintf(fp, "MANAGEMENT_ERROR_STATUS "); goto out; } else { fprintf(fp, "unknown-tlv "); -- 2.1.4
From baffc2efe3e008b289071caa1d091ee92d5fa366 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?IOhannes=20m=20zm=C3=B6lnig?= <[email protected]> Date: Tue, 2 Jun 2015 15:59:17 +0200 Subject: [PATCH 2/2] fixed hyphen/minus signs in groff in manpages, the '-' denotes a hyphen. for a proper minus, we need to write '\-' --- ptp4l.8 | 6 +++--- timemaster.8 | 16 ++++++++-------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/ptp4l.8 b/ptp4l.8 index fd00ea3..caeb805 100644 --- a/ptp4l.8 +++ b/ptp4l.8 @@ -1,6 +1,6 @@ .TH PTP4l 8 "December 2014" "linuxptp" .SH NAME -ptp4l \- PTP Boundary/Ordinary Clock +ptp4l - PTP Boundary/Ordinary Clock .SH SYNOPSIS .B ptp4l @@ -170,7 +170,7 @@ The default is 0 (disabled). .B fault_reset_interval The time in seconds between the detection of a port's fault and the fault being reset. This value is expressed as a power of two. Setting this -value to -128 or to the special key word "ASAP" will let the fault be +value to \-128 or to the special key word "ASAP" will let the fault be reset immediately. The default is 4 (16 seconds). .TP @@ -350,7 +350,7 @@ The default is 0.0. .B pi_proportional_exponent The kp_exponent constant in the formula used to set the proportional constant of the PI controller from the sync interval. -The default is -0.3. +The default is \-0.3. .TP .B pi_proportional_norm_max The kp_norm_max constant in the formula used to set the proportional constant of diff --git a/timemaster.8 b/timemaster.8 index 062322b..4da4299 100644 --- a/timemaster.8 +++ b/timemaster.8 @@ -1,7 +1,7 @@ .TH TIMEMASTER 8 "October 2014" "linuxptp" .SH NAME -timemaster \- run NTP with PTP as reference clocks +timemaster - run NTP with PTP as reference clocks .SH SYNOPSIS @@ -138,7 +138,7 @@ default value is 0 (1 second). Specify the maximum assumed roundtrip delay to the primary source of the time in this PTP domain. This value is included in the distance used by \fBchronyd\fR in the source selection algorithm to detect falsetickers and -assign weights for source combining. The default value is 1e-4 (100 +assign weights for source combining. The default value is 1e\-4 (100 microseconds). With \fBntpd\fR, the \fBtos mindist\fR command can be used to set a limit with similar purpose globally for all time sources. @@ -209,7 +209,7 @@ Specify the path to the \fBphc2sys\fR binary. The default value is .TP .B options Specify extra options that should be added to all \fBphc2sys\fR command lines. -By default, \fB-l 5\fR is added to the command lines. +By default, \fB\-l 5\fR is added to the command lines. .SS [ptp4l] @@ -221,7 +221,7 @@ search for the binary in \fBPATH\fR. .TP .B options Specify extra options that should be added to all \fBptp4l\fR command lines. By -default, \fB-l 5\fR is added to the command lines. +default, \fB\-l 5\fR is added to the command lines. .SS [ptp4l.conf] Settings specified in this section are copied directly to the configuration @@ -288,8 +288,8 @@ iburst 1 [ptp_domain 0] interfaces eth0 eth1 ntp_poll 0 -phc2sys_poll -2 -delay 10e-6 +phc2sys_poll \-2 +delay 10e\-6 ptp4l_option clock_servo linreg ptp4l_option delay_mechanism P2P @@ -309,7 +309,7 @@ driftfile /var/lib/chrony/drift [ntpd] path /usr/sbin/ntpd -options -u ntp:ntp +options \-u ntp:ntp [ntp.conf] restrict default nomodify notrap nopeer noquery @@ -319,7 +319,7 @@ driftfile /var/lib/ntp/drift [phc2sys] path /usr/sbin/phc2sys -options -l 5 +options \-l 5 [ptp4l] path /usr/sbin/ptp4l -- 2.1.4
signature.asc
Description: OpenPGP digital signature
------------------------------------------------------------------------------
_______________________________________________ Linuxptp-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linuxptp-users
