docs/75545: typos in man3 manual pages, form_field_opts.3, form_hook.3, form_page.3, getaddrinfo.3, getenv.3, getobjformat.3, heap.3, hosts_access.3.

Mon Dec 27 15:50:18 UTC 2004

>Number:         75545
>Category:       docs
>Synopsis:       typos in man3 manual pages, form_field_opts.3, form_hook.3, form_page.3, getaddrinfo.3, getenv.3, getobjformat.3, heap.3, hosts_access.3.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Dec 27 15:50:17 GMT 2004
>Closed-Date:
>Last-Modified:
>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 at perseus.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC  i386


>Description:
	I found some typos in form_field_opts.3, form_hook.3, form_page.3,
	getaddrinfo.3, getenv.3, getobjformat.3, heap.3, hosts_access.3.
	and erases trailing spaces.

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

diff -u form_field_opts.3.orig ./form_field_opts.3

--- form_field_opts.3.orig	Sat Dec 18 00:08:15 2004
+++ ./form_field_opts.3	Tue Dec 28 00:37:30 2004
@@ -102,7 +102,6 @@
 The field is the current field.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).
-.TP 5
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
diff -u form_hook.3.orig ./form_hook.3
--- form_hook.3.orig	Sat Dec 18 00:08:15 2004
+++ ./form_hook.3	Tue Dec 28 00:39:05 2004
@@ -69,7 +69,7 @@
 current form init hook, if any (\fBNULL\fR if there is no such hook).
 
 The function \fBset_form_term\fR sets a hook to be called at form-unpost time
-and just before a page change once it is posted.  \fBform_init\fR
+and just before a page change once it is posted.  \fBform_term\fR
 returns the current form term hook, if any (\fBNULL\fR if there is no such
 hook).
 .SH RETURN VALUE
diff -u form_page.3.orig ./form_page.3
--- form_page.3.orig	Sat Dec 18 00:08:15 2004
+++ ./form_page.3	Tue Dec 28 00:40:29 2004
@@ -45,7 +45,7 @@
 int field_index(const FIELD *field);
 .br
 .SH DESCRIPTION
-The function \fBset_current field\fR sets the current field of the given
+The function \fBset_current\fR sets the current field of the given
 form; \fBcurrent_field\fR returns the current field of the given form.
 .PP
 The function \fBset_form_page\fR sets the form's page number (goes to page
diff -u getaddrinfo.3.orig ./getaddrinfo.3
--- getaddrinfo.3.orig	Sat Dec 18 00:08:11 2004
+++ ./getaddrinfo.3	Tue Dec 28 00:41:53 2004
@@ -342,7 +342,8 @@
 The
 .Fa addrinfo
 structure pointed to by the
-.Fa ai argument
+.Fa ai
+argument
 is freed, along with any dynamic storage pointed to by the structure.
 This operation is repeated until a
 .Dv NULL
@@ -398,7 +399,7 @@
 The following code tries to connect to
 .Dq Li www.kame.net
 service
-.Dq Li http .
+.Dq Li http
 via stream socket.
 It loops through all the addresses available, regardless of the address family.
 If the destination resolves to an IPv4 address, it will use an
diff -u getenv.3.orig ./getenv.3
--- getenv.3.orig	Sat Dec 18 00:08:11 2004
+++ ./getenv.3	Tue Dec 28 00:42:46 2004
@@ -93,7 +93,8 @@
 If the variable does exist, the argument
 .Ar overwrite
 is tested; if
-.Ar overwrite is
+.Ar overwrite
+is
 zero, the
 variable is not reset, otherwise it is reset
 to the given
diff -u getobjformat.3.orig ./getobjformat.3
--- getobjformat.3.orig	Sat Dec 18 00:08:11 2004
+++ ./getobjformat.3	Tue Dec 28 00:43:31 2004
@@ -112,7 +112,8 @@
 If the environment variable
 .Ev OBJFORMAT
 is set, it overrides the default object file format.
-.Ev OBJFORMAT takes precedence over
+.Ev OBJFORMAT
+takes precedence over
 .Pa /etc/objformat .
 .El
 .Sh FILES
diff -u heap.3.orig ./heap.3
--- heap.3.orig	Sat Dec 18 00:08:16 2004
+++ ./heap.3	Tue Dec 28 00:46:52 2004
@@ -27,11 +27,11 @@
 .Nm heap_increased ,
 .Nm heap_decreased ,
 .Nm heap_element ,
-.Nm heap_for_each 
+.Nm heap_for_each
 .Nd heap implementation of priority queues
 .Sh SYNOPSIS
 .Fd #include <isc/heap.h>
