annotate Doc/lib/libfilecmp.tex @ 21467:4e35fa5d5708 legacy-trunk

Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents 2e015f8a1ac2
children e62174c7d8e5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1 \section{\module{filecmp} ---
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
2 File and Directory Comparisons}
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
3
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
4 \declaremodule{standard}{filecmp}
15467
d7864345b1c8 Update Moshe Zadka's email address to one works and might last a while.
Fred Drake <fdrake@acm.org>
parents: 13317
diff changeset
5 \sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
6 \modulesynopsis{Compare files efficiently.}
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
7
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
8
17792
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
9 The \module{filecmp} module defines functions to compare files and
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
10 directories, with various optional time/correctness trade-offs.
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
11
17792
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
12 The \module{filecmp} module defines the following functions:
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
13
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
14 \begin{funcdesc}{cmp}{f1, f2\optional{, shallow\optional{, use_statcache}}}
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
15 Compare the files named \var{f1} and \var{f2}, returning \code{1} if
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
16 they seem equal, \code{0} otherwise.
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
17
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
18 Unless \var{shallow} is given and is false, files with identical
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
19 \function{os.stat()} signatures are taken to be equal. If
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
20 \var{use_statcache} is given and is true,
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
21 \function{statcache.stat()} will be called rather then
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
22 \function{os.stat()}; the default is to use \function{os.stat()}.
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
23
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
24 Files that were compared using this function will not be compared again
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
25 unless their \function{os.stat()} signature changes. Note that using
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
26 \var{use_statcache} true will cause the cache invalidation mechanism to
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
27 fail --- the stale stat value will be used from \refmodule{statcache}'s
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
28 cache.
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
29
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
30 Note that no external programs are called from this function, giving it
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
31 portability and efficiency.
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
32 \end{funcdesc}
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
33
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
34 \begin{funcdesc}{cmpfiles}{dir1, dir2, common\optional{,
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
35 shallow\optional{, use_statcache}}}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
36 Returns three lists of file names: \var{match}, \var{mismatch},
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
37 \var{errors}. \var{match} contains the list of files match in both
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
38 directories, \var{mismatch} includes the names of those that don't,
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
39 and \var{errros} lists the names of files which could not be
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
40 compared. Files may be listed in \var{errors} because the user may
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
41 lack permission to read them or many other reasons, but always that
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
42 the comparison could not be done for some reason.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
43
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
44 The \var{shallow} and \var{use_statcache} parameters have the same
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
45 meanings and default values as for \function{filecmp.cmp()}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
46 \end{funcdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
47
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
48 Example:
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
49
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
50 \begin{verbatim}
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
51 >>> import filecmp
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
52 >>> filecmp.cmp('libundoc.tex', 'libundoc.tex')
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
53 1
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
54 >>> filecmp.cmp('libundoc.tex', 'lib.tex')
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
55 0
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
56 \end{verbatim}
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
57
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
58
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
59 \subsection{The \protect\class{dircmp} class \label{dircmp-objects}}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
60
17792
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
61 \class{dircmp} instances are built using this constructor:
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
62
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
63 \begin{classdesc}{dircmp}{a, b\optional{, ignore\optional{, hide}}}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
64 Construct a new directory comparison object, to compare the
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
65 directories \var{a} and \var{b}. \var{ignore} is a list of names to
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
66 ignore, and defaults to \code{['RCS', 'CVS', 'tags']}. \var{hide} is a
15982
91304c4c7256 correct typo - closes bug #129205
Skip Montanaro <skip@pobox.com>
parents: 15467
diff changeset
67 list of names to hide, and defaults to \code{[os.curdir, os.pardir]}.
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
68 \end{classdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
69
17792
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
70 The \class{dircmp} class provides the following methods:
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
71
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
72 \begin{methoddesc}[dircmp]{report}{}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
73 Print (to \code{sys.stdout}) a comparison between \var{a} and \var{b}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
74 \end{methoddesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
75
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
76 \begin{methoddesc}[dircmp]{report_partial_closure}{}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
77 Print a comparison between \var{a} and \var{b} and common immediate
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
78 subdirctories.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
79 \end{methoddesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
80
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
81 \begin{methoddesc}[dircmp]{report_full_closure}{}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
82 Print a comparison between \var{a} and \var{b} and common
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
83 subdirctories (recursively).
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
84 \end{methoddesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
85
17792
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
86
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
87 The \class{dircmp} offers a number of interesting attributes that may
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
88 be used to get various bits of information about the directory trees
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
89 being compared.
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
90
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
91 Note that via \method{__getattr__()} hooks, all attributes are
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
92 computed lazilly, so there is no speed penalty if only those
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
93 attributes which are lightweight to compute are used.
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
94
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
95 \begin{memberdesc}[dircmp]{left_list}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
96 Files and subdirectories in \var{a}, filtered by \var{hide} and
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
97 \var{ignore}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
98 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
99
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
100 \begin{memberdesc}[dircmp]{right_list}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
101 Files and subdirectories in \var{b}, filtered by \var{hide} and
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
102 \var{ignore}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
103 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
104
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
105 \begin{memberdesc}[dircmp]{common}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
106 Files and subdirectories in both \var{a} and \var{b}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
107 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
108
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
109 \begin{memberdesc}[dircmp]{left_only}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
110 Files and subdirectories only in \var{a}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
111 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
112
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
113 \begin{memberdesc}[dircmp]{right_only}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
114 Files and subdirectories only in \var{b}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
115 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
116
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
117 \begin{memberdesc}[dircmp]{common_dirs}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
118 Subdirectories in both \var{a} and \var{b}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
119 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
120
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
121 \begin{memberdesc}[dircmp]{common_files}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
122 Files in both \var{a} and \var{b}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
123 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
124
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
125 \begin{memberdesc}[dircmp]{common_funny}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
126 Names in both \var{a} and \var{b}, such that the type differs between
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
127 the directories, or names for which \function{os.stat()} reports an
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
128 error.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
129 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
130
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
131 \begin{memberdesc}[dircmp]{same_files}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
132 Files which are identical in both \var{a} and \var{b}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
133 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
134
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
135 \begin{memberdesc}[dircmp]{diff_files}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
136 Files which are in both \var{a} and \var{b}, whose contents differ.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
137 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
138
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
139 \begin{memberdesc}[dircmp]{funny_files}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
140 Files which are in both \var{a} and \var{b}, but could not be
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
141 compared.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
142 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
143
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
144 \begin{memberdesc}[dircmp]{subdirs}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
145 A dictionary mapping names in \member{common_dirs} to
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
146 \class{dircmp} objects.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
147 \end{memberdesc}