[Git][NTPsec/ntpsec][master] Address GitLab issue #241: two copies of the documentation...
Eric S. Raymond
gitlab at mg.gitlab.com
Tue Feb 21 14:13:06 UTC 2017
Eric S. Raymond pushed to branch master at NTPsec / ntpsec
Commits:
67b446db by Eric S. Raymond at 2017-02-21T09:11:20-05:00
Address GitLab issue #241: two copies of the documentation...
...for the statistics files. Eliminate that duplication, merging
the useful bits.
- - - - -
4 changed files:
- docs/includes/mon-commands.txt
- docs/includes/special.txt
- docs/monopt.txt
- − docs/statfiles.txt
Changes:
=====================================
docs/includes/mon-commands.txt
=====================================
--- a/docs/includes/mon-commands.txt
+++ b/docs/includes/mon-commands.txt
@@ -11,13 +11,22 @@
form to the file generation set named _clockstats_:
+
-----------------------------------------------
-49213 525.624 SPECTRACOM(4) 93 226 00:08:29.606 D
+49213 525.624 SPECTRACOM(1) 93 226 00:08:29.606
-----------------------------------------------
+
+[width="100%",cols="<34%,<33%,<33%"]
+|====================================================================
+|Item |Units |Description
+|49213 |MJD |modified Julian day number
+|525.624 |s |time of day (s) past midnight UTC
+|SPECTRACOM(1) | |receiver identifier (Spectracom unit 1)
+|93 226 00:08:29.606 | |timecode (format varies by refclock)
+|====================================================================
+
The first two fields show the date (Modified Julian Day) and time
-(seconds and fraction past UTC midnight). The next field shows the
+(seconds and fraction past UTC midnight). The next
normally shows clock type and unit (but if you are running in strict
-Classic compatibility it will show the magic clock address in
+Classic compatibility mode it will show the magic clock address in
dotted-quad notation). The final field last timecode received from the
clock in decoded ASCII format, where meaningful. In some clock drivers
a good deal of additional information can be gathered and displayed as
@@ -87,12 +96,12 @@ The event message code and _message_ field are described on the
|Item |Units |Description
|+48773+ |MJD |date
|+10847.650+ |s |time past midnight
-|+SPECTRACOM(4)+ |IP |clock name(unit) or source address
+|+SPECTRACOM(4)+ | |clock name (unit) or source address
|+9714+ |hex |status word
|+-0.001605376+ |s |clock offset
|+0.000000000+ |s |roundtrip delay
|+0.001424877+ |s |dispersion
-|+0.000958674+ |s |RMS jitter
+|+0.000958674+ |s |RMS jitter
|===================================================
+
The first two fields show the date (Modified Julian Day) and time
=====================================
docs/includes/special.txt
=====================================
--- a/docs/includes/special.txt
+++ b/docs/includes/special.txt
@@ -6,7 +6,6 @@
* link:filter.html[Clock Filter Algorithm]
* link:select.html[Clock Select Algorithm]
* link:cluster.html[Clock Cluster Algorithm]
-* link:statfiles.html[Statistics File Formats]
* link:discipline.html[Clock Discipline Algorithm]
* link:poll.html[Poll Process]
* link:clock.html[Clock State Machine]
=====================================
docs/monopt.txt
=====================================
--- a/docs/monopt.txt
+++ b/docs/monopt.txt
@@ -43,10 +43,8 @@ _suffix_::
A string of elements beginning with . (dot) followed by a number of
elements depending on the file set type.
-For more details on the format of statistics files, see
-link:statfiles.html[Statistics file formats]. There is a
-visualization tool, link:ntpviz.html[ntpviz], which assists
-in making sense of these.
+There is a visualization tool, link:ntpviz.html[ntpviz], which assists
+in making sense of statistics files.
[[cmd]]
== Monitoring Commands and Options ==
=====================================
docs/statfiles.txt deleted
=====================================
--- a/docs/statfiles.txt
+++ /dev/null
@@ -1,89 +0,0 @@
-= Statistics file formats =
-
-The ntpd daemon can produce a variety of statistics files which are
-useful for maintenance, evaluation and retrospective calibration
-purposes. See the ntpd man page for instructions on how to configure
-this feature. There are four file collections presently defined:
-clockstats, loopstats, peerstats and temps, each of which is described
-in this note.
-
-Note: The NTPsec versions of these formats differ in that clock IDs
-consist of a string drivername followed by unit number in parentheses
-rather than the magic IP addresses used in NTP Classic. The code can
-be built in a Classic compatibility node that restores the old behavior.
-
-The temps file is unique to NTPsec.
-
-== clockstats ==
-
-A line in this file is produced at each valid update received from a
-refclock configured to append to it. The first part of each data line
-is similar for all radios.
-
-----------------------------------------------------------------------------
- 49234 60517.826 SPECTRACOM(1) 93 247 16:48:21.814
-
- 49234 modified Julian day number
- 60517.826 time of day (s) past midnight UTC
- SPECTRACOM(1) receiver identifier (Spectracom unit 1)
- 93 247 16:48:21.814 timecode (format varies by refclock)
-----------------------------------------------------------------------------
-
-== loopstats ==
-
-The following data are collected in the loopstats files. A line in the file
-is produced at each valid update of the local clock.
-
-----------------------------------------------------------------------------
- 49236 11.897 -0.000004 -35.9384 0.000003815 0.000805 0
-
- 49236 modified Julian day number
- 11.897 time of day (s) past midnight UTC
- -0.000004 time offset (s)
- -35.9384 frequency offset (ppm)
- 0.000003815 jitter
- 0.000805 wander (ppm)
- 0 phase-lock loop time constant
-----------------------------------------------------------------------------
-
-== peerstats ==
-
-The following data are collected in the peerstats files. A line in the file
-is produced upon reception of each valid update from a configured peer.
-
-----------------------------------------------------------------------------
- 49236 30.756 140.173.96.1 9474 0.000603 0.37532
-
- 49236 modified Julian day number
- 30.756 time of day (s) past midnight UTC
- 140.173.96.1 peer identifier (IP address or receiver identifier)
- 9474 peer status word (hex) (see NTP specification)
- 0.000603 offset (s)
- 0.08929 delay (s)
- 0.37532 dispersion (s)
-----------------------------------------------------------------------------
-
-== temps ==
-
-This file is user generated. The wide range of temperature sensors
-makes it too difficult to make it a standard process. There are
-examples of programs to log data from different temperature sensors in
-the contrib/ directory.
-
-When this file exists, the ntpviz program will graph the data.
-
-Each line in this file is one valid logged temperature. The file can
-contain data from several different thermometers. Each line is tagged
-with the data source symbolic name in field 2.
-
-----------------------------------------------------------------------------
- 1471625701 TEMPER 24.9
-
- 1471625701 Unix time, seconds since the start of the epoch
- TEMPER Name of the temperature source.
- 24.9 Measured temperature in degree Celsius
-----------------------------------------------------------------------------
-
-'''''
-
-include::includes/footer.txt[]
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/67b446dbadf80d35c8d1e3191c3f150515de30e6
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20170221/de2e6592/attachment.html>
More information about the vc
mailing list