]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
pullup:
authorAndreas Gustafsson <source@isc.org>
Fri, 2 Nov 2001 21:06:16 +0000 (21:06 +0000)
committerAndreas Gustafsson <source@isc.org>
Fri, 2 Nov 2001 21:06:16 +0000 (21:06 +0000)
1093.   [doc]           libbind: miscellaneous nroff fixes.

CHANGES
lib/bind/isc/assertions.mdoc
lib/bind/isc/bitncmp.mdoc
lib/bind/isc/eventlib.mdoc
lib/bind/isc/heap.mdoc
lib/bind/isc/logging.mdoc
lib/bind/isc/memcluster.mdoc
lib/bind/isc/tree.mdoc

diff --git a/CHANGES b/CHANGES
index 01fd3ad6a08b1cddab91ecaccf558c52cc851cdb..ce6bd781ff1fc4fdca3da8d0f439cc08c78beaf5 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -6,6 +6,8 @@
 
 1101.  [bug]           Array bounds read error in lwres_gai_strerror.
 
+1093.  [doc]           libbind: miscellaneous nroff fixes.
+
 1092.  [bug]           libbind: get*by*() failed to check if res_init() had
                        been called.
 
index 7fa00c97f6a9e4db09bbbce227bd14bd2e828035..9f8cc639bc573894f4193a4d2bcca396126841e9 100644 (file)
@@ -1,4 +1,4 @@
-.\" $Id: assertions.mdoc,v 1.1 2001/03/29 06:31:53 marka Exp $
+.\" $Id: assertions.mdoc,v 1.1.2.1 2001/11/02 21:05:58 gson Exp $
 .\"
 .\"Copyright (c) 1997,1999 by Internet Software Consortium.
 .\"
@@ -75,9 +75,9 @@ macro.  If this macro's value is
 when
 .Dq "<isc/assertions.h>"
 is included, then assertions of that type will not be checked.  E.g.
-
+.Pp
 .Dl #define CHECK_ENSURE 0
-
+.Pp
 will disable checking of
 .Fn ENSURE
 and
@@ -93,8 +93,7 @@ assertion types should be checked.
 specifies the function to call when an assertion fails.
 .Pp
 When an
-.li
-assertion_failure_callback
+.Fn assertion_failure_callback
 is called, the 
 .Fa filename
 and
@@ -109,7 +108,7 @@ assert_ensure
 assert_insist
 assert_invariant
 .Ed
-
+.Pp
 and may be used by the callback to determine the type of the failing
 assertion.
 .Fa condition
@@ -127,8 +126,13 @@ For example,
 returns the string
 .Dq REQUIRE .
 .Sh SEE ALSO
-Bertrand Meyer,
-.Sy Object-Oriented Software Construction,
-2nd edition, Prentice\-Hall, 1997, ISBN 0\-13\-629155\-4, chapter 11.
+.Rs
+.%A Bertrand Meyer
+.%B Object-Oriented Software Construction, 2nd edition
+.%Q Prentice\-Hall
+.%D 1997
+.%O ISBN 0\-13\-629155\-4
+.%P chapter 11
+.Re
 .Sh AUTHOR
 Bob Halley (ISC).
index 7ad37f3ab0330fabf6a598b1d5aed7ddc41ab22a..6eb7201769f4b1a7caf3c48dfaf0df28c800a8a1 100644 (file)
@@ -1,4 +1,4 @@
-.\" $Id: bitncmp.mdoc,v 1.1 2001/03/29 06:31:53 marka Exp $
+.\" $Id: bitncmp.mdoc,v 1.1.2.1 2001/11/02 21:05:59 gson Exp $
 .\"
 .\"Copyright (c) 1996,1999 by Internet Software Consortium.
 .\"
@@ -41,7 +41,7 @@ is lexicographically less than, equal to, or greater than
 when taken to be unsigned characters (this behaviour is just like that of
 .Xr memcmp 3 ) .
 .Pp
-.Sy NOTE:
+.Sy NOTE :
 .Fn Bitncmp 
 assumes 
 .Sy network byte order ;
