summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libfilecmp.tex
diff options
context:
space:
mode:
authorNeal Norwitz <nnorwitz@gmail.com>2003-02-06 21:17:17 (GMT)
committerNeal Norwitz <nnorwitz@gmail.com>2003-02-06 21:17:17 (GMT)
commit694d9b354195ac3bf361b33601ed77e5b02e4fa7 (patch)
tree4e0cc01ce0b71336b9a6b5c52153aa0589d86cb6 /Doc/lib/libfilecmp.tex
parentd683504b85206334aba32e8706ca6cb15b3efbf7 (diff)
downloadcpython-694d9b354195ac3bf361b33601ed77e5b02e4fa7.zip
cpython-694d9b354195ac3bf361b33601ed77e5b02e4fa7.tar.gz
cpython-694d9b354195ac3bf361b33601ed77e5b02e4fa7.tar.bz2
Update doc to reflect code changes for obsoleting use_statcache parameter
Diffstat (limited to 'Doc/lib/libfilecmp.tex')
-rw-r--r--Doc/lib/libfilecmp.tex11
1 files changed, 3 insertions, 8 deletions
diff --git a/Doc/lib/libfilecmp.tex b/Doc/lib/libfilecmp.tex
index ddb74ab..7747c8c 100644
--- a/Doc/lib/libfilecmp.tex
+++ b/Doc/lib/libfilecmp.tex
@@ -16,16 +16,11 @@ Compare the files named \var{f1} and \var{f2}, returning \code{True} if
they seem equal, \code{False} otherwise.
Unless \var{shallow} is given and is false, files with identical
-\function{os.stat()} signatures are taken to be equal. If
-\var{use_statcache} is given and is true,
-\function{statcache.stat()} will be called rather then
-\function{os.stat()}; the default is to use \function{os.stat()}.
+\function{os.stat()} signatures are taken to be equal.
+\versionchanged[\var{use_statcache} is obsolete and ignored.]{2.3}
Files that were compared using this function will not be compared again
-unless their \function{os.stat()} signature changes. Note that using
-\var{use_statcache} true will cause the cache invalidation mechanism to
-fail --- the stale stat value will be used from \refmodule{statcache}'s
-cache.
+unless their \function{os.stat()} signature changes.
Note that no external programs are called from this function, giving it
portability and efficiency.