From: Georg Brandl <georg@python.org>
Date: Wed, 7 Mar 2007 09:34:52 +0000 (+0000)
Subject: Patch #1669331: clarify shutil.copyfileobj() behavior wrt. file position.
X-Git-Tag: v2.5.1c1~76
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4a7da9cdbc2100e5b6c8b6d9da58ee8f5a813a96;p=python

Patch #1669331: clarify shutil.copyfileobj() behavior wrt. file position.
 (backport from rev. 54202)
---

diff --git a/Doc/lib/libshutil.tex b/Doc/lib/libshutil.tex
index 449d7414f3..f5c55a04b1 100644
--- a/Doc/lib/libshutil.tex
+++ b/Doc/lib/libshutil.tex
@@ -34,7 +34,9 @@ file type and creator codes will not be correct.
   is the buffer size. In particular, a negative \var{length} value
   means to copy the data without looping over the source data in
   chunks; by default the data is read in chunks to avoid uncontrolled
-  memory consumption.
+  memory consumption. Note that if the current file position of the
+  \var{fsrc} object is not 0, only the contents from the current file
+  position to the end of the file will be copied.
 \end{funcdesc}
 
 \begin{funcdesc}{copymode}{src, dst}