← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/controldir.py

  • Committer: Jelmer Vernooij
  • Date: 2010-08-21 21:33:57 UTC
  • mto: This revision was merged to the branch mainline in revision 5389.
  • Revision ID: jelmer@samba.org-20100821213357-zbtpmb15h6f9blxg
Update comments.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/controldir.py
19
19
The ControlDir class is the base for the control directory used
20
20
by all bzr and foreign formats. For the ".bzr" implementation,
21
21
see bzrlib.bzrdir.BzrDir.
 
22
 
22
23
"""
23
24
 
24
25
from bzrlib.lazy_import import lazy_import
81
82
 
82
83
 
83
84
class ControlDir(ControlComponent):
84
 
    """A control directory."""
 
85
    """A control directory.
 
86
 
 
87
    While this represents a generic control directory, there are a few
 
88
    features that are present in this interface that are currently only
 
89
    supported by one of its implementations, BzrDir.
 
90
 
 
91
    These features (bound branches, stacked branches) are currently only
 
92
    supported by Bazaar, but could be supported by other version control
 
93
    systems as well. Implementations are required to raise the appropriate
 
94
    exceptions when an operation is requested that is not supported.
 
95
 
 
96
    This also makes life easier for API users who can rely on the
 
97
    implementation always allowing a particular feature to be requested but
 
98
    raising an exception when it is not supported, rather than requiring the
 
99
    API users to check for magic attributes to see what features are supported.
 
100
    """
85
101
 
86
102
    def can_convert_format(self):
87
103
        """Return true if this controldir is one whose format we can convert