[Git][NTPsec/ntpsec][master] Revise documentation of refid codes.

[Eric S. Raymond]

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


Commits:
19a17169 by Eric S. Raymond at 2019-03-01T19:19:08Z
Revise documentation of refid codes.

- - - - -


4 changed files:

- docs/decode.adoc
- docs/includes/ntpmon-body.adoc
- docs/includes/ntpq-body.adoc
- docs/standards.adoc


Changes:

=====================================
docs/decode.adoc
=====================================
@@ -92,7 +92,7 @@ follows:
 | +4+   | +sync_uhf_radio+ | VHF/UHF radio/satellite (GPS, Galileo, etc.)
 | +5+   | +sync_local+     | local timecode (IRIG, LOCAL driver, etc.)
 | +6+   | +sync_ntp+       | NTP
-| +7+   | +sync_other+     | other (IEEE 1588, openntp, crony, etc.)
+| +7+   | +sync_other+     | other (IEEE 1588, openntp, chrony, etc.)
 | +8+   | +sync_wristwatch+| eyeball and wristwatch
 | +9+   | +sync_telephone+ | telephone modem (ACTS, PTB, etc.)
 |=============================================================================
@@ -145,7 +145,7 @@ Field is listed in the following table:
 [width="70%",cols=">10%,<30%,<60%",]
 |==============================================================
 | Code | Message   | Description
-| +08+ | +bcst+    | broadcast association
+| +08+ | +bcst+    | broadcast association (not implemented in NTPsec)
 | +10+ | +reach+   | host reachable
 | +20+ | +auth+    | authentication ok
 | +40+ | +authenb+ | authentication enabled
@@ -159,7 +159,7 @@ the following table gives the corresponding tally codes used in the
 [width="70%",cols=">10%,<25%,^10%,<55%",]
 |============================================================================
 | Code| Message         | T   | Description
-| +0+ | +sel_reject+    |     | discarded as not valid (TEST10-TEST13)
+| +0+ | +sel_reject+    |     | discarded as not valid (BOGON10-BOGON13)
 | +1+ | +sel_falsetick+ | +x+ | discarded by intersection algorithm
 | +2+ | +sel_excess+    | +.+ | discarded by table overflow (not used)
 | +3+ | +sel_outlier+   | +-+ | discarded by the cluster algorithm
@@ -250,25 +250,24 @@ The "Tag" field is the name the source code uses for the status bit.
 Not all bits are in use, but have been kept for backwards compatibility.
 
 [[kiss]]
-== Kiss Codes
+== Refid codes
 
-Kiss codes are used in kiss-o'-death (KoD) packets, billboard displays
-and log messages. They consist of a string of four zero-padded ASCII
+Refid codes are used in kiss-o'-death (KoD) packets, the reference
+identifier field in +ntpq+ and +ntpmon+ billboard displays and log
+messages. They consist of a string of four zero-padded ASCII
 characters. In practice they are informal and tend to change with time
-and implementation. Some of these codes can appear in the reference
-identifier field in +ntpq+ billboards. Following is the current list:
+and implementation.  Following is the current list:
 
 [width="50%",cols=">20%,<80%"]
 |==================================================================
 | Code   | Description
-| +ACST+ | manycast server
-| +AUTH+ | authentication error
-| +BCST+ | broadcast server
 | +DENY+ | access denied by server
 | +INIT+ | association initialized
 | +RATE+ | rate exceeded
 | +TIME+ | association timeout
 | +STEP+ | step time change
+| +DNS+  | DNS lookup in progress
+| +NTS+  | NTS key exchange in progress
 |==================================================================
 
 include::includes/footer.adoc[]


=====================================
docs/includes/ntpmon-body.adoc
=====================================
@@ -43,6 +43,9 @@ And the MRU list in the bottom window:
 
 include::mrufmt.adoc[]
 
+The refid field is as described under "Event Messages and Status
+Words" in the NTP documentation on the Web.
+
 == Commands
 
 a:: Change peer display to apeers mode, showing association IDs.


=====================================
docs/includes/ntpq-body.adoc
=====================================
@@ -82,6 +82,8 @@ read interactive format commands from the standard input.
 +-p+, +--peers+::
   Print a list of the peers known to the server as well as a summary of
   their state; this is equivalent to the +peers+ interactive command.
+  The refid field is as described under "Event Messages and Status
+  Words" in the NTP documentation on the Web.
 +-k+ filename, +--keyfile+=filename::
   Specify a keyfile. ntpq will look in this file for the key specified
   with -a.


=====================================
docs/standards.adoc
=====================================
@@ -65,8 +65,10 @@ and somewhat incomplete relative to the code.
 
 In the table of KISS codes (Figure 13), only RATE still exists and is
 implemented in NTPsec; others proved unnecessary or (in the cases of
-DENY and RSTR) outright dangerous. INIT and STEP are no lonkrt KoD types
-but persist as peer statuses that may be reported by {ntpqman}/{ntpmon}.
+DENY and RSTR) outright dangerous. INIT and STEP are no longer KoD types
+but persist as peer statuses that may be reported by
+{ntpqman}/{ntpmon}.  NTPsec has additional codes DNS and NTS for
+preparatory phases in association setup.
 
 The continuing relevance of much of Appendix A is doubtful.
 



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/19a171696a0be7e364d2bb4b77f858eb1792ba35

-- 
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/19a171696a0be7e364d2bb4b77f858eb1792ba35
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/20190301/bc76a4fa/attachment-0001.html>