aboutsummaryrefslogtreecommitdiffstats
path: root/doc/README.fuse-io-uring
diff options
context:
space:
mode:
authorizxl007 <zeng.zheng@zte.com.cn>2025-06-03 22:04:52 +0800
committerBernd Schubert <bernd@bsbernd.com>2025-06-05 17:55:25 +0200
commitb773020464641d3e9cec5ad5fa35e7153e54e118 (patch)
tree2392d24dcc4e268ec98e1394670159c04982a22b /doc/README.fuse-io-uring
parentfc71597c8dba7ca8da474cbae3509552e30cbd46 (diff)
downloadlibfuse-b773020464641d3e9cec5ad5fa35e7153e54e118.tar.gz
Update how to use the io_uring and io_uring_q_depth mount options
This patch updates how to use the io_uring and io_uring_q_depth mount options. There are two reasons for this: 1. It is recommended for end-users to use a format like “-o io_uring" (with a space) in README.fuse-io-uring. This is because, in the passthrough_hp example, cxxopts does not support the "-oio_uring" format (without a space), and using it would result in a syntax error. 2. Remove redundant "--uring" and "--uring-q-depth=" from passthrough_hp example. Signed-off-by: izxl007 <zeng.zheng@zte.com.cn>
Diffstat (limited to 'doc/README.fuse-io-uring')
-rw-r--r--doc/README.fuse-io-uring8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/README.fuse-io-uring b/doc/README.fuse-io-uring
index 7207c6e..5134890 100644
--- a/doc/README.fuse-io-uring
+++ b/doc/README.fuse-io-uring
@@ -6,7 +6,7 @@ echo 1 > /sys/module/fuse/parameters/enable_uring
Additionally, FUSE_CAP_OVER_IO_URING needs to be set and
se->uring.enable has to be true. The latter can be
-achieved with the libfuse option '-oio_uring'.
+achieved with the libfuse option '-o io_uring'.
Default queue-depth is 8 and can be changed with the parameter
'-oio_uring_q_depth'.
@@ -22,11 +22,11 @@ Benefits:
Usage:
To enable io_uring support when mounting a FUSE filesystem:
1. Enable kernel support: echo 1 > /sys/module/fuse/parameters/enable_uring
-2. Mount with io_uring option: -oio_uring
-3. Optionally adjust queue depth: -oio_uring_q_depth=<depth>
+2. Mount with io_uring option: -o io_uring
+3. Optionally adjust queue depth: -o io_uring_q_depth=<depth>
Example:
-./my_fuse_fs /source /mountpoint -oio_uring -oio_uring_q_depth=16
+./my_fuse_fs /source /mountpoint -o io_uring -o io_uring_q_depth=16
Requirements:
- Linux kernel with io_uring and FUSE io_uring support enabled