Skip to content

[GIT PULL] man: Fixup dead links in man pages#1615

Open
cmazakas wants to merge 1 commit into
axboe:masterfrom
cmazakas:man-page-fixes
Open

[GIT PULL] man: Fixup dead links in man pages#1615
cmazakas wants to merge 1 commit into
axboe:masterfrom
cmazakas:man-page-fixes

Conversation

@cmazakas

@cmazakas cmazakas commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Fix a couple of spots in the docs where typos created dead links in
the generated man pages.


git request-pull output:

The following changes since commit e50e32a6b9030faba2e30fa0ba999571a0cffe28:

  Merge branch 'user/cge/improve-zcrx-test' of https://github.com/zeehha/liburing (2026-07-01 06:24:23 -0600)

are available in the Git repository at:

  git@github.com:cmazakas/liburing.git man-page-fixes

for you to fetch changes up to 2b0ca15387bc7985b52aece7c7c9657df05b1489:

  man: Fixup dead links in man pages (2026-07-08 15:58:39 -0700)

----------------------------------------------------------------
Christian Mazakas (1):
      man: Fixup dead links in man pages

 man/io_uring_cqe_get_data.3        | 2 +-
 man/io_uring_register_iowq_aff.3   | 2 +-
 man/io_uring_setup_flags.7         | 2 +-
 man/io_uring_sqe_set_buf_group.3   | 2 +-
 man/io_uring_submit_and_wait_reg.3 | 2 +-
 man/io_uring_unregister_buf_ring.3 | 2 +-
 6 files changed, 6 insertions(+), 6 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
  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 <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).

@krisman

krisman commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Missing Signed-off-by line in the commit message.
Other than that, looks good to me.

Signed-off-by: Christian Mazakas <christian.mazakas@gmail.com>
@cmazakas

cmazakas commented Jul 9, 2026

Copy link
Copy Markdown
Contributor Author

Missing Signed-off-by line in the commit message. Other than that, looks good to me.

Ah, can't believe I forgot that. I updated the commit message.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants