From: Lars Gustäbel <lars@gustaebel.de>
Date: Mon, 12 Feb 2007 09:27:10 +0000 (+0000)
Subject: Bug #1656581: Point out that external file objects are supposed to be
X-Git-Tag: v2.5.1c1~117
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f5bf3b0c719eb4c59c33d81afff39357ad0352a8;p=python

Bug #1656581: Point out that external file objects are supposed to be
at position 0. (backport from rev. 53752)
---

diff --git a/Doc/lib/libtarfile.tex b/Doc/lib/libtarfile.tex
index ca6e65a8ad..b33ac606ca 100644
--- a/Doc/lib/libtarfile.tex
+++ b/Doc/lib/libtarfile.tex
@@ -48,8 +48,8 @@ Some facts and figures:
     avoid this.  If a compression method is not supported,
     \exception{CompressionError} is raised.
 
-    If \var{fileobj} is specified, it is used as an alternative to
-    a file object opened for \var{name}.
+    If \var{fileobj} is specified, it is used as an alternative to a file
+    object opened for \var{name}. It is supposed to be at position 0.
 
     For special purposes, there is a second format for \var{mode}:
     \code{'filemode|[compression]'}.  \function{open()} will return a
@@ -155,6 +155,7 @@ tar archive several times. Each archive member is represented by a
 
     If \var{fileobj} is given, it is used for reading or writing data.
     If it can be determined, \var{mode} is overridden by \var{fileobj}'s mode.
+    \var{fileobj} will be used from position 0.
     \begin{notice}
         \var{fileobj} is not closed, when \class{TarFile} is closed.
     \end{notice}