From 816584b7d1072fa993c8b810ca65d7936abf1b7c Mon Sep 17 00:00:00 2001
From: Samy Al Bahra <sbahra@repnop.org>
Date: Wed, 18 Dec 2013 12:30:42 -0500
Subject: [PATCH] doc: Add ck_ht_gc cross-references.

---
 doc/ck_ht_count                | 1 +
 doc/ck_ht_destroy              | 1 +
 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_size_spmc      | 1 +
 doc/ck_ht_reset_spmc           | 1 +
 doc/ck_ht_set_spmc             | 1 +
 doc/ck_ht_stat                 | 1 +
 25 files changed, 25 insertions(+)

diff --git a/doc/ck_ht_count b/doc/ck_ht_count
index 92d2089..ba10835 100644
--- a/doc/ck_ht_count
+++ b/doc/ck_ht_count
@@ -55,6 +55,7 @@ has not been initialized.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_destroy b/doc/ck_ht_destroy
index a509a09..95e4acb 100644
--- a/doc/ck_ht_destroy
+++ b/doc/ck_ht_destroy
@@ -64,6 +64,7 @@ This function is guaranteed not to fail.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_empty b/doc/ck_ht_entry_empty
index 385be4b..9233344 100644
--- a/doc/ck_ht_entry_empty
+++ b/doc/ck_ht_entry_empty
@@ -68,6 +68,7 @@ has not been initialized.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_key b/doc/ck_ht_entry_key
index 651477a..5003a1a 100644
--- a/doc/ck_ht_entry_key
+++ b/doc/ck_ht_entry_key
@@ -66,6 +66,7 @@ has not been initialized.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_key_direct b/doc/ck_ht_entry_key_direct
index a5ed16f..e0a75a2 100644
--- a/doc/ck_ht_entry_key_direct
+++ b/doc/ck_ht_entry_key_direct
@@ -69,6 +69,7 @@ has not been initialized.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_key_length b/doc/ck_ht_entry_key_length
index c0e1326..6ac3ded 100644
--- a/doc/ck_ht_entry_key_length
+++ b/doc/ck_ht_entry_key_length
@@ -66,6 +66,7 @@ has not been initialized.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_key_set b/doc/ck_ht_entry_key_set
index 0dd4628..03e53bb 100644
--- a/doc/ck_ht_entry_key_set
+++ b/doc/ck_ht_entry_key_set
@@ -71,6 +71,7 @@ This function will never fail.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_key_set_direct b/doc/ck_ht_entry_key_set_direct
index 9d57444..1cd2d6c 100644
--- a/doc/ck_ht_entry_key_set_direct
+++ b/doc/ck_ht_entry_key_set_direct
@@ -66,6 +66,7 @@ This function will never fail.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_set b/doc/ck_ht_entry_set
index b5c2f80..b017430 100644
--- a/doc/ck_ht_entry_set
+++ b/doc/ck_ht_entry_set
@@ -73,6 +73,7 @@ This function will never fail.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_set_direct b/doc/ck_ht_entry_set_direct
index c446044..9c9bf08 100644
--- a/doc/ck_ht_entry_set_direct
+++ b/doc/ck_ht_entry_set_direct
@@ -72,6 +72,7 @@ This function will never fail.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_value b/doc/ck_ht_entry_value
index c0ca3ef..2e712e3 100644
--- a/doc/ck_ht_entry_value
+++ b/doc/ck_ht_entry_value
@@ -66,6 +66,7 @@ has not been initialized or if the key is empty.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_entry_value_direct b/doc/ck_ht_entry_value_direct
index 9cdf022..1a7c28e 100644
--- a/doc/ck_ht_entry_value_direct
+++ b/doc/ck_ht_entry_value_direct
@@ -67,6 +67,7 @@ has not been initialized or if the key is empty.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_get_spmc b/doc/ck_ht_get_spmc
index c46f0c1..91b9534 100644
--- a/doc/ck_ht_get_spmc
+++ b/doc/ck_ht_get_spmc
@@ -155,6 +155,7 @@ was not found in the hash table.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
 .Xr ck_ht_reset_spmc 3 ,
