From: Charlie Shepherd <cs...@cam.ac.uk>
Coroutine functions that can yield directly or indirectly should be annotated
with a coroutine_fn annotation. Add an explanation to that effect in
include/block/coroutine.h.
---
include/block/coroutine.h | 3 +++
1 file changed, 3 insertions(+)
diff --git a/include/block/coroutine.h b/include/block/coroutine.h
index 377805a..3b94b6d 100644
--- a/include/block/coroutine.h
+++ b/include/block/coroutine.h
@@ -37,6 +37,9 @@
* static checker support for catching such errors. This annotation might make
* it possible and in the meantime it serves as documentation.
*
+ * A function must be marked with coroutine_fn if it can yield execution,
either
+ * directly or indirectly.
+ *
* For example:
*
* static void coroutine_fn foo(void) {
--
1.8.3.2
