[Git][NTPsec/ntpsec][master] Documentation polishing.

[Eric S. Raymond]

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


Commits:
4f15ccde by Eric S. Raymond at 2019-02-04T10:21:22Z
Documentation polishing.

- - - - -


2 changed files:

- docs/driver_modem.adoc
- docs/refclock.adoc


Changes:

=====================================
docs/driver_modem.adoc
=====================================
@@ -12,7 +12,7 @@ Requires: a dial-out device.
 
 == Warning ==
 
-The ACTS mode of this driver reports only two-digit years, and is thus
+The ACTS and USNO modes of this driver report only two-digit years, and is thus
 reliant on the system clock to be near correct before samples will be
 processed properly. You will not be able to use it to run
 autonomously, nor will it reliably recover from a trashed or zeroed
@@ -28,14 +28,15 @@ clock correction. It is designed primarily for backup when neither a
 radio clock nor connectivity to Internet time servers are available. It
 can also be configured to operate full period.
 
-For best results the indicated time must be corrected for the modem and
-telephone circuit propagation delays, which can reach 200 ms or more.
-For the NIST service, corrections are determined automatically by
-measuring the roundtrip delay of echoed characters. With this service,
-the absolute accuracy is typically a millisecond or two. Determining corrections for
-the other services must be by other means. With these
-services variations from call to call and between messages during a call
-are typically a few milliseconds, occasionally higher.
+For best results the indicated time must be corrected for the modem
+and telephone circuit propagation delays, which can reach 200 ms or
+more.  For the NIST service, corrections are determined automatically
+by measuring the roundtrip delay of echoed characters. With this
+service, the absolute accuracy is typically a millisecond or
+two. Determining corrections for the other services must be by other
+means. With these services variations from call to call and between
+messages during a call 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.


=====================================
docs/refclock.adoc
=====================================
@@ -162,22 +162,22 @@ the 6021 in the generic parse driver.
 [cols="15%,5%,80%",options="header"]
 |====================================================================
 | Name                                  | Flags | Driver
-|link:driver_local.html[local]          | - | Undisciplined Local Clock
-|link:driver_spectracom.html[spectracom]| D | Generic Spectracom Receivers
-|link:driver_truetime.html[truetime]    | D | TrueTime GPS/GOES Receivers
-|link:driver_generic.html[generic]      | T | Generic Reference Driver (Parse)
-|link:driver_arbiter.html[arbiter]      | D | Arbiter 1088A/B GPS Receiver
-|link:driver_modem.html[modem]          | - | NIST/USNO/PTB Modem Time Services
-|link:driver_nmea.html[nmea]            | T | Generic NMEA GPS Receiver
-|link:driver_pps.html[pps]              | T | PPS Clock Discipline
-|link:driver_hpgps.html[hpgps]          | T | Hewlett Packard GPS Receivers
-|link:driver_shm.html[shm]              | T | Shared Memory Driver
-|link:driver_trimble.html[trimble]      | D | Trimble Palisade/Thunderbolt/Acutime GPSes
-|link:driver_oncore.html[oncore]        | D | Motorola UT Oncore GPS
-|link:driver_jjy.html[jjy]              | T | JJY Receivers
-|link:driver_zyfer.html[zyfer]          | - | Zyfer GPStarplus Receiver
-|link:driver_neoclock.html[neoclock]    | D | NeoClock4X DCF77 / TDF Receiver
-|link:driver_gpsd.html[gpsd]            | T | GPSD client protocol
+|link:driver_local.html[local]          | -  | Undisciplined Local Clock
+|link:driver_spectracom.html[spectracom]| D2 | Generic Spectracom Receivers
+|link:driver_truetime.html[truetime]    | D2 | TrueTime GPS/GOES Receivers
+|link:driver_generic.html[generic]      | T  | Generic Reference Driver (Parse)
+|link:driver_arbiter.html[arbiter]      | D2 | Arbiter 1088A/B GPS Receiver
+|link:driver_modem.html[modem]          | -  | NIST/USNO/PTB Modem Time Services
+|link:driver_nmea.html[nmea]            | T  | Generic NMEA GPS Receiver
+|link:driver_pps.html[pps]              | T  | PPS Clock Discipline
+|link:driver_hpgps.html[hpgps]          | T  | Hewlett Packard GPS Receivers
+|link:driver_shm.html[shm]              | T  | Shared Memory Driver
+|link:driver_trimble.html[trimble]      | D  | Trimble Palisade/Thunderbolt/Acutime GPSes
+|link:driver_oncore.html[oncore]        | D2 | Motorola UT Oncore GPS
+|link:driver_jjy.html[jjy]              | T  | JJY Receivers
+|link:driver_zyfer.html[zyfer]          | -  | Zyfer GPStarplus Receiver
+|link:driver_neoclock.html[neoclock]    | D2 | NeoClock4X DCF77 / TDF Receiver
+|link:driver_gpsd.html[gpsd]            | T  | GPSD client protocol
 |====================================================================
 
 The name in the left column is the driver type to be used in the
@@ -190,6 +190,7 @@ The flags field should be interpreted as follows:
 |Flag| Meaning
 | D | Deprecated.  May be removed in a future release
 | T | Regularly tested by an active maintainer (some devices/modes)
+| 2 | Returns only 2-digit years. Relies on system clock for century.
 |====================================================================
 
 '''''



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/4f15ccde53e51ad649385e0a9e383f513f309401

-- 
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/4f15ccde53e51ad649385e0a9e383f513f309401
You're receiving this email because of your account on gitlab.com.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20190204/d594e51a/attachment-0001.html>