← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Martin
  • Date: 2011-04-15 21:22:57 UTC
  • mto: This revision was merged to the branch mainline in revision 5797.
  • Revision ID: gzlist@googlemail.com-20110415212257-jgtovwwp4be7egd9
Add release notes

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
23
23
import sys
24
24
 
25
25
from bzrlib import (
 
26
    cmdline,
26
27
    config,
27
28
    osutils,
28
29
    trace,
30
31
    ui,
31
32
    )
32
33
from bzrlib.errors import BzrError, BadCommitMessageEncoding
33
 
from bzrlib.hooks import HookPoint, Hooks
 
34
from bzrlib.hooks import Hooks
34
35
 
35
36
 
36
37
def _get_editor():
59
60
def _run_editor(filename):
60
61
    """Try to execute an editor to edit the commit message."""
61
62
    for candidate, candidate_source in _get_editor():
62
 
        edargs = candidate.split(' ')
 
63
        edargs = cmdline.split(candidate)
63
64
        try:
64
65
            ## mutter("trying editor: %r", (edargs +[filename]))
65
66
            x = call(edargs + [filename])
208
209
 
209
210
def _create_temp_file_with_commit_template(infotext,
210
211
                                           ignoreline=DEFAULT_IGNORE_LINE,
211
 
                                           start_message=None):
 
212
                                           start_message=None,
 
213
                                           tmpdir=None):
212
214
    """Create temp file and write commit template in it.
213
215
 
214
 
    :param infotext:    Text to be displayed at bottom of message
215
 
                        for the user's reference;
216
 
                        currently similar to 'bzr status'.
217
 
                        The text is already encoded.
 
216
    :param infotext: Text to be displayed at bottom of message for the
 
217
        user's reference; currently similar to 'bzr status'.  The text is
 
218
        already encoded.
218
219
 
219
220
    :param ignoreline:  The separator to use above the infotext.
220
221
 
221
 
    :param start_message:   The text to place above the separator, if any.
222
 
                            This will not be removed from the message
223
 
                            after the user has edited it.
224
 
                            The string is already encoded
 
222
    :param start_message: The text to place above the separator, if any.
 
223
        This will not be removed from the message after the user has edited
 
224
        it.  The string is already encoded
225
225
 
226
226
    :return:    2-tuple (temp file name, hasinfo)
227
227
    """
228
228
    import tempfile
229
229
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
230
 
                                               dir='.',
231
 
                                               text=True)
232
 
    msgfilename = osutils.basename(msgfilename)
 
230
                                               dir=tmpdir, text=True)
233
231
    msgfile = os.fdopen(tmp_fileno, 'w')
234
232
    try:
235
233
        if start_message is not None:
304
302
 
305
303
        These are all empty initially.
306
304
        """
307
 
        Hooks.__init__(self)
308
 
        self.create_hook(HookPoint('commit_message_template',
 
305
        Hooks.__init__(self, "bzrlib.msgeditor", "hooks")
 
306
        self.add_hook('commit_message_template',
309
307
            "Called when a commit message is being generated. "
310
308
            "commit_message_template is called with the bzrlib.commit.Commit "
311
309
            "object and the message that is known so far. "
313
311
            "could be the same as it was given. When there are multiple "
314
312
            "hooks registered for commit_message_template, they are chained "
315
313
            "with the result from the first passed into the second, and so "
316
 
            "on.", (1, 10), None))
 
314
            "on.", (1, 10))
317
315
 
318
316
 
319
317
hooks = MessageEditorHooks()