annotate Doc/lib/libfilecmp.tex @ 28646:193b8aec00ce legacy-trunk

Changes from Jonathan Riehl to allow his pgen extension (PEP 269) to work. This includes some more code that used to be part of pgen in the main parser; I'm okay with that. I'll see if the Windows build needs work next.
author Guido van Rossum <guido@python.org>
date Thu, 17 Apr 2003 14:55:42 +0000
parents 32fb94a6a4fe
children cf555ec698eb 67f2190e1f6d
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}}}
22835
73d145bfd8e4 Update doc to reflect Tim's changes to bool.
Neal Norwitz <nnorwitz@gmail.com>
parents: 22419
diff changeset
15 Compare the files named \var{f1} and \var{f2}, returning \code{True} if
73d145bfd8e4 Update doc to reflect Tim's changes to bool.
Neal Norwitz <nnorwitz@gmail.com>
parents: 22419
diff changeset
16 they seem equal, \code{False} 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
27735
32fb94a6a4fe Update doc to reflect code changes for obsoleting use_statcache parameter
Neal Norwitz <nnorwitz@gmail.com>
parents: 22835
diff changeset
19 \function{os.stat()} signatures are taken to be equal.
32fb94a6a4fe Update doc to reflect code changes for obsoleting use_statcache parameter
Neal Norwitz <nnorwitz@gmail.com>
parents: 22835
diff changeset
20 \versionchanged[\var{use_statcache} is obsolete and ignored.]{2.3}
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
21
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
22 Files that were compared using this function will not be compared again
27735
32fb94a6a4fe Update doc to reflect code changes for obsoleting use_statcache parameter
Neal Norwitz <nnorwitz@gmail.com>
parents: 22835
diff changeset
23 unless their \function{os.stat()} signature changes.
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
24
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
25 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
26 portability and efficiency.
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
27 \end{funcdesc}
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
28
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
29 \begin{funcdesc}{cmpfiles}{dir1, dir2, common\optional{,
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
30 shallow\optional{, use_statcache}}}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
31 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
32 \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
33 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
34 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
35 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
36 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
37 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
38
22419
b148e18ae77a SF# 522426, add doc for common parameter for filecmp.cmpfiles()
Neal Norwitz <nnorwitz@gmail.com>
parents: 17792
diff changeset
39 The \var{common} parameter is a list of file names found in both directories.
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
40 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
41 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
42 \end{funcdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
43
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
44 Example:
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
45
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
46 \begin{verbatim}
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
47 >>> import filecmp
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
48 >>> filecmp.cmp('libundoc.tex', 'libundoc.tex')
22835
73d145bfd8e4 Update doc to reflect Tim's changes to bool.
Neal Norwitz <nnorwitz@gmail.com>
parents: 22419
diff changeset
49 True
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
50 >>> filecmp.cmp('libundoc.tex', 'lib.tex')
22835
73d145bfd8e4 Update doc to reflect Tim's changes to bool.
Neal Norwitz <nnorwitz@gmail.com>
parents: 22419
diff changeset
51 False
11415
a60fa74aaeaf filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>.
Fred Drake <fdrake@acm.org>
parents:
diff changeset
52 \end{verbatim}
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
53
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
54
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
55 \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
56
17792
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
57 \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
58
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
59 \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
60 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
61 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
62 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
63 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
64 \end{classdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
65
17792
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
66 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
67
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
68 \begin{methoddesc}[dircmp]{report}{}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
69 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
70 \end{methoddesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
71
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
72 \begin{methoddesc}[dircmp]{report_partial_closure}{}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
73 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
74 subdirctories.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
75 \end{methoddesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
76
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
77 \begin{methoddesc}[dircmp]{report_full_closure}{}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
78 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
79 subdirctories (recursively).
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
80 \end{methoddesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
81
17792
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
82
2e015f8a1ac2 Add some text to make the dircmp object section more readable, and move
Fred Drake <fdrake@acm.org>
parents: 15982
diff changeset
83 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
84 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
85 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
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 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
88 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
89 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
90
13317
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
91 \begin{memberdesc}[dircmp]{left_list}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
92 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
93 \var{ignore}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
94 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
95
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
96 \begin{memberdesc}[dircmp]{right_list}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
97 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
98 \var{ignore}.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
99 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
100
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
101 \begin{memberdesc}[dircmp]{common}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
102 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
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]{left_only}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
106 Files and subdirectories only in \var{a}.
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]{right_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{b}.
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]{common_dirs}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
114 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
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_files}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
118 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
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_funny}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
122 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
123 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
124 error.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
125 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
126
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
127 \begin{memberdesc}[dircmp]{same_files}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
128 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
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]{diff_files}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
132 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
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]{funny_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}, but could not be
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
137 compared.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
138 \end{memberdesc}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
139
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
140 \begin{memberdesc}[dircmp]{subdirs}
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
141 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
142 \class{dircmp} objects.
66d42c51df16 Moshe Zadka <moshez@math.huji.ac.il>:
Fred Drake <fdrake@acm.org>
parents: 11415
diff changeset
143 \end{memberdesc}