From: Rusty Russell <rusty@rustcorp.com.au>
Date: Tue, 11 Nov 2014 05:40:21 +0000 (+1030)
Subject: io: fix example in io_plan.h which didn't compile.
X-Git-Url: https://git.ozlabs.org/?p=ccan;a=commitdiff_plain;h=a77ce0e968469c31c3c41efde85d77e6d5eac011

io: fix example in io_plan.h which didn't compile.

This was found because ccanlint now looks for examples here too.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
---

diff --git a/ccan/io/io_plan.h b/ccan/io/io_plan.h
index 1781856e..1d503133 100644
--- a/ccan/io/io_plan.h
+++ b/ccan/io/io_plan.h
@@ -35,22 +35,24 @@ enum io_direction {
  * io_set_plan() when you've initialized it.
  *
  * Example:
+ * #include <ccan/io/io_plan.h>
+ *
  * // Simple helper to read a single char.
  * static int do_readchar(int fd, struct io_plan_arg *arg)
  * {
  *	return read(fd, arg->u1.cp, 1) <= 0 ? -1 : 1;
  * }
  *
- * struct io_plan *io_read_char_(struct io_conn *conn, char *in,
+ * static struct io_plan *io_read_char_(struct io_conn *conn, char *in,
  *				 struct io_plan *(*next)(struct io_conn*,void*),
- *				 void *arg)
+ *				 void *next_arg)
  * {
- *	struct io_plan_arg *arg = io_get_plan_arg(conn, IO_IN);
+ *	struct io_plan_arg *arg = io_plan_arg(conn, IO_IN);
  *
  *	// Store information we need in the plan unions u1 and u2.
  *	arg->u1.cp = in;
  *
- *	return io_set_plan(conn, IO_IN, do_readchar, next, arg);
+ *	return io_set_plan(conn, IO_IN, do_readchar, next, next_arg);
  * }
  */
 struct io_plan_arg *io_plan_arg(struct io_conn *conn, enum io_direction dir);