1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
"""Commit message editor support."""
23
from bzrlib.errors import BzrError
26
"""Return a sequence of possible editor binaries for the current platform"""
27
from bzrlib.osutils import _read_config_value
29
e = _read_config_value("editor")
33
if os.name == "windows":
35
elif os.name == "posix":
37
yield os.environ["EDITOR"]
42
def _run_editor(filename):
43
"""Try to execute an editor to edit the commit message."""
44
for e in _get_editor():
46
x = os.spawnvp(os.P_WAIT, edargs[0],
54
raise BzrError("Could not start any editor. "
55
"Please specify $EDITOR or use ~/.bzr.conf/editor")
58
def edit_commit_message(infotext, ignoreline=None):
59
"""Let the user edit a commit message in a temp file.
61
This is run if they don't give a message or
62
message-containing file on the command line.
65
Text to be displayed at bottom of message for
66
the user's reference; currently similar to
71
if ignoreline is None:
72
ignoreline = "-- This line and the following will be ignored --"
75
tmp_fileno, msgfilename = tempfile.mkstemp()
76
msgfile = os.close(tmp_fileno)
77
if infotext is not None and infotext != "":
79
msgfile = file(msgfilename, "w")
80
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
85
if not _run_editor(msgfilename):
90
lastline, nlines = 0, 0
91
for line in file(msgfilename, "r"):
92
stripped_line = line.strip()
93
# strip empty line before the log message starts
95
if stripped_line != "":
99
# check for the ignore line only if there
100
# is additional information at the end
101
if hasinfo and stripped_line == ignoreline:
104
# keep track of the last line that had some content
105
if stripped_line != "":
111
# delete empty lines at the end
113
# add a newline at the end, if needed
114
if not msg[-1].endswith("\n"):
115
return "%s%s" % ("".join(msg), "\n")
119
# delete the msg file in any case
120
try: os.unlink(msgfilename)
added
removed
bzrlib/msgeditor.py
