TheCloud/dwarfs
1
0
Fork 0
mirror of https://github.com/mhx/dwarfs.git synced 2025-09-10 04:50:31 -04:00
Code Issues Packages Projects Releases Wiki Activity

Minor wording changes in mkdwarfs.md

Browse Source
This commit is contained in:
txkx 2023-07-11 15:13:22 +02:00
parent c7aaf110f6
commit 3071f48a9e
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/mkdwarfs.md
View File

@ -18,13 +18,13 @@ full contents of `/path/dir` with:
mkdwarfs -i /path/dir -o image.dwarfs mkdwarfs -i /path/dir -o image.dwarfs
After that, you can mount it with dwarfs(1): After that, you can mount it using dwarfs(1):
dwarfs image.dwarfs /path/to/mountpoint dwarfs image.dwarfs /path/to/mountpoint
## OPTIONS ## OPTIONS
There two mandatory options for specifying the input and output: There are two mandatory options for specifying the input and output:
- `-i`, `--input=`*path*|*file*: - `-i`, `--input=`*path*|*file*:
Path to the root directory containing the files from which you want to Path to the root directory containing the files from which you want to
@ -78,9 +78,9 @@ Most other options are concerned with compression tuning:
to the number of processors available on your system. Use this option if to the number of processors available on your system. Use this option if
you want to limit the resources used by `mkdwarfs` or to optimize build you want to limit the resources used by `mkdwarfs` or to optimize build
speed. This option affects only the compression phase. speed. This option affects only the compression phase.
In the compression phase, the worker threads are used to compress the During the compression phase, the worker threads are used to compress the
individual filesystem blocks in the background. Ordering, segmenting individual filesystem blocks in the background. Ordering, segmenting
and block building are, again, single-threaded and run independently. and block building are single-threaded and run independently.
- `--compress-niceness=`*value*: - `--compress-niceness=`*value*:
Set the niceness of compression worker threads. Defaults to 5. This makes Set the niceness of compression worker threads. Defaults to 5. This makes
@ -112,7 +112,7 @@ Most other options are concerned with compression tuning:
will completely disable duplicate segment search. will completely disable duplicate segment search.
- `-W`, `--window-size=`*value*: - `-W`, `--window-size=`*value*:
Window size of cyclic hash used for segmenting. This is again an exponent Window size of cyclic hash used for segmenting. This is an exponent
to a base of two. Cyclic hashes are used by `mkdwarfs` for finding to a base of two. Cyclic hashes are used by `mkdwarfs` for finding
identical segments across multiple files. This is done on top of duplicate identical segments across multiple files. This is done on top of duplicate
file detection. If a reasonable amount of duplicate segments is found, file detection. If a reasonable amount of duplicate segments is found,
@ -399,7 +399,7 @@ a library that allows serialization of structures defined in
[Thrift IDL](https://github.com/facebook/fbthrift/) into an extremely [Thrift IDL](https://github.com/facebook/fbthrift/) into an extremely
compact representation that can be used in-place without the need for compact representation that can be used in-place without the need for
deserialization. It is very well suited for persistent, memory-mappable deserialization. It is very well suited for persistent, memory-mappable
data. With Frozen, you essentially only pay for what you use: if fields data. With Frozen, you essentially only "pay for what you use": if fields
are defined in the IDL, but they always hold the same value (or are not are defined in the IDL, but they always hold the same value (or are not
used at all), not a single bit will be allocated for this field even if used at all), not a single bit will be allocated for this field even if
you have a list of millions of items. you have a list of millions of items.
@ -461,7 +461,7 @@ These options are controlled by the `--pack-metadata` option.
of two. The entries can be decompressed individually, so no of two. The entries can be decompressed individually, so no
extra memory is used when accessing the filesystem (except for extra memory is used when accessing the filesystem (except for
the symbol table, which is only a few hundred bytes). This is the symbol table, which is only a few hundred bytes). This is
turned on by default. For small filesystems, it's possible that enabled by default. For small filesystems, it's possible that
the compressed strings plus symbol table are actually larger the compressed strings plus symbol table are actually larger
than the uncompressed strings. If this is the case, the strings than the uncompressed strings. If this is the case, the strings
will be stored uncompressed, unless `force` is also specified. will be stored uncompressed, unless `force` is also specified.
@ -497,10 +497,10 @@ the corresponding packing option.
plain | 6,430,275 | 121.30% | 48.36% | 41.37% plain | 6,430,275 | 121.30% | 48.36% | 41.37%
---------|---------------|-----------|---------|--------- ---------|---------------|-----------|---------|---------
So the default (`auto`) is roughly 20% smaller than not using any So, the default (`auto`) is roughly 20% smaller than not using any
packing (`none` or `plain`). Enabling `all` packing options doesn't packing (`none` or `plain`). Enabling `all` packing options doesn't
reduce the size much more. However, it *does* help if you want to reduce the size much more. However, it *does* help if you want to
further compress the block. So if you're really desperately trying further compress the block. So, if you're really desperately trying
to reduce the image size, enabling `all` packing would be an option to reduce the image size, enabling `all` packing would be an option
at the cost of using a lot more memory when using the filesystem. at the cost of using a lot more memory when using the filesystem.
@ -521,7 +521,7 @@ using `--input-list`.
## FILTER RULES ## FILTER RULES
The filter rules have been inspired by the `rsync` utility. They The filter rules have been inspired by the `rsync` utility. These
look very similar, but there are differences. These rules are quite look very similar, but there are differences. These rules are quite
powerful, yet they're somewhat hard to get used to. powerful, yet they're somewhat hard to get used to.