[Git][NTPsec/ntpsec][master] Improve the documentation of the acts driver.

[Eric S. Raymond]

Eric S. Raymond pushed to branch master at NTPsec / ntpsec


Commits:
6ecf6c2d by Eric S. Raymond at 2016-10-11T08:59:00-04:00
Improve the documentation of the acts driver.

- - - - -


2 changed files:

- docs/driver_acts.txt
- ntpd/refclock_acts.c


Changes:

=====================================
docs/driver_acts.txt
=====================================
--- a/docs/driver_acts.txt
+++ b/docs/driver_acts.txt
@@ -30,9 +30,11 @@ are typically a few milliseconds, occasionally higher.
 
 This driver requires a 9600-bps modem with a Hayes-compatible command
 set and control over the modem data terminal ready (DTR) control line.
-The actual line speed ranges from 1200 bps with USNO to 14,400 bps with
-NIST. The modem setup string is hard-coded in the driver and may require
-changes for nonstandard modems or special circumstances.
+The actual line speed ranges from 1200 bps with USNO to 14,400 bps
+with NIST. The modem setup string is hard-coded in the driver and may
+require changes for nonstandard modems or special circumstances. It
+can be overridden by setting the extended system variable
+"modem_setup" via ntpq.
 
 There are three modes of operation selected by the +mode+ keyword in the
 +server+ configuration command. In manual mode (2) the calling program
@@ -166,8 +168,6 @@ with the Hayes connection and hang-up commands and result codes.
 refclock acts
 ----------------------------------------------------------------------------
 
-The modem-control string is, alas, hardwired into the driver.
-
 == Author ==
 
 David L. Mills <mills at udel.edu>


=====================================
ntpd/refclock_acts.c
=====================================
--- a/ntpd/refclock_acts.c
+++ b/ntpd/refclock_acts.c
@@ -25,10 +25,12 @@
  * use as backup when neither a radio clock nor connectivity to Internet
  * time servers is available.
  *
- * This driver requires a modem with a Hayes-compatible command set and
- * control over the modem data terminal ready (DTR) control line. The
- * modem setup string is hard-coded in the driver and may require
- * changes for nonstandard modems or special circumstances.
+ * This driver requires a modem with a Hayes-compatible command set
+ * and control over the modem data terminal ready (DTR) control
+ * line. The default modem setup string is hard-coded in the driver
+ * and may require changes for nonstandard modems or special
+ * circumstances.  It can be overridden by setting the extended system
+ * variable "modem_setup" via ntpq.
  *
  * When enabled, the calling program dials the first number in the
  * phones file. If that call fails, it dials the second number and
@@ -40,7 +42,7 @@
  * poll interval whether or not other synchronization sources are 
  * present. The calling program disconnects if (a) the called party
  * is busy or does not answer, (b) the called party disconnects
- * before a sufficient nuimber of timecodes have been received. 
+ * before a sufficient number of timecodes have been received. 
  *
  * The driver is transparent to each of the modem time services and
  * Spectracom receivers. It selects the parsing algorithm depending on the



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/6ecf6c2daa1ade977a479d26fd567955df7ca02d
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20161011/febbcf12/attachment.html>