Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GIT PULL] man/io_uring: Small fixes and additions #1247

Merged
merged 5 commits into from
Sep 28, 2024

Conversation

CPestka
Copy link
Contributor

@CPestka CPestka commented Sep 28, 2024

This:

  1. Fixes a couple of fmt things
  2. Updates the sqe struct
  3. Moves the read op as an example of an sqe to the bullet point where sqes are described first
  4. Adds a remark that the generally described order of operation in the beginning of the man page can significantly change based on config parameters and usage
  5. Adds a pointer to where one can find info about memory models after the statement that, while they are important here, they are out of scope for the man page

git request-pull output:

The following changes since commit 206650ff72b6ea4d76921f9c91ebfffd9902e6a0:

  test/fixed-hugepage: skip test on -ENOMEM (2024-09-27 10:27:10 -0600)

are available in the Git repository at:

  https://github.com/CPestka/liburing io_uring_man

for you to fetch changes up to 8a7810d0ac44fcb3082ece0f9d699414d8d590b3:

  man/io_uring: Add remark about where to find info about memory ordering (2024-09-28 14:36:19 +0200)

----------------------------------------------------------------
CPestka (5):
      man/io_uring: Formatting fixes
      man/io_uring: Moved SQE example of a read request to SQE description
      man/io_uring: Add remark that operational behavior changes with flags
      man/io_uring: Update SQE struct
      man/io_uring: Add remark about where to find info about memory ordering

 man/io_uring.7 | 169 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------------------------------

Click to show/hide pull request guidelines

Pull Request Guidelines

  1. To make everyone easily filter pull request from the email
    notification, use [GIT PULL] as a prefix in your PR title.
[GIT PULL] Your Pull Request Title
  1. Follow the commit message format rules below.
  2. Follow the Linux kernel coding style (see: https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst).

Commit message format rules:

  1. The first line is title (don't be more than 72 chars if possible).
  2. Then an empty line.
  3. Then a description (may be omitted for truly trivial changes).
  4. Then an empty line again (if it has a description).
  5. Then a Signed-off-by tag with your real name and email. For example:
Signed-off-by: Foo Bar <foo.bar@gmail.com>

The description should be word-wrapped at 72 chars. Some things should
not be word-wrapped. They may be some kind of quoted text - long
compiler error messages, oops reports, Link, etc. (things that have a
certain specific format).

Note that all of this goes in the commit message, not in the pull
request text. The pull request text should introduce what this pull
request does, and each commit message should explain the rationale for
why that particular change was made. The git tree is canonical source
of truth, not github.

Each patch should do one thing, and one thing only. If you find yourself
writing an explanation for why a patch is fixing multiple issues, that's
a good indication that the change should be split into separate patches.

If the commit is a fix for an issue, add a Fixes tag with the issue
URL.

Don't use GitHub anonymous email like this as the commit author:

123456789+username@users.noreply.github.com

Use a real email address!

Commit message example:

src/queue: don't flush SQ ring for new wait interface

If we have IORING_FEAT_EXT_ARG, then timeouts are done through the
syscall instead of by posting an internal timeout. This was done
to be both more efficient, but also to enable multi-threaded use
the wait side. If we touch the SQ state by flushing it, that isn't
safe without synchronization.

Fixes: https://github.com/axboe/liburing/issues/402
Signed-off-by: Jens Axboe <axboe@kernel.dk>

By submitting this pull request, I acknowledge that:

  1. I have followed the above pull request guidelines.
  2. I have the rights to submit this work under the same license.
  3. I agree to a Developer Certificate of Origin (see https://developercertificate.org for more information).

Signed-of-by: Constantin Pestka <constantin.pestk@c-pestka.de>
Signed-of-by: Constantin Pestka <constantin.pestka@c-pestka.de>
Signed-of-by: Constantin Pestka <constantin.pestk@c-pestka.de>
Signed-of-by: Constantin Pestka <constantin.pestka@c-pestka.de>
The current man page has a remark about why certain barriers are
required when using the SQ and CQ and then goes on to say that memory
orderings (rightfully so) are out of scope, due to being a big topic.
This adds a pointer to the interested reader where to find this out
of scope information.

Signed-of-by: Constantin Pestka <constantin.pestka@c-pestka.de>
@axboe axboe merged commit 4a581ec into axboe:master Sep 28, 2024
15 checks passed
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.

2 participants