Mercurial > public > mercurial-scm > hg-stable
diff mercurial/localrepo.py @ 3532:26b556c1d01d
improve walk docstrings
author | Matt Mackall <mpm@selenic.com> |
---|---|
date | Fri, 27 Oct 2006 11:24:10 -0500 |
parents | 9383af6f236d |
children | 23f7d9621783 |
line wrap: on
line diff
--- a/mercurial/localrepo.py Fri Oct 27 00:38:42 2006 -0500 +++ b/mercurial/localrepo.py Fri Oct 27 11:24:10 2006 -0500 @@ -714,6 +714,18 @@ return n def walk(self, node=None, files=[], match=util.always, badmatch=None): + ''' + walk recursively through the directory tree or a given + changeset, finding all files matched by the match + function + + results are yielded in a tuple (src, filename), where src + is one of: + 'f' the file was found in the directory tree + 'm' the file was only in the dirstate and not in the tree + 'b' file was not found and matched badmatch + ''' + if node: fdict = dict.fromkeys(files) for fn in self.manifest.read(self.changelog.read(node)[0]):