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, relpath = Branch.open_containing(file_list[0])
83
if relpath == '' and len(file_list) == 1:
86
# generate relative paths.
87
# note that if this is a remote branch, we would want
88
# relpath against the transport. RBC 20051018
89
tree = WorkingTree(b.base, b)
90
file_list = [tree.relpath(x) for x in file_list]
92
b = Branch.open_containing('.')[0]
94
from bzrlib.status import show_status
95
show_status(b, show_unchanged=all, show_ids=show_ids,
96
specific_files=file_list, revision=revision)
99
class cmd_cat_revision(Command):
100
"""Write out metadata for a revision.
102
The revision to print can either be specified by a specific
103
revision identifier, or you can use --revision.
107
takes_args = ['revision_id?']
108
takes_options = ['revision']
110
def run(self, revision_id=None, revision=None):
112
if revision_id is not None and revision is not None:
113
raise BzrCommandError('You can only supply one of revision_id or --revision')
114
if revision_id is None and revision is None:
115
raise BzrCommandError('You must supply either --revision or a revision_id')
116
b = Branch.open_containing('.')[0]
117
if revision_id is not None:
118
sys.stdout.write(b.get_revision_xml_file(revision_id).read())
119
elif revision is not None:
122
raise BzrCommandError('You cannot specify a NULL revision.')
123
revno, rev_id = rev.in_history(b)
124
sys.stdout.write(b.get_revision_xml_file(rev_id).read())
127
class cmd_revno(Command):
128
"""Show current revision number.
130
This is equal to the number of revisions on this branch."""
132
print Branch.open_containing('.')[0].revno()
135
class cmd_revision_info(Command):
136
"""Show revision number and revision id for a given revision identifier.
139
takes_args = ['revision_info*']
140
takes_options = ['revision']
141
def run(self, revision=None, revision_info_list=[]):
144
if revision is not None:
145
revs.extend(revision)
146
if revision_info_list is not None:
147
for rev in revision_info_list:
148
revs.append(RevisionSpec(rev))
150
raise BzrCommandError('You must supply a revision identifier')
152
b = Branch.open_containing('.')[0]
155
revinfo = rev.in_history(b)
156
if revinfo.revno is None:
157
print ' %s' % revinfo.rev_id
159
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
162
class cmd_add(Command):
163
"""Add specified files or directories.
165
In non-recursive mode, all the named items are added, regardless
166
of whether they were previously ignored. A warning is given if
167
any of the named files are already versioned.
169
In recursive mode (the default), files are treated the same way
170
but the behaviour for directories is different. Directories that
171
are already versioned do not give a warning. All directories,
172
whether already versioned or not, are searched for files or
173
subdirectories that are neither versioned or ignored, and these
174
are added. This search proceeds recursively into versioned
175
directories. If no names are given '.' is assumed.
177
Therefore simply saying 'bzr add' will version all files that
178
are currently unknown.
180
Adding a file whose parent directory is not versioned will
181
implicitly add the parent, and so on up to the root. This means
182
you should never need to explictly add a directory, they'll just
183
get added when you add a file in the directory.
185
takes_args = ['file*']
186
takes_options = ['no-recurse', 'quiet']
188
def run(self, file_list, no_recurse=False, quiet=False):
189
from bzrlib.add import smart_add, add_reporter_print, add_reporter_null
191
reporter = add_reporter_null
193
reporter = add_reporter_print
194
smart_add(file_list, not no_recurse, reporter)
197
class cmd_mkdir(Command):
198
"""Create a new versioned directory.
200
This is equivalent to creating the directory and then adding it.
202
takes_args = ['dir+']
204
def run(self, dir_list):
210
b = Branch.open_containing(d)[0]
215
class cmd_relpath(Command):
216
"""Show path of a file relative to root"""
217
takes_args = ['filename']
220
def run(self, filename):
221
branch, relpath = Branch.open_containing(filename)
225
class cmd_inventory(Command):
226
"""Show inventory of the current working copy or a revision."""
227
takes_options = ['revision', 'show-ids']
229
def run(self, revision=None, show_ids=False):
230
b = Branch.open_containing('.')[0]
232
inv = b.read_working_inventory()
234
if len(revision) > 1:
235
raise BzrCommandError('bzr inventory --revision takes'
236
' exactly one revision identifier')
237
inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
239
for path, entry in inv.entries():
241
print '%-50s %s' % (path, entry.file_id)
246
class cmd_move(Command):
247
"""Move files to a different directory.
252
The destination must be a versioned directory in the same branch.
254
takes_args = ['source$', 'dest']
255
def run(self, source_list, dest):
256
b = Branch.open_containing('.')[0]
258
# TODO: glob expansion on windows?
259
tree = WorkingTree(b.base, b)
260
b.move([tree.relpath(s) for s in source_list], tree.relpath(dest))
263
class cmd_rename(Command):
264
"""Change the name of an entry.
267
bzr rename frob.c frobber.c
268
bzr rename src/frob.c lib/frob.c
270
It is an error if the destination name exists.
272
See also the 'move' command, which moves files into a different
273
directory without changing their name.
275
# TODO: Some way to rename multiple files without invoking
276
# bzr for each one?"""
277
takes_args = ['from_name', 'to_name']
279
def run(self, from_name, to_name):
280
b = Branch.open_containing('.')[0]
281
tree = WorkingTree(b.base, b)
282
b.rename_one(tree.relpath(from_name), tree.relpath(to_name))
285
class cmd_mv(Command):
286
"""Move or rename a file.
289
bzr mv OLDNAME NEWNAME
290
bzr mv SOURCE... DESTINATION
292
If the last argument is a versioned directory, all the other names
293
are moved into it. Otherwise, there must be exactly two arguments
294
and the file is changed to a new name, which must not already exist.
296
Files cannot be moved between branches.
298
takes_args = ['names*']
299
def run(self, names_list):
300
if len(names_list) < 2:
301
raise BzrCommandError("missing file argument")
302
b = Branch.open_containing(names_list[0])[0]
303
tree = WorkingTree(b.base, b)
304
rel_names = [tree.relpath(x) for x in names_list]
306
if os.path.isdir(names_list[-1]):
307
# move into existing directory
308
for pair in b.move(rel_names[:-1], rel_names[-1]):
309
print "%s => %s" % pair
311
if len(names_list) != 2:
312
raise BzrCommandError('to mv multiple files the destination '
313
'must be a versioned directory')
314
b.rename_one(rel_names[0], rel_names[1])
315
print "%s => %s" % (rel_names[0], rel_names[1])
320
class cmd_pull(Command):
321
"""Pull any changes from another branch into the current one.
323
If the location is omitted, the last-used location will be used.
324
Both the revision history and the working directory will be
327
This command only works on branches that have not diverged. Branches are
328
considered diverged if both branches have had commits without first
329
pulling from the other.
331
If branches have diverged, you can use 'bzr merge' to pull the text changes
332
from one into the other.
334
takes_options = ['remember']
335
takes_args = ['location?']
337
def run(self, location=None, remember=False):
338
from bzrlib.merge import merge
340
from shutil import rmtree
343
br_to = Branch.open_containing('.')[0]
344
stored_loc = br_to.get_parent()
346
if stored_loc is None:
347
raise BzrCommandError("No pull location known or specified.")
349
print "Using saved location: %s" % stored_loc
350
location = stored_loc
351
cache_root = tempfile.mkdtemp()
352
br_from = Branch.open(location)
355
br_from.setup_caching(cache_root)
356
location = br_from.base
357
old_revno = br_to.revno()
358
old_revision_history = br_to.revision_history()
360
br_to.update_revisions(br_from)
361
except DivergedBranches:
362
raise BzrCommandError("These branches have diverged."
364
new_revision_history = br_to.revision_history()
365
if new_revision_history != old_revision_history:
366
merge(('.', -1), ('.', old_revno), check_clean=False)
367
if stored_loc is None or remember:
368
br_to.set_parent(location)
375
class cmd_branch(Command):
376
"""Create a new copy of a branch.
378
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
379
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
381
To retrieve the branch as of a particular revision, supply the --revision
382
parameter, as in "branch foo/bar -r 5".
384
--basis is to speed up branching from remote branches. When specified, it
385
copies all the file-contents, inventory and revision data from the basis
386
branch before copying anything from the remote branch.
388
takes_args = ['from_location', 'to_location?']
389
takes_options = ['revision', 'basis']
390
aliases = ['get', 'clone']
392
def run(self, from_location, to_location=None, revision=None, basis=None):
393
from bzrlib.clone import copy_branch
396
from shutil import rmtree
397
cache_root = tempfile.mkdtemp()
400
elif len(revision) > 1:
401
raise BzrCommandError(
402
'bzr branch --revision takes exactly 1 revision value')
404
br_from = Branch.open(from_location)
406
if e.errno == errno.ENOENT:
407
raise BzrCommandError('Source location "%s" does not'
408
' exist.' % to_location)
413
br_from.setup_caching(cache_root)
414
if basis is not None:
415
basis_branch = Branch.open_containing(basis)[0]
418
if len(revision) == 1 and revision[0] is not None:
419
revision_id = revision[0].in_history(br_from)[1]
422
if to_location is None:
423
to_location = os.path.basename(from_location.rstrip("/\\"))
425
os.mkdir(to_location)
427
if e.errno == errno.EEXIST:
428
raise BzrCommandError('Target directory "%s" already'
429
' exists.' % to_location)
430
if e.errno == errno.ENOENT:
431
raise BzrCommandError('Parent of "%s" does not exist.' %
436
copy_branch(br_from, to_location, revision_id, basis_branch)
437
except bzrlib.errors.NoSuchRevision:
439
msg = "The branch %s has no revision %d." % (from_location, revision[0])
440
raise BzrCommandError(msg)
441
except bzrlib.errors.UnlistableBranch:
442
msg = "The branch %s cannot be used as a --basis"
448
class cmd_renames(Command):
449
"""Show list of renamed files.
451
# TODO: Option to show renames between two historical versions.
453
# TODO: Only show renames under dir, rather than in the whole branch.
454
takes_args = ['dir?']
456
def run(self, dir='.'):
457
b = Branch.open_containing(dir)[0]
458
old_inv = b.basis_tree().inventory
459
new_inv = b.read_working_inventory()
461
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
463
for old_name, new_name in renames:
464
print "%s => %s" % (old_name, new_name)
467
class cmd_info(Command):
468
"""Show statistical information about a branch."""
469
takes_args = ['branch?']
471
def run(self, branch=None):
473
b = Branch.open_containing(branch)[0]
477
class cmd_remove(Command):
478
"""Make a file unversioned.
480
This makes bzr stop tracking changes to a versioned file. It does
481
not delete the working copy.
483
takes_args = ['file+']
484
takes_options = ['verbose']
487
def run(self, file_list, verbose=False):
488
b = Branch.open_containing(file_list[0])[0]
489
tree = WorkingTree(b.base, b)
490
tree.remove([tree.relpath(f) for f in file_list], verbose=verbose)
493
class cmd_file_id(Command):
494
"""Print file_id of a particular file or directory.
496
The file_id is assigned when the file is first added and remains the
497
same through all revisions where the file exists, even when it is
501
takes_args = ['filename']
502
def run(self, filename):
503
b, relpath = Branch.open_containing(filename)
504
i = b.inventory.path2id(relpath)
506
raise BzrError("%r is not a versioned file" % filename)
511
class cmd_file_path(Command):
512
"""Print path of file_ids to a file or directory.
514
This prints one line for each directory down to the target,
515
starting at the branch root."""
517
takes_args = ['filename']
518
def run(self, filename):
519
b, relpath = Branch.open_containing(filename)
521
fid = inv.path2id(relpath)
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('.')[0].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('.')[0].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])[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('.')[0]
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('.')[0]
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('.')[0]
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('.')[0]
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)[0]
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, fp = Branch.open_containing(filename)
737
file_id = b.read_working_inventory().path2id(fp)
739
file_id = None # points to branch root
741
b, relpath = Branch.open_containing('.')
747
elif len(revision) == 1:
748
rev1 = rev2 = revision[0].in_history(b).revno
749
elif len(revision) == 2:
750
rev1 = revision[0].in_history(b).revno
751
rev2 = revision[1].in_history(b).revno
753
raise BzrCommandError('bzr log --revision takes one or two values.')
760
mutter('encoding log as %r' % bzrlib.user_encoding)
762
# use 'replace' so that we don't abort if trying to write out
763
# in e.g. the default C locale.
764
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
771
lf = log_formatter(log_format,
774
show_timezone=timezone)
787
class cmd_touching_revisions(Command):
788
"""Return revision-ids which affected a particular file.
790
A more user-friendly interface is "bzr log FILE"."""
792
takes_args = ["filename"]
793
def run(self, filename):
794
b, relpath = Branch.open_containing(filename)[0]
795
inv = b.read_working_inventory()
796
file_id = inv.path2id(relpath)
797
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
798
print "%6d %s" % (revno, what)
801
class cmd_ls(Command):
802
"""List files in a tree.
804
# TODO: Take a revision or remote path and list that tree instead.
806
def run(self, revision=None, verbose=False):
807
b, relpath = Branch.open_containing('.')[0]
809
tree = b.working_tree()
811
tree = b.revision_tree(revision.in_history(b).rev_id)
812
for fp, fc, kind, fid, entry in tree.list_files():
814
kindch = entry.kind_character()
815
print '%-8s %s%s' % (fc, fp, kindch)
821
class cmd_unknowns(Command):
822
"""List unknown files."""
824
from bzrlib.osutils import quotefn
825
for f in Branch.open_containing('.')[0].unknowns():
830
class cmd_ignore(Command):
831
"""Ignore a command or pattern.
833
To remove patterns from the ignore list, edit the .bzrignore file.
835
If the pattern contains a slash, it is compared to the whole path
836
from the branch root. Otherwise, it is compared to only the last
837
component of the path. To match a file only in the root directory,
840
Ignore patterns are case-insensitive on case-insensitive systems.
842
Note: wildcards must be quoted from the shell on Unix.
845
bzr ignore ./Makefile
848
# TODO: Complain if the filename is absolute
849
takes_args = ['name_pattern']
851
def run(self, name_pattern):
852
from bzrlib.atomicfile import AtomicFile
855
b, relpath = Branch.open_containing('.')
856
ifn = b.abspath('.bzrignore')
858
if os.path.exists(ifn):
861
igns = f.read().decode('utf-8')
867
# TODO: If the file already uses crlf-style termination, maybe
868
# we should use that for the newly added lines?
870
if igns and igns[-1] != '\n':
872
igns += name_pattern + '\n'
875
f = AtomicFile(ifn, 'wt')
876
f.write(igns.encode('utf-8'))
881
inv = b.working_tree().inventory
882
if inv.path2id('.bzrignore'):
883
mutter('.bzrignore is already versioned')
885
mutter('need to make new .bzrignore file versioned')
886
b.add(['.bzrignore'])
890
class cmd_ignored(Command):
891
"""List ignored files and the patterns that matched them.
893
See also: bzr ignore"""
895
tree = Branch.open_containing('.')[0].working_tree()
896
for path, file_class, kind, file_id, entry in tree.list_files():
897
if file_class != 'I':
899
## XXX: Slightly inefficient since this was already calculated
900
pat = tree.is_ignored(path)
901
print '%-50s %s' % (path, pat)
904
class cmd_lookup_revision(Command):
905
"""Lookup the revision-id from a revision-number
908
bzr lookup-revision 33
911
takes_args = ['revno']
913
def run(self, revno):
917
raise BzrCommandError("not a valid revision-number: %r" % revno)
919
print Branch.open_containing('.')[0].get_rev_id(revno)
922
class cmd_export(Command):
923
"""Export past revision to destination directory.
925
If no revision is specified this exports the last committed revision.
927
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
928
given, try to find the format with the extension. If no extension
929
is found exports to a directory (equivalent to --format=dir).
931
Root may be the top directory for tar, tgz and tbz2 formats. If none
932
is given, the top directory will be the root name of the file."""
933
# TODO: list known exporters
934
takes_args = ['dest']
935
takes_options = ['revision', 'format', 'root']
936
def run(self, dest, revision=None, format=None, root=None):
938
b = Branch.open_containing('.')[0]
940
rev_id = b.last_revision()
942
if len(revision) != 1:
943
raise BzrError('bzr export --revision takes exactly 1 argument')
944
rev_id = revision[0].in_history(b).rev_id
945
t = b.revision_tree(rev_id)
946
arg_root, ext = os.path.splitext(os.path.basename(dest))
947
if ext in ('.gz', '.bz2'):
948
new_root, new_ext = os.path.splitext(arg_root)
949
if new_ext == '.tar':
957
elif ext in (".tar.gz", ".tgz"):
959
elif ext in (".tar.bz2", ".tbz2"):
963
t.export(dest, format, root)
966
class cmd_cat(Command):
967
"""Write a file's text from a previous revision."""
969
takes_options = ['revision']
970
takes_args = ['filename']
972
def run(self, filename, revision=None):
974
raise BzrCommandError("bzr cat requires a revision number")
975
elif len(revision) != 1:
976
raise BzrCommandError("bzr cat --revision takes exactly one number")
977
b, relpath = Branch.open_containing(filename)
978
b.print_file(relpath, revision[0].in_history(b).revno)
981
class cmd_local_time_offset(Command):
982
"""Show the offset in seconds from GMT to local time."""
985
print bzrlib.osutils.local_time_offset()
989
class cmd_commit(Command):
990
"""Commit changes into a new revision.
992
If no arguments are given, the entire tree is committed.
994
If selected files are specified, only changes to those files are
995
committed. If a directory is specified then the directory and everything
996
within it is committed.
998
A selected-file commit may fail in some cases where the committed
999
tree would be invalid, such as trying to commit a file in a
1000
newly-added directory that is not itself committed.
1002
# TODO: Run hooks on tree to-be-committed, and after commit.
1004
# TODO: Strict commit that fails if there are deleted files.
1005
# (what does "deleted files" mean ??)
1007
# TODO: Give better message for -s, --summary, used by tla people
1009
# XXX: verbose currently does nothing
1011
takes_args = ['selected*']
1012
takes_options = ['message', 'verbose',
1014
help='commit even if nothing has changed'),
1015
Option('file', type=str,
1017
help='file containing commit message'),
1019
help="refuse to commit if there are unknown "
1020
"files in the working tree."),
1022
aliases = ['ci', 'checkin']
1024
def run(self, message=None, file=None, verbose=True, selected_list=None,
1025
unchanged=False, strict=False):
1026
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1028
from bzrlib.msgeditor import edit_commit_message
1029
from bzrlib.status import show_status
1030
from cStringIO import StringIO
1032
b = Branch.open_containing('.')[0]
1033
tree = WorkingTree(b.base, b)
1035
selected_list = [tree.relpath(s) for s in selected_list]
1036
if message is None and not file:
1037
catcher = StringIO()
1038
show_status(b, specific_files=selected_list,
1040
message = edit_commit_message(catcher.getvalue())
1043
raise BzrCommandError("please specify a commit message"
1044
" with either --message or --file")
1045
elif message and file:
1046
raise BzrCommandError("please specify either --message or --file")
1050
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1053
raise BzrCommandError("empty commit message specified")
1056
b.commit(message, specific_files=selected_list,
1057
allow_pointless=unchanged, strict=strict)
1058
except PointlessCommit:
1059
# FIXME: This should really happen before the file is read in;
1060
# perhaps prepare the commit; get the message; then actually commit
1061
raise BzrCommandError("no changes to commit",
1062
["use --unchanged to commit anyhow"])
1063
except ConflictsInTree:
1064
raise BzrCommandError("Conflicts detected in working tree. "
1065
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1066
except StrictCommitFailed:
1067
raise BzrCommandError("Commit refused because there are unknown "
1068
"files in the working tree.")
1071
class cmd_check(Command):
1072
"""Validate consistency of branch history.
1074
This command checks various invariants about the branch storage to
1075
detect data corruption or bzr bugs.
1077
takes_args = ['dir?']
1078
takes_options = ['verbose']
1080
def run(self, dir='.', verbose=False):
1081
from bzrlib.check import check
1082
check(Branch.open_containing(dir)[0], verbose)
1085
class cmd_scan_cache(Command):
1088
from bzrlib.hashcache import HashCache
1094
print '%6d stats' % c.stat_count
1095
print '%6d in hashcache' % len(c._cache)
1096
print '%6d files removed from cache' % c.removed_count
1097
print '%6d hashes updated' % c.update_count
1098
print '%6d files changed too recently to cache' % c.danger_count
1105
class cmd_upgrade(Command):
1106
"""Upgrade branch storage to current format.
1108
The check command or bzr developers may sometimes advise you to run
1111
This version of this command upgrades from the full-text storage
1112
used by bzr 0.0.8 and earlier to the weave format (v5).
1114
takes_args = ['dir?']
1116
def run(self, dir='.'):
1117
from bzrlib.upgrade import upgrade
1121
class cmd_whoami(Command):
1122
"""Show bzr user id."""
1123
takes_options = ['email']
1125
def run(self, email=False):
1127
b = bzrlib.branch.Branch.open_containing('.')[0]
1128
config = bzrlib.config.BranchConfig(b)
1129
except NotBranchError:
1130
config = bzrlib.config.GlobalConfig()
1133
print config.user_email()
1135
print config.username()
1138
class cmd_selftest(Command):
1139
"""Run internal test suite.
1141
This creates temporary test directories in the working directory,
1142
but not existing data is affected. These directories are deleted
1143
if the tests pass, or left behind to help in debugging if they
1146
If arguments are given, they are regular expressions that say
1147
which tests should run.
1149
# TODO: --list should give a list of all available tests
1151
takes_args = ['testspecs*']
1152
takes_options = ['verbose',
1153
Option('one', help='stop when one test fails'),
1156
def run(self, testspecs_list=None, verbose=False, one=False):
1158
from bzrlib.selftest import selftest
1159
# we don't want progress meters from the tests to go to the
1160
# real output; and we don't want log messages cluttering up
1162
save_ui = bzrlib.ui.ui_factory
1163
bzrlib.trace.info('running tests...')
1165
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1166
if testspecs_list is not None:
1167
pattern = '|'.join(testspecs_list)
1170
result = selftest(verbose=verbose,
1172
stop_on_failure=one)
1174
bzrlib.trace.info('tests passed')
1176
bzrlib.trace.info('tests failed')
1177
return int(not result)
1179
bzrlib.ui.ui_factory = save_ui
1183
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1184
# is bzrlib itself in a branch?
1185
bzrrev = bzrlib.get_bzr_revision()
1187
print " (bzr checkout, revision %d {%s})" % bzrrev
1188
print bzrlib.__copyright__
1189
print "http://bazaar-ng.org/"
1191
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1192
print "you may use, modify and redistribute it under the terms of the GNU"
1193
print "General Public License version 2 or later."
1196
class cmd_version(Command):
1197
"""Show version of bzr."""
1201
class cmd_rocks(Command):
1202
"""Statement of optimism."""
1205
print "it sure does!"
1208
class cmd_find_merge_base(Command):
1209
"""Find and print a base revision for merging two branches.
1211
# TODO: Options to specify revisions on either side, as if
1212
# merging only part of the history.
1213
takes_args = ['branch', 'other']
1216
def run(self, branch, other):
1217
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1219
branch1 = Branch.open_containing(branch)[0]
1220
branch2 = Branch.open_containing(other)[0]
1222
history_1 = branch1.revision_history()
1223
history_2 = branch2.revision_history()
1225
last1 = branch1.last_revision()
1226
last2 = branch2.last_revision()
1228
source = MultipleRevisionSources(branch1, branch2)
1230
base_rev_id = common_ancestor(last1, last2, source)
1232
print 'merge base is revision %s' % base_rev_id
1236
if base_revno is None:
1237
raise bzrlib.errors.UnrelatedBranches()
1239
print ' r%-6d in %s' % (base_revno, branch)
1241
other_revno = branch2.revision_id_to_revno(base_revid)
1243
print ' r%-6d in %s' % (other_revno, other)
1247
class cmd_merge(Command):
1248
"""Perform a three-way merge.
1250
The branch is the branch you will merge from. By default, it will
1251
merge the latest revision. If you specify a revision, that
1252
revision will be merged. If you specify two revisions, the first
1253
will be used as a BASE, and the second one as OTHER. Revision
1254
numbers are always relative to the specified branch.
1256
By default bzr will try to merge in all new work from the other
1257
branch, automatically determining an appropriate base. If this
1258
fails, you may need to give an explicit base.
1262
To merge the latest revision from bzr.dev
1263
bzr merge ../bzr.dev
1265
To merge changes up to and including revision 82 from bzr.dev
1266
bzr merge -r 82 ../bzr.dev
1268
To merge the changes introduced by 82, without previous changes:
1269
bzr merge -r 81..82 ../bzr.dev
1271
merge refuses to run if there are any uncommitted changes, unless
1274
takes_args = ['branch?']
1275
takes_options = ['revision', 'force', 'merge-type']
1277
def run(self, branch=None, revision=None, force=False,
1279
from bzrlib.merge import merge
1280
from bzrlib.merge_core import ApplyMerge3
1281
if merge_type is None:
1282
merge_type = ApplyMerge3
1284
branch = Branch.open_containing('.')[0].get_parent()
1286
raise BzrCommandError("No merge location known or specified.")
1288
print "Using saved location: %s" % branch
1289
if revision is None or len(revision) < 1:
1291
other = [branch, -1]
1293
if len(revision) == 1:
1295
other = [branch, revision[0].in_history(branch).revno]
1297
assert len(revision) == 2
1298
if None in revision:
1299
raise BzrCommandError(
1300
"Merge doesn't permit that revision specifier.")
1301
b = Branch.open(branch)
1303
base = [branch, revision[0].in_history(b).revno]
1304
other = [branch, revision[1].in_history(b).revno]
1307
merge(other, base, check_clean=(not force), merge_type=merge_type)
1308
except bzrlib.errors.AmbiguousBase, e:
1309
m = ("sorry, bzr can't determine the right merge base yet\n"
1310
"candidates are:\n "
1311
+ "\n ".join(e.bases)
1313
"please specify an explicit base with -r,\n"
1314
"and (if you want) report this to the bzr developers\n")
1318
class cmd_revert(Command):
1319
"""Reverse all changes since the last commit.
1321
Only versioned files are affected. Specify filenames to revert only
1322
those files. By default, any files that are changed will be backed up
1323
first. Backup files have a '~' appended to their name.
1325
takes_options = ['revision', 'no-backup']
1326
takes_args = ['file*']
1327
aliases = ['merge-revert']
1329
def run(self, revision=None, no_backup=False, file_list=None):
1330
from bzrlib.merge import merge
1331
from bzrlib.commands import parse_spec
1333
if file_list is not None:
1334
if len(file_list) == 0:
1335
raise BzrCommandError("No files specified")
1336
if revision is None:
1338
elif len(revision) != 1:
1339
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1341
b = Branch.open_containing('.')[0]
1342
revno = revision[0].in_history(b).revno
1343
merge(('.', revno), parse_spec('.'),
1346
backup_files=not no_backup,
1347
file_list=file_list)
1349
Branch.open_containing('.')[0].set_pending_merges([])
1352
class cmd_assert_fail(Command):
1353
"""Test reporting of assertion failures"""
1356
assert False, "always fails"
1359
class cmd_help(Command):
1360
"""Show help on a command or other topic.
1362
For a list of all available commands, say 'bzr help commands'."""
1363
takes_options = ['long']
1364
takes_args = ['topic?']
1367
def run(self, topic=None, long=False):
1369
if topic is None and long:
1374
class cmd_shell_complete(Command):
1375
"""Show appropriate completions for context.
1377
For a list of all available commands, say 'bzr shell-complete'."""
1378
takes_args = ['context?']
1382
def run(self, context=None):
1383
import shellcomplete
1384
shellcomplete.shellcomplete(context)
1387
class cmd_fetch(Command):
1388
"""Copy in history from another branch but don't merge it.
1390
This is an internal method used for pull and merge."""
1392
takes_args = ['from_branch', 'to_branch']
1393
def run(self, from_branch, to_branch):
1394
from bzrlib.fetch import Fetcher
1395
from bzrlib.branch import Branch
1396
from_b = Branch(from_branch)
1397
to_b = Branch(to_branch)
1398
Fetcher(to_b, from_b)
1402
class cmd_missing(Command):
1403
"""What is missing in this branch relative to other branch.
1405
# TODO: rewrite this in terms of ancestry so that it shows only
1408
takes_args = ['remote?']
1409
aliases = ['mis', 'miss']
1410
# We don't have to add quiet to the list, because
1411
# unknown options are parsed as booleans
1412
takes_options = ['verbose', 'quiet']
1414
def run(self, remote=None, verbose=False, quiet=False):
1415
from bzrlib.errors import BzrCommandError
1416
from bzrlib.missing import show_missing
1418
if verbose and quiet:
1419
raise BzrCommandError('Cannot pass both quiet and verbose')
1421
b = Branch.open_containing('.')[0]
1422
parent = b.get_parent()
1425
raise BzrCommandError("No missing location known or specified.")
1428
print "Using last location: %s" % parent
1430
elif parent is None:
1431
# We only update parent if it did not exist, missing
1432
# should not change the parent
1433
b.set_parent(remote)
1434
br_remote = Branch.open_containing(remote)[0]
1435
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1438
class cmd_plugins(Command):
1442
import bzrlib.plugin
1443
from inspect import getdoc
1444
for plugin in bzrlib.plugin.all_plugins:
1445
if hasattr(plugin, '__path__'):
1446
print plugin.__path__[0]
1447
elif hasattr(plugin, '__file__'):
1448
print plugin.__file__
1454
print '\t', d.split('\n')[0]
1457
class cmd_testament(Command):
1458
"""Show testament (signing-form) of a revision."""
1459
takes_options = ['revision', 'long']
1460
takes_args = ['branch?']
1461
def run(self, branch='.', revision=None, long=False):
1462
from bzrlib.testament import Testament
1463
b = Branch.open_containing(branch)[0]
1466
if revision is None:
1467
rev_id = b.last_revision()
1469
rev_id = revision[0].in_history(b).rev_id
1470
t = Testament.from_revision(b, rev_id)
1472
sys.stdout.writelines(t.as_text_lines())
1474
sys.stdout.write(t.as_short_text())
1479
class cmd_annotate(Command):
1480
"""Show the origin of each line in a file.
1482
This prints out the given file with an annotation on the left side
1483
indicating which revision, author and date introduced the change.
1485
If the origin is the same for a run of consecutive lines, it is
1486
shown only at the top, unless the --all option is given.
1488
# TODO: annotate directories; showing when each file was last changed
1489
# TODO: annotate a previous version of a file
1490
# TODO: if the working copy is modified, show annotations on that
1491
# with new uncommitted lines marked
1492
aliases = ['blame', 'praise']
1493
takes_args = ['filename']
1494
takes_options = [Option('all', help='show annotations on all lines'),
1495
Option('long', help='show date in annotations'),
1498
def run(self, filename, all=False, long=False):
1499
from bzrlib.annotate import annotate_file
1500
b, relpath = Branch.open_containing(filename)
1503
tree = WorkingTree(b.base, b)
1504
tree = b.revision_tree(b.last_revision())
1505
file_id = tree.inventory.path2id(relpath)
1506
file_version = tree.inventory[file_id].revision
1507
annotate_file(b, file_version, file_id, long, all, sys.stdout)
1512
class cmd_re_sign(Command):
1513
"""Create a digital signature for an existing revision."""
1514
# TODO be able to replace existing ones.
1516
hidden = True # is this right ?
1517
takes_args = ['revision_id?']
1518
takes_options = ['revision']
1520
def run(self, revision_id=None, revision=None):
1521
import bzrlib.config as config
1522
import bzrlib.gpg as gpg
1523
if revision_id is not None and revision is not None:
1524
raise BzrCommandError('You can only supply one of revision_id or --revision')
1525
if revision_id is None and revision is None:
1526
raise BzrCommandError('You must supply either --revision or a revision_id')
1527
b = Branch.open_containing('.')[0]
1528
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
1529
if revision_id is not None:
1530
b.sign_revision(revision_id, gpg_strategy)
1531
elif revision is not None:
1532
for rev in revision:
1534
raise BzrCommandError('You cannot specify a NULL revision.')
1535
revno, rev_id = rev.in_history(b)
1536
b.sign_revision(rev_id, gpg_strategy)
1539
# these get imported and then picked up by the scan for cmd_*
1540
# TODO: Some more consistent way to split command definitions across files;
1541
# we do need to load at least some information about them to know of
1543
from bzrlib.conflicts import cmd_resolve, cmd_conflicts