From n-kogane@syd.odn.ne.jp  Wed Dec 29 16:40:37 2004
Return-Path: <n-kogane@syd.odn.ne.jp>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 3584F16A4CE
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 29 Dec 2004 16:40:37 +0000 (GMT)
Received: from t-mta2.odn.ne.jp (mfep2.odn.ne.jp [143.90.131.180])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 022D343D2F
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 29 Dec 2004 16:40:36 +0000 (GMT)
	(envelope-from n-kogane@syd.odn.ne.jp)
Received: from kces6.koganemaru.co.jp ([61.201.44.74]) by t-mta2.odn.ne.jp
          with ESMTP
          id <20041229164035114.RIQC.2654.t-mta2.odn.ne.jp@mta2.odn.ne.jp>
          for <FreeBSD-gnats-submit@freebsd.org>;
          Thu, 30 Dec 2004 01:40:35 +0900
Received: by kces6.koganemaru.co.jp (Postfix, from userid 100)
	id 661FB10221; Thu, 30 Dec 2004 01:45:03 +0000 (GMT)
Message-Id: <20041230014503.661FB10221@kces6.koganemaru.co.jp>
Date: Thu, 30 Dec 2004 01:45:03 +0000 (GMT)
From: n-kogane@syd.odn.ne.jp
Reply-To: n-kogane@syd.odn.ne.jp
To: FreeBSD-gnats-submit@freebsd.org
Subject: typos in man3 manual pages, signal.3, stdarg.3, strmode.3, tree.3, utime.3.
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         75615
>Category:       docs
>Synopsis:       typos in man3 manual pages, signal.3, stdarg.3, strmode.3, tree.3, utime.3.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    keramida
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Dec 29 16:50:20 GMT 2004
>Closed-Date:    Mon Jan 17 12:10:59 GMT 2005
>Last-Modified:  Mon Jan 17 12:10:59 GMT 2005
>Originator:     Nobuyuki Koganemaru
>Release:        FreeBSD 4.11-RC1 i386
>Organization:
KOGANEMARU Computer Engineering Service Corporation.
>Environment:
FreeBSD kcesx3.koganemaru.co.jp 4.10-RELEASE FreeBSD 4.10-RELEASE #0: Tue May 25 22:47:12 GMT 2004     root@perseus.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC  i386


>Description:
	I found some typos in signal.3, stdarg.3, strmode.3, tree.3, utime.3.
	and something wrong.

>How-To-Repeat:
	Do "man 3 xxxxx".
>Fix:

diff -u signal.3.orig ./signal.3
--- signal.3.orig	Sat Dec 18 00:08:11 2004
+++ ./signal.3	Thu Dec 30 01:09:58 2004
@@ -228,7 +228,7 @@
 An attempt is made to ignore or supply a handler for
 .Dv SIGKILL
 or
-.Ev SIGSTOP .
+.Dv SIGSTOP .
 .El
 .Sh SEE ALSO
 .Xr kill 1 ,
@@ -244,6 +244,6 @@
 .Xr tty 4
 .Sh HISTORY
 This
-.Fn signal
+.Nm
 facility appeared in
 .Bx 4.0 .
diff -u stdarg.3.orig ./stdarg.3
--- stdarg.3.orig	Sat Dec 18 00:08:47 2004
+++ ./stdarg.3	Thu Dec 30 01:11:11 2004
@@ -199,7 +199,7 @@
 code to
 .Nm
 code,
-but it also creates difficulties for variadic functions that
+but it also creates difficulties for varied functions that
 wish to pass all of their arguments on to a function
 that takes a
 .Em va_list
diff -u strmode.3.orig ./strmode.3
--- strmode.3.orig	Sat Dec 18 00:08:12 2004
+++ ./strmode.3	Thu Dec 30 01:13:19 2004
@@ -98,7 +98,7 @@
 If the second character of the three character set is a ``w'', the file is
 writable for that set of users; if a dash ``\-'', it is not writable.
 .Pp
-The third character is the first of the following characters that apply:
+The third character is the one of the following characters that apply:
 .Bl -tag -width xxxx
 .It S
 If the character is part of the owner permissions and the file is not
diff -u tree.3.orig ./tree.3
--- tree.3.orig	Sat Dec 18 00:08:16 2004
+++ ./tree.3	Thu Dec 30 01:14:13 2004
@@ -149,6 +149,6 @@
 .Xr free
 functions to be used internally when allocating meta data.
 .Sh AUTHOR
-Paul Vixie, converted and augumented from Modula\-2 examples in
+Paul Vixie, converted and augmented from Modula\-2 examples in
 .Dq Algorithms & Data Structures ,
 Niklaus Wirth, Prentice\-Hall, ISBN 0\-13\-022005\-1.
diff -u utime.3.orig ./utime.3
--- utime.3.orig	Sat Dec 18 00:08:11 2004
+++ ./utime.3	Thu Dec 30 01:23:56 2004
@@ -53,9 +53,10 @@
 .Pp
 The
 .Fn utime
-function sets the access and modification times of the named file from
-the structures in the argument array
+function sets the access and modification times of the named file that
+the structures in the argument
 .Fa timep .
