Browse Source

Merge pull request #1235 from DavidFair/readme_direct_parallel

Docs: clarify parallel-direct-writes and cache.files
pull/1237/head
trapexit 1 year ago
committed by GitHub
parent
commit
82781b6ff8
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 13
      README.md

13
README.md

@ -289,7 +289,8 @@ These options are the same regardless of whether you use them with the
(default: false) (default: false)
* **parallel-direct-writes=BOOL**: Allow the kernel to dispatch * **parallel-direct-writes=BOOL**: Allow the kernel to dispatch
multiple, parallel (non-extending) write requests for files opened multiple, parallel (non-extending) write requests for files opened
with `direct_io=true` (if supported by the kernel)
with `cache.files=per-process` (if the process is not in `process-names`)
or `cache.files=off`. (This requires kernel support, and was added in v6.2)
* **direct_io**: deprecated - Bypass page cache. Use `cache.files=off` * **direct_io**: deprecated - Bypass page cache. Use `cache.files=off`
instead. (default: false) instead. (default: false)
* **kernel_cache**: deprecated - Do not invalidate data cache on file * **kernel_cache**: deprecated - Do not invalidate data cache on file
@ -1293,12 +1294,12 @@ https://en.wikipedia.org/wiki/Page_cache
unchanged since previous open. unchanged since previous open.
* cache.files=libfuse: follow traditional libfuse `direct_io`, * cache.files=libfuse: follow traditional libfuse `direct_io`,
`kernel_cache`, and `auto_cache` arguments. `kernel_cache`, and `auto_cache` arguments.
* cache.files=per-process: Enable page caching only for processes
which 'comm' name matches one of the values defined in
`cache.files.process-names`.
* cache.files=per-process: Enable page caching (equivalent to `cache.files=partial`)
only for processes whose 'comm' name matches one of the values defined in
`cache.files.process-names`. If the name does not match the file open
is equivalent to `cache.files=off`.
FUSE, which mergerfs uses, offers a number of page caching
modes. mergerfs tries to simplify their use via the `cache.files`
FUSE, which mergerfs uses, offers a number of page caching modes. mergerfs tries to simplify their use via the `cache.files`
option. It can and should replace usage of `direct_io`, option. It can and should replace usage of `direct_io`,
`kernel_cache`, and `auto_cache`. `kernel_cache`, and `auto_cache`.

Loading…
Cancel
Save