From: Brad Fitzpatrick <bradfitz@golang.org>
Date: Tue, 30 Dec 2014 06:28:02 +0000 (-0800)
Subject: archive/tar: document Reader.Next's behavior at the end
X-Git-Tag: go1.5beta1~2495
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=f005d6e34aa94cad99e881c4fc87bc6e614ba9a6;p=gostls13.git

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 a27559d0f0..abd8f148a7 100644
--- 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 {