[Git][NTPsec/ntpsec][master] 4 commits: *Really* sync docs with code this time.

[Eric S. Raymond]

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


Commits:
e9c51c62 by Eric S. Raymond at 2019-03-04T21:19:21Z
*Really* sync docs with code this time.

- - - - -
53a95ef3 by Eric S. Raymond at 2019-03-04T21:19:21Z
Text polishing.

- - - - -
cbede7f1 by Eric S. Raymond at 2019-03-04T21:19:21Z
Add Hal's second description of the refclock code.

- - - - -
c21d9bad by Eric S. Raymond at 2019-03-04T21:19:21Z
Typo fix.

- - - - -


3 changed files:

- devel/tour.adoc
- docs/history.adoc
- docs/includes/auth-commands.adoc


Changes:

=====================================
devel/tour.adoc
=====================================
@@ -408,6 +408,18 @@ The process everything step sorts the contents of the FIFO, then discards
 outliers, roughly 1/3 of the samples, and then figures out the average and
 injects that into the peer buffer for the refclock.
 
+Another way of looking at it: there are two parts to the refclock code.
+
+The first operates on the second time scale.  The main thread calls the 
+refclock receive routine when a "packet" arrives over the serial port and/or 
+the timer routine every second so it can poll SHM and cleanup of the serial 
+port gets unplugged.  That level of code puts samples into a FIFO.
+ 
+The other is at the poll-interval level,16 seconds to 64 seconds.  That takes 
+data out of the FIFO, discards outliers, averages, and injects a sample into 
+the normal NTP processing pipeline where it shows up as a 1 bit in the peers 
+reach mask.  (or a 0 if there weren't any good samples)
+
 == Asynchronous DNS lookup
 
 The DNS code runs in a separate thread to avoid stalling


=====================================
docs/history.adoc
=====================================
@@ -5,7 +5,7 @@
 The first NTP implementation started around 1980 with an accuracy of
 only several hundred milliseconds. That very first implementation was
 documented in Internet Engineering Note
-https://www.rfc-editor.org/ien/ien175.txt[IEN-173]. Later the first
+https://www.rfc-editor.org/ien/ien173.txt[IEN-173]. Later the first
 specification appeared in
 https://www.rfc-editor.org/rfc/rfc778.txt[RFC 778], but it was still
 named Internet Clock Service. At that time clock synchronization was


=====================================
docs/includes/auth-commands.adoc
=====================================
@@ -59,13 +59,15 @@ The options are as follows:
 
 +mintls+ _string_::
   Set the lowest allowable TLS version to negotiate. Will be useful in
-  the wake of a TLS compromise.  Reasonable values are _"1.2"_ and
-  _"1.3"_ if your system supports it.  1.3 was first supported in
+  the wake of a TLS compromise.  Reasonable values are _"TLS1.2"_ and
+  _"TLS1.3"_ if your system supports it (those string quotes need to
+  be part of the literal in the configuration file).  1.3 was first supported in
   OpenSSL version 1.1.1.
 
 +maxtls+ _string_::
   Set the highest allowable TLS version to negotiate. By setting
-  +mintls+ and +maxtls+ equal, you can force the TLS version for testing.
+  +mintls+ and +maxtls+ equal, you can force the TLS version for
+  testing. Format is as for +mintls+.
 
 // https://crypto.stackexchange.com/questions/8964/sending-tls-messages-with-out-encryption-using-openssl-code
 +tlsciphers+ _string_::



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/compare/f9c198d8ace2a9ae13ce58ca02cb578d0ebe5dc1...c21d9bad6bb84a762a5e67bb7ed800c4588084d1

-- 
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/compare/f9c198d8ace2a9ae13ce58ca02cb578d0ebe5dc1...c21d9bad6bb84a762a5e67bb7ed800c4588084d1
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/20190304/191300ef/attachment-0001.html>