Skip to content

docs: update docs for verify_mode=compare of io_uring_cmd - #1873

Merged
axboe merged 1 commit into
axboe:masterfrom
minwooim:update-docs-for-compare
Mar 5, 2025
Merged

axboe merged 1 commit into
axboe:masterfrom
minwooim:update-docs-for-compare

Conversation

@minwooim

@minwooim minwooim commented Mar 2, 2025

Copy link
Copy Markdown
Contributor

Add missing limitation of verify_mode=compare in io_uring_cmd ioengine. Data verification with NVMe COMPARE command has been introduced in Commit 6170d92 ("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=

Please confirm that your commit message(s) follow these guidelines:

  1. First line is a commit title, a descriptive one-liner for the change
  2. Empty second line
  3. Commit message body that explains why the change is useful. Break lines that
    aren't something like a URL at 72-74 chars.
  4. Empty line
  5. Signed-off-by: Real Name real@email.com

Reminders:

  1. If you modify struct thread_options, also make corresponding changes in
    cconv.c and bump FIO_SERVER_VER in server.h
  2. If you change the ioengine interface (hooks, flags, etc), remember to bump
    FIO_IOOPS_VERSION in ioengines.h.

@vincentkfu

Copy link
Copy Markdown
Collaborator

Please update the HOWTO as well.

Add missing limitation of verify_mode=compare in io_uring_cmd
ioengine.  Data verification with NVMe COMPARE command has been
introduced in Commit 6170d92 ("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=<pattern>

Signed-off-by: Minwoo Im <minwoo.im@samsung.com>
@minwooim
minwooim force-pushed the update-docs-for-compare branch from d9d92d6 to f0aec1d Compare March 3, 2025 20:44
@axboe
axboe merged commit df60924 into axboe:master Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

⌂ 换网址