From 0888f372aa118420c844045569636a2bb5e24e33 Mon Sep 17 00:00:00 2001 From: Antonio SJ Musumeci Date: Sat, 23 Sep 2023 14:53:41 -0500 Subject: [PATCH] Fix readdir doc typos --- README.md | 6 +++--- man/mergerfs.1 | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bbb9c429c..1032ec16d 100644 --- a/README.md +++ b/README.md @@ -826,7 +826,7 @@ policies is not appropriate. #### func.readdir -examples: `fuse.readdir=seq`, `fuse.readdir=cor:4` +examples: `func.readdir=seq`, `func.readdir=cor:4` `readdir` has policies to control how it manages reading directory content. @@ -834,8 +834,8 @@ content. | Policy | Description | |--------|-------------| | seq | "sequential" : Iterate over branches in the order defined. This is the default and traditional behavior found prior to the readdir policy introduction. | -| cosr | "concurrent open, sequential read" : Concurrently open branch directories using a thread pool and process them in order of definition. This keeps memory and CPU usage low while also reducing the time spent waiting on branches to respond. Number of threads defaults to the number of logical cores. Can be overwritten via the syntax `fuse.readdir=cosr:N` where `N` is the number of threads. | -| cor | "concurrent open and read" : Concurrently open branch directories and immediately start reading their contents using a thread pool. This will result in slightly higher memory and CPU usage but reduced latency. Particularly when using higher latency / slower speed network filesystem branches. Unlike `seq` and `cosr` the order of files could change due the async nature of the thread pool. Number of threads defaults to the number of logical cores. Can be overwritten via the syntax `fuse.readdir=cor:N` where `N` is the number of threads. +| cosr | "concurrent open, sequential read" : Concurrently open branch directories using a thread pool and process them in order of definition. This keeps memory and CPU usage low while also reducing the time spent waiting on branches to respond. Number of threads defaults to the number of logical cores. Can be overwritten via the syntax `func.readdir=cosr:N` where `N` is the number of threads. | +| cor | "concurrent open and read" : Concurrently open branch directories and immediately start reading their contents using a thread pool. This will result in slightly higher memory and CPU usage but reduced latency. Particularly when using higher latency / slower speed network filesystem branches. Unlike `seq` and `cosr` the order of files could change due the async nature of the thread pool. Number of threads defaults to the number of logical cores. Can be overwritten via the syntax `func.readdir=cor:N` where `N` is the number of threads. Keep in mind that `readdir` mostly just provides a list of file names in a directory and possibly some basic metadata about said files. To diff --git a/man/mergerfs.1 b/man/mergerfs.1 index 81dc3550d..296ce519d 100644 --- a/man/mergerfs.1 +++ b/man/mergerfs.1 @@ -1140,7 +1140,7 @@ T} .TE .SS func.readdir .PP -examples: \f[C]fuse.readdir=seq\f[R], \f[C]fuse.readdir=cor:4\f[R] +examples: \f[C]func.readdir=seq\f[R], \f[C]func.readdir=cor:4\f[R] .PP \f[C]readdir\f[R] has policies to control how it manages reading directory content. @@ -1169,7 +1169,7 @@ directories using a thread pool and process them in order of definition. This keeps memory and CPU usage low while also reducing the time spent waiting on branches to respond. Number of threads defaults to the number of logical cores. -Can be overwritten via the syntax \f[C]fuse.readdir=cosr:N\f[R] where +Can be overwritten via the syntax \f[C]func.readdir=cosr:N\f[R] where \f[C]N\f[R] is the number of threads. T} T{ @@ -1185,7 +1185,7 @@ branches. Unlike \f[C]seq\f[R] and \f[C]cosr\f[R] the order of files could change due the async nature of the thread pool. Number of threads defaults to the number of logical cores. -Can be overwritten via the syntax \f[C]fuse.readdir=cor:N\f[R] where +Can be overwritten via the syntax \f[C]func.readdir=cor:N\f[R] where \f[C]N\f[R] is the number of threads. T} .TE