archive/tar: document Reader.Next's behavior at the end

Change-Id: I72f6d0fc66dbee3f832d2d960b99a166a5bb10c3
Reviewed-on: https://go-review.googlesource.com/2191
Reviewed-by: David Symonds <dsymonds@golang.org>

diff --git a/src/archive/tar/reader.go b/src/archive/tar/reader.go
index a27559d0f042c152ca4ef8b20cbe21412fc14fa7..abd8f148a787499024802272adc900c3aa48e284 100644 (file)
--- a/src/archive/tar/reader.go
+++ b/src/archive/tar/reader.go
@@ -85,6 +85,8 @@ const (
 func NewReader(r io.Reader) *Reader { return &Reader{r: r} }
 
 // Next advances to the next entry in the tar archive.
+//
+// io.EOF is returned at the end of the input.
 func (tr *Reader) Next() (*Header, error) {
        var hdr *Header
        if tr.err == nil {