[ntpsec commit] Minor tweaks to unternal documentation and TODO.
Eric S. Raymond
esr at ntpsec.org
Mon Oct 19 23:21:51 UTC 2015
Module: ntpsec
Branch: master
Commit: d4f61202f4dfe01ff657d42fe6f00b4421822e7e
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=d4f61202f4dfe01ff657d42fe6f00b4421822e7e
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Mon Oct 19 19:20:38 2015 -0400
Minor tweaks to unternal documentation and TODO.
---
NEWS | 2 +-
README | 6 ++++--
devel-docs/TODO | 6 +++---
scripts/README | 8 +++-----
4 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/NEWS b/NEWS
index 44b1efc..5f0da1b 100644
--- a/NEWS
+++ b/NEWS
@@ -1,6 +1,6 @@
= NTPsec project news =
-For historic news from NTP Classic, see devel-docs/TODO.
+For historic news from NTP Classic, see devel-docs/TODO in the distribution.
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
diff --git a/README b/README
index 659da5f..ba33d2a 100644
--- a/README
+++ b/README
@@ -62,10 +62,12 @@ ntpfrob:: The ntpfrob utility collects several small diagnostic
hardware, including reading the clock tick rate,
precision, and jitter.
-ntpkeygen::
- Directory containing the utility program used to generate
+ntpkeygen:: Directory containing the utility program used to generate
NTP authentication keys.
+mtpleapfetch:: Directory containing a script ro be run from a cron job
+ to keep your local leap-second file properly updated.
+
ntpq/:: Directory containing sources for a utility program to
query local and remote NTP peers for state variables and
related timekeeping information. This program conforms
diff --git a/devel-docs/TODO b/devel-docs/TODO
index f9575e4..2e1da53 100644
--- a/devel-docs/TODO
+++ b/devel-docs/TODO
@@ -23,9 +23,9 @@ None right now. (Sep-22 2015)
is right if we're trying to install a test setup to userspace but wrong
in the normal case - we want /sbin, not /usr/sbin.
-* There's no installation yet for ntpleapfetch, or the Perl
- executables under scripts/, or their support library under
- scripts/lib/.
+* There's no installation yet for ntpleapfetch, or the three Perl
+ executables under scripts/ that should be installed (ntpwait, ntpsweep,
+ ntptrace), or their support library under scripts/lib/.
* The install production needs to warn of stale ntpdc and ntpdate binaries.
diff --git a/scripts/README b/scripts/README
index 12bc0dd..cff44b5 100644
--- a/scripts/README
+++ b/scripts/README
@@ -1,19 +1,17 @@
== README file for directory scripts/ ==
This directory contains shell and perl script files for the configuration,
-monitoring and support of NTP installations.
+monitoring and support of NTP installations. Not all of these are
+installed in a normal setup
calc_tickadj:: Calculates "optimal" value for tick given ntp.drift file
lib:: NTP interface package required to query Mode 6 packets
- from the daemon.
+ from the daemon from Perl scripts.
monitoring:: Directory containing perl scripts useful for monitoring
operations
-ntpleapfetch:: Script to update the leap-second from the NIST leapsecond file.
- Meant to be run from a cron job.
-
ntpwait:: 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.
More information about the vc
mailing list