80
79
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
83
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
85
"""Let the user edit a commit message in a temp file.
87
This is run if they don't give a message or
88
message-containing file on the command line.
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.
103
if not start_message is None:
104
start_message = start_message.encode(bzrlib.user_encoding)
105
infotext = infotext.encode(bzrlib.user_encoding, 'replace')
106
return edit_commit_message_encoded(infotext, ignoreline, start_message)
109
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
111
"""Let the user edit a commit message in a temp file.
113
This is run if they don't give a message or
114
message-containing file on the command line.
116
:param infotext: Text to be displayed at bottom of message
117
for the user's reference;
118
currently similar to 'bzr status'.
119
The string is already encoded
121
:param ignoreline: The separator to use above the infotext.
123
:param start_message: The text to place above the separator, if any.
124
This will not be removed from the message
125
after the user has edited it.
126
The string is already encoded
128
: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
130
95
msgfilename = None
132
msgfilename, hasinfo = _create_temp_file_with_commit_template(
133
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')))
135
if not msgfilename or not _run_editor(msgfilename):
108
if not _run_editor(msgfilename):
140
113
lastline, nlines = 0, 0
141
# codecs.open() ALWAYS opens file in binary mode but we need text mode
142
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
143
f = file(msgfilename, 'rU')
146
for line in codecs.getreader(bzrlib.user_encoding)(f):
147
stripped_line = line.strip()
148
# strip empty line before the log message starts
150
if stripped_line != "":
154
# check for the ignore line only if there
155
# is additional information at the end
156
if hasinfo and stripped_line == ignoreline:
159
# keep track of the last line that had some content
160
if stripped_line != "":
163
except UnicodeDecodeError:
164
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 != "":
168
132
if len(msg) == 0:
170
134
# delete empty lines at the end
183
147
warning("failed to unlink %s: %s; ignored", msgfilename, e)
186
def _create_temp_file_with_commit_template(infotext,
187
ignoreline=DEFAULT_IGNORE_LINE,
189
"""Create temp file and write commit template in it.
191
:param infotext: Text to be displayed at bottom of message
192
for the user's reference;
193
currently similar to 'bzr status'.
194
The text is already encoded.
196
:param ignoreline: The separator to use above the infotext.
198
:param start_message: The text to place above the separator, if any.
199
This will not be removed from the message
200
after the user has edited it.
201
The string is already encoded
203
:return: 2-tuple (temp file name, hasinfo)
206
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
209
msgfile = os.fdopen(tmp_fileno, 'w')
211
if start_message is not None:
212
msgfile.write("%s\n" % start_message)
214
if infotext is not None and infotext != "":
216
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
222
return (msgfilename, hasinfo)
225
150
def make_commit_message_template(working_tree, specific_files):
226
151
"""Prepare a template file for a commit into a branch.
228
153
Returns a unicode string containing the template.
155
# TODO: Should probably be given the WorkingTree not the branch
230
157
# TODO: make provision for this to be overridden or modified by a hook
232
159
# TODO: Rather than running the status command, should prepare a draft of
238
165
show_tree_status(working_tree, specific_files=specific_files,
239
166
to_file=status_tmp)
240
167
return status_tmp.getvalue()
243
def make_commit_message_template_encoded(working_tree, specific_files,
244
diff=None, output_encoding='utf-8'):
245
"""Prepare a template file for a commit into a branch.
247
Returns an encoded string.
249
# TODO: make provision for this to be overridden or modified by a hook
251
# TODO: Rather than running the status command, should prepare a draft of
252
# the revision to be committed, then pause and ask the user to
253
# confirm/write a message.
254
from StringIO import StringIO # must be unicode-safe
255
from bzrlib.diff import show_diff_trees
257
template = make_commit_message_template(working_tree, specific_files)
258
template = template.encode(output_encoding, "replace")
262
show_diff_trees(working_tree.basis_tree(),
263
working_tree, stream, specific_files,
264
path_encoding=output_encoding)
265
template = template + '\n' + stream.getvalue()
added
removed
bzrlib/msgeditor.py
