From 2be2dfd8906b64323a61b9dc79f79b04684f3074 Mon Sep 17 00:00:00 2001
From: Fred Drake <fdrake@acm.org>
Date: Mon, 31 Jul 2000 15:45:46 +0000
Subject: [PATCH] Moshe Zadka <mzadka@geocities.com>: Document new method in
shutil (copyfileobj). Minor clarification by Fred.
---
Doc/lib/libshutil.tex | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/Doc/lib/libshutil.tex b/Doc/lib/libshutil.tex
index 5da3a0e196f..ad96bd38bde 100644
--- a/Doc/lib/libshutil.tex
+++ b/Doc/lib/libshutil.tex
@@ -23,6 +23,15 @@ file type and creator codes will not be correct.
it will be replaced, otherwise it will be created.
\end{funcdesc}
+\begin{funcdesc}{copyfileobj}{fsrc, fdst\optional{, length}}
+ Copy the contents of the file-like object \var{fsrc} to the
+ file-like object \var{fdst}. The integer \var{length}, if given,
+ 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.
+\end{funcdesc}
+
\begin{funcdesc}{copymode}{src, dst}
Copy the permission bits from \var{src} to \var{dst}. The file
contents, owner, and group are unaffected.
--
2.30.9