From e434a0518a26150f070a8be5384ef1b6fd97c36b Mon Sep 17 00:00:00 2001 From: Samy Al Bahra Date: Mon, 3 Sep 2012 04:02:15 -0400 Subject: [PATCH] doc/ck_ht: Remove remaining references to ck_ht_allocator_set. --- doc/Makefile.in | 3 +- doc/ck_ht_allocator_set | 89 ---------------------------------- doc/ck_ht_count | 1 - doc/ck_ht_destroy | 3 +- doc/ck_ht_entry_empty | 1 - doc/ck_ht_entry_key | 1 - doc/ck_ht_entry_key_direct | 1 - doc/ck_ht_entry_key_length | 1 - doc/ck_ht_entry_key_set | 1 - doc/ck_ht_entry_key_set_direct | 1 - doc/ck_ht_entry_set | 1 - doc/ck_ht_entry_set_direct | 1 - doc/ck_ht_entry_value | 1 - doc/ck_ht_entry_value_direct | 1 - doc/ck_ht_get_spmc | 1 - doc/ck_ht_grow_spmc | 1 - doc/ck_ht_hash | 1 - doc/ck_ht_hash_direct | 1 - doc/ck_ht_init | 1 - doc/ck_ht_iterator_init | 1 - doc/ck_ht_next | 1 - doc/ck_ht_put_spmc | 1 - doc/ck_ht_remove_spmc | 1 - doc/ck_ht_reset_spmc | 1 - doc/ck_ht_set_spmc | 1 - 25 files changed, 2 insertions(+), 115 deletions(-) delete mode 100644 doc/ck_ht_allocator_set diff --git a/doc/Makefile.in b/doc/Makefile.in index f75c906..2da574c 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -3,8 +3,7 @@ MANDIR=@MANDIR@ GZIP=@GZIP@ GZIP_SUFFIX=.3@GZIP_SUFFIX@ -OBJECTS=ck_ht_allocator_set$(GZIP_SUFFIX) \ - ck_ht_count$(GZIP_SUFFIX) \ +OBJECTS=ck_ht_count$(GZIP_SUFFIX) \ ck_ht_destroy$(GZIP_SUFFIX) \ ck_ht_get_spmc$(GZIP_SUFFIX) \ ck_ht_grow_spmc$(GZIP_SUFFIX) \ diff --git a/doc/ck_ht_allocator_set b/doc/ck_ht_allocator_set deleted file mode 100644 index f327c6f..0000000 --- a/doc/ck_ht_allocator_set +++ /dev/null @@ -1,89 +0,0 @@ -.\" -.\" Copyright 2012 Samy Al Bahra. -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" -.Dd March 29, 2012 -.Dt CK_HT_ALLOCATOR_SET 3 -.Sh NAME -.Nm ck_ht_allocator_set -.Nd specify hash table memory allocation functions -.Sh LIBRARY -Concurrency Kit (libck, \-lck) -.Sh SYNOPSIS -.In ck_ht.h -.Ft bool -.Fn ck_ht_allocator_set "struct ck_malloc *allocator" -.Sh DESCRIPTION -The -.Fn ck_ht_allocator_set -function initializes the memory allocation functions used by the hash -table implementation according to the function pointers specified -by the structure pointed to by the -.Fa allocator -argument. It is mandatory that this function is called before -any other ck_ht operations. -.Sh RETURN VALUES -Upon successful completion -.Fn ck_ht_allocator_set -returns a value of -.Dv true -and otherwise returns a value of -.Dv false -to indicate failure. -.Sh ERRORS -.Bl -tag -width Er -The only failure condition is that one of the pointers -specified by -.Fa allocator -is a -.Dv NULL -value. -.El -.Sh SEE ALSO -.Xr ck_ht_init 3 , -.Xr ck_ht_destroy 3 , -.Xr ck_ht_hash 3 , -.Xr ck_ht_hash_direct 3 , -.Xr ck_ht_set_spmc 3 , -.Xr ck_ht_put_spmc 3 , -.Xr ck_ht_get_spmc 3 , -.Xr ck_ht_grow_spmc 3 , -.Xr ck_ht_remove_spmc 3 , -.Xr ck_ht_reset_spmc 3 , -.Xr ck_ht_count 3 , -.Xr ck_ht_entry_empty 3 , -.Xr ck_ht_entry_key_set 3 , -.Xr ck_ht_entry_key_set_direct 3 , -.Xr ck_ht_entry_key 3 , -.Xr ck_ht_entry_key_length 3 , -.Xr ck_ht_entry_value 3 , -.Xr ck_ht_entry_set 3 , -.Xr ck_ht_entry_set_direct 3 , -.Xr ck_ht_entry_key_direct 3 , -.Xr ck_ht_entry_value_direct 3 , -.Xr ck_ht_iterator_init 3 , -.Xr ck_ht_next 3 -.Pp -Additional information available at http://concurrencykit.org/ diff --git a/doc/ck_ht_count b/doc/ck_ht_count index f1f9615..6059dac 100644 --- a/doc/ck_ht_count +++ b/doc/ck_ht_count @@ -50,7 +50,6 @@ has not been initialized. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_destroy b/doc/ck_ht_destroy index 8bd2369..4ba77f0 100644 --- a/doc/ck_ht_destroy +++ b/doc/ck_ht_destroy @@ -39,7 +39,7 @@ Concurrency Kit (libck, \-lck) The .Fn ck_ht_destroy function will request that the underlying allocator, as specified by the -.Xr ck_ht_allocator_set 3 +.Xr ck_ht_init 3 function, immediately destroy the object pointed to by the .Fa ht argument. @@ -59,7 +59,6 @@ This function is guaranteed not to fail. .El .Sh SEE ALSO .Xr ck_ht_init 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_empty b/doc/ck_ht_entry_empty index 4b2f659..a99070d 100644 --- a/doc/ck_ht_entry_empty +++ b/doc/ck_ht_entry_empty @@ -63,7 +63,6 @@ has not been initialized. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_key b/doc/ck_ht_entry_key index 4fcc898..790f11b 100644 --- a/doc/ck_ht_entry_key +++ b/doc/ck_ht_entry_key @@ -61,7 +61,6 @@ has not been initialized. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_key_direct b/doc/ck_ht_entry_key_direct index a4a9019..821a78c 100644 --- a/doc/ck_ht_entry_key_direct +++ b/doc/ck_ht_entry_key_direct @@ -64,7 +64,6 @@ has not been initialized. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_key_length b/doc/ck_ht_entry_key_length index eb87265..16ee7a3 100644 --- a/doc/ck_ht_entry_key_length +++ b/doc/ck_ht_entry_key_length @@ -61,7 +61,6 @@ has not been initialized. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_key_set b/doc/ck_ht_entry_key_set index 40774b9..155c4a6 100644 --- a/doc/ck_ht_entry_key_set +++ b/doc/ck_ht_entry_key_set @@ -63,7 +63,6 @@ This function will never fail. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_key_set_direct b/doc/ck_ht_entry_key_set_direct index 71cc763..b7fe550 100644 --- a/doc/ck_ht_entry_key_set_direct +++ b/doc/ck_ht_entry_key_set_direct @@ -61,7 +61,6 @@ This function will never fail. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_set b/doc/ck_ht_entry_set index 545f725..91655a4 100644 --- a/doc/ck_ht_entry_set +++ b/doc/ck_ht_entry_set @@ -65,7 +65,6 @@ This function will never fail. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_set_direct b/doc/ck_ht_entry_set_direct index 69e2ed7..ecccf53 100644 --- a/doc/ck_ht_entry_set_direct +++ b/doc/ck_ht_entry_set_direct @@ -67,7 +67,6 @@ This function will never fail. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_value b/doc/ck_ht_entry_value index 7f668d2..a842f3d 100644 --- a/doc/ck_ht_entry_value +++ b/doc/ck_ht_entry_value @@ -61,7 +61,6 @@ has not been initialized or if the key is empty. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_entry_value_direct b/doc/ck_ht_entry_value_direct index d67deaa..c63e252 100644 --- a/doc/ck_ht_entry_value_direct +++ b/doc/ck_ht_entry_value_direct @@ -62,7 +62,6 @@ has not been initialized or if the key is empty. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_get_spmc b/doc/ck_ht_get_spmc index a933320..413c90c 100644 --- a/doc/ck_ht_get_spmc +++ b/doc/ck_ht_get_spmc @@ -150,7 +150,6 @@ was not found in the hash table. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_grow_spmc b/doc/ck_ht_grow_spmc index 693282c..10150b4 100644 --- a/doc/ck_ht_grow_spmc +++ b/doc/ck_ht_grow_spmc @@ -71,7 +71,6 @@ if there are internal memory allocation failures. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_hash b/doc/ck_ht_hash index 183d60b..676cb3b 100644 --- a/doc/ck_ht_hash +++ b/doc/ck_ht_hash @@ -63,7 +63,6 @@ is uninitialized. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , .Xr ck_ht_put_spmc 3 , diff --git a/doc/ck_ht_hash_direct b/doc/ck_ht_hash_direct index 9230bfb..f83e90d 100644 --- a/doc/ck_ht_hash_direct +++ b/doc/ck_ht_hash_direct @@ -63,7 +63,6 @@ is uninitialized. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_set_spmc 3 , .Xr ck_ht_put_spmc 3 , diff --git a/doc/ck_ht_init b/doc/ck_ht_init index 4826820..51750e1 100644 --- a/doc/ck_ht_init +++ b/doc/ck_ht_init @@ -154,7 +154,6 @@ is not a pointer to a object. .El .Sh SEE ALSO -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_destroy 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , diff --git a/doc/ck_ht_iterator_init b/doc/ck_ht_iterator_init index 97ddf89..6813ffc 100644 --- a/doc/ck_ht_iterator_init +++ b/doc/ck_ht_iterator_init @@ -62,7 +62,6 @@ This function will not fail. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_next b/doc/ck_ht_next index 97a82e0..0352e05 100644 --- a/doc/ck_ht_next +++ b/doc/ck_ht_next @@ -80,7 +80,6 @@ are uninitialized. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_put_spmc b/doc/ck_ht_put_spmc index 4a3f554..a5889b5 100644 --- a/doc/ck_ht_put_spmc +++ b/doc/ck_ht_put_spmc @@ -119,7 +119,6 @@ was already present in the hash table. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_remove_spmc b/doc/ck_ht_remove_spmc index 789f4f8..496b526 100644 --- a/doc/ck_ht_remove_spmc +++ b/doc/ck_ht_remove_spmc @@ -90,7 +90,6 @@ will return .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_reset_spmc b/doc/ck_ht_reset_spmc index a10f5ea..f657978 100644 --- a/doc/ck_ht_reset_spmc +++ b/doc/ck_ht_reset_spmc @@ -54,7 +54,6 @@ could not be allocated internally. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_set_spmc 3 , diff --git a/doc/ck_ht_set_spmc b/doc/ck_ht_set_spmc index cbee99c..f4bdf56 100644 --- a/doc/ck_ht_set_spmc +++ b/doc/ck_ht_set_spmc @@ -113,7 +113,6 @@ while attempting to grow. .Sh SEE ALSO .Xr ck_ht_init 3 , .Xr ck_ht_destroy 3 , -.Xr ck_ht_allocator_set 3 , .Xr ck_ht_hash 3 , .Xr ck_ht_hash_direct 3 , .Xr ck_ht_put_spmc 3 ,