From: Nick Mathewson <nickm@torproject.org>
Date: Wed, 17 Oct 2012 14:34:23 +0000 (-0400)
Subject: Document return value of channel_get_addr_if_possible
X-Git-Tag: tor-0.2.4.4-alpha~12
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f633184af1f0dd4a0d2a4c3490d95a8aa6e964d1;p=thirdparty%2Ftor.git

Document return value of channel_get_addr_if_possible
---

diff --git a/src/or/channel.c b/src/or/channel.c
index 49ce129585..10097ae477 100644
--- a/src/or/channel.c
+++ b/src/or/channel.c
@@ -3506,12 +3506,12 @@ channel_get_canonical_remote_descr(channel_t *chan)
 }
 
 /**
- * Get remote address if possible
+ * Get remote address if possible.
  *
  * Write the remote address out to a tor_addr_t if the underlying transport
- * supports this operation.
+ * supports this operation, and return 1.  Return 0 if the underlying transport
+ * doesn't let us do this.
  */
-
 int
 channel_get_addr_if_possible(channel_t *chan, tor_addr_t *addr_out)
 {