14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Bazaar-NG -- a free distributed version-control tool
20
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
* Metadata format is not stable yet -- you may need to
23
discard history in the future.
25
* Many commands unimplemented or partially implemented.
27
* Space-inefficient storage.
29
* No merge operators yet.
36
Show software version/licence/non-warranty.
38
Start versioning the current directory
42
Show revision history.
45
bzr move FROM... DESTDIR
46
Move one or more files to a different directory.
48
Show changes from last revision to working copy.
49
bzr commit -m 'MESSAGE'
50
Store current state as new revision.
51
bzr export [-r REVNO] DESTINATION
52
Export the branch state at a previous version.
54
Show summary of pending changes.
56
Make a file not versioned.
58
Show statistics about this branch.
60
Verify history is stored safely.
61
(for more type 'bzr help commands')
67
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
69
from pprint import pprint
18
# TODO: Split the command framework away from the actual commands.
20
# TODO: probably should say which arguments are candidates for glob
21
# expansion on windows and do that at the command level.
23
# TODO: Help messages for options.
25
# TODO: Define arguments by objects, rather than just using names.
26
# Those objects can specify the expected type of the argument, which
27
# would help with validation and shell completion.
74
from bzrlib.store import ImmutableStore
75
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
101
def get_cmd_class(cmd):
104
cmd = CMD_ALIASES.get(cmd, cmd)
107
cmd_class = globals()['cmd_' + cmd.replace('-', '_')]
109
raise BzrError("unknown command %r" % cmd)
111
return cmd, cmd_class
34
from bzrlib.trace import mutter, note, log_error, warning
35
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
36
from bzrlib.branch import find_branch
37
from bzrlib import BZRDIR
43
def register_command(cmd):
44
"Utility function to help register a command"
47
if k.startswith("cmd_"):
48
k_unsquished = _unsquish_command_name(k)
51
if not plugin_cmds.has_key(k_unsquished):
52
plugin_cmds[k_unsquished] = cmd
54
log_error('Two plugins defined the same command: %r' % k)
55
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
58
def _squish_command_name(cmd):
59
return 'cmd_' + cmd.replace('-', '_')
62
def _unsquish_command_name(cmd):
63
assert cmd.startswith("cmd_")
64
return cmd[4:].replace('_','-')
67
def _parse_revision_str(revstr):
68
"""This handles a revision string -> revno.
70
This always returns a list. The list will have one element for
72
It supports integers directly, but everything else it
73
defers for passing to Branch.get_revision_info()
75
>>> _parse_revision_str('234')
77
>>> _parse_revision_str('234..567')
79
>>> _parse_revision_str('..')
81
>>> _parse_revision_str('..234')
83
>>> _parse_revision_str('234..')
85
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
87
>>> _parse_revision_str('234....789') # Error?
89
>>> _parse_revision_str('revid:test@other.com-234234')
90
['revid:test@other.com-234234']
91
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
92
['revid:test@other.com-234234', 'revid:test@other.com-234235']
93
>>> _parse_revision_str('revid:test@other.com-234234..23')
94
['revid:test@other.com-234234', 23]
95
>>> _parse_revision_str('date:2005-04-12')
97
>>> _parse_revision_str('date:2005-04-12 12:24:33')
98
['date:2005-04-12 12:24:33']
99
>>> _parse_revision_str('date:2005-04-12T12:24:33')
100
['date:2005-04-12T12:24:33']
101
>>> _parse_revision_str('date:2005-04-12,12:24:33')
102
['date:2005-04-12,12:24:33']
103
>>> _parse_revision_str('-5..23')
105
>>> _parse_revision_str('-5')
107
>>> _parse_revision_str('123a')
109
>>> _parse_revision_str('abc')
113
old_format_re = re.compile('\d*:\d*')
114
m = old_format_re.match(revstr)
116
warning('Colon separator for revision numbers is deprecated.'
119
for rev in revstr.split(':'):
121
revs.append(int(rev))
126
for x in revstr.split('..'):
137
def get_merge_type(typestring):
138
"""Attempt to find the merge class/factory associated with a string."""
139
from merge import merge_types
141
return merge_types[typestring][0]
143
templ = '%s%%7s: %%s' % (' '*12)
144
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
145
type_list = '\n'.join(lines)
146
msg = "No known merge type %s. Supported types are:\n%s" %\
147
(typestring, type_list)
148
raise BzrCommandError(msg)
151
def get_merge_type(typestring):
152
"""Attempt to find the merge class/factory associated with a string."""
153
from merge import merge_types
155
return merge_types[typestring][0]
157
templ = '%s%%7s: %%s' % (' '*12)
158
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
159
type_list = '\n'.join(lines)
160
msg = "No known merge type %s. Supported types are:\n%s" %\
161
(typestring, type_list)
162
raise BzrCommandError(msg)
166
def _get_cmd_dict(plugins_override=True):
168
for k, v in globals().iteritems():
169
if k.startswith("cmd_"):
170
d[_unsquish_command_name(k)] = v
171
# If we didn't load plugins, the plugin_cmds dict will be empty
173
d.update(plugin_cmds)
175
d2 = plugin_cmds.copy()
181
def get_all_cmds(plugins_override=True):
182
"""Return canonical name and class for all registered commands."""
183
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
187
def get_cmd_class(cmd, plugins_override=True):
188
"""Return the canonical name and command class for a command.
190
cmd = str(cmd) # not unicode
192
# first look up this command under the specified name
193
cmds = _get_cmd_dict(plugins_override=plugins_override)
195
return cmd, cmds[cmd]
199
# look for any command which claims this as an alias
200
for cmdname, cmdclass in cmds.iteritems():
201
if cmd in cmdclass.aliases:
202
return cmdname, cmdclass
204
cmdclass = ExternalCommand.find_command(cmd)
208
raise BzrCommandError("unknown command %r" % cmd)
211
class Command(object):
116
212
"""Base class for commands.
118
214
The docstring for an actual command should give a single-line
155
254
This is invoked with the options and arguments bound to
156
255
keyword parameters.
158
Return True if the command was successful, False if not.
257
Return 0 or None if the command was successful, or a shell
263
class ExternalCommand(Command):
264
"""Class to wrap external commands.
266
We cheat a little here, when get_cmd_class() calls us we actually
267
give it back an object we construct that has the appropriate path,
268
help, options etc for the specified command.
270
When run_bzr() tries to instantiate that 'class' it gets caught by
271
the __call__ method, which we override to call the Command.__init__
272
method. That then calls our run method which is pretty straight
275
The only wrinkle is that we have to map bzr's dictionary of options
276
and arguments back into command line options and arguments for the
280
def find_command(cls, cmd):
282
bzrpath = os.environ.get('BZRPATH', '')
284
for dir in bzrpath.split(os.pathsep):
285
path = os.path.join(dir, cmd)
286
if os.path.isfile(path):
287
return ExternalCommand(path)
291
find_command = classmethod(find_command)
293
def __init__(self, path):
296
pipe = os.popen('%s --bzr-usage' % path, 'r')
297
self.takes_options = pipe.readline().split()
299
for opt in self.takes_options:
300
if not opt in OPTIONS:
301
raise BzrError("Unknown option '%s' returned by external command %s"
304
# TODO: Is there any way to check takes_args is valid here?
305
self.takes_args = pipe.readline().split()
307
if pipe.close() is not None:
308
raise BzrError("Failed funning '%s --bzr-usage'" % path)
310
pipe = os.popen('%s --bzr-help' % path, 'r')
311
self.__doc__ = pipe.read()
312
if pipe.close() is not None:
313
raise BzrError("Failed funning '%s --bzr-help'" % path)
315
def __call__(self, options, arguments):
316
Command.__init__(self, options, arguments)
319
def run(self, **kargs):
326
optname = name.replace('_','-')
328
if OPTIONS.has_key(optname):
330
opts.append('--%s' % optname)
331
if value is not None and value is not True:
332
opts.append(str(value))
334
# it's an arg, or arg list
335
if type(value) is not list:
341
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
164
345
class cmd_status(Command):
165
346
"""Display status summary.
167
For each file there is a single line giving its file state and name.
168
The name is that in the current revision unless it is deleted or
169
missing, in which case the old name is shown.
348
This reports on versioned and unknown files, reporting them
349
grouped by state. Possible states are:
352
Versioned in the working copy but not in the previous revision.
355
Versioned in the previous revision but removed or deleted
359
Path of this file changed from the previous revision;
360
the text may also have changed. This includes files whose
361
parent directory was renamed.
364
Text has changed since the previous revision.
367
Nothing about this file has changed since the previous revision.
368
Only shown with --all.
371
Not versioned and not matching an ignore pattern.
373
To see ignored files use 'bzr ignored'. For details in the
374
changes to file texts, use 'bzr diff'.
376
If no arguments are specified, the status of the entire working
377
directory is shown. Otherwise, only the status of the specified
378
files or directories is reported. If a directory is given, status
379
is reported for everything inside that directory.
381
If a revision is specified, the changes since that revision are shown.
171
takes_options = ['all']
383
takes_args = ['file*']
384
takes_options = ['all', 'show-ids', 'revision']
385
aliases = ['st', 'stat']
173
def run(self, all=False):
174
#import bzrlib.status
175
#bzrlib.status.tree_status(Branch('.'))
176
Branch('.').show_status(show_all=all)
387
def run(self, all=False, show_ids=False, file_list=None):
389
b = find_branch(file_list[0])
390
file_list = [b.relpath(x) for x in file_list]
391
# special case: only one path was given and it's the root
393
if file_list == ['']:
398
from bzrlib.status import show_status
399
show_status(b, show_unchanged=all, show_ids=show_ids,
400
specific_files=file_list)
179
403
class cmd_cat_revision(Command):
207
454
whether already versioned or not, are searched for files or
208
455
subdirectories that are neither versioned or ignored, and these
209
456
are added. This search proceeds recursively into versioned
457
directories. If no names are given '.' is assumed.
212
Therefore simply saying 'bzr add .' will version all files that
459
Therefore simply saying 'bzr add' will version all files that
213
460
are currently unknown.
215
462
TODO: Perhaps adding a file whose directly is not versioned should
216
463
recursively add that parent, rather than giving an error?
218
takes_args = ['file+']
219
takes_options = ['verbose']
465
takes_args = ['file*']
466
takes_options = ['verbose', 'no-recurse']
221
def run(self, file_list, verbose=False):
222
bzrlib.add.smart_add(file_list, verbose)
225
def Relpath(Command):
468
def run(self, file_list, verbose=False, no_recurse=False):
469
from bzrlib.add import smart_add
470
smart_add(file_list, verbose, not no_recurse)
474
class cmd_mkdir(Command):
475
"""Create a new versioned directory.
477
This is equivalent to creating the directory and then adding it.
479
takes_args = ['dir+']
481
def run(self, dir_list):
488
b.add([d], verbose=True)
491
class cmd_relpath(Command):
226
492
"""Show path of a file relative to root"""
227
takes_args = ('filename')
493
takes_args = ['filename']
230
print Branch(self.args['filename']).relpath(filename)
496
def run(self, filename):
497
print find_branch(filename).relpath(filename)
234
501
class cmd_inventory(Command):
235
502
"""Show inventory of the current working copy or a revision."""
236
takes_options = ['revision']
503
takes_options = ['revision', 'show-ids']
238
def run(self, revision=None):
505
def run(self, revision=None, show_ids=False):
240
507
if revision == None:
241
508
inv = b.read_working_inventory()
243
inv = b.get_revision_inventory(b.lookup_revision(revision))
510
if len(revision) > 1:
511
raise BzrCommandError('bzr inventory --revision takes'
512
' exactly one revision identifier')
513
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
245
for path, entry in inv.iter_entries():
246
print '%-50s %s' % (entry.file_id, path)
515
for path, entry in inv.entries():
517
print '%-50s %s' % (path, entry.file_id)
249
522
class cmd_move(Command):
278
552
takes_args = ['from_name', 'to_name']
280
554
def run(self, from_name, to_name):
282
556
b.rename_one(b.relpath(from_name), b.relpath(to_name))
560
class cmd_mv(Command):
561
"""Move or rename a file.
564
bzr mv OLDNAME NEWNAME
565
bzr mv SOURCE... DESTINATION
567
If the last argument is a versioned directory, all the other names
568
are moved into it. Otherwise, there must be exactly two arguments
569
and the file is changed to a new name, which must not already exist.
571
Files cannot be moved between branches.
573
takes_args = ['names*']
574
def run(self, names_list):
575
if len(names_list) < 2:
576
raise BzrCommandError("missing file argument")
577
b = find_branch(names_list[0])
579
rel_names = [b.relpath(x) for x in names_list]
581
if os.path.isdir(names_list[-1]):
582
# move into existing directory
583
b.move(rel_names[:-1], rel_names[-1])
585
if len(names_list) != 2:
586
raise BzrCommandError('to mv multiple files the destination '
587
'must be a versioned directory')
588
b.move(rel_names[0], rel_names[1])
593
class cmd_pull(Command):
594
"""Pull any changes from another branch into the current one.
596
If the location is omitted, the last-used location will be used.
597
Both the revision history and the working directory will be
600
This command only works on branches that have not diverged. Branches are
601
considered diverged if both branches have had commits without first
602
pulling from the other.
604
If branches have diverged, you can use 'bzr merge' to pull the text changes
605
from one into the other.
607
takes_args = ['location?']
609
def run(self, location=None):
610
from bzrlib.merge import merge
612
from shutil import rmtree
615
br_to = find_branch('.')
618
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
620
if e.errno != errno.ENOENT:
623
if stored_loc is None:
624
raise BzrCommandError("No pull location known or specified.")
626
print "Using last location: %s" % stored_loc
627
location = stored_loc
628
cache_root = tempfile.mkdtemp()
629
from bzrlib.branch import DivergedBranches
630
br_from = find_branch(location)
631
location = pull_loc(br_from)
632
old_revno = br_to.revno()
634
from branch import find_cached_branch, DivergedBranches
635
br_from = find_cached_branch(location, cache_root)
636
location = pull_loc(br_from)
637
old_revno = br_to.revno()
639
br_to.update_revisions(br_from)
640
except DivergedBranches:
641
raise BzrCommandError("These branches have diverged."
644
merge(('.', -1), ('.', old_revno), check_clean=False)
645
if location != stored_loc:
646
br_to.controlfile("x-pull", "wb").write(location + "\n")
652
class cmd_branch(Command):
653
"""Create a new copy of a branch.
655
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
656
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
658
To retrieve the branch as of a particular revision, supply the --revision
659
parameter, as in "branch foo/bar -r 5".
661
takes_args = ['from_location', 'to_location?']
662
takes_options = ['revision']
663
aliases = ['get', 'clone']
665
def run(self, from_location, to_location=None, revision=None):
667
from bzrlib.merge import merge
668
from bzrlib.branch import DivergedBranches, \
669
find_cached_branch, Branch
670
from shutil import rmtree
671
from meta_store import CachedStore
673
cache_root = tempfile.mkdtemp()
677
elif len(revision) > 1:
678
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
682
br_from = find_cached_branch(from_location, cache_root)
684
if e.errno == errno.ENOENT:
685
raise BzrCommandError('Source location "%s" does not'
686
' exist.' % to_location)
690
if to_location is None:
691
to_location = os.path.basename(from_location.rstrip("/\\"))
694
os.mkdir(to_location)
696
if e.errno == errno.EEXIST:
697
raise BzrCommandError('Target directory "%s" already'
698
' exists.' % to_location)
699
if e.errno == errno.ENOENT:
700
raise BzrCommandError('Parent of "%s" does not exist.' %
704
br_to = Branch(to_location, init=True)
706
br_to.set_root_id(br_from.get_root_id())
709
if revision[0] is None:
710
revno = br_from.revno()
712
revno, rev_id = br_from.get_revision_info(revision[0])
714
br_to.update_revisions(br_from, stop_revision=revno)
715
except bzrlib.errors.NoSuchRevision:
717
msg = "The branch %s has no revision %d." % (from_location,
719
raise BzrCommandError(msg)
721
merge((to_location, -1), (to_location, 0), this_dir=to_location,
722
check_clean=False, ignore_zero=True)
723
from_location = pull_loc(br_from)
724
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
729
def pull_loc(branch):
730
# TODO: Should perhaps just make attribute be 'base' in
731
# RemoteBranch and Branch?
732
if hasattr(branch, "baseurl"):
733
return branch.baseurl
286
739
class cmd_renames(Command):
287
740
"""Show list of renamed files.
456
975
takes_args = ['filename?']
457
976
def run(self, filename=None):
458
977
"""Print the branch root."""
459
print bzrlib.branch.find_branch_root(filename)
978
b = find_branch(filename)
979
print getattr(b, 'base', None) or getattr(b, 'baseurl')
463
982
class cmd_log(Command):
464
983
"""Show log of this branch.
466
TODO: Options to show ids; to limit range; etc.
985
To request a range of logs, you can use the command -r begin:end
986
-r revision requests a specific revision, -r :end or -r begin: are
989
--message allows you to give a regular expression, which will be evaluated
990
so that only matching entries will be displayed.
992
TODO: Make --revision support uuid: and hash: [future tag:] notation.
468
takes_options = ['timezone', 'verbose']
469
def run(self, timezone='original', verbose=False):
470
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
996
takes_args = ['filename?']
997
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
998
'long', 'message', 'short',]
1000
def run(self, filename=None, timezone='original',
1008
from bzrlib.branch import find_branch
1009
from bzrlib.log import log_formatter, show_log
1012
direction = (forward and 'forward') or 'reverse'
1015
b = find_branch(filename)
1016
fp = b.relpath(filename)
1018
file_id = b.read_working_inventory().path2id(fp)
1020
file_id = None # points to branch root
1022
b = find_branch('.')
1025
if revision is None:
1028
elif len(revision) == 1:
1029
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1030
elif len(revision) == 2:
1031
rev1 = b.get_revision_info(revision[0])[0]
1032
rev2 = b.get_revision_info(revision[1])[0]
1034
raise BzrCommandError('bzr log --revision takes one or two values.')
1041
mutter('encoding log as %r' % bzrlib.user_encoding)
1043
# use 'replace' so that we don't abort if trying to write out
1044
# in e.g. the default C locale.
1045
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1050
log_format = 'short'
1051
lf = log_formatter(log_format,
1054
show_timezone=timezone)
1060
direction=direction,
1061
start_revision=rev1,
1067
class cmd_touching_revisions(Command):
1068
"""Return revision-ids which affected a particular file.
1070
A more user-friendly interface is "bzr log FILE"."""
1072
takes_args = ["filename"]
1073
def run(self, filename):
1074
b = find_branch(filename)
1075
inv = b.read_working_inventory()
1076
file_id = inv.path2id(b.relpath(filename))
1077
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1078
print "%6d %s" % (revno, what)
473
1081
class cmd_ls(Command):
501
1109
class cmd_unknowns(Command):
502
"""List unknown files"""
1110
"""List unknown files."""
504
for f in Branch('.').unknowns():
1112
from bzrlib.osutils import quotefn
1113
for f in find_branch('.').unknowns():
505
1114
print quotefn(f)
509
1118
class cmd_ignore(Command):
510
"""Ignore a command or pattern"""
1119
"""Ignore a command or pattern.
1121
To remove patterns from the ignore list, edit the .bzrignore file.
1123
If the pattern contains a slash, it is compared to the whole path
1124
from the branch root. Otherwise, it is comapred to only the last
1125
component of the path.
1127
Ignore patterns are case-insensitive on case-insensitive systems.
1129
Note: wildcards must be quoted from the shell on Unix.
1132
bzr ignore ./Makefile
1133
bzr ignore '*.class'
511
1135
takes_args = ['name_pattern']
513
1137
def run(self, name_pattern):
516
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
517
f = open(b.abspath('.bzrignore'), 'at')
518
f.write(name_pattern + '\n')
1138
from bzrlib.atomicfile import AtomicFile
1141
b = find_branch('.')
1142
ifn = b.abspath('.bzrignore')
1144
if os.path.exists(ifn):
1147
igns = f.read().decode('utf-8')
1153
# TODO: If the file already uses crlf-style termination, maybe
1154
# we should use that for the newly added lines?
1156
if igns and igns[-1] != '\n':
1158
igns += name_pattern + '\n'
1161
f = AtomicFile(ifn, 'wt')
1162
f.write(igns.encode('utf-8'))
521
1167
inv = b.working_tree().inventory
522
1168
if inv.path2id('.bzrignore'):
546
1194
bzr lookup-revision 33
1197
takes_args = ['revno']
549
1199
def run(self, revno):
551
1201
revno = int(revno)
552
1202
except ValueError:
553
raise BzrError("not a valid revision-number: %r" % revno)
555
print Branch('.').lookup_revision(revno) or NONE_STRING
1203
raise BzrCommandError("not a valid revision-number: %r" % revno)
1205
print find_branch('.').lookup_revision(revno)
559
1208
class cmd_export(Command):
560
1209
"""Export past revision to destination directory.
562
If no revision is specified this exports the last committed revision."""
1211
If no revision is specified this exports the last committed revision.
1213
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1214
given, try to find the format with the extension. If no extension
1215
is found exports to a directory (equivalent to --format=dir).
1217
Root may be the top directory for tar, tgz and tbz2 formats. If none
1218
is given, the top directory will be the root name of the file."""
1219
# TODO: list known exporters
563
1220
takes_args = ['dest']
564
takes_options = ['revision']
565
def run(self, dest, revno=None):
568
rh = b.revision_history[-1]
1221
takes_options = ['revision', 'format', 'root']
1222
def run(self, dest, revision=None, format=None, root=None):
1224
b = find_branch('.')
1225
if revision is None:
1226
rev_id = b.last_patch()
570
rh = b.lookup_revision(int(revno))
571
t = b.revision_tree(rh)
1228
if len(revision) != 1:
1229
raise BzrError('bzr export --revision takes exactly 1 argument')
1230
revno, rev_id = b.get_revision_info(revision[0])
1231
t = b.revision_tree(rev_id)
1232
root, ext = os.path.splitext(dest)
1234
if ext in (".tar",):
1236
elif ext in (".gz", ".tgz"):
1238
elif ext in (".bz2", ".tbz2"):
1242
t.export(dest, format, root)
575
1245
class cmd_cat(Command):
596
1268
class cmd_commit(Command):
597
1269
"""Commit changes into a new revision.
599
TODO: Commit only selected files.
1271
If no arguments are given, the entire tree is committed.
1273
If selected files are specified, only changes to those files are
1274
committed. If a directory is specified then the directory and everything
1275
within it is committed.
1277
A selected-file commit may fail in some cases where the committed
1278
tree would be invalid, such as trying to commit a file in a
1279
newly-added directory that is not itself committed.
601
1281
TODO: Run hooks on tree to-be-committed, and after commit.
603
1283
TODO: Strict commit that fails if there are unknown or deleted files.
605
takes_options = ['message', 'verbose']
1285
takes_args = ['selected*']
1286
takes_options = ['message', 'file', 'verbose', 'unchanged']
1287
aliases = ['ci', 'checkin']
1289
# TODO: Give better message for -s, --summary, used by tla people
607
def run(self, message=None, verbose=False):
609
raise BzrCommandError("please specify a commit message")
610
Branch('.').commit(message, verbose=verbose)
1291
def run(self, message=None, file=None, verbose=True, selected_list=None,
1293
from bzrlib.errors import PointlessCommit
1294
from bzrlib.osutils import get_text_message
1296
## Warning: shadows builtin file()
1297
if not message and not file:
1298
# FIXME: Ugly; change status code to send to a provided function?
1302
catcher = cStringIO.StringIO()
1303
sys.stdout = catcher
1304
cmd_status({"file_list":selected_list}, {})
1305
info = catcher.getvalue()
1307
message = get_text_message(info)
1310
raise BzrCommandError("please specify a commit message",
1311
["use either --message or --file"])
1312
elif message and file:
1313
raise BzrCommandError("please specify either --message or --file")
1317
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1319
b = find_branch('.')
1321
selected_list = [b.relpath(s) for s in selected_list]
1324
b.commit(message, verbose=verbose,
1325
specific_files=selected_list,
1326
allow_pointless=unchanged)
1327
except PointlessCommit:
1328
# FIXME: This should really happen before the file is read in;
1329
# perhaps prepare the commit; get the message; then actually commit
1330
raise BzrCommandError("no changes to commit",
1331
["use --unchanged to commit anyhow"])
613
1334
class cmd_check(Command):
628
1388
takes_options = ['email']
630
1390
def run(self, email=False):
1392
b = bzrlib.branch.find_branch('.')
632
print bzrlib.osutils.user_email()
1397
print bzrlib.osutils.user_email(b)
634
print bzrlib.osutils.username()
1399
print bzrlib.osutils.username(b)
637
1402
class cmd_selftest(Command):
638
1403
"""Run internal test suite"""
641
failures, tests = 0, 0
643
import doctest, bzrlib.store, bzrlib.tests
644
bzrlib.trace.verbose = False
646
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
647
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
648
mf, mt = doctest.testmod(m)
651
print '%-40s %3d tests' % (m.__name__, mt),
653
print '%3d FAILED!' % mf
657
print '%-40s %3d tests' % ('total', tests),
659
print '%3d FAILED!' % failures
1405
takes_options = ['verbose']
1406
def run(self, verbose=False):
1407
from bzrlib.selftest import selftest
1408
return int(not selftest(verbose=verbose))
665
1411
class cmd_version(Command):
666
"""Show version of bzr"""
1412
"""Show version of bzr."""
670
1416
def show_version():
671
1417
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1418
# is bzrlib itself in a branch?
1419
bzrrev = bzrlib.get_bzr_revision()
1421
print " (bzr checkout, revision %d {%s})" % bzrrev
672
1422
print bzrlib.__copyright__
673
1423
print "http://bazaar-ng.org/"
684
1434
print "it sure does!"
1436
def parse_spec(spec):
1438
>>> parse_spec(None)
1440
>>> parse_spec("./")
1442
>>> parse_spec("../@")
1444
>>> parse_spec("../f/@35")
1446
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1447
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1452
parsed = spec.split('/@')
1453
assert len(parsed) == 2
1458
parsed[1] = int(parsed[1])
1460
pass # We can allow stuff like ./@revid:blahblahblah
1462
assert parsed[1] >=0
1464
parsed = [spec, None]
1469
class cmd_merge(Command):
1470
"""Perform a three-way merge.
1472
The branch is the branch you will merge from. By default, it will merge
1473
the latest revision. If you specify a revision, that revision will be
1474
merged. If you specify two revisions, the first will be used as a BASE,
1475
and the second one as OTHER. Revision numbers are always relative to the
1480
To merge the latest revision from bzr.dev
1481
bzr merge ../bzr.dev
1483
To merge changes up to and including revision 82 from bzr.dev
1484
bzr merge -r 82 ../bzr.dev
1486
To merge the changes introduced by 82, without previous changes:
1487
bzr merge -r 81..82 ../bzr.dev
1489
merge refuses to run if there are any uncommitted changes, unless
1492
takes_args = ['branch?']
1493
takes_options = ['revision', 'force', 'merge-type']
1495
def run(self, branch='.', revision=None, force=False,
1497
from bzrlib.merge import merge
1498
from bzrlib.merge_core import ApplyMerge3
1499
if merge_type is None:
1500
merge_type = ApplyMerge3
1502
if revision is None or len(revision) < 1:
1504
other = (branch, -1)
1506
if len(revision) == 1:
1507
other = (branch, revision[0])
1510
assert len(revision) == 2
1511
if None in revision:
1512
raise BzrCommandError(
1513
"Merge doesn't permit that revision specifier.")
1514
base = (branch, revision[0])
1515
other = (branch, revision[1])
1517
merge(other, base, check_clean=(not force), merge_type=merge_type)
1520
class cmd_revert(Command):
1521
"""Reverse all changes since the last commit.
1523
Only versioned files are affected. Specify filenames to revert only
1524
those files. By default, any files that are changed will be backed up
1525
first. Backup files have a '~' appended to their name.
1527
takes_options = ['revision', 'no-backup']
1528
takes_args = ['file*']
1529
aliases = ['merge-revert']
1531
def run(self, revision=None, no_backup=False, file_list=None):
1532
from bzrlib.merge import merge
1533
if file_list is not None:
1534
if len(file_list) == 0:
1535
raise BzrCommandError("No files specified")
1536
if revision is None:
1538
elif len(revision) != 1:
1539
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1540
merge(('.', revision[0]), parse_spec('.'),
1543
backup_files=not no_backup,
1544
file_list=file_list)
687
1547
class cmd_assert_fail(Command):
688
1548
"""Test reporting of assertion failures"""
697
1557
For a list of all available commands, say 'bzr help commands'."""
698
1558
takes_args = ['topic?']
700
1561
def run(self, topic=None):
704
def help(topic=None):
707
elif topic == 'commands':
710
help_on_command(topic)
713
def help_on_command(cmdname):
714
cmdname = str(cmdname)
716
from inspect import getdoc
717
topic, cmdclass = get_cmd_class(cmdname)
719
doc = getdoc(cmdclass)
721
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
724
short, rest = doc.split('\n', 1)
729
print 'usage: bzr ' + topic,
730
for aname in cmdclass.takes_args:
731
aname = aname.upper()
732
if aname[-1] in ['$', '+']:
733
aname = aname[:-1] + '...'
734
elif aname[-1] == '?':
735
aname = '[' + aname[:-1] + ']'
736
elif aname[-1] == '*':
737
aname = '[' + aname[:-1] + '...]'
744
help_on_option(cmdclass.takes_options)
747
def help_on_option(options):
755
for shortname, longname in SHORT_OPTIONS.items():
757
l += ', -' + shortname
763
"""List all commands"""
767
for k, v in globals().items():
768
if k.startswith('cmd_'):
769
accu.append((k[4:].replace('_','-'), v))
771
for cmdname, cmdclass in accu:
775
help = inspect.getdoc(cmdclass)
777
print " " + help.split('\n', 1)[0]
780
######################################################################
1566
class cmd_shell_complete(Command):
1567
"""Show appropriate completions for context.
1569
For a list of all available commands, say 'bzr shell-complete'."""
1570
takes_args = ['context?']
1574
def run(self, context=None):
1575
import shellcomplete
1576
shellcomplete.shellcomplete(context)
1579
class cmd_missing(Command):
1580
"""What is missing in this branch relative to other branch.
1582
takes_args = ['remote?']
1583
aliases = ['mis', 'miss']
1584
# We don't have to add quiet to the list, because
1585
# unknown options are parsed as booleans
1586
takes_options = ['verbose', 'quiet']
1588
def run(self, remote=None, verbose=False, quiet=False):
1589
from bzrlib.branch import find_branch, DivergedBranches
1590
from bzrlib.errors import BzrCommandError
1591
from bzrlib.missing import get_parent, show_missing
1593
if verbose and quiet:
1594
raise BzrCommandError('Cannot pass both quiet and verbose')
1596
b = find_branch('.')
1597
parent = get_parent(b)
1600
raise BzrCommandError("No missing location known or specified.")
1603
print "Using last location: %s" % parent
1605
elif parent is None:
1606
# We only update x-pull if it did not exist, missing should not change the parent
1607
b.controlfile('x-pull', 'wb').write(remote + '\n')
1608
br_remote = find_branch(remote)
1610
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1614
class cmd_plugins(Command):
1618
import bzrlib.plugin
1619
from inspect import getdoc
1620
from pprint import pprint
1621
for plugin in bzrlib.plugin.all_plugins:
1622
print plugin.__path__[0]
1625
print '\t', d.split('\n')[0]
1627
#pprint(bzrlib.plugin.all_plugins)
784
1631
# list of all available options; the rhs can be either None for an
841
1712
if optname not in OPTIONS:
842
bailout('unknown long option %r' % a)
1713
raise BzrError('unknown long option %r' % a)
844
1715
shortopt = a[1:]
845
if shortopt not in SHORT_OPTIONS:
846
bailout('unknown short option %r' % a)
847
optname = SHORT_OPTIONS[shortopt]
1716
if shortopt in SHORT_OPTIONS:
1717
# Multi-character options must have a space to delimit
1719
optname = SHORT_OPTIONS[shortopt]
1721
# Single character short options, can be chained,
1722
# and have their value appended to their name
1724
if shortopt not in SHORT_OPTIONS:
1725
# We didn't find the multi-character name, and we
1726
# didn't find the single char name
1727
raise BzrError('unknown short option %r' % a)
1728
optname = SHORT_OPTIONS[shortopt]
1731
# There are extra things on this option
1732
# see if it is the value, or if it is another
1734
optargfn = OPTIONS[optname]
1735
if optargfn is None:
1736
# This option does not take an argument, so the
1737
# next entry is another short option, pack it back
1739
argv.insert(0, '-' + a[2:])
1741
# This option takes an argument, so pack it
849
1745
if optname in opts:
850
1746
# XXX: Do we ever want to support this, e.g. for -r?
851
bailout('repeated option %r' % a)
1747
raise BzrError('repeated option %r' % a)
853
1749
optargfn = OPTIONS[optname]
855
1751
if optarg == None:
857
bailout('option %r needs an argument' % a)
1753
raise BzrError('option %r needs an argument' % a)
859
1755
optarg = argv.pop(0)
860
1756
opts[optname] = optargfn(optarg)
862
1758
if optarg != None:
863
bailout('option %r takes no argument' % optname)
1759
raise BzrError('option %r takes no argument' % optname)
864
1760
opts[optname] = True
921
1817
This is similar to main(), but without all the trappings for
922
1818
logging and error handling.
1821
The command-line arguments, without the program name from argv[0]
1823
Returns a command status or raises an exception.
1825
Special master options: these must come before the command because
1826
they control how the command is interpreted.
1829
Do not load plugin modules at all
1832
Only use builtin commands. (Plugins are still allowed to change
1836
Run under the Python profiler.
925
1839
argv = [a.decode(bzrlib.user_encoding) for a in argv]
928
args, opts = parse_args(argv[1:])
935
elif 'version' in opts:
938
cmd = str(args.pop(0))
940
log_error('usage: bzr COMMAND')
941
log_error(' try "bzr help"')
944
canonical_cmd, cmd_class = get_cmd_class(cmd)
947
if 'profile' in opts:
1841
opt_profile = opt_no_plugins = opt_builtin = False
1843
# --no-plugins is handled specially at a very early stage. We need
1844
# to load plugins before doing other command parsing so that they
1845
# can override commands, but this needs to happen first.
1848
if a == '--profile':
1850
elif a == '--no-plugins':
1851
opt_no_plugins = True
1852
elif a == '--builtin':
1858
if not opt_no_plugins:
1859
from bzrlib.plugin import load_plugins
1862
args, opts = parse_args(argv)
1865
from bzrlib.help import help
1872
if 'version' in opts:
1877
from bzrlib.help import help
1881
cmd = str(args.pop(0))
1883
canonical_cmd, cmd_class = \
1884
get_cmd_class(cmd, plugins_override=not opt_builtin)
953
1886
# check options are reasonable
954
1887
allowed = cmd_class.takes_options
955
1888
for oname in opts:
956
1889
if oname not in allowed:
957
raise BzrCommandError("option %r is not allowed for command %r"
1890
raise BzrCommandError("option '--%s' is not allowed for command %r"
960
1893
# mix arguments and options into one dictionary
1006
1939
def main(argv):
1009
bzrlib.trace.create_tracefile(argv)
1940
bzrlib.trace.open_tracefile(argv)
1014
# do this here to catch EPIPE
1944
return run_bzr(argv[1:])
1946
# do this here inside the exception wrappers to catch EPIPE
1015
1947
sys.stdout.flush()
1018
quiet = isinstance(e, (BzrCommandError))
1019
_report_exception(e, 'error: ' + e.args[0], quiet=quiet)
1022
# some explanation or hints
1025
except AssertionError, e:
1026
msg = 'assertion failed'
1028
msg += ': ' + str(e)
1029
_report_exception(e, msg)
1031
except KeyboardInterrupt, e:
1032
_report_exception(e, 'interrupted', quiet=True)
1034
except Exception, e:
1036
if isinstance(e, IOError) and e.errno == errno.EPIPE:
1040
msg = str(e).rstrip('\n')
1041
_report_exception(e, msg, quiet)
1044
bzrlib.trace.close_trace()
1948
except BzrCommandError, e:
1949
# command line syntax error, etc
1953
bzrlib.trace.log_exception()
1955
except AssertionError, e:
1956
bzrlib.trace.log_exception('assertion failed: ' + str(e))
1958
except KeyboardInterrupt, e:
1959
bzrlib.trace.note('interrupted')
1961
except Exception, e:
1963
if (isinstance(e, IOError)
1964
and hasattr(e, 'errno')
1965
and e.errno == errno.EPIPE):
1966
bzrlib.trace.note('broken pipe')
1969
bzrlib.trace.log_exception('terminated by exception')
1047
1973
if __name__ == '__main__':