io-uring icon indicating copy to clipboard operation
io-uring copied to clipboard

Stabilize more APIs

Open quininer opened this issue 4 years ago • 7 comments

I hope to stabilize more APIs in 0.5. To stabilize a new API, the following conditions must be meet.

  • Available in the latest stable kernel
  • Documentation
  • Test

for new API of 5.10, we must upgrade the cross kernel version to pass ci.

quininer avatar Jan 10 '21 03:01 quininer

Is there still work to be done here? Do you mind pointing me at some resources to get started?

rushilmehra avatar Mar 03 '23 05:03 rushilmehra

@RushilMehra Thank you for your interest.

Since the unstable feature was removed, this title is no longer appropriate. but we still have work to do.

  1. we need to upgrade the kernel used by ci tests. see https://github.com/tokio-rs/io-uring/issues/125
  2. some documents need to be sync with upstream manpage, and add available kernel version note to some function.
  3. some opcodes have less tests than liburing, it would be nice to add that.

quininer avatar Mar 03 '23 05:03 quininer

@quininer I'll start looking into all 3, thanks

rushilmehra avatar Mar 03 '23 06:03 rushilmehra

@quininer Also, for #2 and #3, if you could give me some specific examples of stale documentation / missing opcode tests that will help me move along faster

rushilmehra avatar Mar 03 '23 21:03 rushilmehra

@RushilMehra Sorry, I'm not track this. but this is an example https://github.com/tokio-rs/io-uring/blob/master/src/opcode.rs#L1377

quininer avatar Mar 04 '23 03:03 quininer

@quininer Is that missing tests?

rushilmehra avatar Mar 04 '23 03:03 rushilmehra

@RushilMehra Yes, it miss docs and test.

quininer avatar Mar 04 '23 04:03 quininer