[ntpsec commit] Documentation polishing.

[Eric S. Raymond]

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

Author:    Eric S. Raymond <esr at thyrsus.com>
Date:      Wed Oct 14 08:14:36 2015 -0400

Documentation polishing.

---

 NEWS            | 9 +++++++++
 README          | 8 ++++++--
 docs/index.txt  | 6 ++++--
 ntpfrob/wscript | 2 +-
 4 files changed, 20 insertions(+), 5 deletions(-)

diff --git a/NEWS b/NEWS
new file mode 100644
index 0000000..44b1efc
--- /dev/null
+++ b/NEWS
@@ -0,0 +1,9 @@
+= NTPsec project news =
+
+For historic news from NTP Classic, see devel-docs/TODO.
+
+Much of the traditional function of a news file is now better addressed
+by browsing the comments in the revision history.  This file will focus
+on user-visible changes.
+
+// end
diff --git a/README b/README
index 922b08f..659da5f 100644
--- a/README
+++ b/README
@@ -1,8 +1,7 @@
 = The NTPsec distribution base directory =
 
 This directory and its subdirectories contain NTPSec, a
-security-hardened implementation of Network Time Protocol Version 4
-(NTP) for Unix systems.
+security-hardened implementation of Network Time Protocol Version 4.
 
 The contents of the base directory are given in this file. The contents of
 subdirectories are usually given in the README files in each subdirectory.
@@ -58,6 +57,11 @@ ntpdate/::	Directory containing sources for a program to set the
 		local machine time from one or more remote machines
 		running NTP.  Operates like rdate, but much more accurate.
 
+ntpfrob::       The ntpfrob utility collects several small diagnostic
+		functions for reading and tweaking the local clock
+		hardware, including reading the clock tick rate,
+		precision, and jitter.
+
 ntpkeygen::
 		Directory containing the utility program used to generate
 		NTP authentication keys.
diff --git a/docs/index.txt b/docs/index.txt
index 226eb66..8f444be 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -82,10 +82,12 @@ few will be user-visible:
 
 * The deprecated ntpdc utility, long since replaced by {ntpq}, has been removed.
 
-* The `tickadj` utility has been renamed `ntptickadj`.
-
 * A number of obsolete refclocks have been removed.
 
+* A new utility, {ntpfrob}, collects several small diagnostic functions
+  for reading and tweaking the local clock hardware, including reading
+  the clock tick rate, precision, and jitter. 
+
 * The sntp program has been renamed {ntpdig} in order to make
   NTP installables have a uniform name prefix and take up less
   namespace. Also, `ntp-keygen` is now {ntpkeygen} and `ntp-wait`
diff --git a/ntpfrob/wscript b/ntpfrob/wscript
index 26148b8..58cb117 100644
--- a/ntpfrob/wscript
+++ b/ntpfrob/wscript
@@ -6,7 +6,7 @@ def build(ctx):
 
 	frob_sources = ['main.c', 'jitter.c', 'precision.c', 'stepback.c']
 
-	# FIXME: These guards do not currebtly work
+	# FIXME: These guards do not currently work
 	if ctx.get_define("HAVE_SYS_TIMEPPS_H"):
 		frob_sources += ["pps-api.c"]