Browse Source

Merge pull request #1147 from trapexit/readme

Update README regarding why epmfs is default
pull/1074/merge
trapexit 2 years ago
committed by GitHub
parent
commit
55bd0ca25a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 9
      README.md
  2. 18
      man/mergerfs.1

9
README.md

@ -1943,9 +1943,12 @@ some particular need. mergerfs is very easy to test and experiment
with. I suggest creating a test setup and experimenting to get a sense with. I suggest creating a test setup and experimenting to get a sense
of what you want. of what you want.
The reason `mfs` is not the default `category.create` policy is `epmfs` is the default `category.create` policy because `ep` policies
historical. When/if a 3.X gets released it will be changed to minimize are not going to change the general layout of the branches. It won't
confusion people often have with path preserving policies. place files/dirs on branches that don't already have the relative
branch. So it keeps the system in a known state. It's much easier to
stop using `epmfs` or redistribute files around the filesystem than it
is to consolidate them back.
#### What settings should I use? #### What settings should I use?

18
man/mergerfs.1

@ -112,10 +112,10 @@ start with one of the following option sets.
\f[C]cache.files=off,dropcacheonclose=true,category.create=mfs\f[R] \f[C]cache.files=off,dropcacheonclose=true,category.create=mfs\f[R]
.SS Command Line .SS Command Line
.PP .PP
\f[C]mergerfs -o create.files=partial,dropcacheonclose=true,category.create=mfs /mnt/hdd0:/mnt/hdd1 /media\f[R] \f[C]mergerfs -o cache.files=partial,dropcacheonclose=true,category.create=mfs /mnt/hdd0:/mnt/hdd1 /media\f[R]
.SS /etc/fstab .SS /etc/fstab
.PP .PP
\f[C]/mnt/hdd0:/mnt/hdd1 /media fuse.mergerfs create.files=partial,dropcacheonclose=true,category.create=mfs 0 0\f[R] \f[C]/mnt/hdd0:/mnt/hdd1 /media fuse.mergerfs cache.files=partial,dropcacheonclose=true,category.create=mfs 0 0\f[R]
.SS systemd mount .SS systemd mount
.PP .PP
https://github.com/trapexit/mergerfs/wiki/systemd https://github.com/trapexit/mergerfs/wiki/systemd
@ -130,7 +130,7 @@ Type=simple
KillMode=none KillMode=none
ExecStart=/usr/bin/mergerfs \[rs] ExecStart=/usr/bin/mergerfs \[rs]
-f \[rs] -f \[rs]
-o create.files=partial \[rs] -o cache.files=partial \[rs]
-o dropcacheonclose=true \[rs] -o dropcacheonclose=true \[rs]
-o category.create=mfs \[rs] -o category.create=mfs \[rs]
/mnt/hdd0:/mnt/hdd1 \[rs] /mnt/hdd0:/mnt/hdd1 \[rs]
@ -2430,10 +2430,14 @@ mergerfs is very easy to test and experiment with.
I suggest creating a test setup and experimenting to get a sense of what I suggest creating a test setup and experimenting to get a sense of what
you want. you want.
.PP .PP
The reason \f[C]mfs\f[R] is not the default \f[C]category.create\f[R] \f[C]epmfs\f[R] is the default \f[C]category.create\f[R] policy because
policy is historical. \f[C]ep\f[R] policies are not going to change the general layout of the
When/if a 3.X gets released it will be changed to minimize confusion branches.
people often have with path preserving policies. It won\[cq]t place files/dirs on branches that don\[cq]t already have
the relative branch.
So it keeps the system in a known state.
It\[cq]s much easier to stop using \f[C]epmfs\f[R] or redistribute files
around the filesystem than it is to consolidate them back.
.SS What settings should I use? .SS What settings should I use?
.PP .PP
Depends on what features you want. Depends on what features you want.

|||||||
100:0
Loading…
Cancel
Save