← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Vincent Ladeuil
  • Date: 2010-10-07 06:08:01 UTC
  • mto: This revision was merged to the branch mainline in revision 5491.
  • Revision ID: v.ladeuil+lp@free.fr-20101007060801-wfdhizfhfmctl8qa
Fix some typos and propose a release planning.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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,
27
26
    config,
28
27
    osutils,
29
28
    trace,
31
30
    ui,
32
31
    )
33
32
from bzrlib.errors import BzrError, BadCommitMessageEncoding
34
 
from bzrlib.hooks import Hooks
 
33
from bzrlib.hooks import HookPoint, Hooks
35
34
 
36
35
 
37
36
def _get_editor():
41
40
    except KeyError:
42
41
        pass
43
42
 
44
 
    e = config.GlobalStack().get('editor')
 
43
    e = config.GlobalConfig().get_editor()
45
44
    if e is not None:
46
45
        yield e, config.config_filename()
47
46
 
60
59
def _run_editor(filename):
61
60
    """Try to execute an editor to edit the commit message."""
62
61
    for candidate, candidate_source in _get_editor():
63
 
        edargs = cmdline.split(candidate)
 
62
        edargs = candidate.split(' ')
64
63
        try:
65
64
            ## mutter("trying editor: %r", (edargs +[filename]))
66
65
            x = call(edargs + [filename])
144
143
        if not msgfilename:
145
144
            return None
146
145
        basename = osutils.basename(msgfilename)
147
 
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
 
146
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
148
147
        reference_content = msg_transport.get_bytes(basename)
149
148
        if not _run_editor(msgfilename):
150
149
            return None
151
150
        edited_content = msg_transport.get_bytes(basename)
152
151
        if edited_content == reference_content:
153
152
            if not ui.ui_factory.confirm_action(
154
 
                u"Commit message was not edited, use anyway",
 
153
                "Commit message was not edited, use anyway",
155
154
                "bzrlib.msgeditor.unchanged",
156
155
                {}):
157
156
                # Returning "" makes cmd_commit raise 'empty commit message
209
208
 
210
209
def _create_temp_file_with_commit_template(infotext,
211
210
                                           ignoreline=DEFAULT_IGNORE_LINE,
212
 
                                           start_message=None,
213
 
                                           tmpdir=None):
 
211
                                           start_message=None):
214
212
    """Create temp file and write commit template in it.
215
213
 
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.
 
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.
219
218
 
220
219
    :param ignoreline:  The separator to use above the infotext.
221
220
 
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
 
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
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=tmpdir, text=True)
 
230
                                               dir='.',
 
231
                                               text=True)
 
232
    msgfilename = osutils.basename(msgfilename)
231
233
    msgfile = os.fdopen(tmp_fileno, 'w')
232
234
    try:
233
235
        if start_message is not None:
302
304
 
303
305
        These are all empty initially.
304
306
        """
305
 
        Hooks.__init__(self, "bzrlib.msgeditor", "hooks")
306
 
        self.add_hook('set_commit_message',
307
 
            "Set a fixed commit message. "
308
 
            "set_commit_message is called with the "
309
 
            "bzrlib.commit.Commit object (so you can also change e.g. revision "
310
 
            "properties by editing commit.builder._revprops) and the message "
311
 
            "so far. set_commit_message must return the message to use or None"
312
 
            " if it should use the message editor as normal.", (2, 4))
313
 
        self.add_hook('commit_message_template',
 
307
        Hooks.__init__(self)
 
308
        self.create_hook(HookPoint('commit_message_template',
314
309
            "Called when a commit message is being generated. "
315
310
            "commit_message_template is called with the bzrlib.commit.Commit "
316
311
            "object and the message that is known so far. "
317
312
            "commit_message_template must return a new message to use (which "
318
 
            "could be the same as it was given). When there are multiple "
 
313
            "could be the same as it was given. When there are multiple "
319
314
            "hooks registered for commit_message_template, they are chained "
320
315
            "with the result from the first passed into the second, and so "
321
 
            "on.", (1, 10))
 
316
            "on.", (1, 10), None))
322
317
 
323
318
 
324
319
hooks = MessageEditorHooks()
325
320
 
326
321
 
327
 
def set_commit_message(commit, start_message=None):
328
 
    """Sets the commit message.
329
 
    :param commit: Commit object for the active commit.
330
 
    :return: The commit message or None to continue using the message editor
331
 
    """
332
 
    start_message = None
333
 
    for hook in hooks['set_commit_message']:
334
 
        start_message = hook(commit, start_message)
335
 
    return start_message
336
 
 
337
 
 
338
322
def generate_commit_message_template(commit, start_message=None):
339
323
    """Generate a commit message template.
340
324