From 3db56aeeb8a59629690a05cd43565764a254d1e1 Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Wed, 4 Sep 2019 14:01:43 -0400
Subject: [PATCH] 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 23a89ba627..b0ff4daa83 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)
 {