[tor-commits] [tor/master] Note that threadpool_queue_work...() can't actually return NULL

[nickm at torproject.org]

commit f5a852de91110c4db367946e848656b45a078f39
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Jul 27 16:11:58 2017 -0400

    Note that threadpool_queue_work...() can't actually return NULL
---
 src/common/workqueue.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/common/workqueue.c b/src/common/workqueue.c
index f44f566d2..d1303ee0e 100644
--- a/src/common/workqueue.c
+++ b/src/common/workqueue.c
@@ -360,7 +360,8 @@ workerthread_new(int32_t lower_priority_chance,
  * function's responsibility to free the work object.
  *
  * On success, return a workqueue_entry_t object that can be passed to
- * workqueue_entry_cancel(). On failure, return NULL.
+ * workqueue_entry_cancel(). On failure, return NULL.  (Failure is not
+ * currently possible, but callers should check anyway.)
  *
  * Items are executed in a loose priority order -- each thread will usually
  * take from the queued work with the highest prioirity, but will occasionally