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

Merge pull request #150 from txkxgit/txkx/docu2

Browse Source 
Doc nits
This commit is contained in:
mhx 2023-07-14 09:43:06 +02:00 committed by Marcus Holland-Moritz
commit 6de6479ca1
5 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/dwarfs-format.md
View File

@ -337,7 +337,7 @@ is true.
Both the `names` and `symlinks` tables can be stored in a Both the `names` and `symlinks` tables can be stored in a
packed format in `compact_names` and `compact_symlinks`. packed format in `compact_names` and `compact_symlinks`.
There are two separate packing schemes that can be combined. There are two separate packing schemes which can be combined.
If none of these schemes is active, the difference between If none of these schemes is active, the difference between
e.g. `names` and `compact_names` is that the former is stored e.g. `names` and `compact_names` is that the former is stored
as a "proper" list, whereas the latter is stored as a single as a "proper" list, whereas the latter is stored as a single

4
doc/dwarfs.md
View File

@ -73,7 +73,7 @@ options:
- `-o readonly`: - `-o readonly`:
Show all file system entries as read-only. By default, DwarFS Show all file system entries as read-only. By default, DwarFS
will preserve the original writeability, which is obviously a will preserve the original writability, which is obviously a
lie as it's a read-only file system. However, this is needed lie as it's a read-only file system. However, this is needed
for overlays to work correctly, as otherwise directories are for overlays to work correctly, as otherwise directories are
seen as read-only by the overlay and it'll be impossible to seen as read-only by the overlay and it'll be impossible to
@ -204,7 +204,7 @@ set of Perl versions back.
Here's what you need to do: Here's what you need to do:
- Create a set of directories. In my case, these are all located - Create a set of directories. In my case, these are all located
in `/tmp/perl` as this was the orginal install location. in `/tmp/perl` as this was the original install location.
``` ```
cd /tmp/perl cd /tmp/perl

4
doc/dwarfsck.md
View File

@ -44,10 +44,10 @@ with a non-zero exit code.
note that the format is *not* stable. note that the format is *not* stable.
- `--export-metadata=`*file*: - `--export-metadata=`*file*:
Export all filesystem meteadata in JSON format. Export all filesystem metadata in JSON format.
- `--log-level=`*name*: - `--log-level=`*name*:
Specifiy a logging level. Specify a logging level.
- `--help`: - `--help`:
Show program help, including option defaults. Show program help, including option defaults.

2
doc/dwarfsextract.md
View File

@ -84,7 +84,7 @@ to disk:
can use a significant amount of additional memory. can use a significant amount of additional memory.
- `-l`, `--log-level=`*name*: - `-l`, `--log-level=`*name*:
Specifiy a logging level. Specify a logging level.
- `--perfmon=`*name*: - `--perfmon=`*name*:
Enable performance monitoring for the list of comma-separated components. Enable performance monitoring for the list of comma-separated components.

26
doc/mkdwarfs.md
View File

