Browse Source

Update fuse-msg-size docs (#1552)

pull/1553/head
trapexit 2 weeks ago
committed by GitHub
parent
commit
700fcfccf5
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 4
      mkdocs/docs/config/cache.md
  2. 10
      mkdocs/docs/config/fuse-msg-size.md
  3. 2
      mkdocs/docs/known_issues_bugs.md

4
mkdocs/docs/config/cache.md

@ -172,8 +172,8 @@ the FUSE writeback cache small writes *may* be aggregated by the
kernel and then sent to mergerfs as one larger request. This can kernel and then sent to mergerfs as one larger request. This can
greatly improve the throughput for apps which write to files greatly improve the throughput for apps which write to files
inefficiently. The amount the kernel can aggregate is limited by the inefficiently. The amount the kernel can aggregate is limited by the
size of a FUSE message. Read the fuse_msg_size section for more
details.
size of a FUSE message. Read the [fuse-msg-size](fuse-msg-size.md)
section for more details.
There is a side effect as a result of enabling writeback There is a side effect as a result of enabling writeback
caching. Underlying files won't ever be opened with O_APPEND or caching. Underlying files won't ever be opened with O_APPEND or

10
mkdocs/docs/config/fuse-msg-size.md

@ -1,8 +1,8 @@
# fuse_msg_size
# fuse-msg-size
* type: `UINT|SIZE` * type: `UINT|SIZE`
* default: `1M` * default: `1M`
* example: `fuse_msg_size=1M`
* example: `fuse-msg-size=1M`
* If the value is a `SIZE` in the form of `xB`, `xK`, `xM`, `xG`, or * If the value is a `SIZE` in the form of `xB`, `xK`, `xM`, `xG`, or
`xT` then it will choose the closest multiple of the system page `xT` then it will choose the closest multiple of the system page
size. If the value is just an integer without a size multipler suffix size. If the value is just an integer without a size multipler suffix
@ -28,10 +28,10 @@ v6.13](https://web.git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/co
and above the max value supported by the kernel can range from 1 and above the max value supported by the kernel can range from 1
(4KiB) to 65535 (~256MiB) (assuming a page size of 4KiB.) The default (4KiB) to 65535 (~256MiB) (assuming a page size of 4KiB.) The default
used by Linux >= 4.20, and hard coded value used before 4.20, is 32 used by Linux >= 4.20, and hard coded value used before 4.20, is 32
(128KiB). In mergerfs it is referred to as `fuse_msg_size` to make it
(128KiB). In mergerfs it is referred to as `fuse-msg-size` to make it
clear what it impacts and provide some abstraction. clear what it impacts and provide some abstraction.
If the `fuse_msg_size` value provided is more than the system wide
If the `fuse-msg-size` value provided is more than the system wide
maximum mergerfs will attempt to increase the system wide value to keep maximum mergerfs will attempt to increase the system wide value to keep
the user from needing to set the value using `sysctl`, the user from needing to set the value using `sysctl`,
`/etc/sysctl.conf`, or `/proc/sys/fs/fuse/max_pages_limit`. `/etc/sysctl.conf`, or `/proc/sys/fs/fuse/max_pages_limit`.
@ -47,4 +47,4 @@ v4.20 and v6.13 the max value is 256. On kernels >= v6.13 the maximum
value is 65535. value is 65535.
NOTE: If you intend to enable `cache.files` you should also set NOTE: If you intend to enable `cache.files` you should also set
[readahead](readahead.md) to match `fuse_msg_size`.
[readahead](readahead.md) to match `fuse-msg-size`.

2
mkdocs/docs/known_issues_bugs.md

@ -12,7 +12,7 @@
* statx * statx
* lazy umount * lazy umount
* oom_score_adj * oom_score_adj
* fuse_msg_size
* fuse-msg-size
* kernel symlink caching * kernel symlink caching
* kernel readdir caching * kernel readdir caching
* writeback caching * writeback caching

Loading…
Cancel
Save