Bug 28104

Summary: [PATCH] man pages for named.reload(8) and named.restart(8) are incorrect
Product: Documentation Reporter: Maxim Konovalov <maxim>
Component: Books & ArticlesAssignee: dd <dd>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff
none
file.diff none

Description Maxim Konovalov 2001-06-12 19:50:04 UTC 
	named.reload(8) and named.restart(8) do not send
	any signals to named(8), but man pages claim that.

How-To-Repeat: 
	more /usr/sbin/named.reload /usr/sbin/named.restart
	man 8 ndc
	more /usr/src/contrib/bind/bin/ndc/ndc.c
	man 8 named.reload
	man 8 named.restart
Comment 1 dima 2001-06-13 01:20:57 UTC 
maxim@macomnet.ru writes:
> --- named.reload.8.orig	Tue Jun 12 21:32:27 2001
> +++ named.reload.8	Tue Jun 12 22:09:46 2001
> @@ -61,16 +61,10 @@
...
> +This command runs
> +.Xr ndc
 ^^^^^^^^^^
Did you actually look at the output?  Did it look right?  The .Xr
macro takes two arguments, the name and the section of the manual
page.  It's used correctly in the SEE ALSO section:

>  .Sh SEE ALSO
>  .Xr @INDOT@named @SYS_OPS_EXT@ ,
> -.Xr @INDOT@named.restart @SYS_OPS_EXT@
> +.Xr @INDOT@named.restart @SYS_OPS_EXT@ ,
> +.Xr @INDOT@ndc @SYS_OPS_EXT@
> 
> --- named.restart.8.orig	Tue Jun 12 21:32:05 2001
> +++ named.restart.8	Tue Jun 12 22:09:58 2001

Same applies here.
Comment 2 Maxim Konovalov 2001-06-13 07:27:16 UTC 
On Tue, 12 Jun 2001, Dima Dorfman wrote:

> maxim@macomnet.ru writes:
> > --- named.reload.8.orig	Tue Jun 12 21:32:27 2001
> > +++ named.reload.8	Tue Jun 12 22:09:46 2001
> > @@ -61,16 +61,10 @@
> ...
> > +This command runs
> > +.Xr ndc
>  ^^^^^^^^^^
> Did you actually look at the output?  Did it look right?  The .Xr
> macro takes two arguments, the name and the section of the manual
> page.  It's used correctly in the SEE ALSO section:
>
> >  .Sh SEE ALSO
> >  .Xr @INDOT@named @SYS_OPS_EXT@ ,
> > -.Xr @INDOT@named.restart @SYS_OPS_EXT@
> > +.Xr @INDOT@named.restart @SYS_OPS_EXT@ ,
> > +.Xr @INDOT@ndc @SYS_OPS_EXT@
> >
> > --- named.restart.8.orig	Tue Jun 12 21:32:05 2001
> > +++ named.restart.8	Tue Jun 12 22:09:58 2001
>
> Same applies here.

How about this one?

--- named.reload.8.orig	Tue Jun 12 21:32:27 2001
+++ named.reload.8	Tue Jun 12 22:09:46 2001
@@ -61,16 +61,10 @@
 .Nm @INDOT@named.reload
 .Nd "cause the name server to synchronize its database"
 .Sh DESCRIPTION
-This command sends a
-.Dv SIGHUP
-to the running name server.
-This
-signal is documented in
-.Xr named @SYS_OPS_EXT@ .
-.Sh BUGS
-Does not check to see if the name server is actually running, and could
-use a stale PID cache file which may result in the death of an unrelated
-process.
+This command runs
+.Xr ndc @SYS_OPS_EXT@
+which reloads the running name server.
 .Sh SEE ALSO
 .Xr @INDOT@named @SYS_OPS_EXT@ ,
-.Xr @INDOT@named.restart @SYS_OPS_EXT@
+.Xr @INDOT@named.restart @SYS_OPS_EXT@ ,
+.Xr @INDOT@ndc @SYS_OPS_EXT@

--- named.restart.8.orig	Tue Jun 12 21:32:05 2001
+++ named.restart.8	Tue Jun 12 22:09:58 2001
@@ -61,20 +61,17 @@
 .Nm @INDOT@named.restart
 .Nd "stop and restart the name server"
 .Sh DESCRIPTION
-This command sends a
-.Dv SIGKILL
-to the running name server and then
-starts a new one with the command line options specified in
+This command runs
+.Xr ndc @SYS_OPS_EXT@
+which restarts the running name server with the command line options
+specified in
 .Xr rc.conf 5 .
 .Sh BUGS
-Does not check to see if the name server is actually running, and could
-use a stale PID cache file which may result in the death of an unrelated
-process.
-.Pp
 Does not wait after killing the old server before starting a new one; since
 the server could take some time to die and the new one will experience a
 fatal error if the old one isn't gone by the time it starts, you can be left
 in a situation where you have no name server at all.
 .Sh SEE ALSO
 .Xr @INDOT@named @SYS_OPS_EXT@ ,
-.Xr @INDOT@named.reload @SYS_OPS_EXT@
+.Xr @INDOT@named.reload @SYS_OPS_EXT@ ,
+.Xr @INDOT@ndc @SYS_OPS_EXT@

-- 
Maxim Konovalov, MAcomnet, Internet-Intranet Dept., system engineer
phone: +7 (095) 796-9079, mailto: maxim@macomnet.ru
Comment 3 dd freebsd_committer freebsd_triage 2001-06-14 05:28:50 UTC 
State Changed
From-To: open->analyzed

Committed, thanks!
Comment 4 dd freebsd_committer freebsd_triage 2001-06-14 05:28:50 UTC 
Responsible Changed
From-To: freebsd-doc->dd

My MFC reminder.
Comment 5 dd freebsd_committer freebsd_triage 2001-07-19 07:04:56 UTC 
State Changed
From-To: analyzed->closed

MFC'd by kris, thanks.