[tor-commits] [tor/master] Improve documentation for CONFIG_TYPE_CSV_INTERVAL.

[nickm at torproject.org]

commit 510220844774dee27f40204ee24a70b81af1dcb5
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Apr 18 11:30:16 2018 -0400

    Improve documentation for CONFIG_TYPE_CSV_INTERVAL.
---
 src/or/confparse.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/or/confparse.h b/src/or/confparse.h
index 64ea65d1b..4b4bf0adb 100644
--- a/src/or/confparse.h
+++ b/src/or/confparse.h
@@ -28,7 +28,9 @@ typedef enum config_type_t {
                               * optional whitespace. */
   CONFIG_TYPE_CSV_INTERVAL, /**< A list of strings, separated by commas and
                               * optional whitespace, representing intervals in
-                              * seconds, with optional units */
+                              * seconds, with optional units.  We allow
+                              * multiple values here for legacy reasons, but
+                              * ignore every value after the first. */
   CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
   CONFIG_TYPE_LINELIST_S,   /**< Uninterpreted, context-sensitive config lines,
                              * mixed with other keywords. */