From jdc@koitsu.dyndns.org  Tue Dec 19 18:13:56 2006
Return-Path: <jdc@koitsu.dyndns.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [69.147.83.52])
	by hub.freebsd.org (Postfix) with ESMTP id 9D88216A403
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 19 Dec 2006 18:13:56 +0000 (UTC)
	(envelope-from jdc@koitsu.dyndns.org)
Received: from rwcrmhc14.comcast.net (rwcrmhc14.comcast.net [204.127.192.84])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 20FBA43CB4
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 19 Dec 2006 18:13:54 +0000 (GMT)
	(envelope-from jdc@koitsu.dyndns.org)
Received: from icarus.home.lan (c-67-174-220-97.hsd1.ca.comcast.net[67.174.220.97])
          by comcast.net (rwcrmhc14) with ESMTP
          id <20061219180350m1400fcb0se>; Tue, 19 Dec 2006 18:03:50 +0000
Received: by icarus.home.lan (Postfix, from userid 1000)
	id DBF981FA037; Tue, 19 Dec 2006 10:03:44 -0800 (PST)
Message-Id: <20061219180344.DBF981FA037@icarus.home.lan>
Date: Tue, 19 Dec 2006 10:03:44 -0800 (PST)
From: Jeremy Chadwick <koitsu@FreeBSD.org>
Reply-To: Jeremy Chadwick <koitsu@FreeBSD.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: ntp docs incorrectly document maxpoll/minpoll calculation
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         106926
>Category:       docs
>Synopsis:       ntp docs incorrectly document maxpoll/minpoll calculation
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    ceri
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Dec 19 18:20:27 GMT 2006
>Closed-Date:    Sun Dec 31 18:57:56 GMT 2006
>Last-Modified:  Sun Dec 31 18:57:56 GMT 2006
>Originator:     Jeremy Chadwick
>Release:        FreeBSD 6.2-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD icarus.home.lan 6.2-PRERELEASE FreeBSD 6.2-PRERELEASE #0: Wed Dec 13 14:55:49 PST 2006 root@icarus.home.lan:/usr/obj/usr/src/sys/ICARUS i386
>Description:
	ntp.conf(5) incorrectly documents the calculation used to
	convert the minpoll and maxpoll values into seconds.

	The manpage states "These options specify the minimum and
	maximum poll intervals for NTP messages, in seconds to
	the power of two", then cites examples such as the
	default value being 10 (thus 1024 seconds).

	10^2 = 100, but 2^10 = 1024.

	So the documentation should really say "These options
	specify the minimum and maximum poll intervals for NTP
	messages, as a power of 2 in seconds".  Other portions
	of the ntp.conf manpage use this wording, so let's
	keep it consistent (and correct :) ).
	
>How-To-Repeat:
	n/a
>Fix:
	Apply below patch.

--- ntp.conf.5.orig	Mon Jun  5 01:14:48 2006
+++ ntp.conf.5	Tue Dec 19 10:01:03 2006
@@ -303,7 +303,7 @@
 .It Cm minpoll Ar minpoll
 .It Cm maxpoll Ar maxpoll
 These options specify the minimum and maximum poll intervals
-for NTP messages, in seconds to the power of two.
+for NTP messages, as a power of 2 in seconds.
 The maximum poll
 interval defaults to 10 (1,024 s), but can be increased by the
 .Cm maxpoll
@@ -2040,7 +2040,7 @@
 .It Cm minpoll Ar int
 .It Cm maxpoll Ar int
 These options specify the minimum and maximum polling interval
-for reference clock messages, in seconds to the power of two.
+for reference clock messages, as a power of 2 in seconds.
 For
 most directly connected reference clocks, both
 .Cm minpoll
>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->patched 
State-Changed-By: ceri 
State-Changed-When: Thu Dec 21 19:08:44 UTC 2006 
State-Changed-Why:  
Corrected in -HEAD, revision 1.22 of src/usr.sbin/ntp/doc/ntp.conf.5, 
thanks. 


Responsible-Changed-From-To: freebsd-doc->ceri 
Responsible-Changed-By: ceri 
Responsible-Changed-When: Thu Dec 21 19:08:44 UTC 2006 
Responsible-Changed-Why:  
My MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=106926 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/106926: commit references a PR
Date: Thu, 21 Dec 2006 19:08:40 +0000 (UTC)

 ceri        2006-12-21 19:08:25 UTC
 
   FreeBSD src repository
 
   Modified files:
     usr.sbin/ntp/doc     ntp.conf.5 
   Log:
   Correct the description of minpoll and maxpoll.
   
   Note that while later versions of the ntpd documentation use the term
   "dual logarithm", the text added here is consistent with the remainder
   of the current document.
   
   PR:             docs/106926
   Submitted by:   Jeremy Chadwick
   
   Revision  Changes    Path
   1.22      +3 -3      src/usr.sbin/ntp/doc/ntp.conf.5
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: ceri 
State-Changed-When: Sun Dec 31 18:57:38 UTC 2006 
State-Changed-Why:  
MFC'd to RELENG_6, thanks. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=106926 
>Unformatted:
