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

[Eric S. Raymond]

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


Commits:
5f0d2e83 by Eric S. Raymond at 2016-08-15T17:34:54-04:00
Documentation polishing.

- - - - -


3 changed files:

- NEWS
- docs/includes/ntpviz-body.txt
- ntpstats/ntpstats.py


Changes:

=====================================
NEWS
=====================================
--- a/NEWS
+++ b/NEWS
@@ -8,6 +8,9 @@ on user-visible changes.
 
 == Repository head ==
 
+A new visualization tool, ntpviz, generates graphical summaries of
+logfile data that can be helpful 
+
 usestats has been added to the statistics collection to record
 system resource usage statistics.
 


=====================================
docs/includes/ntpviz-body.txt
=====================================
--- a/docs/includes/ntpviz-body.txt
+++ b/docs/includes/ntpviz-body.txt
@@ -16,7 +16,9 @@
 
 This utility analyzes files in an NTP log directory and generates
 statistical plots from them.  It can report either PNG images or
-the GNUPLOT programs to generate them to standard output.
+the GNUPLOT programs to generate them to standard output.  In its
+default mode it generates an HTML directory containing all polots
+and an index page.
 
 The most basic option is -d, which specifies a logfile directory to
 examine; the default is /var/log/ntpstats.


=====================================
ntpstats/ntpstats.py
=====================================
--- a/ntpstats/ntpstats.py
+++ b/ntpstats/ntpstats.py
@@ -98,8 +98,9 @@ class NTPStats:
         if key[0].isdigit():
             # TO BE REMOVED SOMEDAY
             # Clock address - only possible if we're looking at a logfile made
-            # by NTP Classic or an NTPsec version before 0.4.  Nasty that we
-            # have to emit a numeric driver type here.
+            # by NTP Classic or an NTPsec version configured with
+            # --enable-classic-mode.  Nasty that we have to emit a numeric
+            # driver type here.
             if key.startswith("127.127."):
                 (_, _, t, u) = key.split(".")
                 return "REFCLOCK(ttype=%s,unit=%s)" % (t, u) 



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/5f0d2e830a7c4bff8732a3d8a7b7b32239db2295
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20160815/596c859e/attachment.html>