1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
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
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(' ')
65
64
## mutter("trying editor: %r", (edargs +[filename]))
66
65
x = call(edargs + [filename])
151
150
edited_content = msg_transport.get_bytes(basename)
152
151
if edited_content == reference_content:
153
if not ui.ui_factory.confirm_action(
154
u"Commit message was not edited, use anyway",
155
"bzrlib.msgeditor.unchanged",
152
if not ui.ui_factory.get_boolean(
153
"Commit message was not edited, use anyway"):
157
154
# Returning "" makes cmd_commit raise 'empty commit message
158
155
# specified' which is a reasonable error, given the user has
159
156
# rejected using the unedited template.
210
207
def _create_temp_file_with_commit_template(infotext,
211
208
ignoreline=DEFAULT_IGNORE_LINE,
214
210
"""Create temp file and write commit template in it.
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
212
:param infotext: Text to be displayed at bottom of message
213
for the user's reference;
214
currently similar to 'bzr status'.
215
The text is already encoded.
220
217
:param ignoreline: The separator to use above the infotext.
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
219
:param start_message: The text to place above the separator, if any.
220
This will not be removed from the message
221
after the user has edited it.
222
The string is already encoded
226
224
:return: 2-tuple (temp file name, hasinfo)
229
227
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
230
dir=tmpdir, text=True)
230
msgfilename = osutils.basename(msgfilename)
231
231
msgfile = os.fdopen(tmp_fileno, 'w')
233
233
if start_message is not None:
303
303
These are all empty initially.
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',
306
self.create_hook(HookPoint('commit_message_template',
314
307
"Called when a commit message is being generated. "
315
308
"commit_message_template is called with the bzrlib.commit.Commit "
316
309
"object and the message that is known so far. "
317
310
"commit_message_template must return a new message to use (which "
318
"could be the same as it was given). When there are multiple "
311
"could be the same as it was given. When there are multiple "
319
312
"hooks registered for commit_message_template, they are chained "
320
313
"with the result from the first passed into the second, and so "
314
"on.", (1, 10), None))
324
317
hooks = MessageEditorHooks()
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
333
for hook in hooks['set_commit_message']:
334
start_message = hook(commit, start_message)
338
320
def generate_commit_message_template(commit, start_message=None):
339
321
"""Generate a commit message template.
added
removed
bzrlib/msgeditor.py
