Skip to content

Commit 00f4d64

Browse files
committed
docs(mkdwarfs): add a warning to the -B flag
1 parent a30e23b commit 00f4d64

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

doc/mkdwarfs.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,14 @@ Most other options are concerned with compression tuning:
128128
By default, only the current block will be scanned. The larger this number,
129129
the more duplicate segments will likely be found, which may further improve
130130
compression. Impact on compression speed is minimal, but this could cause
131-
resulting filesystem to be slightly less efficient to use, as single small
132-
files can now potentially span multiple filesystem blocks. Passing `-B0`
133-
will completely disable duplicate segment search.
131+
resulting filesystem to be less efficient to use, as single small files can
132+
now potentially span multiple filesystem blocks. Definitely avoid passing
133+
large values (i.e. larger than 10) here, especially in combination with
134+
large block sizes, unless you know *exactly* what you are doing. To give
135+
give you an idea, using `-S 26` (i.e. 64 MiB blocks) with `-B 32` means
136+
that in the worst case, to read a single file of less than 1 MiB in size,
137+
the file system may have to decompress 2 GiB of data. You have been warned.
138+
Passing `-B0` will completely disable duplicate segment search.
134139

135140
- `-W`, `--window-size=[*category*`::`]`*value*:
136141
Window size of cyclic hash used for segmenting. This is an exponent

0 commit comments

Comments
 (0)