tor

commit 3a530ae5352cb64e176b889e5449913416c372c0
parent 760d0c056fafdcefd9ac58d48f8ccf473d0ea877
Author: Nick Mathewson <nickm@torproject.org>
Date:   Mon, 26 Aug 2019 19:19:09 -0400

Document types for config_get_changes()

Diffstat:
M
src/app/config/confparse.c
 | 
3
+++

1 file changed, 3 insertions(+), 0 deletions(-)
diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c
@@ -951,6 +951,9 @@ config_is_same(const config_mgr_t *mgr,
  * Return a list of the options which have changed between <b>options1</b> and
  * <b>options2</b>. If an option has reverted to its default value, it has a
  * value entry of NULL.
+ *
+ * <b>options1</b> and <b>options2</b> must be top-level configuration objects
+ * of the type managed by <b>mgr</b>.
  **/
 config_line_t *
 config_get_changes(const config_mgr_t *mgr,