Skip to content

Commit

Permalink
Rectify bup-split documentation for the fanout option.
Browse files Browse the repository at this point in the history
The --fanout option is no longer the maximum number of objects in a
tree, but an average. The documentation, however was never updated and
this can lead to misunderstandings.

Also add a "bold" delimiter that was forgotten in the command summary in
its documentation page.

Signed-off-by: Gabriel Filion <lelutin@gmail.com>
Reviewed-by: Rob Browning <rlb@defaultvalue.org>
  • Loading branch information
Gabriel Filion authored and rlbdv committed Oct 9, 2012
1 parent 73aedc7 commit 9827d85
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
8 changes: 3 additions & 5 deletions Documentation/bup-split.md
Expand Up @@ -10,7 +10,7 @@ bup-split - save individual files to bup backup sets

bup split [-r *host*:*path*] \<-b|-t|-c|-n *name*\> [-v] [-q]
[\--bench] [\--max-pack-size=*bytes*] [-#]
[\--max-pack-objects=*n*] [\--fanout=*count]
[\--max-pack-objects=*n*] [\--fanout=*count*]
[\--git-ids] [\--keep-boundaries] [filenames...]

# DESCRIPTION
Expand Down Expand Up @@ -121,10 +121,8 @@ To get the data back, use `bup-join`(1).
Usually there is no reason to change this.

\--fanout=*numobjs*
: when splitting very large files, never put more than
this number of git blobs in a single git tree. Instead,
generate a new tree and link to that. Default is
4096 objects per tree.
: when splitting very large files, try and keep the number
of elements in trees to an average of *numobjs*.

\--bwlimit=*bytes/sec*
: don't transmit more than *bytes/sec* bytes per second
Expand Down
4 changes: 2 additions & 2 deletions cmd/split-cmd.py
Expand Up @@ -8,7 +8,7 @@
bup split <-t|-c|-b|-n name|--copy|--noop> [--bench] [filenames...]
--
Modes:
b,blobs output a series of blob ids
b,blobs output a series of blob ids. Implies --fanout=0.
t,tree output a tree id
c,commit output a commit id
n,name= save the result under the given name
Expand All @@ -24,7 +24,7 @@
bench print benchmark timings to stderr
max-pack-size= maximum bytes in a single pack
max-pack-objects= maximum number of objects in a single pack
fanout= maximum number of blobs in a single tree
fanout= average number of blobs in a single tree
bwlimit= maximum bytes/sec to transmit to server
#,compress= set compression level to # (0-9, 9 is highest) [1]
"""
Expand Down

0 comments on commit 9827d85

Please sign in to comment.