]> arthur.barton.de Git - bup.git/blobdiff - Documentation/bup-gc.md
_helpers: fix module init, and get it at least building with py3
[bup.git] / Documentation / bup-gc.md
index 1088a8514f918b25ddd1851721168bc8ef8fa5d4..4996f3d1e429a1589efd64a61ffefa91ec57f6a1 100644 (file)
@@ -26,8 +26,12 @@ approaches.
 Typically, the garbage collector would be invoked after some set of
 invocations of `bup rm`.
 
-WARNING: This is one of the few bup commands that modifies your archive
-in intentionally destructive ways.
+WARNING: This is one of the few bup commands that modifies your
+archive in intentionally destructive ways.  Though if an attempt to
+`join` or `restore` the data you still care about after a `gc`
+succeeds, that's a fairly encouraging sign that the commands worked
+correctly.  (The `t/compare-trees` command in the source tree can be
+used to help test before/after results.)
 
 # OPTIONS
 
@@ -43,7 +47,7 @@ in intentionally destructive ways.
 -*#*, \--compress=*#*
 :   set the compression level to # (a value from 0-9, where
     9 is the highest and 0 is no compression).  The default
-    is 6.
+    is 1 (fast, loose compression).
 
 # EXAMPLES