From f3c037475c88c9452d70e32cae0ccf871aa77158 Mon Sep 17 00:00:00 2001 From: Sean McBride Date: Sun, 5 Jul 2020 18:54:37 -0400 Subject: [PATCH] docs: fix incoherent comment --- runtime/src/global_request_scheduler_minheap.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/runtime/src/global_request_scheduler_minheap.c b/runtime/src/global_request_scheduler_minheap.c index 899f4f3..f1ace20 100644 --- a/runtime/src/global_request_scheduler_minheap.c +++ b/runtime/src/global_request_scheduler_minheap.c @@ -29,8 +29,10 @@ global_request_scheduler_minheap_remove(sandbox_request_t **removed_sandbox_requ } /** - * - * @returns A Sandbox Request or NULL + * Peek at the priority of the highest priority task without having to take the lock + * Because this is a min-heap PQ, the highest priority is the lowest 64-bit integer + * This is used to store an absolute deadline + * @returns value of highest priority value in queue or ULONG_MAX if empty */ static uint64_t global_request_scheduler_minheap_peek(void)