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] Fix description of data for REGISTER_RING_FDS #1276

Merged
merged 1 commit into from
Oct 27, 2024

Conversation

Hawk777
Copy link
Contributor

@Hawk777 Hawk777 commented Oct 27, 2024

When using IORING_REGISTER_RING_FDS, the data field of the structure should contain, not point to, the file descriptor to register.


git request-pull output:

The following changes since commit 80272cbeb42bcd0b39a75685a50b0009b77cd380:

  Rename '*ret' to '*err' for io_uring_setup_buf_ring() (2024-10-23 11:13:23 -0600)

are available in the Git repository at:

  https://github.com/Hawk777/liburing.git register-ring-fds-not-pointer

for you to fetch changes up to 1bd53c8ad3cac4d73ede7801f52ea3b4d09fa88d:

  Fix description of data for REGISTER_RING_FDS (2024-10-26 18:20:14 -0700)

----------------------------------------------------------------
Christopher Head (1):
      Fix description of data for REGISTER_RING_FDS

 man/io_uring_register.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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 <[email protected]>

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:

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 <[email protected]>

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).

When using `IORING_REGISTER_RING_FDS`, the `data` field of the structure
should *contain*, not *point to*, the file descriptor to register.

Signed-off-by: Christopher Head <[email protected]>
@axboe axboe merged commit 2cdcaae into axboe:master Oct 27, 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