[or-cvs] [tor/master] Fix comments for getinfo_helper_t

[nickm at torproject.org]

Author: Sebastian Hahn <sebastian at torproject.org>
Date: Wed, 27 Jan 2010 22:11:42 +0100
Subject: Fix comments for getinfo_helper_t
Commit: 02889bae21d31b3c7d8a5bc2dacd5360d479874c

rieo pointed out something isn't right here
---
 src/or/control.c |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/or/control.c b/src/or/control.c
index 13a5f46..c08d6a2 100644
--- a/src/or/control.c
+++ b/src/or/control.c
@@ -1768,8 +1768,9 @@ getinfo_helper_events(control_connection_t *control_conn,
 
 /** Callback function for GETINFO: on a given control connection, try to
  * answer the question <b>q</b> and store the newly-allocated answer in
- * *<b>a</b>.  If there's no answer, or an error occurs, just don't set
- * <b>a</b>.  Return 0.
+ * *<b>a</b>. If an internal error occurs, return -1. On success, or if
+ * the key is not recognized, return 0. Do not set <b>a</b> if the key is
+ * not recognized.
  */
 typedef int (*getinfo_helper_t)(control_connection_t *,
                                 const char *q, char **a);
-- 
1.6.5