index: remove vestigial buffer and sys imports

[bup.git] / Documentation / bup-bloom.md

diff --git a/Documentation/bup-bloom.md b/Documentation/bup-bloom.md
index 1501e2e0c517959afdc03ce39830157eb10f3f68..9efea60b87b1485ed26553b35c54d29b252f7950 100644 (file)
--- a/Documentation/bup-bloom.md
+++ b/Documentation/bup-bloom.md
@@ -8,35 +8,45 @@ bup-bloom - generates, regenerates, updates bloom filters
 
 # SYNOPSIS
 
-bup bloom [-d dir] [-o outfile] [-k hashes] [-c idxfile]
+bup bloom [-d dir] [-o outfile] [-k hashes] [-c idxfile] [-f] [\--ruin]
 
 # DESCRIPTION
 
-`bup bloom` builds a bloom filter file for a bup repo, if
-one already exists, it checks it and updates or regenerates
-it if needed.
+`bup bloom` builds a bloom filter file for a bup
+repository. If one already exists, it checks the filter and
+updates or regenerates it as needed.
 
 # OPTIONS
 
--d, --dir=*directory*
-:   the directory, containing .idx files, to process.
-    defaults to $BUP_DIR/objects/pack
+\--ruin
+:   destroy bloom filters by setting the whole bitmask to
+    zeros.  you really want to know what you are doing if
+    run this and you want to delete the resulting bloom
+    when you are done with it.
 
--o, --outfile=*outfile*
+-f, \--force
+:   don't update the existing bloom file; generate a new
+    one from scratch.
+
+-d, \--dir=*directory*
+:   the directory, containing `.idx` files, to process.
+    Defaults to $BUP_DIR/objects/pack
+
+-o, \--outfile=*outfile*
 :   the file to write the bloom filter to.  defaults to
     $dir/bup.bloom
 
--k, --hashes=*hashes*
+-k, \--hashes=*hashes*
 :   number of hash functions to use only 4 and 5 are valid.
-    defaults to 5 for repositories < 2TiB and 4 otherwise.
-    see comments in git.py for more on this value.
+    defaults to 5 for repositories < 2 TiB, or 4 otherwise.
+    See comments in git.py for more on this value.
 
--c, --check=*idxfile*
+-c, \--check=*idxfile*
 :   checks the bloom file (counterintuitively outfile)
-    against the specified .idx file, first checks that the
-    bloom filter is claiming to contain the .idx, then
+    against the specified `.idx` file, first checks that the
+    bloom filter is claiming to contain the `.idx`, then
     checks that it does actually contain all of the objects
-    in the .idx.  Does not write anything and ignores the
+    in the `.idx`.  Does not write anything and ignores the
     `-k` option.
 
 # BUP