Mercurial Mercurial > hg / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | zip | gz | bz2 | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bundlerepo: add docstring for bundlerepository class
authorGregory Szorc <gregory.szorc@gmail.com>
Sat, 11 Nov 2017 18:09:16 -0800
changeset 35050 d2458ba810c5
parent 35049 4696938d40f9
child 35051 4f04c9207a76
bundlerepo: add docstring for bundlerepository class Differential Revision: https://phab.mercurial-scm.org/D1375
mercurial/bundlerepo.py file | annotate | diff | comparison | revisions 
--- 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:
Mercurial