Mercurial > hg-stable
changeset 35073:d2458ba810c5
bundlerepo: add docstring for bundlerepository class
Differential Revision: https://phab.mercurial-scm.org/D1375
| author | Gregory Szorc <gregory.szorc@gmail.com> |
|---|---|
| date | Sat, 11 Nov 2017 18:09:16 -0800 |
| parents | 4696938d40f9 |
| children | 4f04c9207a76 |
| files | mercurial/bundlerepo.py |
| diffstat | 1 files changed, 8 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/bundlerepo.py Sat Nov 11 18:05:02 2017 -0800 +++ b/mercurial/bundlerepo.py Sat Nov 11 18:09:16 2017 -0800 @@ -256,6 +256,14 @@ return bundlefilespos class bundlerepository(localrepo.localrepository): + """A repository instance that is a union of a local repo and a bundle. + + Instances represent a read-only repository composed of a local repository + with the contents of a bundle file applied. The repository instance is + conceptually similar to the state of a repository after an + ``hg unbundle`` operation. However, the contents of the bundle are never + applied to the actual base repository. + """ def __init__(self, ui, repopath, bundlepath): self._tempparent = None try: