Skip to content

doc: add documentation for uncached buffered I/O#1995

Merged
axboe merged 1 commit into
axboe:masterfrom
Panky-codes:uncached_doc
Oct 5, 2025
Merged

doc: add documentation for uncached buffered I/O#1995
axboe merged 1 commit into
axboe:masterfrom
Panky-codes:uncached_doc

Conversation

@Panky-codes
Copy link
Copy Markdown
Contributor

@Panky-codes Panky-codes commented Oct 5, 2025

Documentation was not updated when this option was reintroduced[1].

Add the documentation for uncached option.

[1] 43c67b9

Copy link
Copy Markdown
Collaborator

@sitsofe sitsofe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Panky-codes:
Good catch! Could you:

  • Mention RWF_DONTCACHE somewhere so it's easier to tie up with documentation for the syscall?
  • Add this change to the fio.1 man page?
  • Squash any subsequent changes down to one commit and change the title from HOWTO: ... to doc: ...

Comment thread HOWTO.rst Outdated
@Panky-codes
Copy link
Copy Markdown
Contributor Author

Panky-codes commented Oct 5, 2025

While we are on this topic, any reason uncached should be FIO_OPT_INT instead of FIO_OPT_BOOL? @axboe @vincentkfu

@Panky-codes Panky-codes changed the title HOWTO: add documentation for uncached buffered I/O doc: add documentation for uncached buffered I/O Oct 5, 2025
Comment thread HOWTO.rst Outdated
Documentation was not updated when this option was reintroduced[1].

Add the documentation for `uncached` option.

[1] axboe@43c67b9

Signed-off-by: Pankaj Raghav <[email protected]>
Copy link
Copy Markdown
Collaborator

@sitsofe sitsofe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vincentkfu, @axboe this LGTM!

@axboe axboe merged commit 925a315 into axboe:master Oct 5, 2025
17 checks passed
@axboe
Copy link
Copy Markdown
Owner

axboe commented Oct 5, 2025

Thanks!

@sitsofe
Copy link
Copy Markdown
Collaborator

sitsofe commented Oct 5, 2025

@Panky-codes:

While we are on this topic, any reason uncached should be FIO_OPT_INT instead of FIO_OPT_BOOL? @axboe @vincentkfu

Personally I don't see why it couldn't be FIO_OPT_BOOL given current users are likely setting uncached=1 (at least that's what I hope they're doing....) and FIO_OPT_BOOL will handle values of 0 or 1 in addition to mere presence.

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