16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Bazaar-NG -- a free distributed version-control tool
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
24
* Metadata format is not stable yet -- you may need to
25
discard history in the future.
27
* Many commands unimplemented or partially implemented.
29
* Space-inefficient storage.
31
* No merge operators yet.
38
Show software version/licence/non-warranty.
40
Start versioning the current directory
44
Show revision history.
47
bzr move FROM... DESTDIR
48
Move one or more files to a different directory.
50
Show changes from last revision to working copy.
51
bzr commit -m 'MESSAGE'
52
Store current state as new revision.
53
bzr export REVNO DESTINATION
54
Export the branch state at a previous version.
56
Show summary of pending changes.
58
Make a file not versioned.
60
Show statistics about this branch.
62
Verify history is stored safely.
63
(for more type 'bzr help commands')
69
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
71
from pprint import pprint
74
from inspect import getdoc
77
from bzrlib.store import ImmutableStore
78
22
from bzrlib.trace import mutter, note, log_error
79
from bzrlib.errors import bailout, BzrError, BzrCheckError
80
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
81
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
82
from bzrlib.revision import Revision
83
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
23
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
86
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
87
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
89
## standard representation
90
NONE_STRING = '(none)'
94
## TODO: Perhaps a different version of inventory commands that
95
## returns iterators...
97
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
99
## TODO: Some kind of locking on branches. Perhaps there should be a
100
## parameter to the branch object saying whether we want a read or
101
## write lock; release it from destructor. Perhaps don't even need a
102
## read lock to look at immutable objects?
104
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
105
## to compare output?
107
## TODO: Some kind of global code to generate the right Branch object
108
## to work on. Almost, but not quite all, commands need one, and it
109
## can be taken either from their parameters or their working
124
def get_cmd_handler(cmd):
127
cmd = cmd_aliases.get(cmd, cmd)
29
def _squish_command_name(cmd):
30
return 'cmd_' + cmd.replace('-', '_')
33
def _unsquish_command_name(cmd):
34
assert cmd.startswith("cmd_")
35
return cmd[4:].replace('_','-')
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
72
"""Return canonical name and class for all registered commands."""
73
for k, v in globals().iteritems():
74
if k.startswith("cmd_"):
75
yield _unsquish_command_name(k), v
77
def get_cmd_class(cmd):
78
"""Return the canonical name and command class for a command.
80
cmd = str(cmd) # not unicode
82
# first look up this command under the specified name
130
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
84
return cmd, globals()[_squish_command_name(cmd)]
132
raise BzrError("unknown command %r" % cmd)
134
return cmd, cmd_handler
138
def cmd_status(all=False):
88
# look for any command which claims this as an alias
89
for cmdname, cmdclass in get_all_cmds():
90
if cmd in cmdclass.aliases:
91
return cmdname, cmdclass
93
cmdclass = ExternalCommand.find_command(cmd)
97
raise BzrCommandError("unknown command %r" % cmd)
100
class Command(object):
101
"""Base class for commands.
103
The docstring for an actual command should give a single-line
104
summary, then a complete description of the command. A grammar
105
description will be inserted.
108
List of argument forms, marked with whether they are optional,
112
List of options that may be given for this command.
115
If true, this command isn't advertised.
124
def __init__(self, options, arguments):
125
"""Construct and run the command.
127
Sets self.status to the return value of run()."""
128
assert isinstance(options, dict)
129
assert isinstance(arguments, dict)
130
cmdargs = options.copy()
131
cmdargs.update(arguments)
132
assert self.__doc__ != Command.__doc__, \
133
("No help message set for %r" % self)
134
self.status = self.run(**cmdargs)
138
"""Override this in sub-classes.
140
This is invoked with the options and arguments bound to
143
Return 0 or None if the command was successful, or a shell
149
class ExternalCommand(Command):
150
"""Class to wrap external commands.
152
We cheat a little here, when get_cmd_class() calls us we actually give it back
153
an object we construct that has the appropriate path, help, options etc for the
156
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
157
method, which we override to call the Command.__init__ method. That then calls
158
our run method which is pretty straight forward.
160
The only wrinkle is that we have to map bzr's dictionary of options and arguments
161
back into command line options and arguments for the script.
164
def find_command(cls, cmd):
166
bzrpath = os.environ.get('BZRPATH', '')
168
for dir in bzrpath.split(':'):
169
path = os.path.join(dir, cmd)
170
if os.path.isfile(path):
171
return ExternalCommand(path)
175
find_command = classmethod(find_command)
177
def __init__(self, path):
180
# TODO: If either of these fail, we should detect that and
181
# assume that path is not really a bzr plugin after all.
183
pipe = os.popen('%s --bzr-usage' % path, 'r')
184
self.takes_options = pipe.readline().split()
185
self.takes_args = pipe.readline().split()
188
pipe = os.popen('%s --bzr-help' % path, 'r')
189
self.__doc__ = pipe.read()
192
def __call__(self, options, arguments):
193
Command.__init__(self, options, arguments)
196
def run(self, **kargs):
204
if OPTIONS.has_key(name):
206
opts.append('--%s' % name)
207
if value is not None and value is not True:
208
opts.append(str(value))
210
# it's an arg, or arg list
211
if type(value) is not list:
217
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
221
class cmd_status(Command):
139
222
"""Display status summary.
141
For each file there is a single line giving its file state and name.
142
The name is that in the current revision unless it is deleted or
143
missing, in which case the old name is shown.
224
This reports on versioned and unknown files, reporting them
225
grouped by state. Possible states are:
228
Versioned in the working copy but not in the previous revision.
231
Versioned in the previous revision but removed or deleted
235
Path of this file changed from the previous revision;
236
the text may also have changed. This includes files whose
237
parent directory was renamed.
240
Text has changed since the previous revision.
243
Nothing about this file has changed since the previous revision.
244
Only shown with --all.
247
Not versioned and not matching an ignore pattern.
249
To see ignored files use 'bzr ignored'. For details in the
250
changes to file texts, use 'bzr diff'.
252
If no arguments are specified, the status of the entire working
253
directory is shown. Otherwise, only the status of the specified
254
files or directories is reported. If a directory is given, status
255
is reported for everything inside that directory.
145
#import bzrlib.status
146
#bzrlib.status.tree_status(Branch('.'))
147
Branch('.').show_status(show_all=all)
151
######################################################################
153
def cmd_get_revision(revision_id):
154
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
157
def cmd_get_file_text(text_id):
158
"""Get contents of a file by hash."""
159
sf = Branch('.').text_store[text_id]
160
pumpfile(sf, sys.stdout)
164
######################################################################
169
"""Show number of revisions on this branch"""
170
print Branch('.').revno()
174
def cmd_add(file_list, verbose=False):
257
takes_args = ['file*']
258
takes_options = ['all', 'show-ids']
259
aliases = ['st', 'stat']
261
def run(self, all=False, show_ids=False, file_list=None):
263
b = Branch(file_list[0])
264
file_list = [b.relpath(x) for x in file_list]
265
# special case: only one path was given and it's the root
267
if file_list == ['']:
272
status.show_status(b, show_unchanged=all, show_ids=show_ids,
273
specific_files=file_list)
276
class cmd_cat_revision(Command):
277
"""Write out metadata for a revision."""
280
takes_args = ['revision_id']
282
def run(self, revision_id):
283
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
286
class cmd_revno(Command):
287
"""Show current revision number.
289
This is equal to the number of revisions on this branch."""
291
print Branch('.').revno()
294
class cmd_add(Command):
175
295
"""Add specified files or directories.
177
297
In non-recursive mode, all the named items are added, regardless
243
377
TODO: Some way to rename multiple files without invoking bzr for each
246
b.rename_one(b.relpath(from_name), b.relpath(to_name))
379
takes_args = ['from_name', 'to_name']
251
def cmd_renames(dir='.'):
381
def run(self, from_name, to_name):
383
b.rename_one(b.relpath(from_name), b.relpath(to_name))
389
class cmd_pull(Command):
390
"""Pull any changes from another branch into the current one.
392
If the location is omitted, the last-used location will be used.
393
Both the revision history and the working directory will be
396
This command only works on branches that have not diverged. Branches are
397
considered diverged if both branches have had commits without first
398
pulling from the other.
400
If branches have diverged, you can use 'bzr merge' to pull the text changes
401
from one into the other.
403
takes_args = ['location?']
405
def run(self, location=None):
406
from bzrlib.merge import merge
412
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
414
if errno == errno.ENOENT:
417
location = stored_loc
419
raise BzrCommandError("No pull location known or specified.")
420
from branch import find_branch, DivergedBranches
421
br_from = find_branch(location)
422
location = pull_loc(br_from)
423
old_revno = br_to.revno()
425
br_to.update_revisions(br_from)
426
except DivergedBranches:
427
raise BzrCommandError("These branches have diverged. Try merge.")
429
merge(('.', -1), ('.', old_revno))
430
if location != stored_loc:
431
br_to.controlfile("x-pull", "wb").write(location + "\n")
435
class cmd_branch(Command):
436
"""Create a new copy of a branch.
438
If the TO_LOCATION is omitted, the last component of the
439
FROM_LOCATION will be used. In other words,
440
"branch ../foo/bar" will attempt to create ./bar.
442
takes_args = ['from_location', 'to_location?']
444
def run(self, from_location, to_location=None):
446
from bzrlib.merge import merge
448
if to_location is None:
449
to_location = os.path.basename(from_location)
450
# FIXME: If there's a trailing slash, keep removing them
451
# until we find the right bit
454
os.mkdir(to_location)
456
if e.errno == errno.EEXIST:
457
raise BzrCommandError('Target directory "%s" already exists.' %
459
if e.errno == errno.ENOENT:
460
raise BzrCommandError('Parent of "%s" does not exist.' %
464
br_to = Branch(to_location, init=True)
465
from branch import find_branch, DivergedBranches
467
br_from = find_branch(from_location)
469
if e.errno == errno.ENOENT:
470
raise BzrCommandError('Source location "%s" does not exist.' %
475
from_location = pull_loc(br_from)
476
br_to.update_revisions(br_from)
477
merge((to_location, -1), (to_location, 0), this_dir=to_location,
479
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
482
def pull_loc(branch):
483
# TODO: Should perhaps just make attribute be 'base' in
484
# RemoteBranch and Branch?
485
if hasattr(branch, "baseurl"):
486
return branch.baseurl
492
class cmd_renames(Command):
252
493
"""Show list of renamed files.
254
usage: bzr renames [BRANCH]
256
495
TODO: Option to show renames between two historical versions.
258
497
TODO: Only show renames under dir, rather than in the whole branch.
261
old_inv = b.basis_tree().inventory
262
new_inv = b.read_working_inventory()
264
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
266
for old_name, new_name in renames:
267
print "%s => %s" % (old_name, new_name)
272
"""info: Show statistical information for this branch
276
info.show_info(Branch('.'))
280
def cmd_remove(file_list, verbose=False):
281
b = Branch(file_list[0])
282
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
286
def cmd_file_id(filename):
499
takes_args = ['dir?']
501
def run(self, dir='.'):
503
old_inv = b.basis_tree().inventory
504
new_inv = b.read_working_inventory()
506
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
508
for old_name, new_name in renames:
509
print "%s => %s" % (old_name, new_name)
512
class cmd_info(Command):
513
"""Show statistical information about a branch."""
514
takes_args = ['branch?']
516
def run(self, branch=None):
519
from branch import find_branch
520
b = find_branch(branch)
524
class cmd_remove(Command):
525
"""Make a file unversioned.
527
This makes bzr stop tracking changes to a versioned file. It does
528
not delete the working copy.
530
takes_args = ['file+']
531
takes_options = ['verbose']
533
def run(self, file_list, verbose=False):
534
b = Branch(file_list[0])
535
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
538
class cmd_file_id(Command):
287
539
"""Print file_id of a particular file or directory.
289
usage: bzr file-id FILE
291
541
The file_id is assigned when the file is first added and remains the
292
542
same through all revisions where the file exists, even when it is
293
543
moved or renamed.
296
i = b.inventory.path2id(b.relpath(filename))
298
bailout("%r is not a versioned file" % filename)
303
def cmd_file_id_path(filename):
546
takes_args = ['filename']
547
def run(self, filename):
549
i = b.inventory.path2id(b.relpath(filename))
551
bailout("%r is not a versioned file" % filename)
556
class cmd_file_path(Command):
304
557
"""Print path of file_ids to a file or directory.
306
usage: bzr file-id-path FILE
308
559
This prints one line for each directory down to the target,
309
560
starting at the branch root."""
312
fid = inv.path2id(b.relpath(filename))
314
bailout("%r is not a versioned file" % filename)
315
for fip in inv.get_idpath(fid):
319
def cmd_revision_history():
320
for patchid in Branch('.').revision_history():
324
def cmd_directories():
325
for name, ie in Branch('.').read_working_inventory().directories():
333
for name, ie in Branch('.').working_tree().missing():
338
# TODO: Check we're not already in a working directory? At the
339
# moment you'll get an ugly error.
341
# TODO: What if we're in a subdirectory of a branch? Would like
342
# to allow that, but then the parent may need to understand that
343
# the children have disappeared, or should they be versioned in
346
# TODO: Take an argument/option for branch name.
347
Branch('.', init=True)
350
def cmd_diff(revision=None, file_list=None):
351
"""bzr diff: Show differences in working tree.
353
usage: bzr diff [-r REV] [FILE...]
356
Show changes since REV, rather than predecessor.
562
takes_args = ['filename']
563
def run(self, filename):
566
fid = inv.path2id(b.relpath(filename))
568
bailout("%r is not a versioned file" % filename)
569
for fip in inv.get_idpath(fid):
573
class cmd_revision_history(Command):
574
"""Display list of revision ids on this branch."""
577
for patchid in Branch('.').revision_history():
581
class cmd_directories(Command):
582
"""Display list of versioned directories in this branch."""
584
for name, ie in Branch('.').read_working_inventory().directories():
591
class cmd_init(Command):
592
"""Make a directory into a versioned branch.
594
Use this to create an empty branch, or before importing an
597
Recipe for importing a tree of files:
602
bzr commit -m 'imported project'
605
Branch('.', init=True)
608
class cmd_diff(Command):
609
"""Show differences in working tree.
358
611
If files are listed, only the changes in those files are listed.
359
612
Otherwise, all changes for the tree are listed.
376
629
TODO: This probably handles non-Unix newlines poorly.
379
## TODO: Shouldn't be in the cmd function.
384
old_tree = b.basis_tree()
386
old_tree = b.revision_tree(b.lookup_revision(revision))
388
new_tree = b.working_tree()
390
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
394
DEVNULL = '/dev/null'
395
# Windows users, don't panic about this filename -- it is a
396
# special signal to GNU patch that the file should be created or
397
# deleted respectively.
399
# TODO: Generation of pseudo-diffs for added/deleted files could
400
# be usefully made into a much faster special case.
402
# TODO: Better to return them in sorted order I think.
405
file_list = [b.relpath(f) for f in file_list]
407
# FIXME: If given a file list, compare only those files rather
408
# than comparing everything and then throwing stuff away.
410
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
412
if file_list and (new_name not in file_list):
415
# Don't show this by default; maybe do it if an option is passed
416
# idlabel = ' {%s}' % fid
419
# FIXME: Something about the diff format makes patch unhappy
420
# with newly-added files.
422
def diffit(oldlines, newlines, **kw):
424
# FIXME: difflib is wrong if there is no trailing newline.
425
# The syntax used by patch seems to be "\ No newline at
426
# end of file" following the last diff line from that
427
# file. This is not trivial to insert into the
428
# unified_diff output and it might be better to just fix
429
# or replace that function.
431
# In the meantime we at least make sure the patch isn't
435
# Special workaround for Python2.3, where difflib fails if
436
# both sequences are empty.
437
if not oldlines and not newlines:
442
if oldlines and (oldlines[-1][-1] != '\n'):
445
if newlines and (newlines[-1][-1] != '\n'):
449
ud = difflib.unified_diff(oldlines, newlines, **kw)
450
sys.stdout.writelines(ud)
452
print "\\ No newline at end of file"
453
sys.stdout.write('\n')
455
if file_state in ['.', '?', 'I']:
457
elif file_state == 'A':
458
print '*** added %s %r' % (kind, new_name)
461
new_tree.get_file(fid).readlines(),
463
tofile=new_label + new_name + idlabel)
464
elif file_state == 'D':
465
assert isinstance(old_name, types.StringTypes)
466
print '*** deleted %s %r' % (kind, old_name)
468
diffit(old_tree.get_file(fid).readlines(), [],
469
fromfile=old_label + old_name + idlabel,
471
elif file_state in ['M', 'R']:
472
if file_state == 'M':
473
assert kind == 'file'
474
assert old_name == new_name
475
print '*** modified %s %r' % (kind, new_name)
476
elif file_state == 'R':
477
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
480
diffit(old_tree.get_file(fid).readlines(),
481
new_tree.get_file(fid).readlines(),
482
fromfile=old_label + old_name + idlabel,
483
tofile=new_label + new_name)
632
takes_args = ['file*']
633
takes_options = ['revision', 'diff-options']
636
def run(self, revision=None, file_list=None, diff_options=None):
637
from bzrlib.diff import show_diff
638
from bzrlib import find_branch
641
b = find_branch(file_list[0])
642
file_list = [b.relpath(f) for f in file_list]
643
if file_list == ['']:
644
# just pointing to top-of-tree
485
bailout("can't represent state %s {%s}" % (file_state, fid))
489
def cmd_deleted(show_ids=False):
649
show_diff(b, revision, specific_files=file_list,
650
external_diff_options=diff_options)
656
class cmd_deleted(Command):
490
657
"""List files deleted in the working tree.
492
659
TODO: Show files deleted since a previous revision, or between two revisions.
496
new = b.working_tree()
498
## TODO: Much more efficient way to do this: read in new
499
## directories with readdir, rather than stating each one. Same
500
## level of effort but possibly much less IO. (Or possibly not,
501
## if the directories are very large...)
503
for path, ie in old.inventory.iter_entries():
504
if not new.has_id(ie.file_id):
506
print '%-50s %s' % (path, ie.file_id)
661
def run(self, show_ids=False):
664
new = b.working_tree()
666
## TODO: Much more efficient way to do this: read in new
667
## directories with readdir, rather than stating each one. Same
668
## level of effort but possibly much less IO. (Or possibly not,
669
## if the directories are very large...)
671
for path, ie in old.inventory.iter_entries():
672
if not new.has_id(ie.file_id):
674
print '%-50s %s' % (path, ie.file_id)
679
class cmd_modified(Command):
680
"""List files modified in working tree."""
685
inv = b.read_working_inventory()
686
sc = statcache.update_cache(b, inv)
687
basis = b.basis_tree()
688
basis_inv = basis.inventory
690
# We used to do this through iter_entries(), but that's slow
691
# when most of the files are unmodified, as is usually the
692
# case. So instead we iterate by inventory entry, and only
693
# calculate paths as necessary.
695
for file_id in basis_inv:
696
cacheentry = sc.get(file_id)
697
if not cacheentry: # deleted
699
ie = basis_inv[file_id]
700
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
701
path = inv.id2path(file_id)
512
def cmd_parse_inventory():
515
cElementTree.ElementTree().parse(file('.bzr/inventory'))
519
def cmd_load_inventory():
520
"""Load inventory for timing purposes"""
521
Branch('.').basis_tree().inventory
524
def cmd_dump_inventory():
525
Branch('.').read_working_inventory().write_xml(sys.stdout)
528
def cmd_dump_new_inventory():
529
import bzrlib.newinventory
530
inv = Branch('.').basis_tree().inventory
531
bzrlib.newinventory.write_inventory(inv, sys.stdout)
534
def cmd_load_new_inventory():
535
import bzrlib.newinventory
536
bzrlib.newinventory.read_new_inventory(sys.stdin)
706
class cmd_added(Command):
707
"""List files added in working tree."""
711
wt = b.working_tree()
712
basis_inv = b.basis_tree().inventory
715
if file_id in basis_inv:
717
path = inv.id2path(file_id)
718
if not os.access(b.abspath(path), os.F_OK):
539
def cmd_dump_slacker_inventory():
540
import bzrlib.newinventory
541
inv = Branch('.').basis_tree().inventory
542
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
546
def cmd_dump_text_inventory():
547
import bzrlib.textinv
548
inv = Branch('.').basis_tree().inventory
549
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
552
def cmd_load_text_inventory():
553
import bzrlib.textinv
554
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
555
print 'loaded %d entries' % len(inv)
559
def cmd_root(filename=None):
560
"""Print the branch root."""
561
print bzrlib.branch.find_branch_root(filename)
564
def cmd_log(timezone='original', verbose=False):
724
class cmd_root(Command):
725
"""Show the tree root directory.
727
The root is the nearest enclosing directory with a .bzr control
729
takes_args = ['filename?']
730
def run(self, filename=None):
731
"""Print the branch root."""
732
from branch import find_branch
733
b = find_branch(filename)
734
print getattr(b, 'base', None) or getattr(b, 'baseurl')
737
class cmd_log(Command):
565
738
"""Show log of this branch.
567
TODO: Options for utc; to show ids; to limit range; etc.
740
To request a range of logs, you can use the command -r begin:end
741
-r revision requests a specific revision, -r :end or -r begin: are
744
TODO: Make --revision support uuid: and hash: [future tag:] notation.
569
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
572
def cmd_ls(revision=None, verbose=False):
748
takes_args = ['filename?']
749
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
751
def run(self, filename=None, timezone='original',
756
from bzrlib import show_log, find_branch
759
direction = (forward and 'forward') or 'reverse'
762
b = find_branch(filename)
763
fp = b.relpath(filename)
765
file_id = b.read_working_inventory().path2id(fp)
767
file_id = None # points to branch root
773
revision = [None, None]
774
elif isinstance(revision, int):
775
revision = [revision, revision]
780
assert len(revision) == 2
782
mutter('encoding log as %r' % bzrlib.user_encoding)
784
# use 'replace' so that we don't abort if trying to write out
785
# in e.g. the default C locale.
786
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
789
show_timezone=timezone,
794
start_revision=revision[0],
795
end_revision=revision[1])
799
class cmd_touching_revisions(Command):
800
"""Return revision-ids which affected a particular file.
802
A more user-friendly interface is "bzr log FILE"."""
804
takes_args = ["filename"]
805
def run(self, filename):
807
inv = b.read_working_inventory()
808
file_id = inv.path2id(b.relpath(filename))
809
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
810
print "%6d %s" % (revno, what)
813
class cmd_ls(Command):
573
814
"""List files in a tree.
575
816
TODO: Take a revision or remote path and list that tree instead.
579
tree = b.working_tree()
581
tree = b.revision_tree(b.lookup_revision(revision))
583
for fp, fc, kind, fid in tree.list_files():
585
if kind == 'directory':
819
def run(self, revision=None, verbose=False):
822
tree = b.working_tree()
824
tree = b.revision_tree(b.lookup_revision(revision))
826
for fp, fc, kind, fid in tree.list_files():
828
if kind == 'directory':
835
print '%-8s %s%s' % (fc, fp, kindch)
592
print '%-8s %s%s' % (fc, fp, kindch)
599
"""List unknown files"""
600
for f in Branch('.').unknowns():
841
class cmd_unknowns(Command):
842
"""List unknown files."""
844
for f in Branch('.').unknowns():
849
class cmd_ignore(Command):
850
"""Ignore a command or pattern.
852
To remove patterns from the ignore list, edit the .bzrignore file.
854
If the pattern contains a slash, it is compared to the whole path
855
from the branch root. Otherwise, it is comapred to only the last
856
component of the path.
858
Ignore patterns are case-insensitive on case-insensitive systems.
860
Note: wildcards must be quoted from the shell on Unix.
863
bzr ignore ./Makefile
866
takes_args = ['name_pattern']
868
def run(self, name_pattern):
869
from bzrlib.atomicfile import AtomicFile
873
ifn = b.abspath('.bzrignore')
875
if os.path.exists(ifn):
878
igns = f.read().decode('utf-8')
884
# TODO: If the file already uses crlf-style termination, maybe
885
# we should use that for the newly added lines?
887
if igns and igns[-1] != '\n':
889
igns += name_pattern + '\n'
892
f = AtomicFile(ifn, 'wt')
893
f.write(igns.encode('utf-8'))
898
inv = b.working_tree().inventory
899
if inv.path2id('.bzrignore'):
900
mutter('.bzrignore is already versioned')
902
mutter('need to make new .bzrignore file versioned')
903
b.add(['.bzrignore'])
907
class cmd_ignored(Command):
606
908
"""List ignored files and the patterns that matched them.
608
tree = Branch('.').working_tree()
609
for path, file_class, kind, file_id in tree.list_files():
610
if file_class != 'I':
612
## XXX: Slightly inefficient since this was already calculated
613
pat = tree.is_ignored(path)
614
print '%-50s %s' % (path, pat)
617
def cmd_lookup_revision(revno):
621
bailout("usage: lookup-revision REVNO",
622
["REVNO is a non-negative revision number for this branch"])
624
print Branch('.').lookup_revision(revno) or NONE_STRING
628
def cmd_export(revno, dest):
629
"""Export past revision to destination directory."""
631
rh = b.lookup_revision(int(revno))
632
t = b.revision_tree(rh)
635
def cmd_cat(revision, filename):
636
"""Print file to stdout."""
638
b.print_file(b.relpath(filename), int(revision))
641
######################################################################
642
# internal/test commands
646
"""Print a newly-generated UUID."""
647
print bzrlib.osutils.uuid()
651
def cmd_local_time_offset():
652
print bzrlib.osutils.local_time_offset()
656
def cmd_commit(message=None, verbose=False):
657
"""Commit changes to a new revision.
660
Description of changes in this revision; free form text.
661
It is recommended that the first line be a single-sentence
664
Show status of changed files,
666
TODO: Commit only selected files.
910
See also: bzr ignore"""
912
tree = Branch('.').working_tree()
913
for path, file_class, kind, file_id in tree.list_files():
914
if file_class != 'I':
916
## XXX: Slightly inefficient since this was already calculated
917
pat = tree.is_ignored(path)
918
print '%-50s %s' % (path, pat)
921
class cmd_lookup_revision(Command):
922
"""Lookup the revision-id from a revision-number
925
bzr lookup-revision 33
928
takes_args = ['revno']
930
def run(self, revno):
934
raise BzrCommandError("not a valid revision-number: %r" % revno)
936
print Branch('.').lookup_revision(revno)
939
class cmd_export(Command):
940
"""Export past revision to destination directory.
942
If no revision is specified this exports the last committed revision."""
943
takes_args = ['dest']
944
takes_options = ['revision']
945
def run(self, dest, revision=None):
948
rh = b.revision_history()[-1]
950
rh = b.lookup_revision(int(revision))
951
t = b.revision_tree(rh)
955
class cmd_cat(Command):
956
"""Write a file's text from a previous revision."""
958
takes_options = ['revision']
959
takes_args = ['filename']
961
def run(self, filename, revision=None):
963
raise BzrCommandError("bzr cat requires a revision number")
965
b.print_file(b.relpath(filename), int(revision))
968
class cmd_local_time_offset(Command):
969
"""Show the offset in seconds from GMT to local time."""
972
print bzrlib.osutils.local_time_offset()
976
class cmd_commit(Command):
977
"""Commit changes into a new revision.
979
If selected files are specified, only changes to those files are
980
committed. If a directory is specified then its contents are also
983
A selected-file commit may fail in some cases where the committed
984
tree would be invalid, such as trying to commit a file in a
985
newly-added directory that is not itself committed.
668
987
TODO: Run hooks on tree to-be-committed, and after commit.
670
989
TODO: Strict commit that fails if there are unknown or deleted files.
674
bailout("please specify a commit message")
675
Branch('.').commit(message, verbose=verbose)
678
def cmd_check(dir='.'):
679
"""check: Consistency check of branch history.
681
usage: bzr check [-v] [BRANCH]
684
--verbose, -v Show progress of checking.
991
takes_args = ['selected*']
992
takes_options = ['message', 'file', 'verbose']
993
aliases = ['ci', 'checkin']
995
def run(self, message=None, file=None, verbose=True, selected_list=None):
996
from bzrlib.commit import commit
998
## Warning: shadows builtin file()
999
if not message and not file:
1000
raise BzrCommandError("please specify a commit message",
1001
["use either --message or --file"])
1002
elif message and file:
1003
raise BzrCommandError("please specify either --message or --file")
1007
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1010
commit(b, message, verbose=verbose, specific_files=selected_list)
1013
class cmd_check(Command):
1014
"""Validate consistency of branch history.
686
1016
This command checks various invariants about the branch storage to
687
1017
detect data corruption or bzr bugs.
690
bzrlib.check.check(Branch(dir, find_root=False))
693
def cmd_is(pred, *rest):
694
"""Test whether PREDICATE is true."""
696
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
698
bailout("unknown predicate: %s" % quotefn(pred))
702
except BzrCheckError:
703
# by default we don't print the message so that this can
704
# be used from shell scripts without producing noise
708
def cmd_whoami(email=False):
714
--email Show only the email address.
1019
takes_args = ['dir?']
1020
def run(self, dir='.'):
1022
bzrlib.check.check(Branch(dir))
1026
class cmd_whoami(Command):
1027
"""Show bzr user id."""
1028
takes_options = ['email']
718
print bzrlib.osutils.user_email()
720
print bzrlib.osutils.username()
723
def cmd_gen_revision_id():
724
print bzrlib.branch._gen_revision_id(time.time())
1030
def run(self, email=False):
1032
print bzrlib.osutils.user_email()
1034
print bzrlib.osutils.username()
1037
class cmd_selftest(Command):
728
1038
"""Run internal test suite"""
729
## -v, if present, is seen by doctest; the argument is just here
730
## so our parser doesn't complain
732
## TODO: --verbose option
734
failures, tests = 0, 0
736
import doctest, bzrlib.store, bzrlib.tests
737
bzrlib.trace.verbose = False
739
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
740
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
741
mf, mt = doctest.testmod(m)
744
print '%-40s %3d tests' % (m.__name__, mt),
746
print '%3d FAILED!' % mf
1041
from bzrlib.selftest import selftest
750
print '%-40s %3d tests' % ('total', tests),
752
print '%3d FAILED!' % failures
759
cmd_doctest = cmd_selftest
762
######################################################################
766
def cmd_help(topic=None):
769
elif topic == 'commands':
772
# otherwise, maybe the name of a command?
773
topic, cmdfn = get_cmd_handler(topic)
777
bailout("sorry, no detailed help yet for %r" % topic)
783
"""List all commands"""
785
for k in globals().keys():
786
if k.startswith('cmd_'):
787
accu.append(k[4:].replace('_','-'))
789
print "bzr commands: "
792
print "note: some of these commands are internal-use or obsolete"
793
# TODO: Some kind of marker for internal-use commands?
794
# TODO: Show aliases?
1049
class cmd_version(Command):
1050
"""Show version of bzr."""
800
1055
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1056
# is bzrlib itself in a branch?
1057
bzrrev = bzrlib.get_bzr_revision()
1059
print " (bzr checkout, revision %d {%s})" % bzrrev
801
1060
print bzrlib.__copyright__
802
1061
print "http://bazaar-ng.org/"
805
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
806
you may use, modify and redistribute it under the terms of the GNU
807
General Public License version 2 or later."""
1063
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1064
print "you may use, modify and redistribute it under the terms of the GNU"
1065
print "General Public License version 2 or later."
1068
class cmd_rocks(Command):
811
1069
"""Statement of optimism."""
812
print "it sure does!"
816
######################################################################
1072
print "it sure does!"
1074
def parse_spec(spec):
1076
>>> parse_spec(None)
1078
>>> parse_spec("./")
1080
>>> parse_spec("../@")
1082
>>> parse_spec("../f/@35")
1088
parsed = spec.split('/@')
1089
assert len(parsed) == 2
1093
parsed[1] = int(parsed[1])
1094
assert parsed[1] >=0
1096
parsed = [spec, None]
1101
class cmd_merge(Command):
1102
"""Perform a three-way merge of trees.
1104
The SPEC parameters are working tree or revision specifiers. Working trees
1105
are specified using standard paths or urls. No component of a directory
1106
path may begin with '@'.
1108
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1110
Revisions are specified using a dirname/@revno pair, where dirname is the
1111
branch directory and revno is the revision within that branch. If no revno
1112
is specified, the latest revision is used.
1114
Revision examples: './@127', 'foo/@', '../@1'
1116
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1117
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1120
merge refuses to run if there are any uncommitted changes, unless
1123
takes_args = ['other_spec', 'base_spec?']
1124
takes_options = ['force']
1126
def run(self, other_spec, base_spec=None, force=False):
1127
from bzrlib.merge import merge
1128
merge(parse_spec(other_spec), parse_spec(base_spec),
1129
check_clean=(not force))
1132
class cmd_revert(Command):
1133
"""Reverse all changes since the last commit.
1135
Only versioned files are affected.
1137
TODO: Store backups of any files that will be reverted, so
1138
that the revert can be undone.
1140
takes_options = ['revision']
1142
def run(self, revision=-1):
1143
merge(('.', revision), parse_spec('.'),
1148
class cmd_assert_fail(Command):
1149
"""Test reporting of assertion failures"""
1152
assert False, "always fails"
1155
class cmd_help(Command):
1156
"""Show help on a command or other topic.
1158
For a list of all available commands, say 'bzr help commands'."""
1159
takes_args = ['topic?']
1162
def run(self, topic=None):
1167
class cmd_update_stat_cache(Command):
1168
"""Update stat-cache mapping inodes to SHA-1 hashes.
1170
For testing only."""
1175
statcache.update_cache(b.base, b.read_working_inventory())
820
1179
# list of all available options; the rhs can be either None for an