]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
tweak router_parse_addr_policy_item_from_string docs
authorNick Mathewson <nickm@torproject.org>
Wed, 16 Dec 2015 13:49:32 +0000 (08:49 -0500)
committerNick Mathewson <nickm@torproject.org>
Wed, 16 Dec 2015 13:49:32 +0000 (08:49 -0500)
src/or/routerparse.c

index f5a003ea701a101db9ea33ec88694f6beccc51ab..3f794ad902c3cd4904c1b374fdece2983f943c0f 100644 (file)
@@ -3668,10 +3668,10 @@ networkstatus_parse_detached_signatures(const char *s, const char *eos)
  *
  * Returns NULL on policy errors.
  *
- * If there is a policy error, malformed_list is set to true if the entire
- * policy list should be discarded. Otherwise, it is set to false, and only
- * this item should be ignored - the rest of the policy list can continue to
- * be processed and used.
+ * Set *<b>malformed_list>/b> to true if the entire policy list should be
+ * discarded. Otherwise, set it to false, and only this item should be ignored
+ * on error - the rest of the policy list can continue to be processed and
+ * used.
  *
  * The addr_policy_t returned by this function can have its address set to
  * AF_UNSPEC for '*'.  Use policy_expand_unspec() to turn this into a pair