[Git][NTPsec/ntpsec][master] Documentation of what units are represented by certain variables

[Ian Bruene]

Ian Bruene pushed to branch master at NTPsec / ntpsec


Commits:
b4b6cace by Ian Bruene at 2017-03-23T17:54:47-05:00
Documentation of what units are represented by certain variables

- - - - -


1 changed file:

- + devel/units.txt


Changes:

=====================================
devel/units.txt
=====================================
--- /dev/null
+++ b/devel/units.txt
@@ -0,0 +1,50 @@
+This document is a list of the important time variables and what units they represent in various areas throughout the program.
+
+System Variables
+
+Name                  | internal  | mode 6
+=================================================
+leap                  | seconds   | seconds (* presumed seconds)
+precision             | UNKNOWN   | UNKNOWN
+rootdelay             | seconds   | milliseconds
+rootdisp              | seconds   | milliseconds
+offset                | seconds   | milliseconds
+frequency (aka drift) | seconds/s | microseconds/s (aka ppm)
+sys_jitter            | seconds   | milliseconds
+clk_jitter            | seconds   | milliseconds
+clk_wander            | seconds/s | microseconds/s
+leapsmearinterval     | UNKNOWN   | UNKNOWN
+leapsmearoffset       | seconds   | milliseconds
+mintc (aka CR_RATE)   | UNKNOWN   | UNKNOWN
+authdelay             | seconds   | milliseconds
+koffset               | seconds   | milliseconds
+kmaxerr               | seconds   | milliseconds
+kesterr               | seconds   | milliseconds
+kprecis               | seconds   | milliseconds
+kppsjitter            | seconds   | milliseconds
+fuzz                  | seconds   | milliseconds
+clk_wander_threshold  | seconds   | microseconds
+tick                  | seconds   | milliseconds
+
+
+Peer Variables
+
+Name       | internal | mode 6
+=====================================
+in         | seconds  | milliseconds
+out        | seconds  | milliseconds
+rootdelay  | seconds  | milliseconds
+rootdisp   | seconds  | milliseconds
+bias       | seconds  | milliseconds
+delay      | seconds  | milliseconds
+offset     | seconds  | milliseconds
+jitter     | seconds  | milliseconds
+dispersion | seconds  | milliseconds
+
+
+Clock Variables
+
+Name       | internal | mode 6
+====================================
+fudgetime1 | seconds  | milliseconds
+fudgetime2 | seconds  | milliseconds



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/b4b6cace634e5f1998d284774439c885dcc10ee6
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20170323/d6f520f7/attachment.html>