diff --git a/doc/ck_ht_grow_spmc b/doc/ck_ht_grow_spmc
index 563fb92..70e6055 100644
--- a/doc/ck_ht_grow_spmc
+++ b/doc/ck_ht_grow_spmc
@@ -76,6 +76,7 @@ if there are internal memory allocation failures.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
 .Xr ck_ht_reset_spmc 3 ,
diff --git a/doc/ck_ht_hash b/doc/ck_ht_hash
index fe037e9..0ac5db9 100644
--- a/doc/ck_ht_hash
+++ b/doc/ck_ht_hash
@@ -67,6 +67,7 @@ is uninitialized.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_hash_direct b/doc/ck_ht_hash_direct
index 4ad5364..564099c 100644
--- a/doc/ck_ht_hash_direct
+++ b/doc/ck_ht_hash_direct
@@ -67,6 +67,7 @@ is uninitialized.
 .Xr ck_ht_hash 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_init b/doc/ck_ht_init
index 864d4f8..602483d 100644
--- a/doc/ck_ht_init
+++ b/doc/ck_ht_init
@@ -165,6 +165,7 @@ object.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_iterator_init b/doc/ck_ht_iterator_init
index 6a2462b..14f10c6 100644
--- a/doc/ck_ht_iterator_init
+++ b/doc/ck_ht_iterator_init
@@ -67,6 +67,7 @@ This function will not fail.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_next b/doc/ck_ht_next
index db298ac..d0365a1 100644
--- a/doc/ck_ht_next
+++ b/doc/ck_ht_next
@@ -85,6 +85,7 @@ are uninitialized.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_put_spmc b/doc/ck_ht_put_spmc
index 38d78c9..f5a6389 100644
--- a/doc/ck_ht_put_spmc
+++ b/doc/ck_ht_put_spmc
@@ -123,6 +123,7 @@ was already present in the hash table.
 .Xr ck_ht_hash 3 ,
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_remove_spmc b/doc/ck_ht_remove_spmc
index f8ba2c6..a263866 100644
--- a/doc/ck_ht_remove_spmc
+++ b/doc/ck_ht_remove_spmc
@@ -95,6 +95,7 @@ will return
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_reset_spmc 3 ,
diff --git a/doc/ck_ht_reset_size_spmc b/doc/ck_ht_reset_size_spmc
index 49cdc29..4308380 100644
--- a/doc/ck_ht_reset_size_spmc
+++ b/doc/ck_ht_reset_size_spmc
@@ -62,6 +62,7 @@ could not be allocated internally.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_reset_spmc b/doc/ck_ht_reset_spmc
index ae072e0..dc2e601 100644
--- a/doc/ck_ht_reset_spmc
+++ b/doc/ck_ht_reset_spmc
@@ -59,6 +59,7 @@ could not be allocated internally.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_set_spmc b/doc/ck_ht_set_spmc
index 6bf9180..e0fe1ae 100644
--- a/doc/ck_ht_set_spmc
+++ b/doc/ck_ht_set_spmc
@@ -117,6 +117,7 @@ while attempting to grow.
 .Xr ck_ht_hash 3 ,
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,
diff --git a/doc/ck_ht_stat b/doc/ck_ht_stat
index ab7d29c..6d2f1cd 100644
--- a/doc/ck_ht_stat
+++ b/doc/ck_ht_stat
@@ -63,6 +63,7 @@ has not been initialized.
 .Xr ck_ht_hash_direct 3 ,
 .Xr ck_ht_set_spmc 3 ,
 .Xr ck_ht_put_spmc 3 ,
+.Xr ck_ht_gc 3 ,
 .Xr ck_ht_get_spmc 3 ,
 .Xr ck_ht_grow_spmc 3 ,
 .Xr ck_ht_remove_spmc 3 ,