[ntpsec commit] Documentation polishing.

Mon Oct 5 17:54:55 UTC 2015

Module:    ntpsec
Branch:    master
Commit:    45f9ac9768d09c81ba5776e37578745c2c3fa668
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=45f9ac9768d09c81ba5776e37578745c2c3fa668

Author:    Eric S. Raymond <esr at thyrsus.com>
Date:      Mon Oct  5 13:53:51 2015 -0400

Documentation polishing.

---

 devel-docs/hacking.txt |  2 +-
 docs/sntp-body.txt     |  2 +-
 include/README         |  2 +-
 ntpd/ntp.conf.txt      |  2 +-
 ntpd/refclock_arc.c    | 11 +++--------
 ntpq/README            |  4 ++--
 scripts/README         | 11 +++++++----
 7 files changed, 16 insertions(+), 18 deletions(-)

diff --git a/devel-docs/hacking.txt b/devel-docs/hacking.txt
index bbbd354..cd3dd40 100644
--- a/devel-docs/hacking.txt
+++ b/devel-docs/hacking.txt
@@ -52,7 +52,7 @@ cause buffer overruns and (all too often) exploitable security holes:
 * gmtime(), localtime(), asctime(), ctime(): use the reentrant *_r variants.
 * tmpnam() - use mkstemp() or tmpfile() instead.
 
-In general, avoid functions that are non-reentrant.  When in doubtm see
+In general, avoid functions that are non-reentrant.  When in doubt, see
 http://www.unix.org/whitepapers/reentrant.html[Thread-safety and POSIX.1]
 
 === Conventions for #ifdef guard names ===
diff --git a/docs/sntp-body.txt b/docs/sntp-body.txt
index 82b3691..89f05e4 100644
--- a/docs/sntp-body.txt
+++ b/docs/sntp-body.txt
@@ -41,7 +41,7 @@ displayed. Otherwise, only the _IP_ is displayed. Finally, the
 _stratum_ of the host is reported and the leap indicator is decoded
 and displayed.
 
-= OPTIONS
+== OPTIONS ==
 
 //`-?, --help`::
 //  displays usage information. The short form typically requires shell
diff --git a/include/README b/include/README
index 5d818dc..b1d654c 100644
--- a/include/README
+++ b/include/README
@@ -1,4 +1,4 @@
-README file for directory ./include of the NTP Version 4 distribution
+= README file for directory include =
 
 This directory contains the include files used by most programs in this
 distribution.
diff --git a/ntpd/ntp.conf.txt b/ntpd/ntp.conf.txt
index d660fb3..b4bc34c 100644
--- a/ntpd/ntp.conf.txt
+++ b/ntpd/ntp.conf.txt
@@ -1289,7 +1289,7 @@ collecting all servers in scope.
 
 == Reference Clock Support ==
 
-The NTP Version 4 daemon supports some two dozen different radio,
+The NTP daemon supports some two dozen different radio,
 satellite and modem reference clocks plus a special pseudo-clock used
 for backup or when no other clock source is available. Detailed
 descriptions of individual device drivers and options can be found in
diff --git a/ntpd/refclock_arc.c b/ntpd/refclock_arc.c
index fc02d11..fdabb32 100644
--- a/ntpd/refclock_arc.c
+++ b/ntpd/refclock_arc.c
@@ -226,22 +226,17 @@ GENERAL
     MSF---thus we should never end up syncing to completely the wrong
     time.
 
- 8) If the flag ARCRON_OWN_FILTER is defined, use own versions of
-    refclock median-filter routines to get round small bug in 3-5.90
-    code which does not return the median offset. XXX Removed this
-    bit due NTP Version 4 upgrade - dlm.
-
- 9) We would appear to have a year-2000 problem with this clock since
+ 8) We would appear to have a year-2000 problem with this clock since
     it returns only the two least-significant digits of the year.  But
     ntpd ignores the year and uses the local-system year instead, so
     this is in fact not a problem.  Nevertheless, we attempt to do a
     sensible thing with the dates, wrapping them into a 100-year
     window.
 
- 10)Logs stats information that can be used by Derek's Tcl/Tk utility
+ 9) Logs stats information that can be used by Derek's Tcl/Tk utility
     to show the status of the clock.
 
- 11)The clock documentation insists that the number of bits per
+ 10)The clock documentation insists that the number of bits per
     character to be sent to the clock, and sent by it, is 11, including
     one start bit and two stop bits.  The data format is either 7+even
     or 8+none.
diff --git a/ntpq/README b/ntpq/README
index d280f74..943bd89 100644
--- a/ntpq/README
+++ b/ntpq/README
@@ -1,6 +1,6 @@
-README file for directory ./ntpq of the NTP Version 4 distribution
+= README file for directory ntpq =
 
 This directory contains the sources for the ntpq utility program. See
-the README and RELNOTES files in the parent directory for directions on
+the README and INSTALL files in the parent directory for directions on
 how to make and install this program. The current version number of this
 program is in the version.c file.
diff --git a/scripts/README b/scripts/README
index fa5c961..41ed17e 100644
--- a/scripts/README
+++ b/scripts/README
@@ -5,11 +5,12 @@ monitoring and support of NTP installations.
 
 calc_tickadj::	Calculates "optimal" value for tick given ntp.drift file
 
+lib::		NTP interface package required to query Mode 6 packets
+		from the daemon.
+
 monitoring::	Directory containing perl scripts useful for monitoring
                 operations
 
-rc1, rc2::	start/stop scripts for NTP
-
 ntp-wait::	Blocks until ntpd is in state 4 (synchronized).
 		Useful at boot time, to delay the boot sequence
 		until after "ntpd -g" has set the time.
@@ -25,6 +26,10 @@ ntptrace::	Directory containing sources for a utility program that
 
 ntpver::	Simple script using ntpq to print out the suite version.
 
+plot_summary::	Plot summaries generated by summary script.
+
+rc1, rc2::	start/stop scripts for NTP
+
 stats::		directory containing awk and shell scripts useful for
 		maintaining statistics summaries of clockstats, loopstats
 		and peerstats files
@@ -32,8 +37,6 @@ stats::		directory containing awk and shell scripts useful for
 summary::	Generate summary files out of stat files produced by NTP
                 daemon.
 
-plot_summary::	Plot summaries generated by summary script.
-
 t::		Tests for the scripts.
 
 // end

