From 5f52acfa9bad83db2e144cc90202dbba47c9fa5e Mon Sep 17 00:00:00 2001 From: Sean Cross Date: Mon, 23 Nov 2020 17:19:37 +0800 Subject: [PATCH] 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 --- xous-rs/src/definitions.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/xous-rs/src/definitions.rs b/xous-rs/src/definitions.rs index 51acb8d0d..58b51ced0 100644 --- a/xous-rs/src/definitions.rs +++ b/xous-rs/src/definitions.rs @@ -460,7 +460,9 @@ pub enum Result { /// The requested system call is 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, /// A scalar with one value @@ -469,7 +471,8 @@ pub enum Result { /// A scalar with two values 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, UnknownResult(usize, usize, usize, usize, usize, usize, usize),