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

[Eric S. Raymond]

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


Commits:
a3bbd7b3 by Eric S. Raymond at 2016-11-13T17:21:53-05:00
Documentation polishing.

- - - - -


2 changed files:

- devel/testing.txt
- docs/mode6.txt


Changes:

=====================================
devel/testing.txt
=====================================
--- a/devel/testing.txt
+++ b/devel/testing.txt
@@ -23,7 +23,7 @@ functions.  If you can't load that library, you can't test effectively.
 The waf build is supposed to create a symbolic link from ntpq/ntp to
 pylib in the build directory. This should enable ntpq to "import ntp"
 before you install to rootspace. If that link is not created or
-dpesn't point to pylib/ under your build directory, report
+doesn't point to pylib/ under your build directory, report
 this as a bug. If it is, but ./ntpq startup fails anyway, you may
 have a mis-configured Python and need to investigate that.
 


=====================================
docs/mode6.txt
=====================================
--- a/docs/mode6.txt
+++ b/docs/mode6.txt
@@ -37,8 +37,8 @@ written.
 
 The protocol uses UDP packets transmitted and received over port 123.
 They use the same structure (header, plus extension, plus optional
-MAC) as time synchronization messages, but the semantics of the header
-fields are different.  They are distinguished from time
+MAC) as time synchronization messages, but the layout and semantics of
+the header fields are different.  They are distinguished from time
 synchronization packets by their Mode field, which has the value 6
 (0110).
 
@@ -91,13 +91,13 @@ reassembling the payloads.
 [[varlists]]
 == Variable-Value Lists ==
 
-Several requests and responses use a common textual payload format
-consisting of a comma-separated list of items.  An item may be
-textual (ASCII) variable name, or a textual variable name followed by
-an equals sign followed by a textual value. Following any comma
-the format may insert a newline; these are not significant to the
-meaning of the payload, but are placed so that if the payload is
-dumped to an 80-character terminal window the lines will be folded
+Several requests and responses (in fact, all but one) use a common
+textual payload format consisting of a comma-separated list of items.
+An item may be textual (ASCII) variable name, or a textual variable
+name followed by an equals sign followed by a textual value. Following
+any comma the format may insert a newline; these are not significant
+to the meaning of the payload, but are placed so that if the payload
+is dumped to an 80-character terminal window the lines will be folded
 in a way convenient for visibility.
 
 Values may be decimal numeric literals, decimal float literals, hex
@@ -350,7 +350,8 @@ rs.#::		restriction mask (RES_* bits)
 The client should accept the values in any order, and ignore .#
 values which it does not understand, to allow a smooth path to
 future changes without requiring a new opcode.  To ensure this,
-ntpd occasionally issues a randomly-generated tag=value pair.
+ntpd occasionally issues a randomly-generated tag=value pair. All
+such noise tags are three letters long.
 
 Clients can rely on all *.0 values preceding any *.1 values, that is
 all values for a given index number are together in the response.
@@ -489,8 +490,9 @@ The contents of the MAC trailer consists of:
 First, the password entered to use the signing key, then the request
 header fields, then the payload.
 
-The cryptographic hash is normally MD5, but if ntpd is built with
-OpenSSL support it is possible to use and generate SHA1 keys as well.
+The cryptographic hash is normally 16 octets of MD5 hash, but if ntpd
+is built with OpenSSL support it is possible to use and generate
+20-octet-long SHA1 keys as well.
 
 == Known bugs ==
 



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/a3bbd7b366f62ddcdaacf1dd58080af96c7f0b25
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20161113/03bd4e9b/attachment.html>