From f0aec1d0bfb215089b814c4d41aa69246d4a1dcf Mon Sep 17 00:00:00 2001 From: Minwoo Im Date: Sun, 2 Mar 2025 08:47:33 +0900 Subject: [PATCH] docs: update docs for verify_mode=compare of io_uring_cmd Add missing limitation of verify_mode=compare in io_uring_cmd ioengine. Data verification with NVMe COMPARE command has been introduced in Commit 6170d92a61da ("io_uring: Support Compare command for verification") and this should have documented COMPARE command only supports in case of data pattern verification. The two more options should be with --verify_mode=compare. verify_mode=compare verify=pattern verify_pattern= Signed-off-by: Minwoo Im --- HOWTO.rst | 4 +++- fio.1 | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/HOWTO.rst b/HOWTO.rst index 3f2bde18..62537b65 100644 --- a/HOWTO.rst +++ b/HOWTO.rst @@ -2896,7 +2896,9 @@ with the caveat that when used on the command line, they must come after the **read** Use Read commands for data verification **compare** - Use Compare commands for data verification + Use Compare commands for data verification. This option is only valid with + specific pattern(s), which means it *must* be given with `verify=pattern` and + `verify_pattern=`. .. option:: sg_write_mode=str : [sg] diff --git a/fio.1 b/fio.1 index 3c5f02b3..1581797a 100644 --- a/fio.1 +++ b/fio.1 @@ -2686,7 +2686,9 @@ Specifies the type of command to be used in the verification phase. Defaults to Use Read commands for data verification .TP .B compare -Use Compare commands for data verification +Use Compare commands for data verification. This option is only valid with +specific pattern(s), which means it *must* be given with `verify=pattern` and +`verify_pattern=`. .TP .RE .RE -- 2.25.1