[tor-commits] [tor/master] Document warn_deprecated_option().

commit 3db56aeeb8a59629690a05cd43565764a254d1e1 Author: Nick Mathewson nickm@torproject.org Date: Wed Sep 4 14:01:43 2019 -0400

Document warn_deprecated_option(). --- src/app/config/confparse.c | 4 ++++ 1 file changed, 4 insertions(+)

diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c index 23a89ba62..b0ff4daa8 100644 --- a/src/app/config/confparse.c +++ b/src/app/config/confparse.c @@ -578,6 +578,10 @@ config_mark_lists_fragile(const config_mgr_t *mgr, void *options) } SMARTLIST_FOREACH_END(mv); }

+/** + * Log a warning that declaring that the option called <b>what</b> + * is deprecated because of the reason in <b>why</b>. + **/ void warn_deprecated_option(const char *what, const char *why) {