liburing icon indicating copy to clipboard operation
liburing copied to clipboard

[GIT PULL] add io_uring_enable_rings.3 man page, fix a few other man page things

Open dankamongmen opened this issue 2 years ago • 3 comments

  • Add a man page for io_uring_enable_rings(3) (#863 )
  • Fix a few other minor things up spotted while studying man pages
  • Normalize all "cancellation/cancelled" to "cancelation/canceled". This is kinda questionable in terms of churn. The former is our American spelling, the latter the British spelling. UNIX spelling quoth ECANCELED sides with the latter. If you'd rather not commit this, let me know and I'll pull it out of the PR.

git request-pull output:

The following changes since commit 2ea05c2a5750ff36a6ee4ce33f85e2989e91be5f:

  src/setup: minor style cleanups (2023-05-16 07:41:30 -0600)

are available in the Git repository at:

  https://github.com/dankamongmen/liburing dankamongmen/man

for you to fetch changes up to c6a68e3ebe0a14137756d6ffd2879770844b5b4f:

  man: add io_uring_enable_rings.3 (2023-05-31 08:57:06 -0400)

----------------------------------------------------------------
nick black (2):
      Settle on canceled/cancelation
      man: add io_uring_enable_rings.3

 man/io_uring_enable_rings.3        | 40 ++++++++++++++++++++++++++++++++++++++++
 man/io_uring_enter.2               |  2 +-
 man/io_uring_prep_link_timeout.3   | 16 ++++++++--------
 man/io_uring_prep_poll_add.3       |  2 +-
 man/io_uring_prep_timeout.3        |  2 +-
 man/io_uring_prep_timeout_update.3 |  2 +-
 src/include/liburing/io_uring.h    |  2 +-
 test/accept.c                      |  4 ++--
 test/defer.c                       |  6 +++---
 test/fpos.c                        |  2 +-
 test/io-cancel.c                   |  8 ++++----
 test/multicqes_drain.c             | 10 +++++-----
 test/poll-cancel.c                 |  4 ++--
 test/timeout.c                     |  2 +-
 14 files changed, 71 insertions(+), 31 deletions(-)
 create mode 100644 man/io_uring_enable_rings.3

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:

[email protected]

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

dankamongmen avatar May 31 '23 12:05 dankamongmen

I like making the cancel bits consistent, and it's a separate patch so good like that. Made a few comments on the other patch.

axboe avatar May 31 '23 14:05 axboe

Nick, can you address the comments from last week? I'd like to cut 2.4 soon, and it would be a shame to do that without adding these bits.

axboe avatar Jun 05 '23 17:06 axboe

@dankamongmen ping on the above...

axboe avatar Jul 13 '23 21:07 axboe

I finally gave up waiting on OP and pulled this, fixing up my complaints after the fact.

axboe avatar Jul 26 '24 14:07 axboe