81
79
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
84
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
86
"""Let the user edit a commit message in a temp file.
88
This is run if they don't give a message or
89
message-containing file on the command line.
91
:param infotext: Text to be displayed at bottom of message
92
for the user's reference;
93
currently similar to 'bzr status'.
95
:param ignoreline: The separator to use above the infotext.
97
:param start_message: The text to place above the separator, if any.
98
This will not be removed from the message
99
after the user has edited it.
101
:return: commit message or None.
104
if not start_message is None:
105
start_message = start_message.encode(bzrlib.user_encoding)
106
infotext = infotext.encode(bzrlib.user_encoding, 'replace')
107
return edit_commit_message_encoded(infotext, ignoreline, start_message)
110
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
112
"""Let the user edit a commit message in a temp file.
114
This is run if they don't give a message or
115
message-containing file on the command line.
117
:param infotext: Text to be displayed at bottom of message
118
for the user's reference;
119
currently similar to 'bzr status'.
120
The string is already encoded
122
:param ignoreline: The separator to use above the infotext.
124
:param start_message: The text to place above the separator, if any.
125
This will not be removed from the message
126
after the user has edited it.
127
The string is already encoded
129
:return: commit message or None.
82
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
83
"""Let the user edit a commit message in a temp file.
85
This is run if they don't give a message or
86
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
131
95
msgfilename = None
133
msgfilename, hasinfo = _create_temp_file_with_commit_template(
134
infotext, ignoreline, start_message)
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')))
136
if not msgfilename or not _run_editor(msgfilename):
108
if not _run_editor(msgfilename):
141
113
lastline, nlines = 0, 0
142
# codecs.open() ALWAYS opens file in binary mode but we need text mode
143
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
144
f = file(msgfilename, 'rU')
147
for line in codecs.getreader(bzrlib.user_encoding)(f):
148
stripped_line = line.strip()
149
# strip empty line before the log message starts
151
if stripped_line != "":
155
# check for the ignore line only if there
156
# is additional information at the end
157
if hasinfo and stripped_line == ignoreline:
160
# keep track of the last line that had some content
161
if stripped_line != "":
164
except UnicodeDecodeError:
165
raise BadCommitMessageEncoding()
114
for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
115
stripped_line = line.strip()
116
# strip empty line before the log message starts
118
if stripped_line != "":
122
# check for the ignore line only if there
123
# is additional information at the end
124
if hasinfo and stripped_line == ignoreline:
127
# keep track of the last line that had some content
128
if stripped_line != "":
169
132
if len(msg) == 0:
171
134
# delete empty lines at the end
184
147
warning("failed to unlink %s: %s; ignored", msgfilename, e)
187
def _create_temp_file_with_commit_template(infotext,
188
ignoreline=DEFAULT_IGNORE_LINE,
190
"""Create temp file and write commit template in it.
192
:param infotext: Text to be displayed at bottom of message
193
for the user's reference;
194
currently similar to 'bzr status'.
195
The text is already encoded.
197
:param ignoreline: The separator to use above the infotext.
199
:param start_message: The text to place above the separator, if any.
200
This will not be removed from the message
201
after the user has edited it.
202
The string is already encoded
204
:return: 2-tuple (temp file name, hasinfo)
207
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
210
msgfilename = osutils.basename(msgfilename)
211
msgfile = os.fdopen(tmp_fileno, 'w')
213
if start_message is not None:
214
msgfile.write("%s\n" % start_message)
216
if infotext is not None and infotext != "":
218
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
224
return (msgfilename, hasinfo)
227
150
def make_commit_message_template(working_tree, specific_files):
228
151
"""Prepare a template file for a commit into a branch.
230
153
Returns a unicode string containing the template.
155
# TODO: Should probably be given the WorkingTree not the branch
232
157
# TODO: make provision for this to be overridden or modified by a hook
234
159
# TODO: Rather than running the status command, should prepare a draft of
240
165
show_tree_status(working_tree, specific_files=specific_files,
241
166
to_file=status_tmp)
242
167
return status_tmp.getvalue()
245
def make_commit_message_template_encoded(working_tree, specific_files,
246
diff=None, output_encoding='utf-8'):
247
"""Prepare a template file for a commit into a branch.
249
Returns an encoded string.
251
# TODO: make provision for this to be overridden or modified by a hook
253
# TODO: Rather than running the status command, should prepare a draft of
254
# the revision to be committed, then pause and ask the user to
255
# confirm/write a message.
256
from StringIO import StringIO # must be unicode-safe
257
from bzrlib.diff import show_diff_trees
259
template = make_commit_message_template(working_tree, specific_files)
260
template = template.encode(output_encoding, "replace")
264
show_diff_trees(working_tree.basis_tree(),
265
working_tree, stream, specific_files,
266
path_encoding=output_encoding)
267
template = template + '\n' + stream.getvalue()
added
removed
bzrlib/msgeditor.py