-.Ft heap_context    
+.Ft heap_context
 .Fn heap_new "heap_higher_priority_func higher_priority" \
 "heap_index_func index" "int array_size_increment"
 .Ft int
@@ -46,7 +46,7 @@
 .Fn heap_decreased "heap_context ctx" "int i"
 .Ft void *
 .Fn heap_element "heap_context ctx" "int i"
-.Ft int 
+.Ft int
 .Fn heap_for_each "heap_context ctx" "heap_for_each_func action" "void *uap"
 .Sh DESCRIPTION
 These functions implement heap\-based priority queues.  The user defines a
@@ -59,7 +59,7 @@
 Each of the functions depends upon the
 .Ft heap_context
 type, which is a pointer to a
-.Ft struct heap_context 
+.Ft struct heap_context
 .Pq see Pa heap.h No for more information .
 .Pp
 The
@@ -73,21 +73,21 @@
 .Ed
 .Pp
 These are pointers to user-defined functions.
-The 
+The
 .Ft heap_higher_priority_func
 type is a pointer to a function which compares two
 different heap (queue) elements and returns an
 .Ft int
-which answers the question, "Does the first queue element 
-have a higher priority than the second?"  In other words, 
-a function pointer of this type 
-.Em must 
+which answers the question, "Does the first queue element
+have a higher priority than the second?"  In other words,
+a function pointer of this type
+.Em must
 return a number greater than zero
-if the element indicated by the first argument is of a higher priority than 
-that indicated by the second element, and zero otherwise.  
+if the element indicated by the first argument is of a higher priority than
+that indicated by the second element, and zero otherwise.
 .Pp
 The other two function pointers are documented in the descriptions
-of 
+of
 .Fn heap_new
 .Pq Va heap_index_func
 and
@@ -97,53 +97,53 @@
 .Pp
 The function
 .Fn heap_new
-initializes a 
+initializes a
 .Ft struct heap_context
 and returns a pointer to it.  The
 .Fa higher_priority
-function pointer 
-.Em must 
-be 
+function pointer
+.Em must
+be
 .No non\- Ns Dv NULL .
-As explained above, this refers to a 
+As explained above, this refers to a
 function supplied by the user which compares the priority of two different
-queue or heap elements; see above for more information. 
-The second argument, 
+queue or heap elements; see above for more information.
+The second argument,
 .Fa index ,
 is a pointer to a user-defined function whose arguments are
 a heap element and its index in the heap.
-.Fa Index 
+.Fa Index
 is intended to provide the user a means of knowing the internal index
 of an element in the heap while maintaining the opacity of the implementation;
 since the user has to know the actual indexes of heap elements in order to use,
-e.g., 
+e.g.,
 .Fn heap_delete
 or
 .Fn heap_element ,
-the user 
+the user
 .Fa index
-function could store the index in the heap element, itself.  If 
+function could store the index in the heap element, itself.  If
 .Fa index
-is 
+is
 .No non\- Ns Dv NULL ,
-then it is called 
-.Em whenever 
+then it is called
+.Em whenever
 the index of an element changes, allowing the user to stay up\-to\-date
 with index changes.
-The last argument, 
+The last argument,
 .Fa array_size_increment
 will be used, as its name suggests, by
 .Xr malloc 3
 or
 .Xr realloc 3
-to increment the array which implements the heap; if zero, a default value 
+to increment the array which implements the heap; if zero, a default value
 will be used.
 .Pp
 The
 .Fn heap_free
 function frees the given
 .Ft heap_context
-argument 
+argument
 .Pq Fa ctx ,
 which also frees the entire
 .Nm heap ,
@@ -154,38 +154,38 @@
 should be
 .No non\- Ns Dv NULL .
 .Pp
-The 
+The
 .Fn heap_insert
 function is used to insert the new heap element
 .Fa elt
 into the appropriate place (priority\-wise) in the
 .Ft heap
-indicated by 
+indicated by
 .Fa ctx
 (a pointer to a
 .Ft heap_context ) .
-If 
+If
 .No non\- Ns Dv NULL ,
 the user-defined
 .Ft higher_priority
-function pointer associated with the indicated 
+function pointer associated with the indicated
 .Nm heap
 is used to determine that
 .Dq appropriate place ;
 the highest\-priority elements are at the front of the queue (top of
 the heap).
