~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/controldir.py

  • Committer: Jelmer Vernooij
  • Date: 2011-03-11 16:55:10 UTC
  • mto: (5712.4.10 bzrdir-weave)
  • mto: This revision was merged to the branch mainline in revision 5716.
  • Revision ID: jelmer@samba.org-20110311165510-eq97nksecq0v7hco
Add some notes about probers.

Show diffs side-by-side

added added

removed removed

Lines of Context:
905
905
 
906
906
 
907
907
class Prober(object):
908
 
    """Abstract class that can be used to detect a particular kind of 
 
908
    """Abstract class that can be used to detect a particular kind of
909
909
    control directory.
910
910
 
911
 
    At the moment this just contains a single method to probe a particular 
912
 
    transport, but it may be extended in the future to e.g. avoid 
 
911
    At the moment this just contains a single method to probe a particular
 
912
    transport, but it may be extended in the future to e.g. avoid
913
913
    multiple levels of probing for Subversion repositories.
 
914
 
 
915
    See BzrProber and RemoteBzrProber in bzrlib.bzrdir for the
 
916
    probers that detect .bzr/ directories and Bazaar smart servers,
 
917
    respectively.
 
918
 
 
919
    Probers should be registered using the register_server_prober or
 
920
    register_prober methods on ControlDirFormat.
914
921
    """
915
922
 
916
923
    def probe_transport(self, transport):