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

[Eric S. Raymond]

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


Commits:
9880a232 by Eric S. Raymond at 2016-08-25T16:44:08-04:00
Documentation polishing.

- - - - -


2 changed files:

- devel/hacking.txt
- ntpstats/ntpviz


Changes:

=====================================
devel/hacking.txt
=====================================
--- a/devel/hacking.txt
+++ b/devel/hacking.txt
@@ -177,6 +177,9 @@ in particular, does not qualify - it doesn't have good enough table
 support for our needs.  ReST does, but the hassle costs of supporting
 two different master markups are too high.
 
+If you must use non-ASCII characters, use UTF-8 and not Latin-1 or
+any other encoding.  Best practice is to use XML character entities.
+
 The NTP Classic documentation had a terrible problem with duplicative
 documentation gradually diverging as the duplicates mutated and
 bitrotted. Therefore one of our house rules is to have a *single point


=====================================
ntpstats/ntpviz
=====================================
--- a/ntpstats/ntpviz
+++ b/ntpstats/ntpviz
@@ -570,8 +570,8 @@ period of time.  The majority of this change should come from
 temperature changes (ex: HVAC, the weather, CPU usage causing local
 heating).</p>
 <p>Smaller changes are better.  An ideal clock would be a flat line at 0ppm.</p>
-<p>Expected values: +/- 500ppm</p>
-<p>Expected values of 99%-1% percentiles: within 10ppm</p>
+<p>Expected values: within ±500ppm of 0</p>
+<p>Expected values of 99%-1% percentiles: within 10ppm of 0</p>
 """,
         "local-offset-histogram": """\
 <p>This shows the clock offsets of the local clock as a histogram.  It
@@ -676,7 +676,7 @@ and response and offset all went in the same direction).<p>
 <dt>upstream clock</dt>
 <dd>Any remote clock or reference clock used as a source of time.</dd>
 
-<dt>us, µs, microsecond</dt>
+<dt>µs, us, microsecond</dt>
 <dd>One millionth of a second, and one thousandth of a millisecond,
 0.0000001s.</dd>
 </dl>



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/9880a23298e2b563b698b3f02488a81f4ea86b35
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20160825/4b81e5d7/attachment.html>