summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorLars Gustäbel <lars@gustaebel.de>2007-02-12 09:25:53 (GMT)
committerLars Gustäbel <lars@gustaebel.de>2007-02-12 09:25:53 (GMT)
commita69aa327aaac8c9156d67b16a81d6b082ba5b012 (patch)
tree5dd9ba3efbcf7fac24a78848ccda5c05d3519e8d /Doc/lib
parent0db62aaf0987db16fc36d3331786168a70ccda8b (diff)
downloadcpython-a69aa327aaac8c9156d67b16a81d6b082ba5b012.zip
cpython-a69aa327aaac8c9156d67b16a81d6b082ba5b012.tar.gz
cpython-a69aa327aaac8c9156d67b16a81d6b082ba5b012.tar.bz2
Bug #1656581: Point out that external file objects are supposed to be
at position 0.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libtarfile.tex5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/lib/libtarfile.tex b/Doc/lib/libtarfile.tex
index 1a53a27..96f835f 100644
--- a/Doc/lib/libtarfile.tex
+++ b/Doc/lib/libtarfile.tex
@@ -49,8 +49,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
@@ -161,6 +161,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}