* Added documentary comments to ntp.conf, reformatted the file a bit

  (closes: #416818)


git-svn-id: svn://svn.debian.org/pkg-ntp/ntp/trunk@190 0070b5ef-2f16-0410-befa-9a02bd1d6ddb

3 files changed, 24 insertions, 14 deletions

diff --git a/debian/changelog b/debian/changelog
index 9383eb9..5827e82 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,6 +1,6 @@
 ntp (1:4.2.4p4+dfsg-3) UNRELEASED; urgency=low
 
-  * Various manpage and NEWS fixes (patches by Justin Pryzby and Vincent
+  * Various man page and NEWS fixes (patches by Justin Pryzby and Vincent
     Lefevre) (closes: #439726, #450721)
   * Run DHCP hooks as exit hooks instead of enter hooks (closes: #408219)
   * Use try-restart to restart ntpd after DHCP event
@@ -11,6 +11,8 @@ ntp (1:4.2.4p4+dfsg-3) UNRELEASED; urgency=low
   * Moved configuration file description from ntpd(8) to ntp.conf(5)
   * Made NTPDATE_USE_NTP_CONF work with openntpd (initial patch by Benoît
     Dejean) (closes: #420692)
+  * Added documentary comments to ntp.conf, reformatted the file a bit
+    (closes: #416818)
 
  -- Peter Eisentraut <petere@debian.org>  Fri, 07 Dec 2007 15:08:07 +0100
 
diff --git a/debian/man/ntp.conf.5 b/debian/man/ntp.conf.5
index 33fc1d8..7856e07 100644
--- a/debian/man/ntp.conf.5
+++ b/debian/man/ntp.conf.5
@@ -265,4 +265,4 @@ Enables the statistics facility.  The default for this flag is enable.
 .SH "SEE ALSO"
 .BR ntpd (8)
 .PP
-The complete documentation can be found at \fI/usr/share/doc/ntp\-doc/html/ntpd.html\fR in the package ntp\-doc.
+The complete documentation can be found at \fI/usr/share/doc/ntp\-doc/html/ntpd.html#cfg\fR in the package ntp\-doc.
diff --git a/debian/ntp.conf b/debian/ntp.conf
index 8a2b4fb..39529f5 100644
--- a/debian/ntp.conf
+++ b/debian/ntp.conf
@@ -1,7 +1,8 @@
-# /etc/ntp.conf, configuration for ntpd
+# /etc/ntp.conf, configuration for ntpd; see ntp.conf(5) for help
 
 driftfile /var/lib/ntp/ntp.drift
 
+
 # Enable this if you want statistics to be logged.
 #statsdir /var/log/ntpstats/
 
@@ -14,17 +15,24 @@ filegen clockstats file clockstats type day enable
 # You do need to talk to an NTP server or two (or three).
 #server ntp.your-provider.example
 
-# pool.ntp.org maps to about 1000 low-stratum NTP servers.
-# Your server will pick a different set every time it starts up.
-#  *** Please consider joining the pool! ***
-#  *** <http://www.pool.ntp.org/join.html> ***
+# pool.ntp.org maps to about 1000 low-stratum NTP servers.  Your server will
+# pick a different set every time it starts up.  Please consider joining the
+# pool: <http://www.pool.ntp.org/join.html>
 server 0.debian.pool.ntp.org iburst dynamic
 server 1.debian.pool.ntp.org iburst dynamic
 server 2.debian.pool.ntp.org iburst dynamic
 server 3.debian.pool.ntp.org iburst dynamic
 
+
+# Access control configuration; see /usr/share/doc/ntp-doc/html/accopt.html for
+# details.  The web page <http://support.ntp.org/bin/view/Support/AccessRestrictions>
+# might also be helpful.
+#
+# Note that "restrict" applies to both servers and clients, so a configuration
+# that might be intended to block requests from certain clients could also end
+# up blocking replies from your own upstream servers.
+
 # By default, exchange time with everybody, but don't allow configuration.
-# See /usr/share/doc/ntp-doc/html/accopt.html for details.
 restrict -4 default kod notrap nomodify nopeer noquery
 restrict -6 default kod notrap nomodify nopeer noquery
 
@@ -32,16 +40,16 @@ restrict -6 default kod notrap nomodify nopeer noquery
 restrict 127.0.0.1
 restrict ::1
 
-# Clients from this (example!) subnet have unlimited access,
-# but only if cryptographically authenticated
-#restrict 192.168.123.0  mask  255.255.255.0 notrust
+# Clients from this (example!) subnet have unlimited access, but only if
+# cryptographically authenticated.
+#restrict 192.168.123.0 mask 255.255.255.0 notrust
+
 
 # If you want to provide time to your local subnet, change the next line.
 # (Again, the address is an example only.)
 #broadcast 192.168.123.255
 
-# If you want to listen to time broadcasts on your local subnet,
-# de-comment the next lines. Please do this only if you trust everybody
-# on the network!
+# If you want to listen to time broadcasts on your local subnet, de-comment the
+# next lines.  Please do this only if you trust everybody on the network!
 #disable auth
 #broadcastclient