[ntpsec commit] Documentation polishing.

[Eric S. Raymond]

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

Author:    Eric S. Raymond <esr at thyrsus.com>
Date:      Wed Sep 30 12:19:21 2015 -0400

Documentation polishing.

---

 devel-docs/TODO | 17 ++++++++++-------
 scripts/README  |  7 +++----
 util/README     |  5 +----
 3 files changed, 14 insertions(+), 15 deletions(-)

diff --git a/devel-docs/TODO b/devel-docs/TODO
index a0c8aa0..c256497 100644
--- a/devel-docs/TODO
+++ b/devel-docs/TODO
@@ -16,21 +16,21 @@ None right now. (Sep-22 2015)
   build + platform information
 
 * scripts/*/*.in and scripts/ntpsweep.in need to be expanded into the
-actual scripts by substituting in @-cookies.  So do all files in the tree
-with extension *.txt.in.
+  actual scripts by substituting in @-cookies.  So do all files in the tree
+  with extension *.txt.in.
 
 * The install production needs to warn of stale ntpdc and ntpdate binaries.
 
-* There are still around 270 conditional symbols in the build that have
+* There are still around 90 conditional symbols in the build that have
   not been audited.
 
 === Code ===
 
 * The u_* types in ntp.h are GCCisms that should be replaced with POSIX types.
 
-* We should audit scripts/ and utils/ to see which of those programs can
-  be thrown out.  Some (such as ntptrace) need to be translated into Python
-  and supported.
+* We should audit scripts/ and utils/ to see which of those programs
+  can be thrown out (some, like util/kern.c, don't even build).  Some
+  (such as ntptrace) need to be translated into Python and supported.
 
 === Porting ===
 
@@ -66,6 +66,9 @@ a file and getting them from other NTP servers.
 * Option testing.  The new, non-autogen option-processing logic
 is not yet tested anywhere but in ntpd itself.
 
+* The script tests in scripts/t should be investigated, perhaps
+  they are salvageable.
+
 === Documentation ===
 
 * man pages outside of docs/ need to be merged with the
@@ -117,7 +120,7 @@ is not yet tested anywhere but in ntpd itself.
 === Remaining procedural issues ===
 
 * The dev changes need to be fed through through Phabricator,
-reviewed, and if necessary fixed.
+  reviewed, and if necessary fixed.
 
 * Version-numbering policy needs to be decided and written up.
 
diff --git a/scripts/README b/scripts/README
index c4e7624..1a36112 100644
--- a/scripts/README
+++ b/scripts/README
@@ -1,15 +1,14 @@
-== README file for directory ./scripts of the NTP Version 4 distribution ==
+== README file for directory scripts/ ==
 
 This directory contains shell and perl script files for the configuration,
-monitoring and support of NTP installations. See the README and RELNOTES
-files in the parent directory for directions on how to use these files.
+monitoring and support of NTP installations.
 
 calc_tickadj::	Calculates "optimal" value for tick given ntp.drift file
 
 monitoring::	Directory containing perl scripts useful for monitoring
                 operations
 
-rc		start/stop scripts for NTP
+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
diff --git a/util/README b/util/README
index 76c6b8f..c1ce835 100644
--- a/util/README
+++ b/util/README
@@ -1,9 +1,6 @@
-= README file for directory ./util of the NTP Version 4 distribution =
+= README file for directory util/ =
 
 This directory contains the sources for the various utility programs.
-See the README and RELNOTES files in the parent directory for directions
-on how to make and install these programs.
-
 Not much documentation, alas.  Read the header comments.
 
 audio-pcm.c::