1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add more detail to the descriptions of the shutil functions.

Browse Source 
This closes SF bug #458223.
This commit is contained in:
Fred Drake 2001-09-04 18:26:27 +00:00
parent c05fc7dd9d
commit 757f7809e1
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/lib/libshutil.tex
View File

@ -21,7 +21,9 @@ file type and creator codes will not be correct.
\begin{funcdesc}{copyfile}{src, dst} \begin{funcdesc}{copyfile}{src, dst}
Copy the contents of the file named \var{src} to a file named Copy the contents of the file named \var{src} to a file named
\var{dst}. If \var{dst} exists, it will be replaced, otherwise it \var{dst}. If \var{dst} exists, it will be replaced, otherwise it
will be created. will be created. Special files such as character or block devices
and pipes cannot not be copied with this function. \var{src} and
\var{dst} are path names given as strings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{copyfileobj}{fsrc, fdst\optional{, length}} \begin{funcdesc}{copyfileobj}{fsrc, fdst\optional{, length}}
@ -35,20 +37,23 @@ file type and creator codes will not be correct.
\begin{funcdesc}{copymode}{src, dst} \begin{funcdesc}{copymode}{src, dst}
Copy the permission bits from \var{src} to \var{dst}. The file Copy the permission bits from \var{src} to \var{dst}. The file
contents, owner, and group are unaffected. contents, owner, and group are unaffected. \var{src} and \var{dst}
are path names given as strings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{copystat}{src, dst} \begin{funcdesc}{copystat}{src, dst}
Copy the permission bits, last access time, and last modification Copy the permission bits, last access time, and last modification
time from \var{src} to \var{dst}. The file contents, owner, and time from \var{src} to \var{dst}. The file contents, owner, and
group are unaffected. group are unaffected. \var{src} and \var{dst} are path names given
as strings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{copy}{src, dst} \begin{funcdesc}{copy}{src, dst}
Copy the file \var{src} to the file or directory \var{dst}. If Copy the file \var{src} to the file or directory \var{dst}. If
\var{dst} is a directory, a file with the same basename as \var{src} \var{dst} is a directory, a file with the same basename as \var{src}
is created (or overwritten) in the directory specified. Permission is created (or overwritten) in the directory specified. Permission
bits are copied. bits are copied. \var{src} and \var{dst} are path names given as
strings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{copy2}{src, dst} \begin{funcdesc}{copy2}{src, dst}