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."""
23
from subprocess import call
26
import bzrlib.config as config
27
from bzrlib.errors import BzrError
31
"""Return a sequence of possible editor binaries for the current platform"""
33
yield os.environ["BZR_EDITOR"]
37
e = config.GlobalConfig().get_editor()
41
for varname in 'VISUAL', 'EDITOR':
42
if os.environ.has_key(varname):
43
yield os.environ[varname]
45
if sys.platform == 'win32':
46
for editor in 'wordpad.exe', 'notepad.exe':
49
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
53
def _run_editor(filename):
54
"""Try to execute an editor to edit the commit message."""
55
for e in _get_editor():
58
x = call(edargs + [filename])
60
# We're searching for an editor, so catch safe errors and continue
61
if e.errno in (errno.ENOENT, ):
70
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
71
" - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
72
config.config_filename())
75
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
76
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
79
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
80
"""Let the user edit a commit message in a temp file.
82
This is run if they don't give a message or
83
message-containing file on the command line.
86
Text to be displayed at bottom of message for
87
the user's reference; currently similar to
93
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
94
msgfile = os.close(tmp_fileno)
95
if infotext is not None and infotext != "":
97
msgfile = file(msgfilename, "w")
98
msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
103
if not _run_editor(msgfilename):
108
lastline, nlines = 0, 0
109
for line in file(msgfilename, "r"):
110
stripped_line = line.strip()
111
# strip empty line before the log message starts
113
if stripped_line != "":
117
# check for the ignore line only if there
118
# is additional information at the end
119
if hasinfo and stripped_line == ignoreline:
122
# keep track of the last line that had some content
123
if stripped_line != "":
129
# delete empty lines at the end
131
# add a newline at the end, if needed
132
if not msg[-1].endswith("\n"):
133
return "%s%s" % ("".join(msg), "\n")
137
# delete the msg file in any case
138
try: os.unlink(msgfilename)
142
def make_commit_message_template(working_tree, specific_files):
143
"""Prepare a template file for a commit into a branch.
145
Returns a unicode string containing the template.
147
# TODO: Should probably be given the WorkingTree not the branch
149
# TODO: make provision for this to be overridden or modified by a hook
151
# TODO: Rather than running the status command, should prepare a draft of
152
# the revision to be committed, then pause and ask the user to
153
# confirm/write a message.
154
from StringIO import StringIO # must be unicode-safe
155
from bzrlib.status import show_tree_status
156
status_tmp = StringIO()
157
show_tree_status(working_tree, specific_files=specific_files,
159
return status_tmp.getvalue()
added
removed
bzrlib/msgeditor.py