-(See the description of 
-.Fn heap_new , 
+(See the description of
+.Fn heap_new ,
 above, for more information.)
 .Pp
 The function
 .Fn heap_delete
-is used to delete the 
+is used to delete the
 .Fa i\- Ns th
 element of the queue (heap), and fixing up the queue (heap) from that
 element onward via the priority as determined by the user function
 pointed to by
-.Ft higher_priority 
+.Ft higher_priority
 function pointer
 (see description of
 .Fn heap_new ,
@@ -195,7 +195,7 @@
 .Pp
 .Fn heap_decreased
 .Pp
-The 
+The
 .Fn heap_element
 function returns the
 .Fa i\- Ns th
@@ -207,17 +207,17 @@
 .Fn heap_for_each
 function provides a mechanism for the user to increment through the entire
 queue (heap) and perform some
-.Fa action 
+.Fa action
 upon each of the queue elements.  This
-.Fa action 
+.Fa action
 is pointer to a user\-defined function with two arguments, the first of
-which should be interpreted by the user's function as a heap element.  The 
+which should be interpreted by the user's function as a heap element.  The
 second value passed to the user function is just the
 .Fa uap
-argument to 
+argument to
 .Fn heap_for_each ;
 this allows the user to specify additional arguments, if necessary, to
-the function pointed to by 
+the function pointed to by
 .Fa action .
 .\" The following requests should be uncommented and
 .\" used where appropriate.  This next request is
@@ -226,54 +226,53 @@
 .Bl -tag -width "heap_decreased()"
 .It Fn heap_new
 .Dv NULL
-if unable to 
+if unable to
 .Xr malloc 3
-a 
+a
 .Ft struct heap_context
 or if the
 .Fa higher_priority
-function pointer is 
+function pointer is
 .Dv NULL ;
 otherwise, a valid
-.Ft heap_context 
-.Ns .
+.Ft heap_context .
 .It Fn heap_free
--1 if 
+-1 if
 .Fa ctx
-is 
-.Dv NULL 
-(with 
+is
+.Dv NULL
+(with
 .Va errno
 set to
 .Dv EINVAL ) ;
 otherwise, 0.
 .It Fn heap_insert
--1 
+-1
 if either
 .Fa ctx
-or 
+or
 .Fa elt
-is 
+is
 .Dv NULL ,
-or if an attempt to 
+or if an attempt to
 .Xr malloc 3
-or 
+or
 .Xr realloc 3
 the heap array fails (with
 .Va errno
-set to 
+set to
 .Dv EINVAL
-or 
+or
 .Dv ENOMEM ,
 respectively).
 Otherwise, 0.
 .It Fn heap_delete
--1 if 
+-1 if
 .Fa ctx
-is 
+is
 .Dv NULL
-or 
-.Fa i 
+or
+.Fa i
 is out\-of\-range (with
 .Va errno
 set to
@@ -286,9 +285,9 @@
 As for
 .Fn heap_delete .
 .It Fn heap_element
-NULL if 
-.Fa ctx 
-is 
+NULL if
+.Fa ctx
+is
 .Dv NULL
 or
 .Fa i
@@ -302,11 +301,11 @@
 .It Fn heap_for_each
 -1 if either
 .Fa ctx
-or 
+or
 .Fa action
-is 
+is
 .Dv NULL
-(with 
+(with
 .Va errno
 set to
 .Dv EINVAL ) ;
@@ -332,12 +331,12 @@
 The variable
 .Va errno
 is set by
-.Fn heap_free , 
-.Fn heap_insert , 
-.Fn heap_delete , 
-.Fn heap_increased , 
+.Fn heap_free ,
+.Fn heap_insert ,
+.Fn heap_delete ,
+.Fn heap_increased ,
 and
-.Fn heap_decreased 
+.Fn heap_decreased
 under the conditions of invalid input
 .Pq Dv EINVAL
 or lack of memory
@@ -370,9 +369,9 @@
 .Sh AUTHORS
 The
 .Nm heap
-library was implemented by Bob Halley (halley at vix.com) of Vixie Enterprises, 
+library was implemented by Bob Halley (halley at vix.com) of Vixie Enterprises,
 Inc., for the Internet Software consortium, and was adapted from
-the two books listed in the 
+the two books listed in the
 .Sx SEE ALSO
 section, above.
 .\" .Sh BUGS
diff -u hosts_access.3.orig ./hosts_access.3
--- hosts_access.3.orig	Sat Dec 18 00:08:17 2004
+++ ./hosts_access.3	Tue Dec 28 00:48:11 2004
@@ -88,6 +88,6 @@
 Wietse Venema (wietse at wzv.win.tue.nl)
 Department of Mathematics and Computing Science
 Eindhoven University of Technology
-Den Dolech 2, P.O. Box 513, 
+Den Dolech 2, P.O. Box 513,
 5600 MB Eindhoven, The Netherlands
-\" @(#) hosts_access.3 1.8 96/02/11 17:01:26
+.\" @(#) hosts_access.3 1.8 96/02/11 17:01:26
>Release-Note:
>Audit-Trail:
>Unformatted:

