descriptive comment for the Cleanup function

This commit is contained in:
Sridhar Ratnakumar 2013-11-13 17:41:13 -08:00
parent 6ffcd854c1
commit accbe0dc99
1 changed files with 3 additions and 2 deletions

View File

@ -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()
}