[GIT PULL] Man improvements

[wlukowicz]

Several fixes and improvements to the man pages:

• fixed buf ring registration flags,
• fixed title headings,
• improved IORING_REGISTER_BUFFERS2 description.

---

git request-pull output:

The following changes since commit 9032c80cdc7e64bf146ec801fa8917bed6493075:

  man/io_uring_register_sync_cancel.3: update io_uring_sync_cancel_reg (2024-11-29 09:14:14 -0700)

are available in the Git repository at:

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

for you to fetch changes up to 416d96ce5a4bb0ffb366b93a3c7333842cc290d8:

  man/io_uring_register.2: improve IORING_REGISTER_BUFFERS2 description (2024-12-01 15:44:56 +0000)

----------------------------------------------------------------
Wojciech Łukowicz (3):
      man: fix buf ring registration flags
      man: fix title headings
      man/io_uring_register.2: improve IORING_REGISTER_BUFFERS2 description

 man/io_uring.7                     |  6 +++---
 man/io_uring_prep_msg_ring_fd.3    |  2 +-
 man/io_uring_prep_read_fixed.3     |  2 +-
 man/io_uring_prep_timeout.3        |  2 +-
 man/io_uring_prep_timeout_update.3 |  2 +-
 man/io_uring_prep_write_fixed.3    |  2 +-
 man/io_uring_register.2            | 31 +++++++++++++++++++++++--------
 man/io_uring_register_buf_ring.3   | 10 +++++-----
 man/io_uring_setup_buf_ring.3      | 12 ++++++------
 man/io_uring_sq_space_left.3       |  2 +-
 10 files changed, 43 insertions(+), 28 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

2. Follow the commit message format rules below.
3. 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).

[axboe]

Looks good, thanks.