[tor-commits] [tor/master] control: Fix comment of control_event_hs_descriptor_content

[nickm at torproject.org]

commit aadb99e5f906a7b8aed8b6c0d995690699bdbfee
Author: David Goulet <dgoulet at torproject.org>
Date:   Tue Apr 25 13:04:47 2017 -0400

    control: Fix comment of control_event_hs_descriptor_content
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 src/or/control.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/src/or/control.c b/src/or/control.c
index ed72d6f..9b0d7c0 100644
--- a/src/or/control.c
+++ b/src/or/control.c
@@ -7138,9 +7138,11 @@ control_event_hs_descriptor_failed(const rend_data_t *rend_data,
                                           rend_data, id_digest, reason);
 }
 
-/** send HS_DESC_CONTENT event after completion of a successful fetch from
- * hs directory. If <b>hsdir_id_digest</b> is NULL, it is replaced by
- * "UNKNOWN". */
+/** Send HS_DESC_CONTENT event after completion of a successful fetch from hs
+ * directory. If <b>hsdir_id_digest</b> is NULL, it is replaced by "UNKNOWN".
+ * If <b>content</b> is NULL, it is replaced by an empty string. The
+ * <b>onion_address</b> or <b>desc_id</b> set to NULL will no trigger the
+ * control event. */
 void
 control_event_hs_descriptor_content(const char *onion_address,
                                     const char *desc_id,