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 subprocess import call
25
import bzrlib.config as config
26
from bzrlib.errors import BzrError
29
"""Return a sequence of possible editor binaries for the current platform"""
31
yield os.environ["BZR_EDITOR"]
35
e = config.GlobalConfig().get_editor()
40
yield os.environ["EDITOR"]
46
elif os.name == "posix":
50
def _run_editor(filename):
51
"""Try to execute an editor to edit the commit message."""
52
for e in _get_editor():
54
x = call(edargs + [filename])
61
raise BzrError("Could not start any editor. "
62
"Please specify $EDITOR or use ~/.bzr.conf/editor")
65
def edit_commit_message(infotext, ignoreline=None):
66
"""Let the user edit a commit message in a temp file.
68
This is run if they don't give a message or
69
message-containing file on the command line.
72
Text to be displayed at bottom of message for
73
the user's reference; currently similar to
78
if ignoreline is None:
79
ignoreline = "-- This line and the following will be ignored --"
82
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
83
msgfile = os.close(tmp_fileno)
84
if infotext is not None and infotext != "":
86
msgfile = file(msgfilename, "w")
87
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
92
if not _run_editor(msgfilename):
97
lastline, nlines = 0, 0
98
for line in file(msgfilename, "r"):
99
stripped_line = line.strip()
100
# strip empty line before the log message starts
102
if stripped_line != "":
106
# check for the ignore line only if there
107
# is additional information at the end
108
if hasinfo and stripped_line == ignoreline:
111
# keep track of the last line that had some content
112
if stripped_line != "":
118
# delete empty lines at the end
120
# add a newline at the end, if needed
121
if not msg[-1].endswith("\n"):
122
return "%s%s" % ("".join(msg), "\n")
126
# delete the msg file in any case
127
try: os.unlink(msgfilename)
131
def make_commit_message_template(working_tree, specific_files):
132
"""Prepare a template file for a commit into a branch.
134
Returns a unicode string containing the template.
136
# TODO: Should probably be given the WorkingTree not the branch
138
# TODO: make provision for this to be overridden or modified by a hook
140
# TODO: Rather than running the status command, should prepare a draft of
141
# the revision to be committed, then pause and ask the user to
142
# confirm/write a message.
143
from StringIO import StringIO # must be unicode-safe
144
from bzrlib.status import show_status
145
status_tmp = StringIO()
146
show_status(working_tree.branch, specific_files=specific_files, to_file=status_tmp)
147
return status_tmp.getvalue()
added
removed
bzrlib/msgeditor.py