@@ -52,7 +52,7 @@ this means that the fourth octet of
 .Fn Bitncmp
 returns values in the manner of
 .Xr memcmp 3 :
-.Bd -filled -offset indent
+.Bd -ragged -offset indent
 +1 if 
 .Dq Fa 1
 is greater than 
@@ -75,7 +75,7 @@ where
 and 
 .Dq Fa r
 are both interpreted as strings of unsigned characters (through bit 
-.Dq Fa n .)
+.Dq Fa n . )
 .Sh SEE ALSO
 .Xr memcmp 3 .
 .Sh AUTHOR
index f3bfef3601e781a9be0aadb351403d3baf25d1da..c0364c9791eb8c3ac50a0990a0f9a5e585fd5d75 100644 (file)
@@ -1,4 +1,4 @@
-.\" $Id: eventlib.mdoc,v 1.1 2001/03/29 06:31:54 marka Exp $
+.\" $Id: eventlib.mdoc,v 1.1.2.1 2001/11/02 21:06:00 gson Exp $
 .\"
 .\"Copyright (c) 1995-1999 by Internet Software Consortium
 .\"
 .Sh SYNOPSIS
 .Fd #include <isc/eventlib.h>
 .Ft typedef void
-.Fn (*evConnFunc) "evContext ctx" "void *uap" "int fd" \
+.Fn \*(lp*evConnFunc\*(rp "evContext ctx" "void *uap" "int fd" \
 "const void *la" "int lalen" "const void *ra" "int ralen"
 .Ft typedef void
-.Fn (*evTimerFunc) "evContext ctx" "void *uap" \
+.Fn \*(lp*evTimerFunc\*(rp "evContext ctx" "void *uap" \
 "struct timespec due" "struct timespec inter"
 .Ft typedef void
-.Fn (*evFileFunc) "evContext ctx" "void *uap" "int fd" "int eventmask"
+.Fn \*(lp*evFileFunc\*(rp "evContext ctx" "void *uap" "int fd" "int eventmask"
 .Ft typedef void
-.Fn (*evStreamFunc) "evContext ctx" "void *uap" "int fd" "int bytes"
+.Fn \*(lp*evStreamFunc\*(rp "evContext ctx" "void *uap" "int fd" "int bytes"
 .Ft typedef void
-.Fn (*evWaitFunc) "evContext ctx" "void *uap" "const void *tag"
+.Fn \*(lp*evWaitFunc\*(rp "evContext ctx" "void *uap" "const void *tag"
 .Ft int
 .Fn evCreate "evContext *ctx"
 .Ft int
@@ -197,7 +197,7 @@ The function
 creates an event context which is needed by all the other functions in this
 library.  All information used internally by this library is bound to this
 context, rather than to static storage.  This makes the library 
-.Dq thread safe
+.Dq thread safe ,
 and permits other library functions to use events without
 disrupting the application's use of events.
 .Pp
@@ -325,7 +325,7 @@ The function
 adds two
 .Dq Fa struct timespec
 values and returns the result as a
-.Dq Fa struct timespec.
+.Dq Fa struct timespec .
 .Pp
 The function
 .Fn evSubTime
@@ -334,7 +334,7 @@ subtracts its second
 argument from its first
 .Dq Fa struct timespec
 argument and returns the result as a
-.Dq Fa struct timespec.
+.Dq Fa struct timespec .
 .Pp
 The function
 .Fn evCmpTime
@@ -384,15 +384,15 @@ argument.  The event will be delivered at absolute time
 and then if time
 .Fa inter
 is not equal to
-.Dq Fa evConsTime(0,0) ,
+.Dq Fn evConsTime 0 0 ,
 subsequently at intervals equal to time
 .Fa inter .
 As a special case, specifying a
 .Fa due
 argument equal to
-.Dq Fa evConsTime(0,0)
+.Dq Fn evConsTime 0 0
 means 
-.Dq due immediately.  
+.Dq due immediately .
 The
 .Fa opaqueID
 argument, if specified as a value other than
@@ -711,7 +711,7 @@ initiates an outgoing connection on
 to destination address
 .Fa ra
 (whose length is
-.Fa ralen ).
+.Fa ralen ) .
 When the connection is complete,
 .Fa func
 will be called with
@@ -719,7 +719,7 @@ will be called with
 as one of its arguments.  The argument
 .Fa fd
 to
-.Fn (*func)()
+.Fn \*(lp*func\*(rp
 will be
 .Fa -1
 if an error occurred that prevented this connection from completing 
index cd1596a510d8b05a54b19e2565ecb367f1a2ca88..49dea3d9c15bbba7e0013d6d03119cc311abcff0 100644 (file)
@@ -1,4 +1,4 @@
-.\" $Id: heap.mdoc,v 1.1 2001/03/29 06:31:55 marka Exp $
+.\" $Id: heap.mdoc,v 1.1.2.1 2001/11/02 21:06:01 gson Exp $
 .\"
 .\"Copyright (c) 1997,1999 by Internet Software Consortium.
 .\"
@@ -15,7 +15,7 @@
 .\"ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 .\"SOFTWARE.
 .\"
-.Dd Jan 1, 1997
+.Dd January 1, 1997
 .\"Os OPERATING_SYSTEM [version/release]
 .Os BSD 4
 .Dt HEAP @SYSCALL_EXT@
 These functions implement heap\-based priority queues.  The user defines a
 priority scheme, and provides a function for comparison of the priority
 of heap elements
-.Po see the description of the
+(see the description of the
 .Ft heap_higher_priority_func
-function pointer, below
-.Pc .
+function pointer, below).
 .Pp
 Each of the functions depends upon the
 .Ft heap_context
@@ -163,9 +162,8 @@ into the appropriate place (priority\-wise) in the
 .Ft heap
 indicated by 
 .Fa ctx
-.Po a pointer to a
-.Ft heap_context
-.Pc .
+(a pointer to a
+.Ft heap_context ) .
 If 
 .No non\- Ns Dv NULL ,
 the user-defined
@@ -189,7 +187,9 @@ element onward via the priority as determined by the user function
 pointed to by
 .Ft higher_priority 
 function pointer
-.Pq see description of Fn heap_new, No above .
+(see description of
+.Fn heap_new ,
+above).
 .Pp
 .Fn heap_increased
 .Pp
@@ -233,7 +233,7 @@ a
 or if the
 .Fa higher_priority
 function pointer is 
-.Dv NULL;
+.Dv NULL ;
 otherwise, a valid
 .Ft heap_context 
 .Ns .
@@ -347,14 +347,24 @@ please refer to
 .Sh SEE ALSO
 .Xr malloc 3 ,
 .Xr realloc 3 .
-.Pp
-Cormen, Leiserson, and Rivest,  
-.Sy Introduction to Algorithms,
-MIT Press / McGraw Hill, 1990, ISBN 0\-262\-03141\-8, chapter 7.
-.Pp
-Sedgewick, 
-.Sy Algorithms,
-2nd ed'n, Addison\-Wesley, 1988, ISBN 0\-201\-06673\-4, chapter 11.
+.Rs
+.%A Cormen
+.%A Leiserson
+.%A Rivest
+.%B Introduction to Algorithms
+.%Q "MIT Press / McGraw Hill"
+.%D 1990
+.%O ISBN 0\-262\-03141\-8
+.%P chapter 7
+.Re
+.Rs
+.%A Sedgewick
+.%B Algorithms, 2nd ed'n
+.%Q Addison\-Wesley
+.%D 1988
+.%O ISBN 0\-201\-06673\-4
+.%P chapter 11
+.Re
 .\" .Sh STANDARDS
 .\" .Sh HISTORY
 .Sh AUTHORS
index 0b7dae1ce952d21607aae5f1a7e964fa364ab68e..4dd0053d7a3e46ac07acc9d960bedc0ab34e734e 100644 (file)
@@ -1,4 +1,4 @@
-.\" $Id: logging.mdoc,v 1.1 2001/03/29 06:31:55 marka Exp $
+.\" $Id: logging.mdoc,v 1.1.2.1 2001/11/02 21:06:02 gson Exp $
 .\"
 .\"Copyright (c) 1995-1999 by Internet Software Consortium
 .\"
@@ -212,7 +212,7 @@ Each category can have its own list of
 associated with it; we say that such a channel is 
 .Dq in 
 the particular category.
-.Sy NOTE:
+.Sy NOTE :
 Individual logging channels can appear in more than one category.
 .Pp
 A
@@ -220,12 +220,12 @@ A
 is the set of all 
 .Nm logging channels 
 associated with the context's
-.Nm categories;
+.Nm categories ;
 thus, a particular 
 .Nm category 
 scheme is associated with a particular
-.Nm logging context.
-.Sy NOTE:
+.Nm logging context .
+.Sy NOTE :
 A logging channel may appear in more than one logging context, and in 
 multiple categories within each logging context.
 .Pp
@@ -370,8 +370,8 @@ bit of the
 field of the logging channel structure is set), then any file with the
 .Dq current
 filename for the stream is
-.X4 unlink 2 Ns -d .
-.Sy NOTE:
+.Xr unlink 2 Ns -d .
+.Sy NOTE :
 If the logging file is 
 .Em not 
 a regular file, and either of the above operations (version numbering
@@ -477,7 +477,7 @@ set and the message is not a debugging message (i.e., has a level greater
 than 0), then it will not be logged.
 Finally, if the message's priority is less important than the
 channel's logging level (the priority threshold), will not be logged.
-.Sy NOTE:
+.Sy NOTE :
 If a logging channel's flag has
 .Dv LOG_USE_CONTEXT_LEVEL
 set, it will use the logging context's priority, rather than its own.
@@ -572,7 +572,7 @@ and
 .Dq Fa category_names
 which are supplied; the latter can be
 .Dv NULL .
-.Sy NOTE:
+.Sy NOTE :
 Since 
 .Dq Fa category_names
 is used directly, it 
@@ -586,7 +586,7 @@ The
 function is used to free the opaque structure 
 .Dq Va lc.opaque
 and its components.
-.Sy NOTE:
+.Sy NOTE :
 The
 .Dq Va opaque
 field of 
@@ -614,7 +614,7 @@ and
 is set to
 .Dv NULL .
 .Pp
-.Sy NOTE:
+.Sy NOTE :
 The function 
 .Fn log_free_context 
 does
@@ -704,7 +704,9 @@ create a new channel of the type specified (thus, the difference in arguments);
 the 
 .Dq Va type
 field of the new
-.Dq Ft struct log_channel
+.Do
+.Ft struct log_channel
+.Dc
 is always set to the appropriate value.
 .Pp
 The 
@@ -807,7 +809,8 @@ c) if any of
 or
 .Xr fdopen 3
 fails
-.Po Va errno 
+.Po
+.Va errno 
 is set by the call which failed 
 .Pc .
 If some value other than
@@ -862,7 +865,8 @@ is
 or 
 .Fa category
 is invalid (negative or greater than or equal to 
-.Va lcp->num_categories ), with
+.Va lcp->num_categories ) ,
+with
 .Va errno 
 set to 
 .Dv EINVAL ;
index 5425650b3378b0cbbd46b8784e8d20b36b34fa33..1e0ba6cfb0393b2dcf7dc230c91da0f322357d2c 100644 (file)
@@ -1,4 +1,4 @@
-.\" $Id: memcluster.mdoc,v 1.1 2001/03/29 06:31:55 marka Exp $
+.\" $Id: memcluster.mdoc,v 1.1.2.1 2001/11/02 21:06:03 gson Exp $
 .\"
 .\"Copyright (c) 1995-1999 by Internet Software Consortium
 .\"
@@ -20,7 +20,7 @@
 .\"Os OPERATING_SYSTEM [version/release]
 .Os BSD 4
 .\"Dt DOCUMENT_TITLE [section number] [volume]
-.Dt memcluster 3
+.Dt MEMCLUSTER 3
 .Sh NAME
 .Nm meminit ,
 .Nm memget ,
@@ -192,7 +192,8 @@ the the value
 as mentioned in the 
 .Sx INTERNALS 
 subsection, above, the block is placed at the head of the free list of 
-.Va new_size Ns No -sized blocks.
+.Va new_size Ns -sized
+blocks.
 If the given
 .Fa size
 is zero or negative, then 
@@ -276,7 +277,7 @@ is generally
 equal to
 .Fa size , 
 which has these implications:
-.Bl -enum -offset -indent means that, for 
+.Bl -enum -offset indent
 .It
 For
 .Fa size
index 02d452f78813c19307ed217def2389fc2fe3d037..653552634b3055e12b5d3e3ec6cca574e339648e 100644 (file)
@@ -1,4 +1,4 @@
-.\" $Id: tree.mdoc,v 1.1 2001/03/29 06:31:55 marka Exp $
+.\" $Id: tree.mdoc,v 1.1.2.1 2001/11/02 21:06:04 gson Exp $
 .\"
 .\"Copyright (c) 1995-1999 by Internet Software Consortium
 .\"
 .Ft void *
 .Fn tree_srch "void **tree" "int (*compare)()" "void *data"
 .Ft void
-.Fn tree_add(tree, compare, data, del_uar) "void **tree" "int (*compare)()" \
+.Fn tree_add "void **tree" "int (*compare)()" \
 "void *data" "void (*del_uar)()"
 .Ft int
-.Fn tree_delete(tree, compare, data, del_uar) "void **tree" "int (*compare)()" \
+.Fn tree_delete "void **tree" "int (*compare)()" \
 "void *data" "void (*del_uar)()"
 .Ft int
-.Fn tree_trav(tree, trav_uar) "void **tree" "int (*trav_uar)()"
+.Fn tree_trav "void **tree" "int (*trav_uar)()"
 .Ft void
-.Fn tree_mung(tree, del_uar) "void **tree" "void (*del_uar)()"
+.Fn tree_mung "void **tree" "void (*del_uar)()"
 .Sh DESCRIPTION
 These functions create and manipulate a balanced binary (AVL) tree.  Each node
 of the tree contains the expected left & right subtree pointers, a short int
@@ -88,19 +88,19 @@ returns 0.
 inserts or replaces a node in the specified tree.  The tree specified by
 .Dq Fa tree
 is searched as in
-.Fn tree_srch,
+.Fn tree_srch ,
 and if a node is found to match
-.Dq Fa data,
+.Dq Fa data ,
 then the
 .Fn del_uar
 function, if non\-\s-2NULL\s+2, is called with the address of the user data
 block for the node (this routine should deallocate any dynamic memory which
 is referenced exclusively by the node); the user data pointer for the node
 is then replaced by the value of
-.Dq Fa data.
+.Dq Fa data .
 If no node is found to match, a new node is added (which may or may not
 cause a transparent rebalance operation), with a user data pointer equal to
-.Dq Fa data.
+.Dq Fa data .
 A rebalance may or may not occur, depending on where the node is added
 and what the rest of the tree looks like.
 .Fn Tree_add
@@ -110,7 +110,7 @@ pointer unless catastrophe occurs in which case it will return \s-2NULL\s+2.
 .Pp
 .Fn Tree_delete
 deletes a node from
-.Dq Fa tree.
+.Dq Fa tree .
 A rebalance may or may not occur, depending on where the node is removed from
 and what the rest of the tree looks like.
 .Fn Tree_delete
@@ -118,7 +118,7 @@ returns TRUE if a node was deleted, FALSE otherwise.
 .Pp
 .Fn Tree_trav
 traverses all of
-.Dq Fa tree,
+.Dq Fa tree ,
 calling
 .Fn trav_uar
 with the address of each user data block.  If
@@ -132,7 +132,7 @@ will return TRUE.
 .Pp
 .Fn Tree_mung
 deletes every node in
-.Dq Fa tree,
+.Dq Fa tree ,
 calling
 .Fn del_uar
 (if it is not \s-2NULL\s+2) with the user data address from each node (see