← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: Andrew Bennetts
  • Date: 2010-09-17 04:35:23 UTC
  • mfrom: (5050.17.20 2.2)
  • mto: This revision was merged to the branch mainline in revision 5431.
  • Revision ID: andrew.bennetts@canonical.com-20100917043523-c5t63gmvxqxmqh5j
Merge lp:bzr/2.2, including fixes for #625574, #636930, #254278.

Show diffs side-by-side

added added

removed removed

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