axboe / liburing

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

[GIT PULL] Fix some syscall name typos in man pages #1244

Closed aconz2 closed 2 months ago

aconz2 commented 2 months ago

The man pages reference unlinkat2, mkdirat2, symlinkat2, and linkat2 which I think are typos. This fixes them by removing the 2.

Related to https://github.com/tokio-rs/io-uring/pull/304

There are also a few references to futex2(2) which I now understand (I think) refers to the group futex_{wait,waitv,wake}, but unfortunately none of those have man pages. Is there a place that documents those that the futex2(2) link could reference instead?


git request-pull output:

The following changes since commit 0c8975ad7c95de0f81a9dc869b55e77131159040:

  man/io_uring_register_ring_fd: add note about kernel availability (2024-09-22 00:47:34 -0600)

are available in the Git repository at:

  https://github.com/aconz2/liburing fix-man-pages2

for you to fetch changes up to d9716086048112ad95a1e976005ed70ddc14f8e5:

  Fix some syscall name typos in man pages (2024-09-24 09:00:14 -0500)

----------------------------------------------------------------
Andrew Consroe (1):
      Fix some syscall name typos in man pages

 man/io_uring_enter.2 | 8 ++++----
 1 file changed, 4 insertions(+), 4 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 ``` 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

There are no futex2 man pages yet it seems, but they should get there at some point... I don't think there are better resources we can point to right now, so probably just leave those as-is? The kernel headers are probably the only reference for them a this point.