← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-29 22:03:03 UTC
  • mfrom: (5416.2.6 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100929220303-cr95h8iwtggco721
(mbp) Add 'break-lock --force'

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hooks.py
18
18
"""Support for plugin hooking logic."""
19
19
from bzrlib import registry
20
20
from bzrlib.lazy_import import lazy_import
21
 
from bzrlib.symbol_versioning import deprecated_method
22
21
lazy_import(globals(), """
23
22
import textwrap
24
23
 
55
54
    'bzrlib.smart.client', 'SmartClientHooks')
56
55
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
57
56
    'bzrlib.smart.server', 'SmartServerHooks')
 
57
known_hooks.register_lazy(('bzrlib.status', 'hooks'),
 
58
    'bzrlib.status', 'StatusHooks')
58
59
known_hooks.register_lazy(
59
60
    ('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
60
61
    'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
61
62
known_hooks.register_lazy(
62
 
    ('bzrlib.merge_directive', '_BaseMergeDirective.hooks'),
 
63
    ('bzrlib.merge_directive', 'BaseMergeDirective.hooks'),
63
64
    'bzrlib.merge_directive', 'MergeDirectiveHooks')
64
65
 
65
66
 
180
181
    """A single hook that clients can register to be called back when it fires.
181
182
 
182
183
    :ivar name: The name of the hook.
 
184
    :ivar doc: The docs for using the hook.
183
185
    :ivar introduced: A version tuple specifying what version the hook was
184
186
        introduced in. None indicates an unknown version.
185
187
    :ivar deprecated: A version tuple specifying what version the hook was
186
188
        deprecated or superseded in. None indicates that the hook is not
187
189
        superseded or deprecated. If the hook is superseded then the doc
188
190
        should describe the recommended replacement hook to register for.
189
 
    :ivar doc: The docs for using the hook.
190
191
    """
191
192
 
192
193
    def __init__(self, name, doc, introduced, deprecated):
277
278
 
278
279
  yyy.hooks.install_named_hook("xxx", ...)
279
280
 
280
 
See `Using hooks`_ in the User Guide for examples.
281
 
 
282
 
.. _Using hooks: ../user-guide/hooks.html
 
281
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
283
282
 
284
283
The class that contains each hook is given before the hooks it supplies. For
285
284
instance, BranchHooks as the class is the hooks class for