← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-12 12:00:49 UTC
  • mfrom: (4119.3.3 Hooks.docs)
  • Revision ID: pqm@pqm.ubuntu.com-20090312120049-uxdmf2dfelp5ctva
(robertc) Migrate all hooks into the HookPoint infrastructure.
        (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
29
29
    trace,
30
30
    )
31
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
 
from bzrlib.hooks import Hooks
 
32
from bzrlib.hooks import HookPoint, Hooks
33
33
 
34
34
 
35
35
def _get_editor():
293
293
        These are all empty initially.
294
294
        """
295
295
        Hooks.__init__(self)
296
 
        # Introduced in 1.10:
297
 
        # Invoked to generate the commit message template shown in the editor
298
 
        # The api signature is:
299
 
        # (commit, message), and the function should return the new message
300
 
        # There is currently no way to modify the order in which
301
 
        # template hooks are invoked
302
 
        self['commit_message_template'] = []
 
296
        self.create_hook(HookPoint('commit_message_template',
 
297
            "Called when a commit message is being generated. "
 
298
            "commit_message_template is called with the bzrlib.commit.Commit "
 
299
            "object and the message that is known so far. "
 
300
            "commit_message_template must return a new message to use (which "
 
301
            "could be the same as it was given. When there are multiple "
 
302
            "hooks registered for commit_message_template, they are chained "
 
303
            "with the result from the first passed into the second, and so "
 
304
            "on.", (1, 10), None))
303
305
 
304
306
 
305
307
hooks = MessageEditorHooks()