annotate Doc/lib/libcmpcache.tex @ 20580:376ee174ecd0 legacy-trunk

Use the \note and \warning macros where appropriate.
author Fred Drake <fdrake@acm.org>
date Sat, 20 Oct 2001 04:24:09 +0000
parents 4b51d069be35
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10996
84ab14d85763 New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>!
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1 \section{\module{cmpcache} ---
84ab14d85763 New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>!
Fred Drake <fdrake@acm.org>
parents:
diff changeset
2 Efficient file comparisons}
84ab14d85763 New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>!
Fred Drake <fdrake@acm.org>
parents:
diff changeset
3
84ab14d85763 New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>!
Fred Drake <fdrake@acm.org>
parents:
diff changeset
4 \declaremodule{standard}{cmpcache}
15467
d7864345b1c8 Update Moshe Zadka's email address to one works and might last a while.
Fred Drake <fdrake@acm.org>
parents: 11414
diff changeset
5 \sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}
10996
84ab14d85763 New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>!
Fred Drake <fdrake@acm.org>
parents:
diff changeset
6 \modulesynopsis{Compare files very efficiently.}
84ab14d85763 New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>!
Fred Drake <fdrake@acm.org>
parents:
diff changeset
7
16253
4b51d069be35 Removed references to Python 1.5.3; that was a "tentative" number I used
Fred Drake <fdrake@acm.org>
parents: 15467
diff changeset
8 \deprecated{1.6}{Use the \refmodule{filecmp} module instead.}
11414
c8155d05d9ca Added deprecation notes, in case anyone decides to read these anyway.
Fred Drake <fdrake@acm.org>
parents: 11005
diff changeset
9
11005
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
10 The \module{cmpcache} module provides an identical interface and similar
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
11 functionality as the \refmodule{cmp} module, but can be a bit more efficient
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
12 as it uses \function{statcache.stat()} instead of \function{os.stat()}
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
13 (see the \refmodule{statcache} module for information on the
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
14 difference).
10996
84ab14d85763 New module documentation sections from Moshe Zadka <moshez@math.huji.ac.il>!
Fred Drake <fdrake@acm.org>
parents:
diff changeset
15
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 16253
diff changeset
16 \note{Using the \refmodule{statcache} module to provide
11005
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
17 \function{stat()} information results in trashing the cache
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
18 invalidation mechanism: results are not as reliable. To ensure
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
19 ``current'' results, use \function{cmp.cmp()} instead of the version
c8ed5a14488d Updated version from Moshe, with a re-written warning about the
Fred Drake <fdrake@acm.org>
parents: 10996
diff changeset
20 defined in this module, or use \function{statcache.forget()} to
20580
376ee174ecd0 Use the \note and \warning macros where appropriate.
Fred Drake <fdrake@acm.org>
parents: 16253
diff changeset
21 invalidate the appropriate entries.}