@ -33,8 +33,8 @@ There are two mandatory options for specifying the input and output:
- `--input-list=`*file*|`-`: - `--input-list=`*file*|`-`:
Read list of paths to add to the file system from this file or from stdin. Read list of paths to add to the file system from this file or from stdin.
The pathames will be interpreted relative to the path given with `--input`. The path names will be interpreted relative to the path given with `--input`.
If `--input` is omitted, the pathames will be interpreted relative to the If `--input` is omitted, the path names will be interpreted relative to the
current directory. If you want files to be stored in the exact same order current directory. If you want files to be stored in the exact same order
as read from this list (because, for example, you have already sorted them as read from this list (because, for example, you have already sorted them
by similarity or access frequency), you must also pass `--order=none`. by similarity or access frequency), you must also pass `--order=none`.
@ -83,8 +83,8 @@ Most other options are concerned with compression tuning:
and block building are 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
sure the ordering and segmenting threads are prioritised over compression ensures the ordering and segmenting threads are prioritised over compression
as they provide the data to the compression workers. On Windows, the values as they provide the data to the compression workers. On Windows, the values
are mapped as follows: 0 (zero) is mapped to "normal" priority, 1 to 5 are are mapped as follows: 0 (zero) is mapped to "normal" priority, 1 to 5 are
mapped to "below normal" priority, 6 to 10 are mapped to "lowest" priority mapped to "below normal" priority, 6 to 10 are mapped to "lowest" priority
@ -119,7 +119,7 @@ Most other options are concerned with compression tuning:
this means less blocks will be used in the filesystem and potentially this means less blocks will be used in the filesystem and potentially
less memory will be used when accessing the filesystem. It doesn't less memory will be used when accessing the filesystem. It doesn't
necessarily mean that the filesystem will be much smaller, as this removes necessarily mean that the filesystem will be much smaller, as this removes
redundany that cannot be exploited by the block compression any longer. redundancy that cannot be exploited by the block compression any longer.
But it shouldn't make the resulting filesystem any bigger. This option But it shouldn't make the resulting filesystem any bigger. This option
is used along with `--window-step` to determine how extensive this is used along with `--window-step` to determine how extensive this
segment search will be. The smaller the window sizes, the more segments segment search will be. The smaller the window sizes, the more segments
@ -131,7 +131,7 @@ Most other options are concerned with compression tuning:
- `-w`, `--window-step=`*value*: - `-w`, `--window-step=`*value*:
This option specifies how often cyclic hash values are stored for lookup. This option specifies how often cyclic hash values are stored for lookup.
It is specified relative to the window size, as a base-2 exponent that It is specified relative to the window size, as a base-2 exponent that
divides the window size. To give a concrete example, if `--window-size=16` divides the window size. As a concrete example, if `--window-size=16`
and `--window-step=1`, then a cyclic hash across 65536 bytes will be stored and `--window-step=1`, then a cyclic hash across 65536 bytes will be stored
at every 32768 bytes of input data. If `--window-step=2`, then a hash value at every 32768 bytes of input data. If `--window-step=2`, then a hash value
will be stored at every 16384 bytes. This means that not every possible will be stored at every 16384 bytes. This means that not every possible
@ -147,8 +147,8 @@ Most other options are concerned with compression tuning:
90% of bad matches quickly with the default bloom filter size. The default 90% of bad matches quickly with the default bloom filter size. The default
is pretty much where the sweet spot lies. If you have copious amounts of is pretty much where the sweet spot lies. If you have copious amounts of
RAM and CPU power, feel free to increase this by one or two and you *might* RAM and CPU power, feel free to increase this by one or two and you *might*
be able to see some improvement. If you're tight on memory, then decreasing be able to see some improvement. If your system is tight on memory, then
this will potentially save a few MiBs. decreasing this will potentially save a few MiBs.
- `-L`, `--memory-limit=`*value*: - `-L`, `--memory-limit=`*value*:
Approximately how much memory you want `mkdwarfs` to use during filesystem Approximately how much memory you want `mkdwarfs` to use during filesystem
@ -175,7 +175,7 @@ Most other options are concerned with compression tuning:
The compression algorithm and configuration used for the metadata schema. The compression algorithm and configuration used for the metadata schema.
Takes the same arguments as `--compression` above. The schema is *very* Takes the same arguments as `--compression` above. The schema is *very*
small, in the hundreds of bytes, so this is only relevant for extremely small, in the hundreds of bytes, so this is only relevant for extremely
small file systems. The default (`zstd`) has shown to give considerably small file systems. The default (`zstd`) has shown to provide considerably
better results than any other algorithms. better results than any other algorithms.
- `--metadata-compression=`*algorithm*[`:`*algopt*[`=`*value*][`,`...]]: - `--metadata-compression=`*algorithm*[`:`*algopt*[`=`*value*][`,`...]]:
@ -365,7 +365,7 @@ following option to enable customizations via the scripting interface:
- `--script=`*file*[`:`*class*[`(`arguments`...)`]]: - `--script=`*file*[`:`*class*[`(`arguments`...)`]]:
Specify the Python script to load. The class name is optional if there's Specify the Python script to load. The class name is optional if there's
a class named `mkdwarfs` in the script. It is also possible to pass a class named `mkdwarfs` in the script. It is also possible to pass
arguments to the constuctor. arguments to the constructor.
## TIPS & TRICKS ## TIPS & TRICKS
@ -409,7 +409,7 @@ but you can still save around 30-50% by enabling compression. However,
this means that upon reading the filesystem, you will first have to this means that upon reading the filesystem, you will first have to
fully decompress the metadata block and keep it in memory. An uncompressed fully decompress the metadata block and keep it in memory. An uncompressed
block could simply be mapped into memory and would be instantly usable. block could simply be mapped into memory and would be instantly usable.
So if e.g. mounting speed is a concern, it would make sense to disable So, if e.g. mounting speed is a concern, it would make sense to disable
metadata compression, in particular for large filesystems. metadata compression, in particular for large filesystems.
However, there are several options to choose from that allow you to However, there are several options to choose from that allow you to
@ -522,7 +522,7 @@ using `--input-list`.
## FILTER RULES ## FILTER RULES
The filter rules have been inspired by the `rsync` utility. These 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, though 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.
There are only 3 different kinds of rules: There are only 3 different kinds of rules:
@ -567,7 +567,7 @@ separators.
Patterns also support character classes. Patterns also support character classes.
Here's an example rule set: Here's an exemplary rule set:
``` ```
+ File/Spec/[EM]*.pm + File/Spec/[EM]*.pm