1
# Copyright (C) 2005, 2006 by Canonical Ltd
1
# Copyright (C) 2005, 2006 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
73
73
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
74
" - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
74
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
75
" - $VISUAL\n - $EDITOR" % \
75
76
config.config_filename())
79
80
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
82
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
83
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
83
85
"""Let the user edit a commit message in a temp file.
85
87
This is run if they don't give a message or
86
88
message-containing file on the command line.
89
Text to be displayed at bottom of message for
90
the user's reference; currently similar to
90
:param infotext: Text to be displayed at bottom of message
91
for the user's reference;
92
currently similar to 'bzr status'.
94
:param ignoreline: The separator to use above the infotext.
96
:param start_message: The text to place above the separator, if any.
97
This will not be removed from the message
98
after the user has edited it.
100
:return: commit message or None.
95
102
msgfilename = None
97
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
98
msgfile = os.close(tmp_fileno)
99
if infotext is not None and infotext != "":
101
msgfile = file(msgfilename, "w")
102
msgfile.write("\n\n%s\n\n%s" % (ignoreline,
103
infotext.encode(bzrlib.user_encoding, 'replace')))
104
msgfilename, hasinfo = _create_temp_file_with_commit_template(
105
infotext, ignoreline, start_message)
108
if not _run_editor(msgfilename):
107
if not msgfilename or not _run_editor(msgfilename):
113
112
lastline, nlines = 0, 0
114
for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
113
# codecs.open() ALWAYS opens file in binary mode but we need text mode
114
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
115
f = file(msgfilename, 'rU')
116
for line in codecs.getreader(bzrlib.user_encoding)(f):
115
117
stripped_line = line.strip()
116
118
# strip empty line before the log message starts
147
150
warning("failed to unlink %s: %s; ignored", msgfilename, e)
153
def _create_temp_file_with_commit_template(infotext,
154
ignoreline=DEFAULT_IGNORE_LINE,
156
"""Create temp file and write commit template in it.
158
:param infotext: Text to be displayed at bottom of message
159
for the user's reference;
160
currently similar to 'bzr status'.
162
:param ignoreline: The separator to use above the infotext.
164
:param start_message: The text to place above the separator, if any.
165
This will not be removed from the message
166
after the user has edited it.
168
:return: 2-tuple (temp file name, hasinfo)
171
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
174
msgfile = os.fdopen(tmp_fileno, 'w')
176
if start_message is not None:
177
msgfile.write("%s\n" % start_message.encode(
178
bzrlib.user_encoding, 'replace'))
180
if infotext is not None and infotext != "":
182
msgfile.write("\n\n%s\n\n%s" % (ignoreline,
183
infotext.encode(bzrlib.user_encoding,
190
return (msgfilename, hasinfo)
150
193
def make_commit_message_template(working_tree, specific_files):
151
194
"""Prepare a template file for a commit into a branch.