aboutsummaryrefslogtreecommitdiff
path: root/src/feature/dirauth/process_descs.c
diff options
context:
space:
mode:
authorteor <teor@torproject.org>2020-03-20 17:01:06 +1000
committerNick Mathewson <nickm@torproject.org>2020-03-20 07:56:26 -0400
commitd4a74021e5ab9dbaf3bb27c0a52e1fd7f8f792ab (patch)
treed34e4c2215ea3b778ccbc1395dc1d38860dd1f2d /src/feature/dirauth/process_descs.c
parentc478dc9b2f6c320cc21a10ffed0d7cc245fa933c (diff)
downloadtor-d4a74021e5ab9dbaf3bb27c0a52e1fd7f8f792ab.tar.gz
tor-d4a74021e5ab9dbaf3bb27c0a52e1fd7f8f792ab.zip
relay/dirauth: Set some output arguments in stubs
And document how some functions set their output arguments. Fixes bug 33674; bugfix on 0.4.3.1-alpha.
Diffstat (limited to 'src/feature/dirauth/process_descs.c')
-rw-r--r--src/feature/dirauth/process_descs.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/feature/dirauth/process_descs.c b/src/feature/dirauth/process_descs.c
index 5c918ca0b4..5025d0ae39 100644
--- a/src/feature/dirauth/process_descs.c
+++ b/src/feature/dirauth/process_descs.c
@@ -285,7 +285,7 @@ dirserv_load_fingerprint_file(void)
* Return the appropriate router status.
*
* If the status is 'RTR_REJECT' and <b>msg</b> is provided, set
- * *<b>msg</b> to an explanation of why. */
+ * *<b>msg</b> to a string constant explaining why. */
uint32_t
dirserv_router_get_status(const routerinfo_t *router, const char **msg,
int severity)
@@ -563,7 +563,8 @@ dirserv_router_has_valid_address(routerinfo_t *ri)
/** Check whether we, as a directory server, want to accept <b>ri</b>. If so,
* set its is_valid,running fields and return 0. Otherwise, return -1.
*
- * If the router is rejected, set *<b>msg</b> to an explanation of why.
+ * If the router is rejected, set *<b>msg</b> to a string constant explining
+ * why.
*
* If <b>complain</b> then explain at log-level 'notice' why we refused
* a descriptor; else explain at log-level 'info'.
@@ -729,7 +730,8 @@ dirserv_add_multiple_descriptors(const char *desc, size_t desclen,
* That means the caller must not access <b>ri</b> after this function
* returns, since it might have been freed.
*
- * Return the status of the operation.
+ * Return the status of the operation, and set *<b>msg</b> to a string
+ * constant describing the status.
*
* This function is only called when fresh descriptors are posted, not when
* we re-load the cache.