[Python-checkins] r54202 - python/trunk/Doc/lib/libshutil.tex

[georg.brandl]

Author: georg.brandl
Date: Wed Mar  7 10:34:45 2007
New Revision: 54202

Modified:
   python/trunk/Doc/lib/libshutil.tex
Log:
Patch #1669331: clarify shutil.copyfileobj() behavior wrt. file position.


Modified: python/trunk/Doc/lib/libshutil.tex
==============================================================================
--- python/trunk/Doc/lib/libshutil.tex	(original)
+++ python/trunk/Doc/lib/libshutil.tex	Wed Mar  7 10:34:45 2007
@@ -34,7 +34,9 @@
   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}