I've been meaning to get round to this for _ages_: in front of my

coroutine macros, I now include a comment linking to my web article
that explains what they do.

[originally from svn r2902]

diff --git a/ssh.c b/ssh.c
index 5bea36b9c34df480ab7551c8ad5da2373f9f5535..82fbf152e32c01dfb664b00e7c7ae9a62aeb2f8e 100644 (file)
--- a/ssh.c
+++ b/ssh.c
@@ -269,7 +269,15 @@ static char *ssh2_pkt_type(int pkt_ctx, int type)
 
 enum { PKT_END, PKT_INT, PKT_CHAR, PKT_DATA, PKT_STR, PKT_BIGNUM };
 
-/* Coroutine mechanics for the sillier bits of the code */
+/*
+ * Coroutine mechanics for the sillier bits of the code. If these
+ * macros look impenetrable to you, you might find it helpful to
+ * read
+ * 
+ *   http://www.chiark.greenend.org.uk/~sgtatham/coroutines.html
+ * 
+ * which explains the theory behind these macros.
+ */
 #define crBegin(v)     { int *crLine = &v; switch(v) { case 0:;
 #define crState(t) \
     struct t *s; \