nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-10 13:13:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: Improve documentation for check_bridge_distribution_setting().

Browse Source
This commit is contained in:
Isis Lovecruft 2017-10-23 19:37:52 +00:00 committed by Nick Mathewson
parent 613b18f0af
commit b0e10f23ba
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/or/config.c
View File

@ -6350,8 +6350,26 @@ warn_client_dns_cache(const char *option, int disabling)
"to your destination.");
}
/** Warn if <b>bd</b> is an unrecognized bridge distribution setting;
* return -1 if it is invalid. */
/**
* Validate the configured bridge distribution method from a BridgeDistribution
* config line.
*
* The input <b>bd</b>, is a string taken from the BridgeDistribution config
* line (if present). If the option wasn't set, return 0 immediately. The
* BridgeDistribution option is then validated. Currently valid, recognised
* options are:
*
* - "none"
* - "any"
* - "https"
* - "email"
* - "moat"
* - "hyphae"
*
* If the option string is unrecognised, a warning will be logged and 0 is
* returned. If the option string contains an invalid character, -1 is
* returned.
**/
static int
check_bridge_distribution_setting(const char *bd)
{