~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: Martin Pool
  • Date: 2009-08-14 12:08:08 UTC
  • mto: This revision was merged to the branch mainline in revision 4614.
  • Revision ID: mbp@sourcefrog.net-20090814120808-4gvx7fhg44z29cj3
Use platform(aliased=1)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
21
22
lazy_import(globals(), """
22
23
import textwrap
23
24
 
44
45
    'bzrlib.info', 'InfoHooks')
45
46
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
46
47
    'LockHooks')
47
 
known_hooks.register_lazy(('bzrlib.merge', 'Merger.hooks'), 'bzrlib.merge',
48
 
    'MergeHooks')
49
48
known_hooks.register_lazy(('bzrlib.msgeditor', 'hooks'), 'bzrlib.msgeditor',
50
49
    'MessageEditorHooks')
51
50
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
58
57
    ('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
59
58
    'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
60
59
known_hooks.register_lazy(
61
 
    ('bzrlib.merge_directive', 'BaseMergeDirective.hooks'),
 
60
    ('bzrlib.merge_directive', '_BaseMergeDirective.hooks'),
62
61
    'bzrlib.merge_directive', 'MergeDirectiveHooks')
63
62
 
64
63
 
220
219
        strings.append('Introduced in: %s' % introduced_string)
221
220
        if self.deprecated:
222
221
            deprecated_string = _format_version_tuple(self.deprecated)
223
 
            strings.append('Deprecated in: %s' % deprecated_string)
 
222
        else:
 
223
            deprecated_string = 'Not deprecated'
 
224
        strings.append('Deprecated in: %s' % deprecated_string)
224
225
        strings.append('')
225
226
        strings.extend(textwrap.wrap(self.__doc__,
226
227
            break_long_words=False))
276
277
 
277
278
  yyy.hooks.install_named_hook("xxx", ...)
278
279
 
279
 
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
 
280
See `Using hooks`_ in the User Guide for examples.
 
281
 
 
282
.. _Using hooks: ../user-guide/index.html#using-hooks
280
283
 
281
284
The class that contains each hook is given before the hooks it supplies. For
282
285
instance, BranchHooks as the class is the hooks class for