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] Several small man fixes #1027

Merged
merged 4 commits into from
Jan 2, 2024
Merged

[GIT PULL] Several small man fixes #1027

merged 4 commits into from
Jan 2, 2024

Conversation

wlukowicz
Copy link
Contributor

Several small man fixes:

  • io_uring_queue_init(3): fix typo
  • io_uring_enter(2): tidy up EBADR description
  • io_uring_setup(2): tidy up IORING_SETUP_CLAMP description
  • io_uring_prep_futex_waitv(3): fix signatures

git request-pull output:

The following changes since commit 7524a6adf4d6720a47bfa617b5cb2fd8d57f16d2:

  t/no-mmap-inval: Replace `valloc()` with `t_posix_memalign()` (2023-12-19 08:22:16 -0700)

are available in the Git repository at:

  https://github.com/wlukowicz/liburing.git man-fixes

for you to fetch changes up to b1250d08dbe238830b49ea04ae6b4a12e69041ac:

  man/io_uring_prep_futex_waitv.3: fix signatures (2024-01-02 18:24:48 +0000)

----------------------------------------------------------------
Wojciech Lukowicz (4):
      man/io_uring_queue_init.3: fix typo
      man/io_uring_enter.2: tidy up EBADR description
      man/io_uring_setup.2: tidy up IORING_SETUP_CLAMP description
      man/io_uring_prep_futex_waitv.3: fix signatures

 man/io_uring_enter.2            |  4 ++--
 man/io_uring_prep_futex_waitv.3 | 12 ++++++------
 man/io_uring_queue_init.3       |  2 +-
 man/io_uring_setup.2            | 10 +++++-----
 4 files changed, 14 insertions(+), 14 deletions(-)

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-off-by: Wojciech Lukowicz <wlukowicz01@gmail.com>
It's next enter on the same ring that won't have this error, not setup
of a new one.

Signed-off-by: Wojciech Lukowicz <wlukowicz01@gmail.com>
cq_entries clamping happens when IORING_SETUP_CQSIZE is set,
IORING_SETUP_SQPOLL does not matter here.

Additionally improved formatting.

Signed-off-by: Wojciech Lukowicz <wlukowicz01@gmail.com>
That's a man page for the waitv call, so fixed the signature accordingly.

There's no io_uring_prep_futex, it should reference
io_uring_prep_futex_wait instead.

Additionally improved formatting.

Signed-off-by: Wojciech Lukowicz <wlukowicz01@gmail.com>
@axboe
Copy link
Owner

axboe commented Jan 2, 2024

Good stuff, thanks!

@axboe axboe merged commit 4865969 into axboe:master Jan 2, 2024
13 checks passed
@wlukowicz wlukowicz deleted the man-fixes branch January 2, 2024 19:13
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