axboe / liburing

Library providing helpers for the Linux kernel io_uring support
MIT License
2.89k stars 407 forks source link

[GIT PULL] man/io_uring_register: Add docs for pbuf status and napi (un)register #1231

Closed CPestka closed 2 months ago

CPestka commented 2 months ago

This adds documentation for:

  1. IORING_REGISTER_NAPI
  2. IORING_UNREGISTER_NAPI
  3. IORING_REGISTER_PBUF_STATUS
  4. Some related errors

Also fixes various fmting errors/inconsistencies.


git request-pull output:

The following changes since commit de5bf97204646ed7b35da2968ce12b5923155af8:

  test/wq-aff: test for SQPOLL affinity with deliberately large CPU (2024-09-16 02:53:34 -0600)

are available in the Git repository at:

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

for you to fetch changes up to d47905331ca1f1183f94f5f800b7ee48f2fd53cf:

  man/io_uring_register: Various formatting fixes (2024-09-16 17:33:29 +0200)

----------------------------------------------------------------
CPestka (4):
      man/io_uring_register: Add docs for IORING_REGISTER_PBUF_STATUS
      man/io_uring_register: Add doc for registering napi
      man/io_uring_register: Add doc for unregistering napi
      man/io_uring_register: Various formatting fixes

 man/io_uring_register.2 | 194 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
 1 file changed, 156 insertions(+), 38 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 ``` 6. Follow the commit message format rules below. 7. 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). 5. Then an empty line. 6. Then a description (may be omitted for truly trivial changes). 8. Then an empty line again (if it has a description). 9. Then a `Signed-off-by` tag with your real name and email. For example: ``` Signed-off-by: Foo Bar ``` 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 ```

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 commented 2 months ago

Thanks for writing these!