Mercurial > public > mercurial-scm > hg
comparison mercurial/localrepo.py @ 31536:48b9c9ca09b7
localrepo: improve vfs documentation
At the beginning of March, I promised Yuya that I would follow up a comment I
made on a patch with improved documention for these vfs objects. Also hat tip
to Pierre-Yves for adding the documentation here in the first place.
| author | Ryan McElroy <rmcelroy@fb.com> |
|---|---|
| date | Tue, 21 Mar 2017 06:50:42 -0700 |
| parents | f42ec07db6a9 |
| children | 66c3ae6d886c |
comparison
equal
deleted
inserted
replaced
| 31535:d0f95ecca2ad | 31536:48b9c9ca09b7 |
|---|---|
| 258 # only functions defined in module of enabled extensions are invoked | 258 # only functions defined in module of enabled extensions are invoked |
| 259 featuresetupfuncs = set() | 259 featuresetupfuncs = set() |
| 260 | 260 |
| 261 def __init__(self, baseui, path, create=False): | 261 def __init__(self, baseui, path, create=False): |
| 262 self.requirements = set() | 262 self.requirements = set() |
| 263 # vfs to access the working copy | 263 # wvfs: rooted at the repository root, used to access the working copy |
| 264 self.wvfs = vfsmod.vfs(path, expandpath=True, realpath=True) | 264 self.wvfs = vfsmod.vfs(path, expandpath=True, realpath=True) |
| 265 # vfs to access the content of the repository | 265 # vfs: rooted at .hg, used to access repo files outside of .hg/store |
| 266 self.vfs = None | 266 self.vfs = None |
| 267 # vfs to access the store part of the repository | 267 # svfs: usually rooted at .hg/store, used to access repository history |
| 268 # If this is a shared repository, this vfs may point to another | |
| 269 # repository's .hg/store directory. | |
| 268 self.svfs = None | 270 self.svfs = None |
| 269 self.root = self.wvfs.base | 271 self.root = self.wvfs.base |
| 270 self.path = self.wvfs.join(".hg") | 272 self.path = self.wvfs.join(".hg") |
| 271 self.origroot = path | 273 self.origroot = path |
| 272 self.auditor = pathutil.pathauditor(self.root, self._checknested) | 274 self.auditor = pathutil.pathauditor(self.root, self._checknested) |