1
# Copyright (C) 2005, 2006 by Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Commit message editor support."""
22
from subprocess import call
24
import bzrlib.config as config
25
from bzrlib.errors import BzrError
28
"""Return a sequence of possible editor binaries for the current platform"""
30
yield os.environ["BZR_EDITOR"]
34
e = config.GlobalConfig().get_editor()
39
yield os.environ["EDITOR"]
43
if sys.platform == 'win32':
44
for editor in 'wordpad.exe', 'notepad.exe':
47
for editor in ['vi', 'pico', 'nano', 'joe']:
51
def _run_editor(filename):
52
"""Try to execute an editor to edit the commit message."""
53
for e in _get_editor():
56
x = call(edargs + [filename])
58
# We're searching for an editor, so catch safe errors and continue
59
if e.errno in (errno.ENOENT, ):
68
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
69
" - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
70
config.config_filename())
73
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
74
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
77
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
78
"""Let the user edit a commit message in a temp file.
80
This is run if they don't give a message or
81
message-containing file on the command line.
84
Text to be displayed at bottom of message for
85
the user's reference; currently similar to
91
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
92
msgfile = os.close(tmp_fileno)
93
if infotext is not None and infotext != "":
95
msgfile = file(msgfilename, "w")
96
msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
101
if not _run_editor(msgfilename):
106
lastline, nlines = 0, 0
107
for line in file(msgfilename, "r"):
108
stripped_line = line.strip()
109
# strip empty line before the log message starts
111
if stripped_line != "":
115
# check for the ignore line only if there
116
# is additional information at the end
117
if hasinfo and stripped_line == ignoreline:
120
# keep track of the last line that had some content
121
if stripped_line != "":
127
# delete empty lines at the end
129
# add a newline at the end, if needed
130
if not msg[-1].endswith("\n"):
131
return "%s%s" % ("".join(msg), "\n")
135
# delete the msg file in any case
136
try: os.unlink(msgfilename)
140
def make_commit_message_template(working_tree, specific_files):
141
"""Prepare a template file for a commit into a branch.
143
Returns a unicode string containing the template.
145
# TODO: Should probably be given the WorkingTree not the branch
147
# TODO: make provision for this to be overridden or modified by a hook
149
# TODO: Rather than running the status command, should prepare a draft of
150
# the revision to be committed, then pause and ask the user to
151
# confirm/write a message.
152
from StringIO import StringIO # must be unicode-safe
153
from bzrlib.status import show_tree_status
154
status_tmp = StringIO()
155
show_tree_status(working_tree, specific_files=specific_files,
157
return status_tmp.getvalue()
added
removed
bzrlib/msgeditor.py
