Rev 452: Add some documentation. in file:///home/jelmer/bzr-svn/0.3/
Jelmer Vernooij
jelmer at samba.org
Thu May 17 17:49:50 BST 2007
At file:///home/jelmer/bzr-svn/0.3/
------------------------------------------------------------
revno: 452
revision-id: jelmer at samba.org-20070517164947-xfgirmo8bkdaf1g3
parent: jelmer at samba.org-20070516182612-ax0t4hcgd8jp0eww
committer: Jelmer Vernooij <jelmer at samba.org>
branch nick: 0.3
timestamp: Thu 2007-05-17 17:49:47 +0100
message:
Add some documentation.
modified:
branch.py svnbranch.py-20051017135706-11c749eb0dab04a7
branchprops.py branchprops.py-20061223204623-80lvm7pjrpsgk0dd-1
checkout.py workingtree.py-20060306120941-b083cb0fdd4a69de
commit.py commit.py-20060607190346-qvq128wgfubhhgm2-1
convert.py svn2bzr.py-20051018015439-cb4563bff29e632d
errors.py errors.py-20061226172623-w1sbj8ynpo0eojqp-1
fetch.py fetch.py-20060625004942-x2lfaib8ra707a8p-1
fileids.py fileids.py-20060714013623-u5iiyqqnko11grcf-1
format.py format.py-20060406233823-b6fa009fe35dfde7
logwalker.py logwalker.py-20060621215743-c13fhfnyzh1xzwh2-1
repository.py repository.py-20060306123302-1f8c5069b3fe0265
scheme.py scheme.py-20060516195850-95181aae6b272f9e
tests/__init__.py __init__.py-20060508151940-e9f4d914801a2535
tests/test_blackbox.py test_blackbox.py-20070325150839-d10llf8arptpcfl6-1
tests/test_branch.py test_branch.py-20060508162215-74ffeb5d608f8e20
tests/test_branchprops.py test_branchprops.py-20061223210444-04xf5224zcg69m3w-1
tests/test_checkout.py test_checkout.py-20070101154110-eevkc29qj0q7udz5-1
tests/test_commit.py test_commit.py-20060624213521-l5kcufywkh9mnilk-1
tests/test_convert.py test_convert.py-20060705203611-b1l0bapeku6foco0-1
tests/test_fileids.py test_fileids.py-20060622131341-19gyrlgqy8yl2od5-1
tests/test_logwalker.py test_logwalker.py-20060622141944-pkocc3rj8g62ukbi-1
tests/test_radir.py test_radir.py-20061231173434-31utf9o4byu7wktm-1
tests/test_repos.py test_repos.py-20060508151940-ddc49a59257ca712
tests/test_scheme.py test_scheme.py-20060621221855-va2xabhlxpmc9llx-1
tests/test_transport.py test_transport.py-20060621232111-xh7xvoblzsrgj79t-1
tests/test_tree.py test_tree.py-20070103204350-pr8nupes7e5sd2wr-1
tests/test_upgrade.py test_upgrade.py-20070106170128-64zt3eqggg4tng1c-1
tests/test_workingtree.py test_workingtree.py-20060622191524-0di7bc3q1ckdbybb-1
transport.py transport.py-20060406231150-b3472d06b3a0818d
tree.py tree.py-20060624222557-dudlwqcmkf22lt2s-1
upgrade.py upgrade.py-20070106192108-0rakplee2lzah4gs-1
=== modified file 'branch.py'
--- a/branch.py 2007-03-25 14:41:44 +0000
+++ b/branch.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Handles branch-specific operations."""
from bzrlib.branch import Branch, BranchFormat, BranchCheckResult, PullResult
from bzrlib.bzrdir import BzrDir
=== modified file 'branchprops.py'
--- a/branchprops.py 2007-03-24 15:40:13 +0000
+++ b/branchprops.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Branch property access and caching."""
+
from bzrlib.errors import NoSuchRevision
from bzrlib.trace import mutter
=== modified file 'checkout.py'
--- a/checkout.py 2007-04-26 13:13:16 +0000
+++ b/checkout.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Checkouts and working trees (working copies)."""
from bzrlib.branch import PullResult
from bzrlib.bzrdir import BzrDirFormat, BzrDir
@@ -55,8 +56,7 @@
class SvnWorkingTree(WorkingTree):
- """Implementation of WorkingTree that uses a Subversion
- Working Copy for storage."""
+ """WorkingTree implementation that uses a Subversion Working Copy for storage."""
def __init__(self, bzrdir, local_path, branch):
self._format = SvnWorkingTreeFormat()
self.basedir = local_path
@@ -602,6 +602,7 @@
class SvnWorkingTreeFormat(WorkingTreeFormat):
+ """Subversion working copy format."""
def get_format_description(self):
return "Subversion Working Copy"
=== modified file 'commit.py'
--- a/commit.py 2007-03-24 15:40:13 +0000
+++ b/commit.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Committing and pushing to Subversion repositories."""
import svn.delta
from svn.core import Pool, SubversionException
@@ -377,6 +378,19 @@
def push_as_merged(target, source, revision_id):
+ """Push a revision as merged revision.
+
+ This will create a new revision in the target repository that
+ merges the specified revision but does not contain any other differences.
+ This is done so that the revision that is being pushed does not need
+ to completely match the target revision and so it can not have the
+ same revision id.
+
+ :param target: Repository to push to
+ :param source: Repository to pull the revision from
+ :param revision_id: Revision id of the revision to push
+ :return: The revision id of the created revision
+ """
rev = source.repository.get_revision(revision_id)
inv = source.repository.get_inventory(revision_id)
=== modified file 'convert.py'
--- a/convert.py 2007-04-03 20:32:46 +0000
+++ b/convert.py 2007-05-17 16:49:47 +0000
@@ -13,7 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
+"""Conversion of full repositories."""
import os
import tempfile
@@ -46,6 +46,7 @@
class NotDumpFile(BzrError):
+ """A file specified was not a dump file."""
_fmt = """%(dumpfile)s is not a dump file."""
def __init__(self, dumpfile):
super(NotDumpFile, self).__init__()
=== modified file 'errors.py'
--- a/errors.py 2007-03-13 09:40:12 +0000
+++ b/errors.py 2007-05-17 16:49:47 +0000
@@ -13,10 +13,12 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Subversion-specific errors and conversion of Subversion-specific errors."""
from bzrlib.errors import BzrError
class NotSvnBranchPath(BzrError):
+ """Error raised when a path was specified that did not exist."""
_fmt = """{%(branch_path)s}:%(revnum)s is not a valid Svn branch path"""
def __init__(self, branch_path, revnum=None):
@@ -24,5 +26,3 @@
self.branch_path = branch_path
self.revnum = revnum
-
-
=== modified file 'fetch.py'
--- a/fetch.py 2007-03-25 14:41:44 +0000
+++ b/fetch.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Fetching revisions from Subversion repositories in batches."""
import bzrlib
from bzrlib.inventory import Inventory, ROOT_ID
=== modified file 'fileids.py'
--- a/fileids.py 2007-03-25 14:41:44 +0000
+++ b/fileids.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Generation of file-ids."""
from bzrlib.errors import NotBranchError
from bzrlib.inventory import ROOT_ID
=== modified file 'format.py'
--- a/format.py 2007-04-26 13:13:16 +0000
+++ b/format.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Subversion BzrDir formats."""
from bzrlib.bzrdir import BzrDirFormat, BzrDir
from bzrlib.errors import (NotBranchError, NotLocalUrl, NoRepositoryPresent,
@@ -142,6 +143,7 @@
class SvnFormat(BzrDirFormat):
+ """Format for the Subversion smart server."""
_lock_class = TransportLock
@classmethod
=== modified file 'logwalker.py'
--- a/logwalker.py 2007-03-24 15:40:13 +0000
+++ b/logwalker.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Cache of the Subversion history log."""
from bzrlib.errors import NoSuchRevision
import bzrlib.ui as ui
=== modified file 'repository.py'
--- a/repository.py 2007-03-25 14:41:44 +0000
+++ b/repository.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Subversion repository access."""
import bzrlib
from bzrlib.branch import BranchCheckResult
=== modified file 'scheme.py'
--- a/scheme.py 2007-03-25 14:41:44 +0000
+++ b/scheme.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Branching scheme implementations."""
from bzrlib.errors import NotBranchError
=== modified file 'tests/__init__.py'
--- a/tests/__init__.py 2007-03-25 15:15:08 +0000
+++ b/tests/__init__.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Tests for the bzr-svn plugin."""
+
import os
import bzrlib
from bzrlib import osutils
=== modified file 'tests/test_blackbox.py'
--- a/tests/test_blackbox.py 2007-03-25 15:15:08 +0000
+++ b/tests/test_blackbox.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Blackbox tests."""
from bzrlib.tests.blackbox import ExternalBase
from tests import TestCaseWithSubversionRepository
=== modified file 'tests/test_branch.py'
--- a/tests/test_branch.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_branch.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Branch tests."""
+
from bzrlib.branch import Branch
from bzrlib.bzrdir import BzrDir
from bzrlib.errors import NoSuchFile
=== modified file 'tests/test_branchprops.py'
--- a/tests/test_branchprops.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_branchprops.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Branch property access tests."""
+
from bzrlib.errors import NoSuchRevision
from tests import TestCaseWithSubversionRepository
=== modified file 'tests/test_checkout.py'
--- a/tests/test_checkout.py 2007-04-03 12:51:01 +0000
+++ b/tests/test_checkout.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Checkout tests."""
+
from bzrlib.bzrdir import BzrDir
from bzrlib.errors import NoRepositoryPresent
from bzrlib.tests import TestCase
=== modified file 'tests/test_commit.py'
--- a/tests/test_commit.py 2007-04-08 01:27:44 +0000
+++ b/tests/test_commit.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Commit and push tests."""
+
from bzrlib.branch import PullResult
from bzrlib.bzrdir import BzrDir
from bzrlib.errors import DivergedBranches
=== modified file 'tests/test_convert.py'
--- a/tests/test_convert.py 2007-04-03 20:32:46 +0000
+++ b/tests/test_convert.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Full repository conversion tests."""
+
from bzrlib.branch import Branch
from bzrlib.bzrdir import BzrDir
from bzrlib.errors import NotBranchError
=== modified file 'tests/test_fileids.py'
--- a/tests/test_fileids.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_fileids.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""File id tests."""
+
from bzrlib.bzrdir import BzrDir
from bzrlib.inventory import ROOT_ID
from bzrlib.repository import Repository
=== modified file 'tests/test_logwalker.py'
--- a/tests/test_logwalker.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_logwalker.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Log walker tests."""
+
from bzrlib.errors import NoSuchRevision
import os
=== modified file 'tests/test_radir.py'
--- a/tests/test_radir.py 2007-04-26 13:13:16 +0000
+++ b/tests/test_radir.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Remote access tests."""
+
from bzrlib.bzrdir import BzrDir
from bzrlib.errors import (NoRepositoryPresent, NotBranchError, NotLocalUrl,
NoWorkingTree)
=== modified file 'tests/test_repos.py'
--- a/tests/test_repos.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_repos.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Subversion repository tests."""
+
from bzrlib.branch import Branch
from bzrlib.bzrdir import BzrDir
from bzrlib.errors import NoSuchRevision, UninitializableFormat
=== modified file 'tests/test_scheme.py'
--- a/tests/test_scheme.py 2007-03-13 09:40:12 +0000
+++ b/tests/test_scheme.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Branching scheme tests."""
+
from bzrlib.errors import NotBranchError
from bzrlib.tests import TestCase
=== modified file 'tests/test_transport.py'
--- a/tests/test_transport.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_transport.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Subversion transport tests."""
+
from tests import TestCaseWithSubversionRepository
from bzrlib.errors import NotBranchError, NoSuchFile, FileExists
from transport import SvnRaTransport, bzr_to_svn_url
=== modified file 'tests/test_tree.py'
--- a/tests/test_tree.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_tree.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Basis and revision tree tests."""
+
from bzrlib.workingtree import WorkingTree
from tree import SvnBasisTree
=== modified file 'tests/test_upgrade.py'
--- a/tests/test_upgrade.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_upgrade.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Mapping upgrade tests."""
+
from bzrlib.bzrdir import BzrDir
from bzrlib.errors import InvalidRevisionId
from bzrlib.repository import Repository
=== modified file 'tests/test_workingtree.py'
--- a/tests/test_workingtree.py 2007-03-25 14:41:44 +0000
+++ b/tests/test_workingtree.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Working tree tests."""
+
from bzrlib.bzrdir import BzrDir
from bzrlib.errors import NoSuchFile
from bzrlib.inventory import Inventory, ROOT_ID
=== modified file 'transport.py'
--- a/transport.py 2007-03-25 14:41:44 +0000
+++ b/transport.py 2007-05-17 16:49:47 +0000
@@ -13,6 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Simple transport for accessing Subversion smart servers."""
from bzrlib.errors import (NoSuchFile, NotBranchError, TransportNotPossible,
FileExists)
=== modified file 'tree.py'
--- a/tree.py 2007-03-25 14:41:44 +0000
+++ b/tree.py 2007-05-17 16:49:47 +0000
@@ -14,6 +14,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""Access to stored Subversion basis trees."""
+
from bzrlib.inventory import (Inventory, ROOT_ID)
import bzrlib.osutils as osutils
from bzrlib.trace import mutter
@@ -43,6 +45,7 @@
return wrapper
class SvnRevisionTree(RevisionTree):
+ """A tree that existed in a historical Subversion revision."""
def __init__(self, repository, revision_id):
self._repository = repository
self._revision_id = revision_id
@@ -67,6 +70,7 @@
class TreeBuildEditor(svn.delta.Editor):
+ """Builds a tree given Subversion tree transform calls."""
def __init__(self, tree, pool):
self.tree = tree
self.repository = tree._repository
=== modified file 'upgrade.py'
--- a/upgrade.py 2007-03-25 14:41:44 +0000
+++ b/upgrade.py 2007-05-17 16:49:47 +0000
@@ -15,7 +15,7 @@
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
+"""Upgrading revisions made with older versions of the mapping."""
from bzrlib.config import Config
from bzrlib.errors import BzrError, InvalidRevisionId
@@ -34,6 +34,7 @@
# Usage: svn-upgrade [--allow-change] PATH REPOSITORY
class UpgradeChangesContent(BzrError):
+ """Inconsistency was found upgrading the mapping of a revision."""
_fmt = """Upgrade will change contents in revision %(revid)s."""
def __init__(self, revid):
More information about the bazaar-commits
mailing list