From accbe0dc99393c183cba203633e77c96fc7b3c2b Mon Sep 17 00:00:00 2001
From: Sridhar Ratnakumar <sridharr@activestate.com>
Date: Wed, 13 Nov 2013 17:41:13 -0800
Subject: [PATCH] descriptive comment for the Cleanup function

---
 tail.go | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/tail.go b/tail.go
index 365164f..61a8cd2 100644
--- a/tail.go
+++ b/tail.go
@@ -306,8 +306,9 @@ func (tail *Tail) sendLine(line []byte) bool {
 	return true
 }
 
-// Cleanup removes open inotify watchers, because the Linux kernel does do so
-// upon process exit.
+// Cleanup removes inotify watches added by the tail package. This function is
+// meant to be invoked from a process's exit handler. Linux kernel will not
+// automatically remove inotify watches after the process exits.
 func Cleanup() {
 	watch.Cleanup()
 }