[GIT PULL] io_uring_submit: note specifics on return value for SQPOLL

[CPestka]

[GIT PULL] io_uring_submit: note specifics on return value for SQPOLL

Added the following behavior of io_uring_submit to the man page. When used with SQ_POLL and in the success case, the return value may not indicate the actual amount of successfully submitted submission queue entries, as mentioned in issue 88

Signed-off-by: Constantin Pestka constantin.pestka@web.de

---

git request-pull output:

The following changes since commit 7056087137dd6509cda8d617d7a6f536f44071f5:

  man/io_uring_prep_timeout: add mention of version that added multishot (2023-10-04 16:28:25 -0600)

are available in the Git repository at:

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

for you to fetch changes up to a65565e06670b98bfa04c719ce8f8b5ebfc4b278:

  io_uring_submit: note specifics on return value for SQPOLL (2023-10-12 15:10:39 +0200)

----------------------------------------------------------------
CPestka (1):
      io_uring_submit: note specifics on return value for SQPOLL

 man/io_uring_submit.3 | 7 ++++++-
 1 file changed, 6 insertions(+), 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

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

[ammarfaizi2]

Please follow the pull request guidelines, especially, the use of Signed-off-by tag.

[axboe]

Change itself looks fine, but as mentioned, the commit message itself is useless. Please do follow the commit format. The first line should be a title. "Updated man page of io_uring_submit based on issue 88" means nothing. If you had made that "io_uring_submit: note specifics on return value for SQPOLL" then people would know what the commit is doing. Then the commit message itself should mention specifics on why, and why this is important. Finally you need the Signed-off-by line.

[CPestka]

Sry... I changed the title to the suggested one, added the signed-of-by tag and updated the commit msg. Is everything as it should be now?

[ammarfaizi2]

Sry... I changed the title to the suggested one, added the signed-of-by tag and updated the commit msg. Is everything as it should be now?

The explanation in the commit message should be word-wrapped at 72 chars. Also, don't put the
[GIT PULL] prefix in the commit message, it's for the pull request subject.