From d6086fa9ece0342a0a94be3b133ee68b55eee833 Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Wed, 9 Apr 2014 22:45:55 +0200
Subject: cache: fix description of the offset field

This field sure is a bit strange. I hope the description is correct now.
---
 stream/cache.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'stream')

diff --git a/stream/cache.c b/stream/cache.c
index ac3efcfb74..6f52609082 100644
--- a/stream/cache.c
+++ b/stream/cache.c
@@ -93,7 +93,9 @@ struct priv {
     int64_t min_filepos;    // range of file that is cached in the buffer
     int64_t max_filepos;    // ... max_filepos being the last read position
     bool eof;               // true if max_filepos = EOF
-    int64_t offset;         // buffer[offset] corresponds to max_filepos
+    int64_t offset;         // buffer[WRAP(s->max_filepos - offset)] corresponds
+                            // to the byte at max_filepos (must be wrapped by
+                            // buffer_size)
 
     bool idle;              // cache thread has stopped reading
     int64_t reads;          // number of actual read attempts performed
-- 
cgit v1.2.3