From: Nick Mathewson <nickm@torproject.org>
Date: Wed, 18 Apr 2018 15:30:16 +0000 (-0400)
Subject: Improve documentation for CONFIG_TYPE_CSV_INTERVAL.
X-Git-Tag: tor-0.3.4.1-alpha~104^2~2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=510220844774dee27f40204ee24a70b81af1dcb5;p=thirdparty%2Ftor.git

Improve documentation for CONFIG_TYPE_CSV_INTERVAL.
---

diff --git a/src/or/confparse.h b/src/or/confparse.h
index 64ea65d1b9..4b4bf0adb4 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. */