diff options
author | Lars Gustäbel <lars@gustaebel.de> | 2007-02-12 09:27:10 +0000 |
---|---|---|
committer | Lars Gustäbel <lars@gustaebel.de> | 2007-02-12 09:27:10 +0000 |
commit | f5bf3b0c719eb4c59c33d81afff39357ad0352a8 (patch) | |
tree | 954d47a3f2109940521b775f6f52c66a6045cf6f | |
parent | 4a67a6741660d32a31ed74b5c4b981553cd7be41 (diff) | |
download | cpython-git-f5bf3b0c719eb4c59c33d81afff39357ad0352a8.tar.gz |
Bug #1656581: Point out that external file objects are supposed to be
at position 0. (backport from rev. 53752)
-rw-r--r-- | Doc/lib/libtarfile.tex | 5 |
1 files changed, 3 insertions, 2 deletions
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} |