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
22
from bzrlib import BZRDIR
23
from bzrlib.commands import Command
24
from bzrlib.branch import Branch
25
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
26
from bzrlib.errors import DivergedBranches
27
from bzrlib.option import Option
28
from bzrlib.revisionspec import RevisionSpec
30
from bzrlib.trace import mutter, note, log_error, warning
31
from bzrlib.workingtree import WorkingTree
34
class cmd_status(Command):
35
"""Display status summary.
37
This reports on versioned and unknown files, reporting them
38
grouped by state. Possible states are:
41
Versioned in the working copy but not in the previous revision.
44
Versioned in the previous revision but removed or deleted
48
Path of this file changed from the previous revision;
49
the text may also have changed. This includes files whose
50
parent directory was renamed.
53
Text has changed since the previous revision.
56
Nothing about this file has changed since the previous revision.
57
Only shown with --all.
60
Not versioned and not matching an ignore pattern.
62
To see ignored files use 'bzr ignored'. For details in the
63
changes to file texts, use 'bzr diff'.
65
If no arguments are specified, the status of the entire working
66
directory is shown. Otherwise, only the status of the specified
67
files or directories is reported. If a directory is given, status
68
is reported for everything inside that directory.
70
If a revision argument is given, the status is calculated against
71
that revision, or between two revisions if two are provided.
73
# XXX: FIXME: bzr status should accept a -r option to show changes
74
# relative to a revision, or between revisions
76
takes_args = ['file*']
77
takes_options = ['all', 'show-ids']
78
aliases = ['st', 'stat']
80
def run(self, all=False, show_ids=False, file_list=None, revision=None):
82
b = Branch.open_containing(file_list[0])
83
tree = WorkingTree(b.base, b)
84
file_list = [tree.relpath(x) for x in file_list]
85
# special case: only one path was given and it's the root
90
b = Branch.open_containing('.')
92
from bzrlib.status import show_status
93
show_status(b, show_unchanged=all, show_ids=show_ids,
94
specific_files=file_list, revision=revision)
97
class cmd_cat_revision(Command):
98
"""Write out metadata for a revision.
100
The revision to print can either be specified by a specific
101
revision identifier, or you can use --revision.
105
takes_args = ['revision_id?']
106
takes_options = ['revision']
108
def run(self, revision_id=None, revision=None):
110
if revision_id is not None and revision is not None:
111
raise BzrCommandError('You can only supply one of revision_id or --revision')
112
if revision_id is None and revision is None:
113
raise BzrCommandError('You must supply either --revision or a revision_id')
114
b = Branch.open_containing('.')
115
if revision_id is not None:
116
sys.stdout.write(b.get_revision_xml_file(revision_id).read())
117
elif revision is not None:
120
raise BzrCommandError('You cannot specify a NULL revision.')
121
revno, rev_id = rev.in_history(b)
122
sys.stdout.write(b.get_revision_xml_file(rev_id).read())
125
class cmd_revno(Command):
126
"""Show current revision number.
128
This is equal to the number of revisions on this branch."""
130
print Branch.open_containing('.').revno()
133
class cmd_revision_info(Command):
134
"""Show revision number and revision id for a given revision identifier.
137
takes_args = ['revision_info*']
138
takes_options = ['revision']
139
def run(self, revision=None, revision_info_list=[]):
142
if revision is not None:
143
revs.extend(revision)
144
if revision_info_list is not None:
145
for rev in revision_info_list:
146
revs.append(RevisionSpec(rev))
148
raise BzrCommandError('You must supply a revision identifier')
150
b = Branch.open_containing('.')
153
revinfo = rev.in_history(b)
154
if revinfo.revno is None:
155
print ' %s' % revinfo.rev_id
157
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
160
class cmd_add(Command):
161
"""Add specified files or directories.
163
In non-recursive mode, all the named items are added, regardless
164
of whether they were previously ignored. A warning is given if
165
any of the named files are already versioned.
167
In recursive mode (the default), files are treated the same way
168
but the behaviour for directories is different. Directories that
169
are already versioned do not give a warning. All directories,
170
whether already versioned or not, are searched for files or
171
subdirectories that are neither versioned or ignored, and these
172
are added. This search proceeds recursively into versioned
173
directories. If no names are given '.' is assumed.
175
Therefore simply saying 'bzr add' will version all files that
176
are currently unknown.
178
Adding a file whose parent directory is not versioned will
179
implicitly add the parent, and so on up to the root. This means
180
you should never need to explictly add a directory, they'll just
181
get added when you add a file in the directory.
183
takes_args = ['file*']
184
takes_options = ['no-recurse', 'quiet']
186
def run(self, file_list, no_recurse=False, quiet=False):
187
from bzrlib.add import smart_add, add_reporter_print, add_reporter_null
189
reporter = add_reporter_null
191
reporter = add_reporter_print
192
smart_add(file_list, not no_recurse, reporter)
195
class cmd_mkdir(Command):
196
"""Create a new versioned directory.
198
This is equivalent to creating the directory and then adding it.
200
takes_args = ['dir+']
202
def run(self, dir_list):
208
b = Branch.open_containing(d)
213
class cmd_relpath(Command):
214
"""Show path of a file relative to root"""
215
takes_args = ['filename']
218
def run(self, filename):
219
branch = Branch.open_containing(filename)
220
print WorkingTree(branch.base, branch).relpath(filename)
223
class cmd_inventory(Command):
224
"""Show inventory of the current working copy or a revision."""
225
takes_options = ['revision', 'show-ids']
227
def run(self, revision=None, show_ids=False):
228
b = Branch.open_containing('.')
230
inv = b.read_working_inventory()
232
if len(revision) > 1:
233
raise BzrCommandError('bzr inventory --revision takes'
234
' exactly one revision identifier')
235
inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
237
for path, entry in inv.entries():
239
print '%-50s %s' % (path, entry.file_id)
244
class cmd_move(Command):
245
"""Move files to a different directory.
250
The destination must be a versioned directory in the same branch.
252
takes_args = ['source$', 'dest']
253
def run(self, source_list, dest):
254
b = Branch.open_containing('.')
256
# TODO: glob expansion on windows?
257
tree = WorkingTree(b.base, b)
258
b.move([tree.relpath(s) for s in source_list], tree.relpath(dest))
261
class cmd_rename(Command):
262
"""Change the name of an entry.
265
bzr rename frob.c frobber.c
266
bzr rename src/frob.c lib/frob.c
268
It is an error if the destination name exists.
270
See also the 'move' command, which moves files into a different
271
directory without changing their name.
273
# TODO: Some way to rename multiple files without invoking
274
# bzr for each one?"""
275
takes_args = ['from_name', 'to_name']
277
def run(self, from_name, to_name):
278
b = Branch.open_containing('.')
279
tree = WorkingTree(b.base, b)
280
b.rename_one(tree.relpath(from_name), tree.relpath(to_name))
283
class cmd_mv(Command):
284
"""Move or rename a file.
287
bzr mv OLDNAME NEWNAME
288
bzr mv SOURCE... DESTINATION
290
If the last argument is a versioned directory, all the other names
291
are moved into it. Otherwise, there must be exactly two arguments
292
and the file is changed to a new name, which must not already exist.
294
Files cannot be moved between branches.
296
takes_args = ['names*']
297
def run(self, names_list):
298
if len(names_list) < 2:
299
raise BzrCommandError("missing file argument")
300
b = Branch.open_containing(names_list[0])
301
tree = WorkingTree(b.base, b)
302
rel_names = [tree.relpath(x) for x in names_list]
304
if os.path.isdir(names_list[-1]):
305
# move into existing directory
306
for pair in b.move(rel_names[:-1], rel_names[-1]):
307
print "%s => %s" % pair
309
if len(names_list) != 2:
310
raise BzrCommandError('to mv multiple files the destination '
311
'must be a versioned directory')
312
b.rename_one(rel_names[0], rel_names[1])
313
print "%s => %s" % (rel_names[0], rel_names[1])
318
class cmd_pull(Command):
319
"""Pull any changes from another branch into the current one.
321
If the location is omitted, the last-used location will be used.
322
Both the revision history and the working directory will be
325
This command only works on branches that have not diverged. Branches are
326
considered diverged if both branches have had commits without first
327
pulling from the other.
329
If branches have diverged, you can use 'bzr merge' to pull the text changes
330
from one into the other.
332
takes_options = ['remember']
333
takes_args = ['location?']
335
def run(self, location=None, remember=False):
336
from bzrlib.merge import merge
338
from shutil import rmtree
341
br_to = Branch.open_containing('.')
342
stored_loc = br_to.get_parent()
344
if stored_loc is None:
345
raise BzrCommandError("No pull location known or specified.")
347
print "Using saved location: %s" % stored_loc
348
location = stored_loc
349
cache_root = tempfile.mkdtemp()
350
br_from = Branch.open(location)
353
br_from.setup_caching(cache_root)
354
location = br_from.base
355
old_revno = br_to.revno()
356
old_revision_history = br_to.revision_history()
358
br_to.update_revisions(br_from)
359
except DivergedBranches:
360
raise BzrCommandError("These branches have diverged."
362
new_revision_history = br_to.revision_history()
363
if new_revision_history != old_revision_history:
364
merge(('.', -1), ('.', old_revno), check_clean=False)
365
if stored_loc is None or remember:
366
br_to.set_parent(location)
373
class cmd_branch(Command):
374
"""Create a new copy of a branch.
376
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
377
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
379
To retrieve the branch as of a particular revision, supply the --revision
380
parameter, as in "branch foo/bar -r 5".
382
--basis is to speed up branching from remote branches. When specified, it
383
copies all the file-contents, inventory and revision data from the basis
384
branch before copying anything from the remote branch.
386
takes_args = ['from_location', 'to_location?']
387
takes_options = ['revision', 'basis']
388
aliases = ['get', 'clone']
390
def run(self, from_location, to_location=None, revision=None, basis=None):
391
from bzrlib.clone import copy_branch
394
from shutil import rmtree
395
cache_root = tempfile.mkdtemp()
398
elif len(revision) > 1:
399
raise BzrCommandError(
400
'bzr branch --revision takes exactly 1 revision value')
402
br_from = Branch.open(from_location)
404
if e.errno == errno.ENOENT:
405
raise BzrCommandError('Source location "%s" does not'
406
' exist.' % to_location)
411
br_from.setup_caching(cache_root)
412
if basis is not None:
413
basis_branch = Branch.open_containing(basis)
416
if len(revision) == 1 and revision[0] is not None:
417
revision_id = revision[0].in_history(br_from)[1]
420
if to_location is None:
421
to_location = os.path.basename(from_location.rstrip("/\\"))
423
os.mkdir(to_location)
425
if e.errno == errno.EEXIST:
426
raise BzrCommandError('Target directory "%s" already'
427
' exists.' % to_location)
428
if e.errno == errno.ENOENT:
429
raise BzrCommandError('Parent of "%s" does not exist.' %
434
copy_branch(br_from, to_location, revision_id, basis_branch)
435
except bzrlib.errors.NoSuchRevision:
437
msg = "The branch %s has no revision %d." % (from_location, revision[0])
438
raise BzrCommandError(msg)
439
except bzrlib.errors.UnlistableBranch:
440
msg = "The branch %s cannot be used as a --basis"
446
class cmd_renames(Command):
447
"""Show list of renamed files.
449
# TODO: Option to show renames between two historical versions.
451
# TODO: Only show renames under dir, rather than in the whole branch.
452
takes_args = ['dir?']
454
def run(self, dir='.'):
455
b = Branch.open_containing(dir)
456
old_inv = b.basis_tree().inventory
457
new_inv = b.read_working_inventory()
459
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
461
for old_name, new_name in renames:
462
print "%s => %s" % (old_name, new_name)
465
class cmd_info(Command):
466
"""Show statistical information about a branch."""
467
takes_args = ['branch?']
469
def run(self, branch=None):
471
b = Branch.open_containing(branch)
475
class cmd_remove(Command):
476
"""Make a file unversioned.
478
This makes bzr stop tracking changes to a versioned file. It does
479
not delete the working copy.
481
takes_args = ['file+']
482
takes_options = ['verbose']
485
def run(self, file_list, verbose=False):
486
b = Branch.open_containing(file_list[0])
487
tree = WorkingTree(b.base, b)
488
b.remove([tree.relpath(f) for f in file_list], verbose=verbose)
491
class cmd_file_id(Command):
492
"""Print file_id of a particular file or directory.
494
The file_id is assigned when the file is first added and remains the
495
same through all revisions where the file exists, even when it is
499
takes_args = ['filename']
500
def run(self, filename):
501
b = Branch.open_containing(filename)
502
tree = WorkingTree(b.base, b)
503
i = b.inventory.path2id(tree.relpath(filename))
505
raise BzrError("%r is not a versioned file" % filename)
510
class cmd_file_path(Command):
511
"""Print path of file_ids to a file or directory.
513
This prints one line for each directory down to the target,
514
starting at the branch root."""
516
takes_args = ['filename']
517
def run(self, filename):
518
b = Branch.open_containing(filename)
520
tree = WorkingTree(b.base, b)
521
fid = inv.path2id(tree.relpath(filename))
523
raise BzrError("%r is not a versioned file" % filename)
524
for fip in inv.get_idpath(fid):
528
class cmd_revision_history(Command):
529
"""Display list of revision ids on this branch."""
532
for patchid in Branch.open_containing('.').revision_history():
536
class cmd_ancestry(Command):
537
"""List all revisions merged into this branch."""
541
for revision_id in b.get_ancestry(b.last_revision()):
545
class cmd_directories(Command):
546
"""Display list of versioned directories in this branch."""
548
for name, ie in Branch.open_containing('.').read_working_inventory().directories():
555
class cmd_init(Command):
556
"""Make a directory into a versioned branch.
558
Use this to create an empty branch, or before importing an
561
Recipe for importing a tree of files:
566
bzr commit -m 'imported project'
569
Branch.initialize('.')
572
class cmd_diff(Command):
573
"""Show differences in working tree.
575
If files are listed, only the changes in those files are listed.
576
Otherwise, all changes for the tree are listed.
583
# TODO: Allow diff across branches.
584
# TODO: Option to use external diff command; could be GNU diff, wdiff,
585
# or a graphical diff.
587
# TODO: Python difflib is not exactly the same as unidiff; should
588
# either fix it up or prefer to use an external diff.
590
# TODO: If a directory is given, diff everything under that.
592
# TODO: Selected-file diff is inefficient and doesn't show you
595
# TODO: This probably handles non-Unix newlines poorly.
597
takes_args = ['file*']
598
takes_options = ['revision', 'diff-options']
599
aliases = ['di', 'dif']
601
def run(self, revision=None, file_list=None, diff_options=None):
602
from bzrlib.diff import show_diff
605
b = Branch.open_containing(file_list[0])
606
tree = WorkingTree(b.base, b)
607
file_list = [tree.relpath(f) for f in file_list]
608
if file_list == ['']:
609
# just pointing to top-of-tree
612
b = Branch.open_containing('.')
614
if revision is not None:
615
if len(revision) == 1:
616
show_diff(b, revision[0], specific_files=file_list,
617
external_diff_options=diff_options)
618
elif len(revision) == 2:
619
show_diff(b, revision[0], specific_files=file_list,
620
external_diff_options=diff_options,
621
revision2=revision[1])
623
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
625
show_diff(b, None, specific_files=file_list,
626
external_diff_options=diff_options)
631
class cmd_deleted(Command):
632
"""List files deleted in the working tree.
634
# TODO: Show files deleted since a previous revision, or
635
# between two revisions.
636
# TODO: Much more efficient way to do this: read in new
637
# directories with readdir, rather than stating each one. Same
638
# level of effort but possibly much less IO. (Or possibly not,
639
# if the directories are very large...)
640
def run(self, show_ids=False):
641
b = Branch.open_containing('.')
643
new = b.working_tree()
644
for path, ie in old.inventory.iter_entries():
645
if not new.has_id(ie.file_id):
647
print '%-50s %s' % (path, ie.file_id)
652
class cmd_modified(Command):
653
"""List files modified in working tree."""
656
from bzrlib.delta import compare_trees
658
b = Branch.open_containing('.')
659
td = compare_trees(b.basis_tree(), b.working_tree())
661
for path, id, kind, text_modified, meta_modified in td.modified:
666
class cmd_added(Command):
667
"""List files added in working tree."""
670
b = Branch.open_containing('.')
671
wt = b.working_tree()
672
basis_inv = b.basis_tree().inventory
675
if file_id in basis_inv:
677
path = inv.id2path(file_id)
678
if not os.access(b.abspath(path), os.F_OK):
684
class cmd_root(Command):
685
"""Show the tree root directory.
687
The root is the nearest enclosing directory with a .bzr control
689
takes_args = ['filename?']
690
def run(self, filename=None):
691
"""Print the branch root."""
692
b = Branch.open_containing(filename)
696
class cmd_log(Command):
697
"""Show log of this branch.
699
To request a range of logs, you can use the command -r begin:end
700
-r revision requests a specific revision, -r :end or -r begin: are
704
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
706
takes_args = ['filename?']
707
takes_options = [Option('forward',
708
help='show from oldest to newest'),
709
'timezone', 'verbose',
710
'show-ids', 'revision',
711
Option('line', help='format with one line per revision'),
714
help='show revisions whose message matches this regexp',
716
Option('short', help='use moderately short format'),
719
def run(self, filename=None, timezone='original',
728
from bzrlib.log import log_formatter, show_log
730
assert message is None or isinstance(message, basestring), \
731
"invalid message argument %r" % message
732
direction = (forward and 'forward') or 'reverse'
735
b = Branch.open_containing(filename)
736
tree = WorkingTree(b.base, b)
737
fp = tree.relpath(filename)
739
file_id = b.read_working_inventory().path2id(fp)
741
file_id = None # points to branch root
743
b = Branch.open_containing('.')
749
elif len(revision) == 1:
750
rev1 = rev2 = revision[0].in_history(b).revno
751
elif len(revision) == 2:
752
rev1 = revision[0].in_history(b).revno
753
rev2 = revision[1].in_history(b).revno
755
raise BzrCommandError('bzr log --revision takes one or two values.')
762
mutter('encoding log as %r' % bzrlib.user_encoding)
764
# use 'replace' so that we don't abort if trying to write out
765
# in e.g. the default C locale.
766
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
773
lf = log_formatter(log_format,
776
show_timezone=timezone)
789
class cmd_touching_revisions(Command):
790
"""Return revision-ids which affected a particular file.
792
A more user-friendly interface is "bzr log FILE"."""
794
takes_args = ["filename"]
795
def run(self, filename):
796
b = Branch.open_containing(filename)
797
inv = b.read_working_inventory()
798
tree = WorkingTree(b.base, b)
799
file_id = inv.path2id(tree.relpath(filename))
800
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
801
print "%6d %s" % (revno, what)
804
class cmd_ls(Command):
805
"""List files in a tree.
807
# TODO: Take a revision or remote path and list that tree instead.
809
def run(self, revision=None, verbose=False):
810
b = Branch.open_containing('.')
812
tree = b.working_tree()
814
tree = b.revision_tree(revision.in_history(b).rev_id)
815
for fp, fc, kind, fid, entry in tree.list_files():
817
kindch = entry.kind_character()
818
print '%-8s %s%s' % (fc, fp, kindch)
824
class cmd_unknowns(Command):
825
"""List unknown files."""
827
from bzrlib.osutils import quotefn
828
for f in Branch.open_containing('.').unknowns():
833
class cmd_ignore(Command):
834
"""Ignore a command or pattern.
836
To remove patterns from the ignore list, edit the .bzrignore file.
838
If the pattern contains a slash, it is compared to the whole path
839
from the branch root. Otherwise, it is compared to only the last
840
component of the path. To match a file only in the root directory,
843
Ignore patterns are case-insensitive on case-insensitive systems.
845
Note: wildcards must be quoted from the shell on Unix.
848
bzr ignore ./Makefile
851
# TODO: Complain if the filename is absolute
852
takes_args = ['name_pattern']
854
def run(self, name_pattern):
855
from bzrlib.atomicfile import AtomicFile
858
b = Branch.open_containing('.')
859
ifn = b.abspath('.bzrignore')
861
if os.path.exists(ifn):
864
igns = f.read().decode('utf-8')
870
# TODO: If the file already uses crlf-style termination, maybe
871
# we should use that for the newly added lines?
873
if igns and igns[-1] != '\n':
875
igns += name_pattern + '\n'
878
f = AtomicFile(ifn, 'wt')
879
f.write(igns.encode('utf-8'))
884
inv = b.working_tree().inventory
885
if inv.path2id('.bzrignore'):
886
mutter('.bzrignore is already versioned')
888
mutter('need to make new .bzrignore file versioned')
889
b.add(['.bzrignore'])
893
class cmd_ignored(Command):
894
"""List ignored files and the patterns that matched them.
896
See also: bzr ignore"""
898
tree = Branch.open_containing('.').working_tree()
899
for path, file_class, kind, file_id, entry in tree.list_files():
900
if file_class != 'I':
902
## XXX: Slightly inefficient since this was already calculated
903
pat = tree.is_ignored(path)
904
print '%-50s %s' % (path, pat)
907
class cmd_lookup_revision(Command):
908
"""Lookup the revision-id from a revision-number
911
bzr lookup-revision 33
914
takes_args = ['revno']
916
def run(self, revno):
920
raise BzrCommandError("not a valid revision-number: %r" % revno)
922
print Branch.open_containing('.').get_rev_id(revno)
925
class cmd_export(Command):
926
"""Export past revision to destination directory.
928
If no revision is specified this exports the last committed revision.
930
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
931
given, try to find the format with the extension. If no extension
932
is found exports to a directory (equivalent to --format=dir).
934
Root may be the top directory for tar, tgz and tbz2 formats. If none
935
is given, the top directory will be the root name of the file."""
936
# TODO: list known exporters
937
takes_args = ['dest']
938
takes_options = ['revision', 'format', 'root']
939
def run(self, dest, revision=None, format=None, root=None):
941
b = Branch.open_containing('.')
943
rev_id = b.last_revision()
945
if len(revision) != 1:
946
raise BzrError('bzr export --revision takes exactly 1 argument')
947
rev_id = revision[0].in_history(b).rev_id
948
t = b.revision_tree(rev_id)
949
arg_root, ext = os.path.splitext(os.path.basename(dest))
950
if ext in ('.gz', '.bz2'):
951
new_root, new_ext = os.path.splitext(arg_root)
952
if new_ext == '.tar':
960
elif ext in (".tar.gz", ".tgz"):
962
elif ext in (".tar.bz2", ".tbz2"):
966
t.export(dest, format, root)
969
class cmd_cat(Command):
970
"""Write a file's text from a previous revision."""
972
takes_options = ['revision']
973
takes_args = ['filename']
975
def run(self, filename, revision=None):
977
raise BzrCommandError("bzr cat requires a revision number")
978
elif len(revision) != 1:
979
raise BzrCommandError("bzr cat --revision takes exactly one number")
980
b = Branch.open_containing('.')
981
tree = WorkingTree(b.base, b)
982
b.print_file(tree.relpath(filename), revision[0].in_history(b).revno)
985
class cmd_local_time_offset(Command):
986
"""Show the offset in seconds from GMT to local time."""
989
print bzrlib.osutils.local_time_offset()
993
class cmd_commit(Command):
994
"""Commit changes into a new revision.
996
If no arguments are given, the entire tree is committed.
998
If selected files are specified, only changes to those files are
999
committed. If a directory is specified then the directory and everything
1000
within it is committed.
1002
A selected-file commit may fail in some cases where the committed
1003
tree would be invalid, such as trying to commit a file in a
1004
newly-added directory that is not itself committed.
1006
# TODO: Run hooks on tree to-be-committed, and after commit.
1008
# TODO: Strict commit that fails if there are unknown or deleted files.
1009
# TODO: Give better message for -s, --summary, used by tla people
1011
# XXX: verbose currently does nothing
1013
takes_args = ['selected*']
1014
takes_options = ['message', 'verbose',
1016
help='commit even if nothing has changed'),
1017
Option('file', type=str,
1019
help='file containing commit message'),
1021
aliases = ['ci', 'checkin']
1023
def run(self, message=None, file=None, verbose=True, selected_list=None,
1025
from bzrlib.errors import PointlessCommit, ConflictsInTree
1026
from bzrlib.msgeditor import edit_commit_message
1027
from bzrlib.status import show_status
1028
from cStringIO import StringIO
1030
b = Branch.open_containing('.')
1031
tree = WorkingTree(b.base, b)
1033
selected_list = [tree.relpath(s) for s in selected_list]
1034
if message is None and not file:
1035
catcher = StringIO()
1036
show_status(b, specific_files=selected_list,
1038
message = edit_commit_message(catcher.getvalue())
1041
raise BzrCommandError("please specify a commit message"
1042
" with either --message or --file")
1043
elif message and file:
1044
raise BzrCommandError("please specify either --message or --file")
1048
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1051
raise BzrCommandError("empty commit message specified")
1055
specific_files=selected_list,
1056
allow_pointless=unchanged)
1057
except PointlessCommit:
1058
# FIXME: This should really happen before the file is read in;
1059
# perhaps prepare the commit; get the message; then actually commit
1060
raise BzrCommandError("no changes to commit",
1061
["use --unchanged to commit anyhow"])
1062
except ConflictsInTree:
1063
raise BzrCommandError("Conflicts detected in working tree. "
1064
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1067
class cmd_check(Command):
1068
"""Validate consistency of branch history.
1070
This command checks various invariants about the branch storage to
1071
detect data corruption or bzr bugs.
1073
takes_args = ['dir?']
1074
takes_options = ['verbose']
1076
def run(self, dir='.', verbose=False):
1077
from bzrlib.check import check
1078
check(Branch.open_containing(dir), verbose)
1081
class cmd_scan_cache(Command):
1084
from bzrlib.hashcache import HashCache
1090
print '%6d stats' % c.stat_count
1091
print '%6d in hashcache' % len(c._cache)
1092
print '%6d files removed from cache' % c.removed_count
1093
print '%6d hashes updated' % c.update_count
1094
print '%6d files changed too recently to cache' % c.danger_count
1101
class cmd_upgrade(Command):
1102
"""Upgrade branch storage to current format.
1104
The check command or bzr developers may sometimes advise you to run
1107
This version of this command upgrades from the full-text storage
1108
used by bzr 0.0.8 and earlier to the weave format (v5).
1110
takes_args = ['dir?']
1112
def run(self, dir='.'):
1113
from bzrlib.upgrade import upgrade
1117
class cmd_whoami(Command):
1118
"""Show bzr user id."""
1119
takes_options = ['email']
1121
def run(self, email=False):
1123
b = bzrlib.branch.Branch.open_containing('.')
1124
config = bzrlib.config.BranchConfig(b)
1125
except NotBranchError:
1126
config = bzrlib.config.GlobalConfig()
1129
print config.user_email()
1131
print config.username()
1134
class cmd_selftest(Command):
1135
"""Run internal test suite.
1137
This creates temporary test directories in the working directory,
1138
but not existing data is affected. These directories are deleted
1139
if the tests pass, or left behind to help in debugging if they
1142
If arguments are given, they are regular expressions that say
1143
which tests should run.
1145
# TODO: --list should give a list of all available tests
1147
takes_args = ['testspecs*']
1148
takes_options = ['verbose',
1149
Option('one', help='stop when one test fails'),
1152
def run(self, testspecs_list=None, verbose=False, one=False):
1154
from bzrlib.selftest import selftest
1155
# we don't want progress meters from the tests to go to the
1156
# real output; and we don't want log messages cluttering up
1158
save_ui = bzrlib.ui.ui_factory
1159
bzrlib.trace.info('running tests...')
1161
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1162
if testspecs_list is not None:
1163
pattern = '|'.join(testspecs_list)
1166
result = selftest(verbose=verbose,
1168
stop_on_failure=one)
1170
bzrlib.trace.info('tests passed')
1172
bzrlib.trace.info('tests failed')
1173
return int(not result)
1175
bzrlib.ui.ui_factory = save_ui
1179
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1180
# is bzrlib itself in a branch?
1181
bzrrev = bzrlib.get_bzr_revision()
1183
print " (bzr checkout, revision %d {%s})" % bzrrev
1184
print bzrlib.__copyright__
1185
print "http://bazaar-ng.org/"
1187
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1188
print "you may use, modify and redistribute it under the terms of the GNU"
1189
print "General Public License version 2 or later."
1192
class cmd_version(Command):
1193
"""Show version of bzr."""
1197
class cmd_rocks(Command):
1198
"""Statement of optimism."""
1201
print "it sure does!"
1204
class cmd_find_merge_base(Command):
1205
"""Find and print a base revision for merging two branches.
1207
# TODO: Options to specify revisions on either side, as if
1208
# merging only part of the history.
1209
takes_args = ['branch', 'other']
1212
def run(self, branch, other):
1213
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1215
branch1 = Branch.open_containing(branch)
1216
branch2 = Branch.open_containing(other)
1218
history_1 = branch1.revision_history()
1219
history_2 = branch2.revision_history()
1221
last1 = branch1.last_revision()
1222
last2 = branch2.last_revision()
1224
source = MultipleRevisionSources(branch1, branch2)
1226
base_rev_id = common_ancestor(last1, last2, source)
1228
print 'merge base is revision %s' % base_rev_id
1232
if base_revno is None:
1233
raise bzrlib.errors.UnrelatedBranches()
1235
print ' r%-6d in %s' % (base_revno, branch)
1237
other_revno = branch2.revision_id_to_revno(base_revid)
1239
print ' r%-6d in %s' % (other_revno, other)
1243
class cmd_merge(Command):
1244
"""Perform a three-way merge.
1246
The branch is the branch you will merge from. By default, it will
1247
merge the latest revision. If you specify a revision, that
1248
revision will be merged. If you specify two revisions, the first
1249
will be used as a BASE, and the second one as OTHER. Revision
1250
numbers are always relative to the specified branch.
1252
By default bzr will try to merge in all new work from the other
1253
branch, automatically determining an appropriate base. If this
1254
fails, you may need to give an explicit base.
1258
To merge the latest revision from bzr.dev
1259
bzr merge ../bzr.dev
1261
To merge changes up to and including revision 82 from bzr.dev
1262
bzr merge -r 82 ../bzr.dev
1264
To merge the changes introduced by 82, without previous changes:
1265
bzr merge -r 81..82 ../bzr.dev
1267
merge refuses to run if there are any uncommitted changes, unless
1270
takes_args = ['branch?']
1271
takes_options = ['revision', 'force', 'merge-type']
1273
def run(self, branch=None, revision=None, force=False,
1275
from bzrlib.merge import merge
1276
from bzrlib.merge_core import ApplyMerge3
1277
if merge_type is None:
1278
merge_type = ApplyMerge3
1280
branch = Branch.open_containing('.').get_parent()
1282
raise BzrCommandError("No merge location known or specified.")
1284
print "Using saved location: %s" % branch
1285
if revision is None or len(revision) < 1:
1287
other = [branch, -1]
1289
if len(revision) == 1:
1291
other = [branch, revision[0].in_history(branch).revno]
1293
assert len(revision) == 2
1294
if None in revision:
1295
raise BzrCommandError(
1296
"Merge doesn't permit that revision specifier.")
1297
b = Branch.open(branch)
1299
base = [branch, revision[0].in_history(b).revno]
1300
other = [branch, revision[1].in_history(b).revno]
1303
merge(other, base, check_clean=(not force), merge_type=merge_type)
1304
except bzrlib.errors.AmbiguousBase, e:
1305
m = ("sorry, bzr can't determine the right merge base yet\n"
1306
"candidates are:\n "
1307
+ "\n ".join(e.bases)
1309
"please specify an explicit base with -r,\n"
1310
"and (if you want) report this to the bzr developers\n")
1314
class cmd_revert(Command):
1315
"""Reverse all changes since the last commit.
1317
Only versioned files are affected. Specify filenames to revert only
1318
those files. By default, any files that are changed will be backed up
1319
first. Backup files have a '~' appended to their name.
1321
takes_options = ['revision', 'no-backup']
1322
takes_args = ['file*']
1323
aliases = ['merge-revert']
1325
def run(self, revision=None, no_backup=False, file_list=None):
1326
from bzrlib.merge import merge
1327
from bzrlib.commands import parse_spec
1329
if file_list is not None:
1330
if len(file_list) == 0:
1331
raise BzrCommandError("No files specified")
1332
if revision is None:
1334
elif len(revision) != 1:
1335
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1337
b = Branch.open_containing('.')
1338
revno = revision[0].in_history(b).revno
1339
merge(('.', revno), parse_spec('.'),
1342
backup_files=not no_backup,
1343
file_list=file_list)
1345
Branch.open_containing('.').set_pending_merges([])
1348
class cmd_assert_fail(Command):
1349
"""Test reporting of assertion failures"""
1352
assert False, "always fails"
1355
class cmd_help(Command):
1356
"""Show help on a command or other topic.
1358
For a list of all available commands, say 'bzr help commands'."""
1359
takes_options = ['long']
1360
takes_args = ['topic?']
1363
def run(self, topic=None, long=False):
1365
if topic is None and long:
1370
class cmd_shell_complete(Command):
1371
"""Show appropriate completions for context.
1373
For a list of all available commands, say 'bzr shell-complete'."""
1374
takes_args = ['context?']
1378
def run(self, context=None):
1379
import shellcomplete
1380
shellcomplete.shellcomplete(context)
1383
class cmd_fetch(Command):
1384
"""Copy in history from another branch but don't merge it.
1386
This is an internal method used for pull and merge."""
1388
takes_args = ['from_branch', 'to_branch']
1389
def run(self, from_branch, to_branch):
1390
from bzrlib.fetch import Fetcher
1391
from bzrlib.branch import Branch
1392
from_b = Branch(from_branch)
1393
to_b = Branch(to_branch)
1394
Fetcher(to_b, from_b)
1398
class cmd_missing(Command):
1399
"""What is missing in this branch relative to other branch.
1401
# TODO: rewrite this in terms of ancestry so that it shows only
1404
takes_args = ['remote?']
1405
aliases = ['mis', 'miss']
1406
# We don't have to add quiet to the list, because
1407
# unknown options are parsed as booleans
1408
takes_options = ['verbose', 'quiet']
1410
def run(self, remote=None, verbose=False, quiet=False):
1411
from bzrlib.errors import BzrCommandError
1412
from bzrlib.missing import show_missing
1414
if verbose and quiet:
1415
raise BzrCommandError('Cannot pass both quiet and verbose')
1417
b = Branch.open_containing('.')
1418
parent = b.get_parent()
1421
raise BzrCommandError("No missing location known or specified.")
1424
print "Using last location: %s" % parent
1426
elif parent is None:
1427
# We only update parent if it did not exist, missing
1428
# should not change the parent
1429
b.set_parent(remote)
1430
br_remote = Branch.open_containing(remote)
1431
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1434
class cmd_plugins(Command):
1438
import bzrlib.plugin
1439
from inspect import getdoc
1440
for plugin in bzrlib.plugin.all_plugins:
1441
if hasattr(plugin, '__path__'):
1442
print plugin.__path__[0]
1443
elif hasattr(plugin, '__file__'):
1444
print plugin.__file__
1450
print '\t', d.split('\n')[0]
1453
class cmd_testament(Command):
1454
"""Show testament (signing-form) of a revision."""
1455
takes_options = ['revision', 'long']
1456
takes_args = ['branch?']
1457
def run(self, branch='.', revision=None, long=False):
1458
from bzrlib.testament import Testament
1459
b = Branch.open_containing(branch)
1462
if revision is None:
1463
rev_id = b.last_revision()
1465
rev_id = revision[0].in_history(b).rev_id
1466
t = Testament.from_revision(b, rev_id)
1468
sys.stdout.writelines(t.as_text_lines())
1470
sys.stdout.write(t.as_short_text())
1475
class cmd_annotate(Command):
1476
"""Show the origin of each line in a file.
1478
This prints out the given file with an annotation on the left side
1479
indicating which revision, author and date introduced the change.
1481
If the origin is the same for a run of consecutive lines, it is
1482
shown only at the top, unless the --all option is given.
1484
# TODO: annotate directories; showing when each file was last changed
1485
# TODO: annotate a previous version of a file
1486
# TODO: if the working copy is modified, show annotations on that
1487
# with new uncommitted lines marked
1488
aliases = ['blame', 'praise']
1489
takes_args = ['filename']
1490
takes_options = [Option('all', help='show annotations on all lines'),
1491
Option('long', help='show date in annotations'),
1494
def run(self, filename, all=False, long=False):
1495
from bzrlib.annotate import annotate_file
1496
b = Branch.open_containing(filename)
1499
tree = WorkingTree(b.base, b)
1500
rp = tree.relpath(filename)
1501
tree = b.revision_tree(b.last_revision())
1502
file_id = tree.inventory.path2id(rp)
1503
file_version = tree.inventory[file_id].revision
1504
annotate_file(b, file_version, file_id, long, all, sys.stdout)
1509
class cmd_re_sign(Command):
1510
"""Create a digital signature for an existing revision."""
1511
# TODO be able to replace existing ones.
1513
hidden = True # is this right ?
1514
takes_args = ['revision_id?']
1515
takes_options = ['revision']
1517
def run(self, revision_id=None, revision=None):
1518
import bzrlib.config as config
1519
import bzrlib.gpg as gpg
1520
if revision_id is not None and revision is not None:
1521
raise BzrCommandError('You can only supply one of revision_id or --revision')
1522
if revision_id is None and revision is None:
1523
raise BzrCommandError('You must supply either --revision or a revision_id')
1524
b = Branch.open_containing('.')
1525
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
1526
if revision_id is not None:
1527
b.sign_revision(revision_id, gpg_strategy)
1528
elif revision is not None:
1529
for rev in revision:
1531
raise BzrCommandError('You cannot specify a NULL revision.')
1532
revno, rev_id = rev.in_history(b)
1533
b.sign_revision(rev_id, gpg_strategy)
1536
# these get imported and then picked up by the scan for cmd_*
1537
# TODO: Some more consistent way to split command definitions across files;
1538
# we do need to load at least some information about them to know of
1540
from bzrlib.conflicts import cmd_resolve, cmd_conflicts