Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notif and related SendZc docs #299

Merged
merged 2 commits into from
Sep 24, 2024
Merged

Add notif and related SendZc docs #299

merged 2 commits into from
Sep 24, 2024

Conversation

erenon
Copy link
Contributor

@erenon erenon commented Aug 16, 2024

  • Add notif that checks for IORING_CQE_F_NOTIF
  • Add extra documentation to SendZc

@quininer
Copy link
Member

Can you add a test? and you don't need to add much docs, just point to manpage of IORING_OP_SEND_ZC.

@erenon
Copy link
Contributor Author

erenon commented Aug 17, 2024

Added a test. I have two issues with just linking the docs:

I find this doc+notif to be visible important, because without these, SendZc cannot be used correctly. If you feel strongly about keeping the doc minimal, I can of course replace the paragraph with a link, let me know.

@erenon erenon force-pushed the notif branch 2 times, most recently from 5294170 to f118dd4 Compare August 17, 2024 11:40
@quininer
Copy link
Member

I don't have the energy to keep track of upstream docs, so I prefer to keep minimal description and point to correct upstream docs.

@erenon
Copy link
Contributor Author

erenon commented Aug 19, 2024

Got it. Added a link instead of the text.

@erenon
Copy link
Contributor Author

erenon commented Aug 19, 2024

fmt fixed (extra newline removed)

@quininer quininer merged commit c884322 into tokio-rs:master Sep 24, 2024
11 checks passed
@quininer
Copy link
Member

Thank you!

@erenon erenon deleted the notif branch September 27, 2024 09:49
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