unixctl: Fix comment on unixctl_command_register().
authorBen Pfaff <blp@nicira.com>
Thu, 6 Sep 2012 22:41:11 +0000 (15:41 -0700)
committerBen Pfaff <blp@nicira.com>
Fri, 21 Sep 2012 16:49:40 +0000 (09:49 -0700)
The arguments to the callback were changed some time ago but the comment
still described the older form.

Signed-off-by: Ben Pfaff <blp@nicira.com>
Acked-by: Ethan Jackson <ethan@nicira.com>
lib/unixctl.c

index 4ab493d48775ea0504b57d4f4233b52c7f3483a9..8686de3fb056613541e47c6b122da157ac78b4b7 100644 (file)
@@ -95,13 +95,13 @@ unixctl_version(struct unixctl_conn *conn, int argc OVS_UNUSED,
  * arguments to the command; it is used only for presentation to the user in
  * "help" output.
  *
- * 'cb' is called when the command is received.  It is passed the actual set of
- * arguments, as a text string, plus a copy of 'aux'.  Normally 'cb' should
- * reply by calling unixctl_command_reply() or unixctl_command_reply_error()
- * before it returns, but if the command cannot be handled immediately then it
- * can defer the reply until later.  A given connection can only process a
- * single request at a time, so a reply must be made eventually to avoid
- * blocking that connection. */
+ * 'cb' is called when the command is received.  It is passed an array
+ * containing the command name and arguments, plus a copy of 'aux'.  Normally
+ * 'cb' should reply by calling unixctl_command_reply() or
+ * unixctl_command_reply_error() before it returns, but if the command cannot
+ * be handled immediately then it can defer the reply until later.  A given
+ * connection can only process a single request at a time, so a reply must be
+ * made eventually to avoid blocking that connection. */
 void
 unixctl_command_register(const char *name, const char *usage,
                          int min_args, int max_args,