1
# Copyright (C) 2004, 2005 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
17
# DO NOT change this to cStringIO - it results in control files
19
# FIXIT! (Only deal with byte streams OR unicode at any one layer.)
21
from StringIO import StringIO
26
from bzrlib import BZRDIR
27
from bzrlib.commands import Command, display_command
28
from bzrlib.branch import Branch
29
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
30
from bzrlib.errors import DivergedBranches
31
from bzrlib.option import Option
32
from bzrlib.revisionspec import RevisionSpec
34
from bzrlib.trace import mutter, note, log_error, warning
35
from bzrlib.workingtree import WorkingTree
38
class cmd_status(Command):
39
"""Display status summary.
41
This reports on versioned and unknown files, reporting them
42
grouped by state. Possible states are:
45
Versioned in the working copy but not in the previous revision.
48
Versioned in the previous revision but removed or deleted
52
Path of this file changed from the previous revision;
53
the text may also have changed. This includes files whose
54
parent directory was renamed.
57
Text has changed since the previous revision.
60
Nothing about this file has changed since the previous revision.
61
Only shown with --all.
64
Not versioned and not matching an ignore pattern.
66
To see ignored files use 'bzr ignored'. For details in the
67
changes to file texts, use 'bzr diff'.
69
If no arguments are specified, the status of the entire working
70
directory is shown. Otherwise, only the status of the specified
71
files or directories is reported. If a directory is given, status
72
is reported for everything inside that directory.
74
If a revision argument is given, the status is calculated against
75
that revision, or between two revisions if two are provided.
78
# XXX: FIXME: bzr status should accept a -r option to show changes
79
# relative to a revision, or between revisions
81
# TODO: --no-recurse, --recurse options
83
takes_args = ['file*']
84
takes_options = ['all', 'show-ids']
85
aliases = ['st', 'stat']
88
def run(self, all=False, show_ids=False, file_list=None, revision=None):
90
b, relpath = Branch.open_containing(file_list[0])
91
if relpath == '' and len(file_list) == 1:
94
# generate relative paths.
95
# note that if this is a remote branch, we would want
96
# relpath against the transport. RBC 20051018
97
tree = WorkingTree(b.base, b)
98
file_list = [tree.relpath(x) for x in file_list]
100
b = Branch.open_containing('.')[0]
102
from bzrlib.status import show_status
103
show_status(b, show_unchanged=all, show_ids=show_ids,
104
specific_files=file_list, revision=revision)
107
class cmd_cat_revision(Command):
108
"""Write out metadata for a revision.
110
The revision to print can either be specified by a specific
111
revision identifier, or you can use --revision.
115
takes_args = ['revision_id?']
116
takes_options = ['revision']
119
def run(self, revision_id=None, revision=None):
121
if revision_id is not None and revision is not None:
122
raise BzrCommandError('You can only supply one of revision_id or --revision')
123
if revision_id is None and revision is None:
124
raise BzrCommandError('You must supply either --revision or a revision_id')
125
b = Branch.open_containing('.')[0]
126
if revision_id is not None:
127
sys.stdout.write(b.get_revision_xml_file(revision_id).read())
128
elif revision is not None:
131
raise BzrCommandError('You cannot specify a NULL revision.')
132
revno, rev_id = rev.in_history(b)
133
sys.stdout.write(b.get_revision_xml_file(rev_id).read())
136
class cmd_revno(Command):
137
"""Show current revision number.
139
This is equal to the number of revisions on this branch."""
142
print Branch.open_containing('.')[0].revno()
145
class cmd_revision_info(Command):
146
"""Show revision number and revision id for a given revision identifier.
149
takes_args = ['revision_info*']
150
takes_options = ['revision']
152
def run(self, revision=None, revision_info_list=[]):
155
if revision is not None:
156
revs.extend(revision)
157
if revision_info_list is not None:
158
for rev in revision_info_list:
159
revs.append(RevisionSpec(rev))
161
raise BzrCommandError('You must supply a revision identifier')
163
b = Branch.open_containing('.')[0]
166
revinfo = rev.in_history(b)
167
if revinfo.revno is None:
168
print ' %s' % revinfo.rev_id
170
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
173
class cmd_add(Command):
174
"""Add specified files or directories.
176
In non-recursive mode, all the named items are added, regardless
177
of whether they were previously ignored. A warning is given if
178
any of the named files are already versioned.
180
In recursive mode (the default), files are treated the same way
181
but the behaviour for directories is different. Directories that
182
are already versioned do not give a warning. All directories,
183
whether already versioned or not, are searched for files or
184
subdirectories that are neither versioned or ignored, and these
185
are added. This search proceeds recursively into versioned
186
directories. If no names are given '.' is assumed.
188
Therefore simply saying 'bzr add' will version all files that
189
are currently unknown.
191
Adding a file whose parent directory is not versioned will
192
implicitly add the parent, and so on up to the root. This means
193
you should never need to explictly add a directory, they'll just
194
get added when you add a file in the directory.
196
takes_args = ['file*']
197
takes_options = ['no-recurse', 'quiet']
199
def run(self, file_list, no_recurse=False, quiet=False):
200
from bzrlib.add import smart_add, add_reporter_print, add_reporter_null
202
reporter = add_reporter_null
204
reporter = add_reporter_print
205
smart_add(file_list, not no_recurse, reporter)
208
class cmd_mkdir(Command):
209
"""Create a new versioned directory.
211
This is equivalent to creating the directory and then adding it.
213
takes_args = ['dir+']
215
def run(self, dir_list):
221
b = Branch.open_containing(d)[0]
226
class cmd_relpath(Command):
227
"""Show path of a file relative to root"""
228
takes_args = ['filename']
232
def run(self, filename):
233
branch, relpath = Branch.open_containing(filename)
237
class cmd_inventory(Command):
238
"""Show inventory of the current working copy or a revision."""
239
takes_options = ['revision', 'show-ids']
242
def run(self, revision=None, show_ids=False):
243
b = Branch.open_containing('.')[0]
245
inv = b.read_working_inventory()
247
if len(revision) > 1:
248
raise BzrCommandError('bzr inventory --revision takes'
249
' exactly one revision identifier')
250
inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
252
for path, entry in inv.entries():
254
print '%-50s %s' % (path, entry.file_id)
259
class cmd_move(Command):
260
"""Move files to a different directory.
265
The destination must be a versioned directory in the same branch.
267
takes_args = ['source$', 'dest']
268
def run(self, source_list, dest):
269
b = Branch.open_containing('.')[0]
271
# TODO: glob expansion on windows?
272
tree = WorkingTree(b.base, b)
273
b.move([tree.relpath(s) for s in source_list], tree.relpath(dest))
276
class cmd_rename(Command):
277
"""Change the name of an entry.
280
bzr rename frob.c frobber.c
281
bzr rename src/frob.c lib/frob.c
283
It is an error if the destination name exists.
285
See also the 'move' command, which moves files into a different
286
directory without changing their name.
288
# TODO: Some way to rename multiple files without invoking
289
# bzr for each one?"""
290
takes_args = ['from_name', 'to_name']
292
def run(self, from_name, to_name):
293
b = Branch.open_containing('.')[0]
294
tree = WorkingTree(b.base, b)
295
b.rename_one(tree.relpath(from_name), tree.relpath(to_name))
298
class cmd_mv(Command):
299
"""Move or rename a file.
302
bzr mv OLDNAME NEWNAME
303
bzr mv SOURCE... DESTINATION
305
If the last argument is a versioned directory, all the other names
306
are moved into it. Otherwise, there must be exactly two arguments
307
and the file is changed to a new name, which must not already exist.
309
Files cannot be moved between branches.
311
takes_args = ['names*']
312
def run(self, names_list):
313
if len(names_list) < 2:
314
raise BzrCommandError("missing file argument")
315
b = Branch.open_containing(names_list[0])[0]
316
tree = WorkingTree(b.base, b)
317
rel_names = [tree.relpath(x) for x in names_list]
319
if os.path.isdir(names_list[-1]):
320
# move into existing directory
321
for pair in b.move(rel_names[:-1], rel_names[-1]):
322
print "%s => %s" % pair
324
if len(names_list) != 2:
325
raise BzrCommandError('to mv multiple files the destination '
326
'must be a versioned directory')
327
b.rename_one(rel_names[0], rel_names[1])
328
print "%s => %s" % (rel_names[0], rel_names[1])
333
class cmd_pull(Command):
334
"""Pull any changes from another branch into the current one.
336
If the location is omitted, the last-used location will be used.
337
Both the revision history and the working directory will be
340
This command only works on branches that have not diverged. Branches are
341
considered diverged if both branches have had commits without first
342
pulling from the other.
344
If branches have diverged, you can use 'bzr merge' to pull the text changes
345
from one into the other.
347
takes_options = ['remember', 'clobber']
348
takes_args = ['location?']
350
def run(self, location=None, remember=False, clobber=False):
351
from bzrlib.merge import merge
352
from shutil import rmtree
355
br_to = Branch.open_containing('.')[0]
356
stored_loc = br_to.get_parent()
358
if stored_loc is None:
359
raise BzrCommandError("No pull location known or specified.")
361
print "Using saved location: %s" % stored_loc
362
location = stored_loc
363
br_from = Branch.open(location)
365
br_to.working_tree().pull(br_from, remember, clobber)
366
except DivergedBranches:
367
raise BzrCommandError("These branches have diverged."
371
class cmd_branch(Command):
372
"""Create a new copy of a branch.
374
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
375
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
377
To retrieve the branch as of a particular revision, supply the --revision
378
parameter, as in "branch foo/bar -r 5".
380
--basis is to speed up branching from remote branches. When specified, it
381
copies all the file-contents, inventory and revision data from the basis
382
branch before copying anything from the remote branch.
384
takes_args = ['from_location', 'to_location?']
385
takes_options = ['revision', 'basis']
386
aliases = ['get', 'clone']
388
def run(self, from_location, to_location=None, revision=None, basis=None):
389
from bzrlib.clone import copy_branch
391
from shutil import rmtree
394
elif len(revision) > 1:
395
raise BzrCommandError(
396
'bzr branch --revision takes exactly 1 revision value')
398
br_from = Branch.open(from_location)
400
if e.errno == errno.ENOENT:
401
raise BzrCommandError('Source location "%s" does not'
402
' exist.' % to_location)
407
if basis is not None:
408
basis_branch = Branch.open_containing(basis)[0]
411
if len(revision) == 1 and revision[0] is not None:
412
revision_id = revision[0].in_history(br_from)[1]
415
if to_location is None:
416
to_location = os.path.basename(from_location.rstrip("/\\"))
419
name = os.path.basename(to_location) + '\n'
421
os.mkdir(to_location)
423
if e.errno == errno.EEXIST:
424
raise BzrCommandError('Target directory "%s" already'
425
' exists.' % to_location)
426
if e.errno == errno.ENOENT:
427
raise BzrCommandError('Parent of "%s" does not exist.' %
432
copy_branch(br_from, to_location, revision_id, basis_branch)
433
except bzrlib.errors.NoSuchRevision:
435
msg = "The branch %s has no revision %s." % (from_location, revision[0])
436
raise BzrCommandError(msg)
437
except bzrlib.errors.UnlistableBranch:
439
msg = "The branch %s cannot be used as a --basis"
440
raise BzrCommandError(msg)
442
branch = Branch.open(to_location)
443
name = StringIO(name)
444
branch.put_controlfile('branch-name', name)
449
class cmd_renames(Command):
450
"""Show list of renamed files.
452
# TODO: Option to show renames between two historical versions.
454
# TODO: Only show renames under dir, rather than in the whole branch.
455
takes_args = ['dir?']
458
def run(self, dir='.'):
459
b = Branch.open_containing(dir)[0]
460
old_inv = b.basis_tree().inventory
461
new_inv = b.read_working_inventory()
463
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
465
for old_name, new_name in renames:
466
print "%s => %s" % (old_name, new_name)
469
class cmd_info(Command):
470
"""Show statistical information about a branch."""
471
takes_args = ['branch?']
474
def run(self, branch=None):
476
b = Branch.open_containing(branch)[0]
480
class cmd_remove(Command):
481
"""Make a file unversioned.
483
This makes bzr stop tracking changes to a versioned file. It does
484
not delete the working copy.
486
takes_args = ['file+']
487
takes_options = ['verbose']
490
def run(self, file_list, verbose=False):
491
b = Branch.open_containing(file_list[0])[0]
492
tree = WorkingTree(b.base, b)
493
tree.remove([tree.relpath(f) for f in file_list], verbose=verbose)
496
class cmd_file_id(Command):
497
"""Print file_id of a particular file or directory.
499
The file_id is assigned when the file is first added and remains the
500
same through all revisions where the file exists, even when it is
504
takes_args = ['filename']
506
def run(self, filename):
507
b, relpath = Branch.open_containing(filename)
508
i = b.inventory.path2id(relpath)
510
raise BzrError("%r is not a versioned file" % filename)
515
class cmd_file_path(Command):
516
"""Print path of file_ids to a file or directory.
518
This prints one line for each directory down to the target,
519
starting at the branch root."""
521
takes_args = ['filename']
523
def run(self, filename):
524
b, relpath = Branch.open_containing(filename)
526
fid = inv.path2id(relpath)
528
raise BzrError("%r is not a versioned file" % filename)
529
for fip in inv.get_idpath(fid):
533
class cmd_revision_history(Command):
534
"""Display list of revision ids on this branch."""
538
for patchid in Branch.open_containing('.')[0].revision_history():
542
class cmd_ancestry(Command):
543
"""List all revisions merged into this branch."""
547
b = Branch.open_containing('.')[0]
548
for revision_id in b.get_ancestry(b.last_revision()):
552
class cmd_directories(Command):
553
"""Display list of versioned directories in this branch."""
556
for name, ie in Branch.open_containing('.')[0].read_working_inventory().directories():
563
class cmd_init(Command):
564
"""Make a directory into a versioned branch.
566
Use this to create an empty branch, or before importing an
569
Recipe for importing a tree of files:
574
bzr commit -m 'imported project'
577
Branch.initialize('.')
580
class cmd_diff(Command):
581
"""Show differences in working tree.
583
If files are listed, only the changes in those files are listed.
584
Otherwise, all changes for the tree are listed.
591
# TODO: Allow diff across branches.
592
# TODO: Option to use external diff command; could be GNU diff, wdiff,
593
# or a graphical diff.
595
# TODO: Python difflib is not exactly the same as unidiff; should
596
# either fix it up or prefer to use an external diff.
598
# TODO: If a directory is given, diff everything under that.
600
# TODO: Selected-file diff is inefficient and doesn't show you
603
# TODO: This probably handles non-Unix newlines poorly.
605
takes_args = ['file*']
606
takes_options = ['revision', 'diff-options']
607
aliases = ['di', 'dif']
610
def run(self, revision=None, file_list=None, diff_options=None):
611
from bzrlib.diff import show_diff
614
b = Branch.open_containing(file_list[0])[0]
615
tree = WorkingTree(b.base, b)
616
file_list = [tree.relpath(f) for f in file_list]
617
if file_list == ['']:
618
# just pointing to top-of-tree
621
b = Branch.open_containing('.')[0]
623
if revision is not None:
624
if len(revision) == 1:
625
show_diff(b, revision[0], specific_files=file_list,
626
external_diff_options=diff_options)
627
elif len(revision) == 2:
628
show_diff(b, revision[0], specific_files=file_list,
629
external_diff_options=diff_options,
630
revision2=revision[1])
632
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
634
show_diff(b, None, specific_files=file_list,
635
external_diff_options=diff_options)
640
class cmd_deleted(Command):
641
"""List files deleted in the working tree.
643
# TODO: Show files deleted since a previous revision, or
644
# between two revisions.
645
# TODO: Much more efficient way to do this: read in new
646
# directories with readdir, rather than stating each one. Same
647
# level of effort but possibly much less IO. (Or possibly not,
648
# if the directories are very large...)
650
def run(self, show_ids=False):
651
b = Branch.open_containing('.')[0]
653
new = b.working_tree()
654
for path, ie in old.inventory.iter_entries():
655
if not new.has_id(ie.file_id):
657
print '%-50s %s' % (path, ie.file_id)
662
class cmd_modified(Command):
663
"""List files modified in working tree."""
667
from bzrlib.delta import compare_trees
669
b = Branch.open_containing('.')[0]
670
td = compare_trees(b.basis_tree(), b.working_tree())
672
for path, id, kind, text_modified, meta_modified in td.modified:
677
class cmd_added(Command):
678
"""List files added in working tree."""
682
b = Branch.open_containing('.')[0]
683
wt = b.working_tree()
684
basis_inv = b.basis_tree().inventory
687
if file_id in basis_inv:
689
path = inv.id2path(file_id)
690
if not os.access(b.abspath(path), os.F_OK):
696
class cmd_root(Command):
697
"""Show the tree root directory.
699
The root is the nearest enclosing directory with a .bzr control
701
takes_args = ['filename?']
703
def run(self, filename=None):
704
"""Print the branch root."""
705
b = Branch.open_containing(filename)[0]
709
class cmd_log(Command):
710
"""Show log of this branch.
712
To request a range of logs, you can use the command -r begin:end
713
-r revision requests a specific revision, -r :end or -r begin: are
717
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
719
takes_args = ['filename?']
720
takes_options = [Option('forward',
721
help='show from oldest to newest'),
722
'timezone', 'verbose',
723
'show-ids', 'revision',
724
Option('line', help='format with one line per revision'),
727
help='show revisions whose message matches this regexp',
729
Option('short', help='use moderately short format'),
732
def run(self, filename=None, timezone='original',
741
from bzrlib.log import log_formatter, show_log
743
assert message is None or isinstance(message, basestring), \
744
"invalid message argument %r" % message
745
direction = (forward and 'forward') or 'reverse'
748
b, fp = Branch.open_containing(filename)
750
file_id = b.read_working_inventory().path2id(fp)
752
file_id = None # points to branch root
754
b, relpath = Branch.open_containing('.')
760
elif len(revision) == 1:
761
rev1 = rev2 = revision[0].in_history(b).revno
762
elif len(revision) == 2:
763
rev1 = revision[0].in_history(b).revno
764
rev2 = revision[1].in_history(b).revno
766
raise BzrCommandError('bzr log --revision takes one or two values.')
773
mutter('encoding log as %r' % bzrlib.user_encoding)
775
# use 'replace' so that we don't abort if trying to write out
776
# in e.g. the default C locale.
777
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
784
lf = log_formatter(log_format,
787
show_timezone=timezone)
800
class cmd_touching_revisions(Command):
801
"""Return revision-ids which affected a particular file.
803
A more user-friendly interface is "bzr log FILE"."""
805
takes_args = ["filename"]
807
def run(self, filename):
808
b, relpath = Branch.open_containing(filename)[0]
809
inv = b.read_working_inventory()
810
file_id = inv.path2id(relpath)
811
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
812
print "%6d %s" % (revno, what)
815
class cmd_ls(Command):
816
"""List files in a tree.
818
# TODO: Take a revision or remote path and list that tree instead.
821
def run(self, revision=None, verbose=False):
822
b, relpath = Branch.open_containing('.')[0]
824
tree = b.working_tree()
826
tree = b.revision_tree(revision.in_history(b).rev_id)
827
for fp, fc, kind, fid, entry in tree.list_files():
829
kindch = entry.kind_character()
830
print '%-8s %s%s' % (fc, fp, kindch)
836
class cmd_unknowns(Command):
837
"""List unknown files."""
840
from bzrlib.osutils import quotefn
841
for f in Branch.open_containing('.')[0].unknowns():
846
class cmd_ignore(Command):
847
"""Ignore a command or pattern.
849
To remove patterns from the ignore list, edit the .bzrignore file.
851
If the pattern contains a slash, it is compared to the whole path
852
from the branch root. Otherwise, it is compared to only the last
853
component of the path. To match a file only in the root directory,
856
Ignore patterns are case-insensitive on case-insensitive systems.
858
Note: wildcards must be quoted from the shell on Unix.
861
bzr ignore ./Makefile
864
# TODO: Complain if the filename is absolute
865
takes_args = ['name_pattern']
867
def run(self, name_pattern):
868
from bzrlib.atomicfile import AtomicFile
871
b, relpath = Branch.open_containing('.')
872
ifn = b.abspath('.bzrignore')
874
if os.path.exists(ifn):
877
igns = f.read().decode('utf-8')
883
# TODO: If the file already uses crlf-style termination, maybe
884
# we should use that for the newly added lines?
886
if igns and igns[-1] != '\n':
888
igns += name_pattern + '\n'
891
f = AtomicFile(ifn, 'wt')
892
f.write(igns.encode('utf-8'))
897
inv = b.working_tree().inventory
898
if inv.path2id('.bzrignore'):
899
mutter('.bzrignore is already versioned')
901
mutter('need to make new .bzrignore file versioned')
902
b.add(['.bzrignore'])
906
class cmd_ignored(Command):
907
"""List ignored files and the patterns that matched them.
909
See also: bzr ignore"""
912
tree = Branch.open_containing('.')[0].working_tree()
913
for path, file_class, kind, file_id, entry 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']
931
def run(self, revno):
935
raise BzrCommandError("not a valid revision-number: %r" % revno)
937
print Branch.open_containing('.')[0].get_rev_id(revno)
940
class cmd_export(Command):
941
"""Export past revision to destination directory.
943
If no revision is specified this exports the last committed revision.
945
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
946
given, try to find the format with the extension. If no extension
947
is found exports to a directory (equivalent to --format=dir).
949
Root may be the top directory for tar, tgz and tbz2 formats. If none
950
is given, the top directory will be the root name of the file."""
951
# TODO: list known exporters
952
takes_args = ['dest']
953
takes_options = ['revision', 'format', 'root']
954
def run(self, dest, revision=None, format=None, root=None):
956
b = Branch.open_containing('.')[0]
958
rev_id = b.last_revision()
960
if len(revision) != 1:
961
raise BzrError('bzr export --revision takes exactly 1 argument')
962
rev_id = revision[0].in_history(b).rev_id
963
t = b.revision_tree(rev_id)
964
arg_root, ext = os.path.splitext(os.path.basename(dest))
965
if ext in ('.gz', '.bz2'):
966
new_root, new_ext = os.path.splitext(arg_root)
967
if new_ext == '.tar':
975
elif ext in (".tar.gz", ".tgz"):
977
elif ext in (".tar.bz2", ".tbz2"):
981
t.export(dest, format, root)
984
class cmd_cat(Command):
985
"""Write a file's text from a previous revision."""
987
takes_options = ['revision']
988
takes_args = ['filename']
991
def run(self, filename, revision=None):
993
raise BzrCommandError("bzr cat requires a revision number")
994
elif len(revision) != 1:
995
raise BzrCommandError("bzr cat --revision takes exactly one number")
996
b, relpath = Branch.open_containing(filename)
997
b.print_file(relpath, revision[0].in_history(b).revno)
1000
class cmd_local_time_offset(Command):
1001
"""Show the offset in seconds from GMT to local time."""
1005
print bzrlib.osutils.local_time_offset()
1009
class cmd_commit(Command):
1010
"""Commit changes into a new revision.
1012
If no arguments are given, the entire tree is committed.
1014
If selected files are specified, only changes to those files are
1015
committed. If a directory is specified then the directory and everything
1016
within it is committed.
1018
A selected-file commit may fail in some cases where the committed
1019
tree would be invalid, such as trying to commit a file in a
1020
newly-added directory that is not itself committed.
1022
# TODO: Run hooks on tree to-be-committed, and after commit.
1024
# TODO: Strict commit that fails if there are deleted files.
1025
# (what does "deleted files" mean ??)
1027
# TODO: Give better message for -s, --summary, used by tla people
1029
# XXX: verbose currently does nothing
1031
takes_args = ['selected*']
1032
takes_options = ['message', 'verbose',
1034
help='commit even if nothing has changed'),
1035
Option('file', type=str,
1037
help='file containing commit message'),
1039
help="refuse to commit if there are unknown "
1040
"files in the working tree."),
1042
aliases = ['ci', 'checkin']
1044
def run(self, message=None, file=None, verbose=True, selected_list=None,
1045
unchanged=False, strict=False):
1046
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1048
from bzrlib.msgeditor import edit_commit_message
1049
from bzrlib.status import show_status
1050
from cStringIO import StringIO
1052
b = Branch.open_containing('.')[0]
1053
tree = WorkingTree(b.base, b)
1055
selected_list = [tree.relpath(s) for s in selected_list]
1056
if message is None and not file:
1057
catcher = StringIO()
1058
show_status(b, specific_files=selected_list,
1060
message = edit_commit_message(catcher.getvalue())
1063
raise BzrCommandError("please specify a commit message"
1064
" with either --message or --file")
1065
elif message and file:
1066
raise BzrCommandError("please specify either --message or --file")
1070
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1073
raise BzrCommandError("empty commit message specified")
1076
b.commit(message, specific_files=selected_list,
1077
allow_pointless=unchanged, strict=strict)
1078
except PointlessCommit:
1079
# FIXME: This should really happen before the file is read in;
1080
# perhaps prepare the commit; get the message; then actually commit
1081
raise BzrCommandError("no changes to commit",
1082
["use --unchanged to commit anyhow"])
1083
except ConflictsInTree:
1084
raise BzrCommandError("Conflicts detected in working tree. "
1085
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1086
except StrictCommitFailed:
1087
raise BzrCommandError("Commit refused because there are unknown "
1088
"files in the working tree.")
1091
class cmd_check(Command):
1092
"""Validate consistency of branch history.
1094
This command checks various invariants about the branch storage to
1095
detect data corruption or bzr bugs.
1097
takes_args = ['dir?']
1098
takes_options = ['verbose']
1100
def run(self, dir='.', verbose=False):
1101
from bzrlib.check import check
1102
check(Branch.open_containing(dir)[0], verbose)
1105
class cmd_scan_cache(Command):
1108
from bzrlib.hashcache import HashCache
1114
print '%6d stats' % c.stat_count
1115
print '%6d in hashcache' % len(c._cache)
1116
print '%6d files removed from cache' % c.removed_count
1117
print '%6d hashes updated' % c.update_count
1118
print '%6d files changed too recently to cache' % c.danger_count
1125
class cmd_upgrade(Command):
1126
"""Upgrade branch storage to current format.
1128
The check command or bzr developers may sometimes advise you to run
1131
This version of this command upgrades from the full-text storage
1132
used by bzr 0.0.8 and earlier to the weave format (v5).
1134
takes_args = ['dir?']
1136
def run(self, dir='.'):
1137
from bzrlib.upgrade import upgrade
1141
class cmd_whoami(Command):
1142
"""Show bzr user id."""
1143
takes_options = ['email']
1146
def run(self, email=False):
1148
b = bzrlib.branch.Branch.open_containing('.')[0]
1149
config = bzrlib.config.BranchConfig(b)
1150
except NotBranchError:
1151
config = bzrlib.config.GlobalConfig()
1154
print config.user_email()
1156
print config.username()
1159
class cmd_selftest(Command):
1160
"""Run internal test suite.
1162
This creates temporary test directories in the working directory,
1163
but not existing data is affected. These directories are deleted
1164
if the tests pass, or left behind to help in debugging if they
1167
If arguments are given, they are regular expressions that say
1168
which tests should run.
1170
# TODO: --list should give a list of all available tests
1172
takes_args = ['testspecs*']
1173
takes_options = ['verbose',
1174
Option('one', help='stop when one test fails'),
1177
def run(self, testspecs_list=None, verbose=False, one=False):
1179
from bzrlib.selftest import selftest
1180
# we don't want progress meters from the tests to go to the
1181
# real output; and we don't want log messages cluttering up
1183
save_ui = bzrlib.ui.ui_factory
1184
bzrlib.trace.info('running tests...')
1186
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1187
if testspecs_list is not None:
1188
pattern = '|'.join(testspecs_list)
1191
result = selftest(verbose=verbose,
1193
stop_on_failure=one)
1195
bzrlib.trace.info('tests passed')
1197
bzrlib.trace.info('tests failed')
1198
return int(not result)
1200
bzrlib.ui.ui_factory = save_ui
1204
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1205
# is bzrlib itself in a branch?
1206
bzrrev = bzrlib.get_bzr_revision()
1208
print " (bzr checkout, revision %d {%s})" % bzrrev
1209
print bzrlib.__copyright__
1210
print "http://bazaar-ng.org/"
1212
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1213
print "you may use, modify and redistribute it under the terms of the GNU"
1214
print "General Public License version 2 or later."
1217
class cmd_version(Command):
1218
"""Show version of bzr."""
1223
class cmd_rocks(Command):
1224
"""Statement of optimism."""
1228
print "it sure does!"
1231
class cmd_find_merge_base(Command):
1232
"""Find and print a base revision for merging two branches.
1234
# TODO: Options to specify revisions on either side, as if
1235
# merging only part of the history.
1236
takes_args = ['branch', 'other']
1240
def run(self, branch, other):
1241
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1243
branch1 = Branch.open_containing(branch)[0]
1244
branch2 = Branch.open_containing(other)[0]
1246
history_1 = branch1.revision_history()
1247
history_2 = branch2.revision_history()
1249
last1 = branch1.last_revision()
1250
last2 = branch2.last_revision()
1252
source = MultipleRevisionSources(branch1, branch2)
1254
base_rev_id = common_ancestor(last1, last2, source)
1256
print 'merge base is revision %s' % base_rev_id
1260
if base_revno is None:
1261
raise bzrlib.errors.UnrelatedBranches()
1263
print ' r%-6d in %s' % (base_revno, branch)
1265
other_revno = branch2.revision_id_to_revno(base_revid)
1267
print ' r%-6d in %s' % (other_revno, other)
1271
class cmd_merge(Command):
1272
"""Perform a three-way merge.
1274
The branch is the branch you will merge from. By default, it will
1275
merge the latest revision. If you specify a revision, that
1276
revision will be merged. If you specify two revisions, the first
1277
will be used as a BASE, and the second one as OTHER. Revision
1278
numbers are always relative to the specified branch.
1280
By default bzr will try to merge in all new work from the other
1281
branch, automatically determining an appropriate base. If this
1282
fails, you may need to give an explicit base.
1286
To merge the latest revision from bzr.dev
1287
bzr merge ../bzr.dev
1289
To merge changes up to and including revision 82 from bzr.dev
1290
bzr merge -r 82 ../bzr.dev
1292
To merge the changes introduced by 82, without previous changes:
1293
bzr merge -r 81..82 ../bzr.dev
1295
merge refuses to run if there are any uncommitted changes, unless
1298
takes_args = ['branch?']
1299
takes_options = ['revision', 'force', 'merge-type',
1300
Option('show-base', help="Show base revision text in "
1303
def run(self, branch=None, revision=None, force=False, merge_type=None,
1305
from bzrlib.merge import merge
1306
from bzrlib.merge_core import ApplyMerge3
1307
if merge_type is None:
1308
merge_type = ApplyMerge3
1310
branch = Branch.open_containing('.')[0].get_parent()
1312
raise BzrCommandError("No merge location known or specified.")
1314
print "Using saved location: %s" % branch
1315
if revision is None or len(revision) < 1:
1317
other = [branch, -1]
1319
if len(revision) == 1:
1321
other_branch = Branch.open_containing(branch)[0]
1322
revno = revision[0].in_history(other_branch).revno
1323
other = [branch, revno]
1325
assert len(revision) == 2
1326
if None in revision:
1327
raise BzrCommandError(
1328
"Merge doesn't permit that revision specifier.")
1329
b = Branch.open_containing(branch)[0]
1331
base = [branch, revision[0].in_history(b).revno]
1332
other = [branch, revision[1].in_history(b).revno]
1335
conflict_count = merge(other, base, check_clean=(not force),
1336
merge_type=merge_type,
1337
show_base=show_base)
1338
if conflict_count != 0:
1342
except bzrlib.errors.AmbiguousBase, e:
1343
m = ("sorry, bzr can't determine the right merge base yet\n"
1344
"candidates are:\n "
1345
+ "\n ".join(e.bases)
1347
"please specify an explicit base with -r,\n"
1348
"and (if you want) report this to the bzr developers\n")
1352
class cmd_revert(Command):
1353
"""Reverse all changes since the last commit.
1355
Only versioned files are affected. Specify filenames to revert only
1356
those files. By default, any files that are changed will be backed up
1357
first. Backup files have a '~' appended to their name.
1359
takes_options = ['revision', 'no-backup']
1360
takes_args = ['file*']
1361
aliases = ['merge-revert']
1363
def run(self, revision=None, no_backup=False, file_list=None):
1364
from bzrlib.merge import merge
1365
from bzrlib.commands import parse_spec
1367
if file_list is not None:
1368
if len(file_list) == 0:
1369
raise BzrCommandError("No files specified")
1370
if revision is None:
1372
elif len(revision) != 1:
1373
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1375
b = Branch.open_containing('.')[0]
1376
revno = revision[0].in_history(b).revno
1377
merge(('.', revno), parse_spec('.'),
1380
backup_files=not no_backup,
1381
file_list=file_list)
1383
Branch.open_containing('.')[0].set_pending_merges([])
1386
class cmd_assert_fail(Command):
1387
"""Test reporting of assertion failures"""
1390
assert False, "always fails"
1393
class cmd_help(Command):
1394
"""Show help on a command or other topic.
1396
For a list of all available commands, say 'bzr help commands'."""
1397
takes_options = ['long']
1398
takes_args = ['topic?']
1402
def run(self, topic=None, long=False):
1404
if topic is None and long:
1409
class cmd_shell_complete(Command):
1410
"""Show appropriate completions for context.
1412
For a list of all available commands, say 'bzr shell-complete'."""
1413
takes_args = ['context?']
1418
def run(self, context=None):
1419
import shellcomplete
1420
shellcomplete.shellcomplete(context)
1423
class cmd_fetch(Command):
1424
"""Copy in history from another branch but don't merge it.
1426
This is an internal method used for pull and merge."""
1428
takes_args = ['from_branch', 'to_branch']
1429
def run(self, from_branch, to_branch):
1430
from bzrlib.fetch import Fetcher
1431
from bzrlib.branch import Branch
1432
from_b = Branch(from_branch)
1433
to_b = Branch(to_branch)
1434
Fetcher(to_b, from_b)
1438
class cmd_missing(Command):
1439
"""What is missing in this branch relative to other branch.
1441
# TODO: rewrite this in terms of ancestry so that it shows only
1444
takes_args = ['remote?']
1445
aliases = ['mis', 'miss']
1446
# We don't have to add quiet to the list, because
1447
# unknown options are parsed as booleans
1448
takes_options = ['verbose', 'quiet']
1451
def run(self, remote=None, verbose=False, quiet=False):
1452
from bzrlib.errors import BzrCommandError
1453
from bzrlib.missing import show_missing
1455
if verbose and quiet:
1456
raise BzrCommandError('Cannot pass both quiet and verbose')
1458
b = Branch.open_containing('.')[0]
1459
parent = b.get_parent()
1462
raise BzrCommandError("No missing location known or specified.")
1465
print "Using last location: %s" % parent
1467
elif parent is None:
1468
# We only update parent if it did not exist, missing
1469
# should not change the parent
1470
b.set_parent(remote)
1471
br_remote = Branch.open_containing(remote)[0]
1472
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1475
class cmd_plugins(Command):
1480
import bzrlib.plugin
1481
from inspect import getdoc
1482
for plugin in bzrlib.plugin.all_plugins:
1483
if hasattr(plugin, '__path__'):
1484
print plugin.__path__[0]
1485
elif hasattr(plugin, '__file__'):
1486
print plugin.__file__
1492
print '\t', d.split('\n')[0]
1495
class cmd_testament(Command):
1496
"""Show testament (signing-form) of a revision."""
1497
takes_options = ['revision', 'long']
1498
takes_args = ['branch?']
1500
def run(self, branch='.', revision=None, long=False):
1501
from bzrlib.testament import Testament
1502
b = Branch.open_containing(branch)[0]
1505
if revision is None:
1506
rev_id = b.last_revision()
1508
rev_id = revision[0].in_history(b).rev_id
1509
t = Testament.from_revision(b, rev_id)
1511
sys.stdout.writelines(t.as_text_lines())
1513
sys.stdout.write(t.as_short_text())
1518
class cmd_annotate(Command):
1519
"""Show the origin of each line in a file.
1521
This prints out the given file with an annotation on the left side
1522
indicating which revision, author and date introduced the change.
1524
If the origin is the same for a run of consecutive lines, it is
1525
shown only at the top, unless the --all option is given.
1527
# TODO: annotate directories; showing when each file was last changed
1528
# TODO: annotate a previous version of a file
1529
# TODO: if the working copy is modified, show annotations on that
1530
# with new uncommitted lines marked
1531
aliases = ['blame', 'praise']
1532
takes_args = ['filename']
1533
takes_options = [Option('all', help='show annotations on all lines'),
1534
Option('long', help='show date in annotations'),
1538
def run(self, filename, all=False, long=False):
1539
from bzrlib.annotate import annotate_file
1540
b, relpath = Branch.open_containing(filename)
1543
tree = WorkingTree(b.base, b)
1544
tree = b.revision_tree(b.last_revision())
1545
file_id = tree.inventory.path2id(relpath)
1546
file_version = tree.inventory[file_id].revision
1547
annotate_file(b, file_version, file_id, long, all, sys.stdout)
1552
class cmd_re_sign(Command):
1553
"""Create a digital signature for an existing revision."""
1554
# TODO be able to replace existing ones.
1556
hidden = True # is this right ?
1557
takes_args = ['revision_id?']
1558
takes_options = ['revision']
1560
def run(self, revision_id=None, revision=None):
1561
import bzrlib.config as config
1562
import bzrlib.gpg as gpg
1563
if revision_id is not None and revision is not None:
1564
raise BzrCommandError('You can only supply one of revision_id or --revision')
1565
if revision_id is None and revision is None:
1566
raise BzrCommandError('You must supply either --revision or a revision_id')
1567
b = Branch.open_containing('.')[0]
1568
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
1569
if revision_id is not None:
1570
b.sign_revision(revision_id, gpg_strategy)
1571
elif revision is not None:
1572
if len(revision) == 1:
1573
revno, rev_id = revision[0].in_history(b)
1574
b.sign_revision(rev_id, gpg_strategy)
1575
elif len(revision) == 2:
1576
# are they both on rh- if so we can walk between them
1577
# might be nice to have a range helper for arbitrary
1578
# revision paths. hmm.
1579
from_revno, from_revid = revision[0].in_history(b)
1580
to_revno, to_revid = revision[1].in_history(b)
1581
if to_revid is None:
1582
to_revno = b.revno()
1583
if from_revno is None or to_revno is None:
1584
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
1585
for revno in range(from_revno, to_revno + 1):
1586
b.sign_revision(b.get_rev_id(revno), gpg_strategy)
1588
raise BzrCommandError('Please supply either one revision, or a range.')
1591
# these get imported and then picked up by the scan for cmd_*
1592
# TODO: Some more consistent way to split command definitions across files;
1593
# we do need to load at least some information about them to know of
1595
from bzrlib.conflicts import cmd_resolve, cmd_conflicts