+.\" I don't know, but something wrong ?
 .Pp
 If the times are specified (the
 .Fa timep
>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Wed Dec 29 19:38:38 GMT 2004 
Responsible-Changed-Why:  
I'll work on this. 

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

From: Giorgos Keramidas <keramida@freebsd.org>
To: n-kogane@syd.odn.ne.jp
Cc: bug-followup@freebsd.org
Subject: Re: docs/75615: typos in man3 manual pages, signal.3, stdarg.3, strmode.3, tree.3, utime.3.
Date: Wed, 29 Dec 2004 22:38:57 +0200

 On 2004-12-30 01:45, n-kogane@syd.odn.ne.jp wrote:
 >
 > diff -u signal.3.orig ./signal.3
 > --- signal.3.orig	Sat Dec 18 00:08:11 2004
 > +++ ./signal.3	Thu Dec 30 01:09:58 2004
 > @@ -228,7 +228,7 @@
 >  An attempt is made to ignore or supply a handler for
 >  .Dv SIGKILL
 >  or
 > -.Ev SIGSTOP .
 > +.Dv SIGSTOP .
 >  .El
 >  .Sh SEE ALSO
 >  .Xr kill 1 ,
 > @@ -244,6 +244,6 @@
 >  .Xr tty 4
 >  .Sh HISTORY
 >  This
 > -.Fn signal
 > +.Nm
 >  facility appeared in
 >  .Bx 4.0 .
 
 I committed this.  Thanks :-)
 
 > diff -u stdarg.3.orig ./stdarg.3
 > --- stdarg.3.orig	Sat Dec 18 00:08:47 2004
 > +++ ./stdarg.3	Thu Dec 30 01:11:11 2004
 > @@ -199,7 +199,7 @@
 >  code to
 >  .Nm
 >  code,
 > -but it also creates difficulties for variadic functions that
 > +but it also creates difficulties for varied functions that
 >  wish to pass all of their arguments on to a function
 >  that takes a
 >  .Em va_list
 
 The original is correct.  Functions with a variabla number of arguments
 are called "variadic" in the C standards.
 
 > diff -u strmode.3.orig ./strmode.3
 > --- strmode.3.orig	Sat Dec 18 00:08:12 2004
 > +++ ./strmode.3	Thu Dec 30 01:13:19 2004
 > @@ -98,7 +98,7 @@
 >  If the second character of the three character set is a ``w'', the file is
 >  writable for that set of users; if a dash ``\-'', it is not writable.
 >  .Pp
 > -The third character is the first of the following characters that apply:
 > +The third character is the one of the following characters that apply:
 >  .Bl -tag -width xxxx
 >  .It S
 >  If the character is part of the owner permissions and the file is not
 
 The original is correct here too.  The order of the characters listed
 below this paragraph _does_ matter.  This is what 'first' instead of
 'one' implies.
 
 > diff -u tree.3.orig ./tree.3
 > --- tree.3.orig	Sat Dec 18 00:08:16 2004
 > +++ ./tree.3	Thu Dec 30 01:14:13 2004
 > @@ -149,6 +149,6 @@
 >  .Xr free
 >  functions to be used internally when allocating meta data.
 >  .Sh AUTHOR
 > -Paul Vixie, converted and augumented from Modula\-2 examples in
 > +Paul Vixie, converted and augmented from Modula\-2 examples in
 >  .Dq Algorithms & Data Structures ,
 >  Niklaus Wirth, Prentice\-Hall, ISBN 0\-13\-022005\-1.
 
 This has already been fixed in CURRENT and RELENG_5.
 
 > diff -u utime.3.orig ./utime.3
 > --- utime.3.orig	Sat Dec 18 00:08:11 2004
 > +++ ./utime.3	Thu Dec 30 01:23:56 2004
 > @@ -53,9 +53,10 @@
 >  .Pp
 >  The
 >  .Fn utime
 > -function sets the access and modification times of the named file from
 > -the structures in the argument array
 > +function sets the access and modification times of the named file that
 > +the structures in the argument
 >  .Fa timep .
 > +.\" I don't know, but something wrong ?
 >  .Pp
 >  If the times are specified (the
 >  .Fa timep
 
 The replacement text is not really more clear than the original.  How
 about something like this?
 
 %%%
 Index: gen/utime.3
 ===================================================================
 RCS file: /home/ncvs/src/lib/libc/gen/utime.3,v
 retrieving revision 1.11
 diff -u -r1.11 utime.3
 --- gen/utime.3  24 Aug 2002 00:39:43 -0000      1.11
 +++ gen/utime.3  29 Dec 2004 20:36:36 -0000
 @@ -53,8 +53,11 @@
  The
  .Fn utime
  function sets the access and modification times of the named file from
 -the structures in the argument array
 -.Fa timep .
 +the
 +.Dt time_t
 +members of the
 +.Fa timep
 +argument.
  .Pp
  If the times are specified (the
  .Fa timep
 %%%
State-Changed-From-To: open->feedback 
State-Changed-By: keramida 
State-Changed-When: Thu Jan 6 19:19:11 GMT 2005 
State-Changed-Why:  
Any comments regarding the changes to the diff that I mentioned? 

http://www.freebsd.org/cgi/query-pr.cgi?pr=75615 
State-Changed-From-To: feedback->patched 
State-Changed-By: keramida 
State-Changed-When: Fri Jan 7 14:38:41 GMT 2005 
State-Changed-Why:  
A slightly more detailed explanation of what `timep' points to has been 
committed to HEAD.  Thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=75615 
State-Changed-From-To: patched->closed 
State-Changed-By: keramida 
State-Changed-When: Mon Jan 17 12:08:42 GMT 2005 
State-Changed-Why:  
All changes merged to RELENG_5. 

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