Repository navigation
[GIT PULL] man: fix four small errors in man pages - #1659
Merged
Merged
Conversation
The prototype ends the zc_flags line with ");" and puts buf_index on the next line, so the synopsis is not a valid declaration. End the line with a comma. Fixes: d0ba544 ("man: Add manpage for io_uring_prep_send_zc_fixed()") Signed-off-by: Ilyas Mallah <github@ilyasm.dev>
The page says "Available since Linux 7.TBD". The command is in Linux 7.3, where block/ioctl.c handles BLOCK_URING_CMD_ZONE_RESET_ALL. Fixes: 9d17991 ("man: add io_uring_prep_cmd_zone_reset_all.3 man page") Signed-off-by: Ilyas Mallah <github@ilyasm.dev>
The page says flags must be set to the futex flags, then that flags are unused and 0 must be passed. The second is right: io_futexv_prep() returns -EINVAL for a non-zero sqe->futex_flags. Fixes: e58e411 ("Add futex related man pages") Signed-off-by: Ilyas Mallah <github@ilyasm.dev>
With IORING_SETUP_CQE_MIXED the iterator steps over two CQ ring slots for a 32b CQE, but the example counts one per CQE and passes that to io_uring_cq_advance(). The head ends short and CQEs are seen again. Count with io_uring_cqe_nr(), as io_uring_cqe_seen() does. Fixes: 9cecbdb ("Add support for IORING_SETUP_CQE_MIXED") Signed-off-by: Ilyas Mallah <github@ilyasm.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Four man pages have errors a reader can check against the header or the kernel source. Each fix is its own commit.
The io_uring_prep_send_zc_fixed() prototype ends one argument early, so the SYNOPSIS pasted into C fails with "conflicting types". The zone reset page says "Available since Linux 7.TBD", it is 7.3. The futex_waitv page says flags must be the futex flags, then that they must be 0, and io_futexv_prep() in v7.3 returns -EINVAL for a non-zero value. The io_uring_for_each_cqe() example advances the CQ ring by a CQE count, which falls short once a 32b CQE takes two slots.
I compiled the pasted prototype before and after, and ran the example against a hand built CQ ring. CQE_MIXED needs 6.18 and I have 5.15, so no mixed ring kernel ran. The futex change comes from the source only.
git request-pull output:
Click to show/hide pull request guidelines
Pull Request Guidelines
notification, use
[GIT PULL]as a prefix in your PR title.Commit message format rules:
Signed-off-bytag with your real name and email. For example: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
Fixestag with the issueURL.
Don't use GitHub anonymous email like this as the commit author:
Use a real email address!
Commit message example:
By submitting this pull request, I acknowledge that: