xous: document WouldBlock and BlockedProcess

These results have similar names but are very different in terms of what
they do.

Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
Sean Cross 2020-11-23 17:19:37 +08:00
parent c36615d014
commit 5f52acfa9b

View file

@ -460,7 +460,9 @@ pub enum Result {
/// The requested system call is unimplemented /// The requested system call is unimplemented
Unimplemented, Unimplemented,
/// The process is blocked and should perform the read() again /// The process is blocked and should perform the read() again. This is only
/// ever seen in `Hosted` mode, because when running natively the kernel
/// simply never schedules the process.
BlockedProcess, BlockedProcess,
/// A scalar with one value /// A scalar with one value
@ -469,7 +471,8 @@ pub enum Result {
/// A scalar with two values /// A scalar with two values
Scalar2(usize, usize), Scalar2(usize, usize),
/// The syscall should be attempted again /// The syscall should be attempted again. This is returned when calling
/// functions such as `try_connect()` and `try_send()` that may block.
WouldBlock, WouldBlock,
UnknownResult(usize, usize, usize, usize, usize, usize, usize), UnknownResult(usize, usize, usize, usize, usize, usize, usize),