summaryrefslogtreecommitdiff
path: root/htab/README
diff options
context:
space:
mode:
Diffstat (limited to 'htab/README')
-rw-r--r--htab/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/htab/README b/htab/README
new file mode 100644
index 0000000..cd296b2
--- /dev/null
+++ b/htab/README
@@ -0,0 +1,8 @@
+Generic open addressing hash table.
+
+The table-related functions in this module expect a sz argument specifying the
+table's element size. This value must remain consistent across all function
+calls referencing the table.
+
+The hash value 0 is reserved as a sentinel value for use by the hash table
+implementation, and must not be used.