Merge commit 'athcx/bloom'

[adu.git] / adu.ggo

diff --git a/adu.ggo b/adu.ggo
index 2ddc34e234acd87538fcfbc49abe9f53a83c1fbf..873cc22cdca5d2102f27fc3731515c9e84048d3c 100644 (file)
--- a/adu.ggo
+++ b/adu.ggo
@@ -165,6 +165,36 @@ details="
        users. Decreasing the value causes adu to use slightly less memory.
 "
 
+option "bloom-filter-order" B
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"use bloom filters for hard link detection"
+int typestr="order"
+dependon="create"
+default="23"
+optional
+details="
+       Allocate bloom filters of size 2^order bits. Each regular
+       file with hard link count greater than one is added to these
+       filters which allows to detect hard links on a per-user basis.
+       Greater values reduce the probability of false positives but
+       require more memory.
+
+       Values less than 10 deactivate this feature so that no hard
+       links are being detected.
+"
+
+option "num-bloom-filter-hash-functions" N
+#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+"number of hash functions for the bloom filters"
+int typestr="num"
+dependon="create"
+default="10"
+optional
+details="
+       Cause each entry which is added to the bloom filter to set
+       \"num\" bits of the bloom filter.
+"
+
 ##############################
 section "Options for --select"
 ##############################