This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Function
Queues (but does not submit) an SQE to perform a no-op. Returns a pointer to the SQE so that you can further modify the SQE for advanced use cases. A no-op is more useful than may appear at first glance. For example, you could call drain_previous_sqes() on the returned SQE, to use the no-op to know when the ring is idle before acting on a kill signal.
Queues (but does not submit) an SQE to perform a no-op. Returns a pointer to the SQE so that you can further modify the SQE for advanced use cases. A no-op is more useful than may appear at first glance. For example, you could call
drain_previous_sqes()on the returned SQE, to use the no-op to know when the ring is idle before acting on a kill signal.