Bug 106926

Summary:

ntp docs incorrectly document maxpoll/minpoll calculation

Product:

Documentation

Reporter:

Jeremy Chadwick <koitsu>

Component:

Books & Articles

Assignee:

Ceri Davies <ceri>

Status:

Closed FIXED

Severity:

Affects Only Me

Priority:

Normal

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
file.diff	none

Description Jeremy Chadwick freebsd_committer

2006-12-19 18:20:27 UTC

	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 :) ).

Fix: Apply below patch.
How-To-Repeat: 	n/a

Comment 1 dfilter service freebsd_committer

2006-12-21 19:08:40 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"

Comment 2 Ceri Davies freebsd_committer

2006-12-21 19:08:44 UTC

State Changed
From-To: open->patched

Corrected in -HEAD, revision 1.22 of src/usr.sbin/ntp/doc/ntp.conf.5, 
thanks.

Comment 3 Ceri Davies freebsd_committer

2006-12-21 19:08:44 UTC

Responsible Changed
From-To: freebsd-doc->ceri

My MFC reminder.

Comment 4 Ceri Davies freebsd_committer

2006-12-31 18:57:38 UTC

State Changed
From-To: patched->closed

MFC'd to RELENG_6, thanks.