Browse Source

Fix typos

pull/1045/head
Andrea Gelmini 2 years ago
parent
commit
338e559e53
No known key found for this signature in database GPG Key ID: A4309075F05960F6
  1. 12
      README.md
  2. 10
      man/mergerfs.1
  3. 5
      src/ghc/filesystem.hpp
  4. 2
      src/wyhash.h
  5. 4
      tests/acutest.h

12
README.md

@ -324,7 +324,7 @@ NFS is not fully POSIX compliant and historically certain behaviors, such as ope
This hack addresses the issue where the creation of a file with a read-only mode but with a read/write or write only flag. Normally this is perfectly valid but NFS chops the one open call into multiple calls. Exactly how it is translated depends on the configuration and versions of the NFS server and clients but it results in a permission error because a normal user is not allowed to open a read-only file as writable. This hack addresses the issue where the creation of a file with a read-only mode but with a read/write or write only flag. Normally this is perfectly valid but NFS chops the one open call into multiple calls. Exactly how it is translated depends on the configuration and versions of the NFS server and clients but it results in a permission error because a normal user is not allowed to open a read-only file as writable.
Even though it's a more niche situation this hack breaks normal security and behavior and as such is `off` by default. If set to `git` it will only perform the hack when the path in question includes `/.git/`. `all` will result it it applying anytime a readonly file which is empty is opened for writing.
Even though it's a more niche situation this hack breaks normal security and behavior and as such is `off` by default. If set to `git` it will only perform the hack when the path in question includes `/.git/`. `all` will result it applying anytime a readonly file which is empty is opened for writing.
# FUNCTIONS, CATEGORIES and POLICIES # FUNCTIONS, CATEGORIES and POLICIES
@ -367,7 +367,7 @@ Policies basically search branches and create a list of files / paths for functi
Policies may have their own additional filtering such as those that require existing paths to be present. Policies may have their own additional filtering such as those that require existing paths to be present.
If all branches are filtered an error will be returned. Typically **EROFS** (read-only filesystem) or **ENOSPC** (no space left on device) depending on the most recent reason for filtering a branch. **ENOENT** will be returned if no elegible branch is found.
If all branches are filtered an error will be returned. Typically **EROFS** (read-only filesystem) or **ENOSPC** (no space left on device) depending on the most recent reason for filtering a branch. **ENOENT** will be returned if no eligible branch is found.
#### Path Preservation #### Path Preservation
@ -739,7 +739,7 @@ MergerFS does not natively support any sort of tiered caching. Most users have n
1. Fast network, slow drives, many readers: You've a 10+Gbps network with many readers and your regular drives can't keep up. 1. Fast network, slow drives, many readers: You've a 10+Gbps network with many readers and your regular drives can't keep up.
2. Fast network, slow drives, small'ish bursty writes: You have a 10+Gbps network and wish to transfer amounts of data less than your cache drive but wish to do so quickly. 2. Fast network, slow drives, small'ish bursty writes: You have a 10+Gbps network and wish to transfer amounts of data less than your cache drive but wish to do so quickly.
With #1 its arguable if you should be using mergerfs at all. RAID would probably be the better solution. If you're going to use mergerfs there are other tactics that may help: spreading the data across drives (see the mergerfs.dup tool) and setting `func.open=rand`, using `symlinkify`, or using dm-cache or a similar technology to add tiered cache to the underlying device.
With #1 it's arguable if you should be using mergerfs at all. RAID would probably be the better solution. If you're going to use mergerfs there are other tactics that may help: spreading the data across drives (see the mergerfs.dup tool) and setting `func.open=rand`, using `symlinkify`, or using dm-cache or a similar technology to add tiered cache to the underlying device.
With #2 one could use dm-cache as well but there is another solution which requires only mergerfs and a cronjob. With #2 one could use dm-cache as well but there is another solution which requires only mergerfs and a cronjob.
@ -884,7 +884,7 @@ echo 3 | sudo tee /proc/sys/vm/drop_caches
* If you don't see some directories and files you expect, policies seem to skip branches, you get strange permission errors, etc. be sure the underlying filesystems' permissions are all the same. Use `mergerfs.fsck` to audit the drive for out of sync permissions. * If you don't see some directories and files you expect, policies seem to skip branches, you get strange permission errors, etc. be sure the underlying filesystems' permissions are all the same. Use `mergerfs.fsck` to audit the drive for out of sync permissions.
* If you still have permission issues be sure you are using POSIX ACL compliant filesystems. mergerfs doesn't generally make exceptions for FAT, NTFS, or other non-POSIX filesystem. * If you still have permission issues be sure you are using POSIX ACL compliant filesystems. mergerfs doesn't generally make exceptions for FAT, NTFS, or other non-POSIX filesystem.
* Do **not** use `cache.files=off` if you expect applications (such as rtorrent) to use [mmap](http://linux.die.net/man/2/mmap) files. Shared mmap is not currently supported in FUSE w/ page caching disabled. Enabling `dropcacheonclose` is recommended when `cache.files=partial|full|auto-full`. * Do **not** use `cache.files=off` if you expect applications (such as rtorrent) to use [mmap](http://linux.die.net/man/2/mmap) files. Shared mmap is not currently supported in FUSE w/ page caching disabled. Enabling `dropcacheonclose` is recommended when `cache.files=partial|full|auto-full`.
* [Kodi](http://kodi.tv), [Plex](http://plex.tv), [Subsonic](http://subsonic.org), etc. can use directory [mtime](http://linux.die.net/man/2/stat) to more efficiently determine whether to scan for new content rather than simply performing a full scan. If using the default **getattr** policy of **ff** it's possible those programs will miss an update on account of it returning the first directory found's **stat** info and its a later directory on another mount which had the **mtime** recently updated. To fix this you will want to set **func.getattr=newest**. Remember though that this is just **stat**. If the file is later **open**'ed or **unlink**'ed and the policy is different for those then a completely different file or directory could be acted on.
* [Kodi](http://kodi.tv), [Plex](http://plex.tv), [Subsonic](http://subsonic.org), etc. can use directory [mtime](http://linux.die.net/man/2/stat) to more efficiently determine whether to scan for new content rather than simply performing a full scan. If using the default **getattr** policy of **ff** it's possible those programs will miss an update on account of it returning the first directory found's **stat** info and it's a later directory on another mount which had the **mtime** recently updated. To fix this you will want to set **func.getattr=newest**. Remember though that this is just **stat**. If the file is later **open**'ed or **unlink**'ed and the policy is different for those then a completely different file or directory could be acted on.
* Some policies mixed with some functions may result in strange behaviors. Not that some of these behaviors and race conditions couldn't happen outside **mergerfs** but that they are far more likely to occur on account of the attempt to merge together multiple sources of data which could be out of sync due to the different policies. * Some policies mixed with some functions may result in strange behaviors. Not that some of these behaviors and race conditions couldn't happen outside **mergerfs** but that they are far more likely to occur on account of the attempt to merge together multiple sources of data which could be out of sync due to the different policies.
* For consistency its generally best to set **category** wide policies rather than individual **func**'s. This will help limit the confusion of tools such as [rsync](http://linux.die.net/man/1/rsync). However, the flexibility is there if needed. * For consistency its generally best to set **category** wide policies rather than individual **func**'s. This will help limit the confusion of tools such as [rsync](http://linux.die.net/man/1/rsync). However, the flexibility is there if needed.
@ -1083,7 +1083,7 @@ Remember that hardlinks will NOT work across devices. That includes between the
#### Can I use mergerfs without SnapRAID? SnapRAID without mergerfs? #### Can I use mergerfs without SnapRAID? SnapRAID without mergerfs?
Yes. They are completely unreleated pieces of software.
Yes. They are completely unrelated pieces of software.
#### Can mergerfs run via Docker, Podman, Kubernetes, etc. #### Can mergerfs run via Docker, Podman, Kubernetes, etc.
@ -1134,7 +1134,7 @@ But FUSE also has a lot of upsides:
* Much lower barrier to entry (getting code into the kernel takes a lot of time and effort initially) * Much lower barrier to entry (getting code into the kernel takes a lot of time and effort initially)
FUSE was chosen because of all the advantages listed above. The negatives of FUSE do not outweight the positives.
FUSE was chosen because of all the advantages listed above. The negatives of FUSE do not outweigh the positives.
#### Is my OS's libfuse needed for mergerfs to work? #### Is my OS's libfuse needed for mergerfs to work?

10
man/mergerfs.1

@ -704,7 +704,7 @@ Even though it\[cq]s a more niche situation this hack breaks normal
security and behavior and as such is \f[C]off\f[R] by default. security and behavior and as such is \f[C]off\f[R] by default.
If set to \f[C]git\f[R] it will only perform the hack when the path in If set to \f[C]git\f[R] it will only perform the hack when the path in
question includes \f[C]/.git/\f[R]. question includes \f[C]/.git/\f[R].
\f[C]all\f[R] will result it it applying anytime a readonly file which
\f[C]all\f[R] will result it applying anytime a readonly file which
is empty is opened for writing. is empty is opened for writing.
.SH FUNCTIONS, CATEGORIES and POLICIES .SH FUNCTIONS, CATEGORIES and POLICIES
.PP .PP
@ -817,7 +817,7 @@ If all branches are filtered an error will be returned.
Typically \f[B]EROFS\f[R] (read\-only filesystem) or \f[B]ENOSPC\f[R] Typically \f[B]EROFS\f[R] (read\-only filesystem) or \f[B]ENOSPC\f[R]
(no space left on device) depending on the most recent reason for (no space left on device) depending on the most recent reason for
filtering a branch. filtering a branch.
\f[B]ENOENT\f[R] will be returned if no elegible branch is found.
\f[B]ENOENT\f[R] will be returned if no eligible branch is found.
.SS Path Preservation .SS Path Preservation
.PP .PP
Policies, as described below, are of two basic types. Policies, as described below, are of two basic types.
@ -1643,7 +1643,7 @@ Fast network, slow drives, small\[cq]ish bursty writes: You have a
10+Gbps network and wish to transfer amounts of data less than your 10+Gbps network and wish to transfer amounts of data less than your
cache drive but wish to do so quickly. cache drive but wish to do so quickly.
.PP .PP
With #1 its arguable if you should be using mergerfs at all.
With #1 it's arguable if you should be using mergerfs at all.
RAID would probably be the better solution. RAID would probably be the better solution.
If you\[cq]re going to use mergerfs there are other tactics that may If you\[cq]re going to use mergerfs there are other tactics that may
help: spreading the data across drives (see the mergerfs.dup tool) and help: spreading the data across drives (see the mergerfs.dup tool) and
@ -2367,7 +2367,7 @@ includes all the paths you need if you want links to work.
.SS Can I use mergerfs without SnapRAID? SnapRAID without mergerfs? .SS Can I use mergerfs without SnapRAID? SnapRAID without mergerfs?
.PP .PP
Yes. Yes.
They are completely unreleated pieces of software.
They are completely unrelated pieces of software.
.SS Can mergerfs run via Docker, Podman, Kubernetes, etc. .SS Can mergerfs run via Docker, Podman, Kubernetes, etc.
.PP .PP
Yes. Yes.
@ -2468,7 +2468,7 @@ Much lower barrier to entry (getting code into the kernel takes a lot of
time and effort initially) time and effort initially)
.PP .PP
FUSE was chosen because of all the advantages listed above. FUSE was chosen because of all the advantages listed above.
The negatives of FUSE do not outweight the positives.
The negatives of FUSE do not outweigh the positives.
.SS Is my OS\[cq]s libfuse needed for mergerfs to work? .SS Is my OS\[cq]s libfuse needed for mergerfs to work?
.PP .PP
No.\ Normally \f[C]mount.fuse\f[R] is needed to get mergerfs (or any No.\ Normally \f[C]mount.fuse\f[R] is needed to get mergerfs (or any

5
src/ghc/filesystem.hpp

@ -214,7 +214,6 @@
#include <compare> #include <compare>
#endif #endif
#endif #endif
#include <chrono>
#include <fstream> #include <fstream>
#include <memory> #include <memory>
#include <stack> #include <stack>
@ -265,7 +264,7 @@
// configure LWG conformance () // configure LWG conformance ()
#define LWG_2682_BEHAVIOUR #define LWG_2682_BEHAVIOUR
//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - //- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// LWG #2395 makes crate_directory/create_directories not emit an error if there is a regular
// LWG #2395 makes create_directory/create_directories not emit an error if there is a regular
// file with that name, it is superseded by P1164R1, so only activate if really needed // file with that name, it is superseded by P1164R1, so only activate if really needed
// #define LWG_2935_BEHAVIOUR // #define LWG_2935_BEHAVIOUR
//- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - //- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -3233,7 +3232,7 @@ GHC_INLINE path::impl_string_type::const_iterator path::iterator::increment(cons
// we can only sit on a slash if it is a network name or a root // we can only sit on a slash if it is a network name or a root
if (i != _last && *i == preferred_separator) { if (i != _last && *i == preferred_separator) {
if (fromStart && !(i + 1 != _last && *(i + 1) == preferred_separator)) { if (fromStart && !(i + 1 != _last && *(i + 1) == preferred_separator)) {
// leadind double slashes detected, treat this and the
// leading double slashes detected, treat this and the
// following until a slash as one unit // following until a slash as one unit
i = std::find(++i, _last, preferred_separator); i = std::find(++i, _last, preferred_separator);
} }

2
src/wyhash.h

@ -3,7 +3,7 @@
#define wyhash_final_version #define wyhash_final_version
//defines that change behavior //defines that change behavior
#ifndef WYHASH_CONDOM #ifndef WYHASH_CONDOM
#define WYHASH_CONDOM 1 //0: read 8 bytes before and after boudaries, dangerous but fastest. 1: normal valid behavior 2: extra protection against entropy loss (probability=2^-63), aka. "blind multiplication"
#define WYHASH_CONDOM 1 //0: read 8 bytes before and after boundaries, dangerous but faster. 1: normal valid behavior 2: extra protection against entropy loss (probability=2^-63), aka. "blind multiplication"
#endif #endif
#define WYHASH_32BIT_MUM 0 //faster on 32 bit system #define WYHASH_32BIT_MUM 0 //faster on 32 bit system
//includes //includes

4
tests/acutest.h

@ -62,7 +62,7 @@
#define TEST_LIST const struct test_ test_list_[] #define TEST_LIST const struct test_ test_list_[]
/* Macros for testing whether an unit test succeeds or fails. These macros
/* Macros for testing whether a unit test succeeds or fails. These macros
* can be used arbitrarily in functions implementing the unit tests. * can be used arbitrarily in functions implementing the unit tests.
* *
* If any condition fails throughout execution of a test, the test fails. * If any condition fails throughout execution of a test, the test fails.
@ -245,7 +245,7 @@
#endif #endif
/* Common test initialiation/clean-up
/* Common test initialization/clean-up
* *
* In some test suites, it may be needed to perform some sort of the same * In some test suites, it may be needed to perform some sort of the same
* initialization and/or clean-up in all the tests. * initialization and/or clean-up in all the tests.

Loading…
Cancel
Save