[tor-commits] [tor/maint-0.3.1] add an explanatory comment about the error codes

[nickm at torproject.org]

commit ea13a47791c1a6b50fed27322a073c54868ac738
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Nov 21 12:36:32 2017 -0500

    add an explanatory comment about the error codes
---
 src/or/conscache.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/or/conscache.c b/src/or/conscache.c
index 4919dba3d..33a549597 100644
--- a/src/or/conscache.c
+++ b/src/or/conscache.c
@@ -539,6 +539,10 @@ consensus_cache_rescan(consensus_cache_t *cache)
     map = storage_dir_map_labeled(cache->dir, fname,
                                   &labels, &body, &bodylen);
     if (! map) {
+      /* The ERANGE error might come from tor_mmap_file() -- it means the file
+       * was empty. EINVAL might come from ..map_labeled() -- it means the
+       * file was misformatted. In both cases, we should just delete it.
+       */
       if (errno == ERANGE || errno == EINVAL) {
         log_warn(LD_FS, "Found %s file %s in consensus cache; removing it.",
                  errno == ERANGE ? "empty" : "misformatted",