Add bup split --noop <--blobs|--tree>

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

diff --git a/Documentation/bup-split.md b/Documentation/bup-split.md
index 22d63cbc12a6571aa2ac09a11ddaf54fefb40b9e..89e4f039c1c765ddf29aaab4f16877388616aa3d 100644 (file)
--- a/Documentation/bup-split.md
+++ b/Documentation/bup-split.md
@@ -12,7 +12,9 @@ bup split \[-t\] \[-c\] \[-n *name*\] COMMON\_OPTIONS
 
 bup split -b COMMON\_OPTIONS
 
-bup split \<--noop \[--copy\]|--copy\> COMMON\_OPTIONS
+bup split --copy COMMON\_OPTIONS
+
+bup split --noop \<\[-t|-b\]\> COMMON\_OPTIONS
 
 COMMON\_OPTIONS
   ~ \[-r *host*:*path*\] \[-v\] \[-q\] \[-d *seconds-since-epoch*\] \[\--bench\]
@@ -76,9 +78,11 @@ being the most likely choice.
 
 \--noop
 :   read the data and split it into blocks based on the "bupsplit"
-    rolling checksum algorithm, but don't do anything with the blocks.
-    This is mostly useful for benchmarking.  Incompatible with -n, -t,
-    -c, and -b.
+    rolling checksum algorithm, but don't store anything in the repo.
+    Can be combined with -b or -t to compute (but not store) the git
+    blobs or tree ids for the dataset. This is mostly useful for
+    benchmarking and validating the bupsplit algorithm. Incompatible
+    with -n and -c.
 
 \--copy
 :   like `--noop`, but also write the data to stdout.  This can be