diff --git a/changes/bug25378 b/changes/bug25378 new file mode 100644 index 000000000..4648a0a31 --- /dev/null +++ b/changes/bug25378 @@ -0,0 +1,4 @@ + o Documentation: + - Update the documentation for "Log" to include the current list + of logging domains. Closes ticket 25378. + diff --git a/doc/tor.1.txt b/doc/tor.1.txt index a8e5de7b5..9dbed2ef6 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -650,7 +650,8 @@ GENERAL OPTIONS + The currently recognized domains are: general, crypto, net, config, fs, protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge, - acct, hist, and handshake. Domain names are case-insensitive. + + acct, hist, handshake, heartbeat, channel, sched, guard, consdiff, and dos. + Domain names are case-insensitive. + + For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends to stdout: all handshake messages of any severity, all info-and-higher diff --git a/src/common/log.c b/src/common/log.c index d59e5a403..9f4a8b2bc 100644 --- a/src/common/log.c +++ b/src/common/log.c @@ -1258,7 +1258,10 @@ log_level_to_string(int level) } /** NULL-terminated array of names for log domains such that domain_list[dom] - * is a description of dom. */ + * is a description of dom. + * + * Remember to update doc/tor.1.txt if you modify this list. + * */ static const char *domain_list[] = { "GENERAL", "CRYPTO", "NET", "CONFIG", "FS", "PROTOCOL", "MM", "HTTP", "APP", "CONTROL", "CIRC", "REND", "BUG", "DIR", "DIRSERV",