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
def branch_files(file_list, default_branch='.'):
40
Return a branch and list of branch-relative paths.
41
If supplied file_list is empty or None, the branch default will be used,
42
and returned file_list will match the original.
44
if file_list is None or len(file_list) == 0:
45
return Branch.open_containing(default_branch)[0], file_list
46
b = Branch.open_containing(file_list[0])[0]
48
# note that if this is a remote branch, we would want
49
# relpath against the transport. RBC 20051018
50
# Most branch ops can't meaningfully operate on files in remote branches;
51
# the above comment was in cmd_status. ADHB 20051026
52
tree = WorkingTree(b.base, b)
54
for filename in file_list:
56
new_list.append(tree.relpath(filename))
57
except NotBranchError:
58
raise BzrCommandError("%s is not in the same branch as %s" %
59
(filename, file_list[0]))
63
# TODO: Make sure no commands unconditionally use the working directory as a
64
# branch. If a filename argument is used, the first of them should be used to
65
# specify the branch. (Perhaps this can be factored out into some kind of
66
# Argument class, representing a file in a branch, where the first occurrence
69
class cmd_status(Command):
70
"""Display status summary.
72
This reports on versioned and unknown files, reporting them
73
grouped by state. Possible states are:
76
Versioned in the working copy but not in the previous revision.
79
Versioned in the previous revision but removed or deleted
83
Path of this file changed from the previous revision;
84
the text may also have changed. This includes files whose
85
parent directory was renamed.
88
Text has changed since the previous revision.
91
Nothing about this file has changed since the previous revision.
92
Only shown with --all.
95
Not versioned and not matching an ignore pattern.
97
To see ignored files use 'bzr ignored'. For details in the
98
changes to file texts, use 'bzr diff'.
100
If no arguments are specified, the status of the entire working
101
directory is shown. Otherwise, only the status of the specified
102
files or directories is reported. If a directory is given, status
103
is reported for everything inside that directory.
105
If a revision argument is given, the status is calculated against
106
that revision, or between two revisions if two are provided.
109
# XXX: FIXME: bzr status should accept a -r option to show changes
110
# relative to a revision, or between revisions
112
# TODO: --no-recurse, --recurse options
114
takes_args = ['file*']
115
takes_options = ['all', 'show-ids']
116
aliases = ['st', 'stat']
119
def run(self, all=False, show_ids=False, file_list=None, revision=None):
120
b, file_list = branch_files(file_list)
122
from bzrlib.status import show_status
123
show_status(b, show_unchanged=all, show_ids=show_ids,
124
specific_files=file_list, revision=revision)
127
class cmd_cat_revision(Command):
128
"""Write out metadata for a revision.
130
The revision to print can either be specified by a specific
131
revision identifier, or you can use --revision.
135
takes_args = ['revision_id?']
136
takes_options = ['revision']
139
def run(self, revision_id=None, revision=None):
141
if revision_id is not None and revision is not None:
142
raise BzrCommandError('You can only supply one of revision_id or --revision')
143
if revision_id is None and revision is None:
144
raise BzrCommandError('You must supply either --revision or a revision_id')
145
b = Branch.open_containing('.')[0]
146
if revision_id is not None:
147
sys.stdout.write(b.get_revision_xml_file(revision_id).read())
148
elif revision is not None:
151
raise BzrCommandError('You cannot specify a NULL revision.')
152
revno, rev_id = rev.in_history(b)
153
sys.stdout.write(b.get_revision_xml_file(rev_id).read())
156
class cmd_revno(Command):
157
"""Show current revision number.
159
This is equal to the number of revisions on this branch."""
162
print Branch.open_containing('.')[0].revno()
165
class cmd_revision_info(Command):
166
"""Show revision number and revision id for a given revision identifier.
169
takes_args = ['revision_info*']
170
takes_options = ['revision']
172
def run(self, revision=None, revision_info_list=[]):
175
if revision is not None:
176
revs.extend(revision)
177
if revision_info_list is not None:
178
for rev in revision_info_list:
179
revs.append(RevisionSpec(rev))
181
raise BzrCommandError('You must supply a revision identifier')
183
b = Branch.open_containing('.')[0]
186
revinfo = rev.in_history(b)
187
if revinfo.revno is None:
188
print ' %s' % revinfo.rev_id
190
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
193
class cmd_add(Command):
194
"""Add specified files or directories.
196
In non-recursive mode, all the named items are added, regardless
197
of whether they were previously ignored. A warning is given if
198
any of the named files are already versioned.
200
In recursive mode (the default), files are treated the same way
201
but the behaviour for directories is different. Directories that
202
are already versioned do not give a warning. All directories,
203
whether already versioned or not, are searched for files or
204
subdirectories that are neither versioned or ignored, and these
205
are added. This search proceeds recursively into versioned
206
directories. If no names are given '.' is assumed.
208
Therefore simply saying 'bzr add' will version all files that
209
are currently unknown.
211
Adding a file whose parent directory is not versioned will
212
implicitly add the parent, and so on up to the root. This means
213
you should never need to explictly add a directory, they'll just
214
get added when you add a file in the directory.
216
takes_args = ['file*']
217
takes_options = ['no-recurse', 'quiet']
219
def run(self, file_list, no_recurse=False, quiet=False):
220
from bzrlib.add import smart_add, add_reporter_print, add_reporter_null
222
reporter = add_reporter_null
224
reporter = add_reporter_print
225
smart_add(file_list, not no_recurse, reporter)
228
class cmd_mkdir(Command):
229
"""Create a new versioned directory.
231
This is equivalent to creating the directory and then adding it.
233
takes_args = ['dir+']
235
def run(self, dir_list):
241
b = Branch.open_containing(d)[0]
246
class cmd_relpath(Command):
247
"""Show path of a file relative to root"""
248
takes_args = ['filename']
252
def run(self, filename):
253
branch, relpath = Branch.open_containing(filename)
257
class cmd_inventory(Command):
258
"""Show inventory of the current working copy or a revision."""
259
takes_options = ['revision', 'show-ids']
262
def run(self, revision=None, show_ids=False):
263
b = Branch.open_containing('.')[0]
265
inv = b.read_working_inventory()
267
if len(revision) > 1:
268
raise BzrCommandError('bzr inventory --revision takes'
269
' exactly one revision identifier')
270
inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
272
for path, entry in inv.entries():
274
print '%-50s %s' % (path, entry.file_id)
279
class cmd_move(Command):
280
"""Move files to a different directory.
285
The destination must be a versioned directory in the same branch.
287
takes_args = ['source$', 'dest']
288
def run(self, source_list, dest):
289
b, source_list = branch_files(source_list)
291
# TODO: glob expansion on windows?
292
tree = WorkingTree(b.base, b)
293
b.move(source_list, tree.relpath(dest))
296
class cmd_rename(Command):
297
"""Change the name of an entry.
300
bzr rename frob.c frobber.c
301
bzr rename src/frob.c lib/frob.c
303
It is an error if the destination name exists.
305
See also the 'move' command, which moves files into a different
306
directory without changing their name.
308
# TODO: Some way to rename multiple files without invoking
309
# bzr for each one?"""
310
takes_args = ['from_name', 'to_name']
312
def run(self, from_name, to_name):
313
b, (from_name, to_name) = branch_files((from_name, to_name))
314
b.rename_one(from_name, to_name)
317
class cmd_mv(Command):
318
"""Move or rename a file.
321
bzr mv OLDNAME NEWNAME
322
bzr mv SOURCE... DESTINATION
324
If the last argument is a versioned directory, all the other names
325
are moved into it. Otherwise, there must be exactly two arguments
326
and the file is changed to a new name, which must not already exist.
328
Files cannot be moved between branches.
330
takes_args = ['names*']
331
def run(self, names_list):
332
if len(names_list) < 2:
333
raise BzrCommandError("missing file argument")
334
b, rel_names = branch_files(names_list)
336
if os.path.isdir(names_list[-1]):
337
# move into existing directory
338
for pair in b.move(rel_names[:-1], rel_names[-1]):
339
print "%s => %s" % pair
341
if len(names_list) != 2:
342
raise BzrCommandError('to mv multiple files the destination '
343
'must be a versioned directory')
344
b.rename_one(rel_names[0], rel_names[1])
345
print "%s => %s" % (rel_names[0], rel_names[1])
348
class cmd_pull(Command):
349
"""Pull any changes from another branch into the current one.
351
If there is no default location set, the first pull will set it. After
352
that, you can omit the location to use the default. To change the
353
default, use --remember.
355
This command only works on branches that have not diverged. Branches are
356
considered diverged if both branches have had commits without first
357
pulling from the other.
359
If branches have diverged, you can use 'bzr merge' to pull the text changes
360
from one into the other. Once one branch has merged, the other should
361
be able to pull it again.
363
If you want to forget your local changes and just update your branch to
364
match the remote one, use --overwrite.
366
takes_options = ['remember', 'overwrite']
367
takes_args = ['location?']
369
def run(self, location=None, remember=False, overwrite=False):
370
from bzrlib.merge import merge
371
from shutil import rmtree
374
br_to = Branch.open_containing('.')[0]
375
stored_loc = br_to.get_parent()
377
if stored_loc is None:
378
raise BzrCommandError("No pull location known or specified.")
380
print "Using saved location: %s" % stored_loc
381
location = stored_loc
382
if br_to.get_parent() is None or remember:
383
br_to.set_parent(location)
384
br_from = Branch.open(location)
386
br_to.working_tree().pull(br_from, overwrite)
387
except DivergedBranches:
388
raise BzrCommandError("These branches have diverged."
392
class cmd_push(Command):
393
"""Push this branch into another branch.
395
The remote branch will not have its working tree populated because this
396
is both expensive, and may not be supported on the remote file system.
398
Some smart servers or protocols *may* put the working tree in place.
400
If there is no default push location set, the first push will set it.
401
After that, you can omit the location to use the default. To change the
402
default, use --remember.
404
This command only works on branches that have not diverged. Branches are
405
considered diverged if the branch being pushed to is not an older version
408
If branches have diverged, you can use 'bzr push --overwrite' to replace
409
the other branch completely.
411
If you want to ensure you have the different changes in the other branch,
412
do a merge (see bzr help merge) from the other branch, and commit that
413
before doing a 'push --overwrite'.
415
takes_options = ['remember', 'overwrite']
416
takes_args = ['location?']
418
def run(self, location=None, remember=False, overwrite=False):
420
from shutil import rmtree
421
from bzrlib.transport import get_transport
423
br_from = Branch.open_containing('.')[0]
424
stored_loc = br_from.get_push_location()
426
if stored_loc is None:
427
raise BzrCommandError("No push location known or specified.")
429
print "Using saved location: %s" % stored_loc
430
location = stored_loc
431
if br_from.get_push_location() is None or remember:
432
br_from.set_push_location(location)
434
br_to = Branch.open(location)
435
except NotBranchError:
437
transport = get_transport(location).clone('..')
438
transport.mkdir(transport.relpath(location))
439
br_to = Branch.initialize(location)
441
br_to.pull(br_from, overwrite)
442
except DivergedBranches:
443
raise BzrCommandError("These branches have diverged."
444
" Try a merge then push with overwrite.")
447
class cmd_branch(Command):
448
"""Create a new copy of a branch.
450
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
451
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
453
To retrieve the branch as of a particular revision, supply the --revision
454
parameter, as in "branch foo/bar -r 5".
456
--basis is to speed up branching from remote branches. When specified, it
457
copies all the file-contents, inventory and revision data from the basis
458
branch before copying anything from the remote branch.
460
takes_args = ['from_location', 'to_location?']
461
takes_options = ['revision', 'basis']
462
aliases = ['get', 'clone']
464
def run(self, from_location, to_location=None, revision=None, basis=None):
465
from bzrlib.clone import copy_branch
467
from shutil import rmtree
470
elif len(revision) > 1:
471
raise BzrCommandError(
472
'bzr branch --revision takes exactly 1 revision value')
474
br_from = Branch.open(from_location)
476
if e.errno == errno.ENOENT:
477
raise BzrCommandError('Source location "%s" does not'
478
' exist.' % to_location)
483
if basis is not None:
484
basis_branch = Branch.open_containing(basis)[0]
487
if len(revision) == 1 and revision[0] is not None:
488
revision_id = revision[0].in_history(br_from)[1]
491
if to_location is None:
492
to_location = os.path.basename(from_location.rstrip("/\\"))
495
name = os.path.basename(to_location) + '\n'
497
os.mkdir(to_location)
499
if e.errno == errno.EEXIST:
500
raise BzrCommandError('Target directory "%s" already'
501
' exists.' % to_location)
502
if e.errno == errno.ENOENT:
503
raise BzrCommandError('Parent of "%s" does not exist.' %
508
copy_branch(br_from, to_location, revision_id, basis_branch)
509
except bzrlib.errors.NoSuchRevision:
511
msg = "The branch %s has no revision %s." % (from_location, revision[0])
512
raise BzrCommandError(msg)
513
except bzrlib.errors.UnlistableBranch:
515
msg = "The branch %s cannot be used as a --basis"
516
raise BzrCommandError(msg)
518
branch = Branch.open(to_location)
519
name = StringIO(name)
520
branch.put_controlfile('branch-name', name)
525
class cmd_renames(Command):
526
"""Show list of renamed files.
528
# TODO: Option to show renames between two historical versions.
530
# TODO: Only show renames under dir, rather than in the whole branch.
531
takes_args = ['dir?']
534
def run(self, dir='.'):
535
b = Branch.open_containing(dir)[0]
536
old_inv = b.basis_tree().inventory
537
new_inv = b.read_working_inventory()
539
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
541
for old_name, new_name in renames:
542
print "%s => %s" % (old_name, new_name)
545
class cmd_info(Command):
546
"""Show statistical information about a branch."""
547
takes_args = ['branch?']
550
def run(self, branch=None):
552
b = Branch.open_containing(branch)[0]
556
class cmd_remove(Command):
557
"""Make a file unversioned.
559
This makes bzr stop tracking changes to a versioned file. It does
560
not delete the working copy.
562
takes_args = ['file+']
563
takes_options = ['verbose']
566
def run(self, file_list, verbose=False):
567
b, file_list = branch_files(file_list)
568
tree = b.working_tree()
569
tree.remove(file_list, verbose=verbose)
572
class cmd_file_id(Command):
573
"""Print file_id of a particular file or directory.
575
The file_id is assigned when the file is first added and remains the
576
same through all revisions where the file exists, even when it is
580
takes_args = ['filename']
582
def run(self, filename):
583
b, relpath = Branch.open_containing(filename)
584
i = b.inventory.path2id(relpath)
586
raise BzrError("%r is not a versioned file" % filename)
591
class cmd_file_path(Command):
592
"""Print path of file_ids to a file or directory.
594
This prints one line for each directory down to the target,
595
starting at the branch root."""
597
takes_args = ['filename']
599
def run(self, filename):
600
b, relpath = Branch.open_containing(filename)
602
fid = inv.path2id(relpath)
604
raise BzrError("%r is not a versioned file" % filename)
605
for fip in inv.get_idpath(fid):
609
class cmd_revision_history(Command):
610
"""Display list of revision ids on this branch."""
614
for patchid in Branch.open_containing('.')[0].revision_history():
618
class cmd_ancestry(Command):
619
"""List all revisions merged into this branch."""
623
b = Branch.open_containing('.')[0]
624
for revision_id in b.get_ancestry(b.last_revision()):
628
class cmd_directories(Command):
629
"""Display list of versioned directories in this branch."""
632
for name, ie in Branch.open_containing('.')[0].read_working_inventory().directories():
639
class cmd_init(Command):
640
"""Make a directory into a versioned branch.
642
Use this to create an empty branch, or before importing an
645
Recipe for importing a tree of files:
650
bzr commit -m 'imported project'
653
Branch.initialize('.')
656
class cmd_diff(Command):
657
"""Show differences in working tree.
659
If files are listed, only the changes in those files are listed.
660
Otherwise, all changes for the tree are listed.
667
# TODO: Allow diff across branches.
668
# TODO: Option to use external diff command; could be GNU diff, wdiff,
669
# or a graphical diff.
671
# TODO: Python difflib is not exactly the same as unidiff; should
672
# either fix it up or prefer to use an external diff.
674
# TODO: If a directory is given, diff everything under that.
676
# TODO: Selected-file diff is inefficient and doesn't show you
679
# TODO: This probably handles non-Unix newlines poorly.
681
takes_args = ['file*']
682
takes_options = ['revision', 'diff-options']
683
aliases = ['di', 'dif']
686
def run(self, revision=None, file_list=None, diff_options=None):
687
from bzrlib.diff import show_diff
689
b, file_list = branch_files(file_list)
690
if revision is not None:
691
if len(revision) == 1:
692
return show_diff(b, revision[0], specific_files=file_list,
693
external_diff_options=diff_options)
694
elif len(revision) == 2:
695
return show_diff(b, revision[0], specific_files=file_list,
696
external_diff_options=diff_options,
697
revision2=revision[1])
699
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
701
return show_diff(b, None, specific_files=file_list,
702
external_diff_options=diff_options)
705
class cmd_deleted(Command):
706
"""List files deleted in the working tree.
708
# TODO: Show files deleted since a previous revision, or
709
# between two revisions.
710
# TODO: Much more efficient way to do this: read in new
711
# directories with readdir, rather than stating each one. Same
712
# level of effort but possibly much less IO. (Or possibly not,
713
# if the directories are very large...)
715
def run(self, show_ids=False):
716
b = Branch.open_containing('.')[0]
718
new = b.working_tree()
719
for path, ie in old.inventory.iter_entries():
720
if not new.has_id(ie.file_id):
722
print '%-50s %s' % (path, ie.file_id)
727
class cmd_modified(Command):
728
"""List files modified in working tree."""
732
from bzrlib.delta import compare_trees
734
b = Branch.open_containing('.')[0]
735
td = compare_trees(b.basis_tree(), b.working_tree())
737
for path, id, kind, text_modified, meta_modified in td.modified:
742
class cmd_added(Command):
743
"""List files added in working tree."""
747
b = Branch.open_containing('.')[0]
748
wt = b.working_tree()
749
basis_inv = b.basis_tree().inventory
752
if file_id in basis_inv:
754
path = inv.id2path(file_id)
755
if not os.access(b.abspath(path), os.F_OK):
761
class cmd_root(Command):
762
"""Show the tree root directory.
764
The root is the nearest enclosing directory with a .bzr control
766
takes_args = ['filename?']
768
def run(self, filename=None):
769
"""Print the branch root."""
770
b = Branch.open_containing(filename)[0]
774
class cmd_log(Command):
775
"""Show log of this branch.
777
To request a range of logs, you can use the command -r begin:end
778
-r revision requests a specific revision, -r :end or -r begin: are
782
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
784
takes_args = ['filename?']
785
takes_options = [Option('forward',
786
help='show from oldest to newest'),
787
'timezone', 'verbose',
788
'show-ids', 'revision',
789
Option('line', help='format with one line per revision'),
792
help='show revisions whose message matches this regexp',
794
Option('short', help='use moderately short format'),
797
def run(self, filename=None, timezone='original',
806
from bzrlib.log import log_formatter, show_log
808
assert message is None or isinstance(message, basestring), \
809
"invalid message argument %r" % message
810
direction = (forward and 'forward') or 'reverse'
813
b, fp = Branch.open_containing(filename)
815
file_id = b.read_working_inventory().path2id(fp)
817
file_id = None # points to branch root
819
b, relpath = Branch.open_containing('.')
825
elif len(revision) == 1:
826
rev1 = rev2 = revision[0].in_history(b).revno
827
elif len(revision) == 2:
828
rev1 = revision[0].in_history(b).revno
829
rev2 = revision[1].in_history(b).revno
831
raise BzrCommandError('bzr log --revision takes one or two values.')
838
mutter('encoding log as %r' % bzrlib.user_encoding)
840
# use 'replace' so that we don't abort if trying to write out
841
# in e.g. the default C locale.
842
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
849
lf = log_formatter(log_format,
852
show_timezone=timezone)
865
class cmd_touching_revisions(Command):
866
"""Return revision-ids which affected a particular file.
868
A more user-friendly interface is "bzr log FILE"."""
870
takes_args = ["filename"]
872
def run(self, filename):
873
b, relpath = Branch.open_containing(filename)[0]
874
inv = b.read_working_inventory()
875
file_id = inv.path2id(relpath)
876
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
877
print "%6d %s" % (revno, what)
880
class cmd_ls(Command):
881
"""List files in a tree.
883
# TODO: Take a revision or remote path and list that tree instead.
886
def run(self, revision=None, verbose=False):
887
b, relpath = Branch.open_containing('.')[0]
889
tree = b.working_tree()
891
tree = b.revision_tree(revision.in_history(b).rev_id)
892
for fp, fc, kind, fid, entry in tree.list_files():
894
kindch = entry.kind_character()
895
print '%-8s %s%s' % (fc, fp, kindch)
901
class cmd_unknowns(Command):
902
"""List unknown files."""
905
from bzrlib.osutils import quotefn
906
for f in Branch.open_containing('.')[0].unknowns():
911
class cmd_ignore(Command):
912
"""Ignore a command or pattern.
914
To remove patterns from the ignore list, edit the .bzrignore file.
916
If the pattern contains a slash, it is compared to the whole path
917
from the branch root. Otherwise, it is compared to only the last
918
component of the path. To match a file only in the root directory,
921
Ignore patterns are case-insensitive on case-insensitive systems.
923
Note: wildcards must be quoted from the shell on Unix.
926
bzr ignore ./Makefile
929
# TODO: Complain if the filename is absolute
930
takes_args = ['name_pattern']
932
def run(self, name_pattern):
933
from bzrlib.atomicfile import AtomicFile
936
b, relpath = Branch.open_containing('.')
937
ifn = b.abspath('.bzrignore')
939
if os.path.exists(ifn):
942
igns = f.read().decode('utf-8')
948
# TODO: If the file already uses crlf-style termination, maybe
949
# we should use that for the newly added lines?
951
if igns and igns[-1] != '\n':
953
igns += name_pattern + '\n'
956
f = AtomicFile(ifn, 'wt')
957
f.write(igns.encode('utf-8'))
962
inv = b.working_tree().inventory
963
if inv.path2id('.bzrignore'):
964
mutter('.bzrignore is already versioned')
966
mutter('need to make new .bzrignore file versioned')
967
b.add(['.bzrignore'])
971
class cmd_ignored(Command):
972
"""List ignored files and the patterns that matched them.
974
See also: bzr ignore"""
977
tree = Branch.open_containing('.')[0].working_tree()
978
for path, file_class, kind, file_id, entry in tree.list_files():
979
if file_class != 'I':
981
## XXX: Slightly inefficient since this was already calculated
982
pat = tree.is_ignored(path)
983
print '%-50s %s' % (path, pat)
986
class cmd_lookup_revision(Command):
987
"""Lookup the revision-id from a revision-number
990
bzr lookup-revision 33
993
takes_args = ['revno']
996
def run(self, revno):
1000
raise BzrCommandError("not a valid revision-number: %r" % revno)
1002
print Branch.open_containing('.')[0].get_rev_id(revno)
1005
class cmd_export(Command):
1006
"""Export past revision to destination directory.
1008
If no revision is specified this exports the last committed revision.
1010
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1011
given, try to find the format with the extension. If no extension
1012
is found exports to a directory (equivalent to --format=dir).
1014
Root may be the top directory for tar, tgz and tbz2 formats. If none
1015
is given, the top directory will be the root name of the file."""
1016
# TODO: list known exporters
1017
takes_args = ['dest']
1018
takes_options = ['revision', 'format', 'root']
1019
def run(self, dest, revision=None, format=None, root=None):
1021
b = Branch.open_containing('.')[0]
1022
if revision is None:
1023
rev_id = b.last_revision()
1025
if len(revision) != 1:
1026
raise BzrError('bzr export --revision takes exactly 1 argument')
1027
rev_id = revision[0].in_history(b).rev_id
1028
t = b.revision_tree(rev_id)
1029
arg_root, ext = os.path.splitext(os.path.basename(dest))
1030
if ext in ('.gz', '.bz2'):
1031
new_root, new_ext = os.path.splitext(arg_root)
1032
if new_ext == '.tar':
1038
if ext in (".tar",):
1040
elif ext in (".tar.gz", ".tgz"):
1042
elif ext in (".tar.bz2", ".tbz2"):
1046
t.export(dest, format, root)
1049
class cmd_cat(Command):
1050
"""Write a file's text from a previous revision."""
1052
takes_options = ['revision']
1053
takes_args = ['filename']
1056
def run(self, filename, revision=None):
1057
if revision is None:
1058
raise BzrCommandError("bzr cat requires a revision number")
1059
elif len(revision) != 1:
1060
raise BzrCommandError("bzr cat --revision takes exactly one number")
1061
b, relpath = Branch.open_containing(filename)
1062
b.print_file(relpath, revision[0].in_history(b).revno)
1065
class cmd_local_time_offset(Command):
1066
"""Show the offset in seconds from GMT to local time."""
1070
print bzrlib.osutils.local_time_offset()
1074
class cmd_commit(Command):
1075
"""Commit changes into a new revision.
1077
If no arguments are given, the entire tree is committed.
1079
If selected files are specified, only changes to those files are
1080
committed. If a directory is specified then the directory and everything
1081
within it is committed.
1083
A selected-file commit may fail in some cases where the committed
1084
tree would be invalid, such as trying to commit a file in a
1085
newly-added directory that is not itself committed.
1087
# TODO: Run hooks on tree to-be-committed, and after commit.
1089
# TODO: Strict commit that fails if there are deleted files.
1090
# (what does "deleted files" mean ??)
1092
# TODO: Give better message for -s, --summary, used by tla people
1094
# XXX: verbose currently does nothing
1096
takes_args = ['selected*']
1097
takes_options = ['message', 'verbose',
1099
help='commit even if nothing has changed'),
1100
Option('file', type=str,
1102
help='file containing commit message'),
1104
help="refuse to commit if there are unknown "
1105
"files in the working tree."),
1107
aliases = ['ci', 'checkin']
1109
def run(self, message=None, file=None, verbose=True, selected_list=None,
1110
unchanged=False, strict=False):
1111
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1113
from bzrlib.msgeditor import edit_commit_message
1114
from bzrlib.status import show_status
1115
from cStringIO import StringIO
1117
b, selected_list = branch_files(selected_list)
1118
if message is None and not file:
1119
catcher = StringIO()
1120
show_status(b, specific_files=selected_list,
1122
message = edit_commit_message(catcher.getvalue())
1125
raise BzrCommandError("please specify a commit message"
1126
" with either --message or --file")
1127
elif message and file:
1128
raise BzrCommandError("please specify either --message or --file")
1132
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1135
raise BzrCommandError("empty commit message specified")
1138
b.commit(message, specific_files=selected_list,
1139
allow_pointless=unchanged, strict=strict)
1140
except PointlessCommit:
1141
# FIXME: This should really happen before the file is read in;
1142
# perhaps prepare the commit; get the message; then actually commit
1143
raise BzrCommandError("no changes to commit",
1144
["use --unchanged to commit anyhow"])
1145
except ConflictsInTree:
1146
raise BzrCommandError("Conflicts detected in working tree. "
1147
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1148
except StrictCommitFailed:
1149
raise BzrCommandError("Commit refused because there are unknown "
1150
"files in the working tree.")
1153
class cmd_check(Command):
1154
"""Validate consistency of branch history.
1156
This command checks various invariants about the branch storage to
1157
detect data corruption or bzr bugs.
1159
takes_args = ['dir?']
1160
takes_options = ['verbose']
1162
def run(self, dir='.', verbose=False):
1163
from bzrlib.check import check
1164
check(Branch.open_containing(dir)[0], verbose)
1167
class cmd_scan_cache(Command):
1170
from bzrlib.hashcache import HashCache
1176
print '%6d stats' % c.stat_count
1177
print '%6d in hashcache' % len(c._cache)
1178
print '%6d files removed from cache' % c.removed_count
1179
print '%6d hashes updated' % c.update_count
1180
print '%6d files changed too recently to cache' % c.danger_count
1187
class cmd_upgrade(Command):
1188
"""Upgrade branch storage to current format.
1190
The check command or bzr developers may sometimes advise you to run
1193
This version of this command upgrades from the full-text storage
1194
used by bzr 0.0.8 and earlier to the weave format (v5).
1196
takes_args = ['dir?']
1198
def run(self, dir='.'):
1199
from bzrlib.upgrade import upgrade
1203
class cmd_whoami(Command):
1204
"""Show bzr user id."""
1205
takes_options = ['email']
1208
def run(self, email=False):
1210
b = bzrlib.branch.Branch.open_containing('.')[0]
1211
config = bzrlib.config.BranchConfig(b)
1212
except NotBranchError:
1213
config = bzrlib.config.GlobalConfig()
1216
print config.user_email()
1218
print config.username()
1221
class cmd_selftest(Command):
1222
"""Run internal test suite.
1224
This creates temporary test directories in the working directory,
1225
but not existing data is affected. These directories are deleted
1226
if the tests pass, or left behind to help in debugging if they
1229
If arguments are given, they are regular expressions that say
1230
which tests should run.
1232
# TODO: --list should give a list of all available tests
1234
takes_args = ['testspecs*']
1235
takes_options = ['verbose',
1236
Option('one', help='stop when one test fails'),
1239
def run(self, testspecs_list=None, verbose=False, one=False):
1241
from bzrlib.selftest import selftest
1242
# we don't want progress meters from the tests to go to the
1243
# real output; and we don't want log messages cluttering up
1245
save_ui = bzrlib.ui.ui_factory
1246
bzrlib.trace.info('running tests...')
1248
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1249
if testspecs_list is not None:
1250
pattern = '|'.join(testspecs_list)
1253
result = selftest(verbose=verbose,
1255
stop_on_failure=one)
1257
bzrlib.trace.info('tests passed')
1259
bzrlib.trace.info('tests failed')
1260
return int(not result)
1262
bzrlib.ui.ui_factory = save_ui
1266
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1267
# is bzrlib itself in a branch?
1268
bzrrev = bzrlib.get_bzr_revision()
1270
print " (bzr checkout, revision %d {%s})" % bzrrev
1271
print bzrlib.__copyright__
1272
print "http://bazaar-ng.org/"
1274
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1275
print "you may use, modify and redistribute it under the terms of the GNU"
1276
print "General Public License version 2 or later."
1279
class cmd_version(Command):
1280
"""Show version of bzr."""
1285
class cmd_rocks(Command):
1286
"""Statement of optimism."""
1290
print "it sure does!"
1293
class cmd_find_merge_base(Command):
1294
"""Find and print a base revision for merging two branches.
1296
# TODO: Options to specify revisions on either side, as if
1297
# merging only part of the history.
1298
takes_args = ['branch', 'other']
1302
def run(self, branch, other):
1303
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1305
branch1 = Branch.open_containing(branch)[0]
1306
branch2 = Branch.open_containing(other)[0]
1308
history_1 = branch1.revision_history()
1309
history_2 = branch2.revision_history()
1311
last1 = branch1.last_revision()
1312
last2 = branch2.last_revision()
1314
source = MultipleRevisionSources(branch1, branch2)
1316
base_rev_id = common_ancestor(last1, last2, source)
1318
print 'merge base is revision %s' % base_rev_id
1322
if base_revno is None:
1323
raise bzrlib.errors.UnrelatedBranches()
1325
print ' r%-6d in %s' % (base_revno, branch)
1327
other_revno = branch2.revision_id_to_revno(base_revid)
1329
print ' r%-6d in %s' % (other_revno, other)
1333
class cmd_merge(Command):
1334
"""Perform a three-way merge.
1336
The branch is the branch you will merge from. By default, it will
1337
merge the latest revision. If you specify a revision, that
1338
revision will be merged. If you specify two revisions, the first
1339
will be used as a BASE, and the second one as OTHER. Revision
1340
numbers are always relative to the specified branch.
1342
By default bzr will try to merge in all new work from the other
1343
branch, automatically determining an appropriate base. If this
1344
fails, you may need to give an explicit base.
1348
To merge the latest revision from bzr.dev
1349
bzr merge ../bzr.dev
1351
To merge changes up to and including revision 82 from bzr.dev
1352
bzr merge -r 82 ../bzr.dev
1354
To merge the changes introduced by 82, without previous changes:
1355
bzr merge -r 81..82 ../bzr.dev
1357
merge refuses to run if there are any uncommitted changes, unless
1360
takes_args = ['branch?']
1361
takes_options = ['revision', 'force', 'merge-type',
1362
Option('show-base', help="Show base revision text in "
1365
def run(self, branch=None, revision=None, force=False, merge_type=None,
1367
from bzrlib.merge import merge
1368
from bzrlib.merge_core import ApplyMerge3
1369
if merge_type is None:
1370
merge_type = ApplyMerge3
1372
branch = Branch.open_containing('.')[0].get_parent()
1374
raise BzrCommandError("No merge location known or specified.")
1376
print "Using saved location: %s" % branch
1377
if revision is None or len(revision) < 1:
1379
other = [branch, -1]
1381
if len(revision) == 1:
1383
other_branch = Branch.open_containing(branch)[0]
1384
revno = revision[0].in_history(other_branch).revno
1385
other = [branch, revno]
1387
assert len(revision) == 2
1388
if None in revision:
1389
raise BzrCommandError(
1390
"Merge doesn't permit that revision specifier.")
1391
b = Branch.open_containing(branch)[0]
1393
base = [branch, revision[0].in_history(b).revno]
1394
other = [branch, revision[1].in_history(b).revno]
1397
conflict_count = merge(other, base, check_clean=(not force),
1398
merge_type=merge_type,
1399
show_base=show_base)
1400
if conflict_count != 0:
1404
except bzrlib.errors.AmbiguousBase, e:
1405
m = ("sorry, bzr can't determine the right merge base yet\n"
1406
"candidates are:\n "
1407
+ "\n ".join(e.bases)
1409
"please specify an explicit base with -r,\n"
1410
"and (if you want) report this to the bzr developers\n")
1414
class cmd_revert(Command):
1415
"""Reverse all changes since the last commit.
1417
Only versioned files are affected. Specify filenames to revert only
1418
those files. By default, any files that are changed will be backed up
1419
first. Backup files have a '~' appended to their name.
1421
takes_options = ['revision', 'no-backup']
1422
takes_args = ['file*']
1423
aliases = ['merge-revert']
1425
def run(self, revision=None, no_backup=False, file_list=None):
1426
from bzrlib.merge import merge
1427
from bzrlib.commands import parse_spec
1429
if file_list is not None:
1430
if len(file_list) == 0:
1431
raise BzrCommandError("No files specified")
1432
if revision is None:
1434
elif len(revision) != 1:
1435
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1437
b, file_list = branch_files(file_list)
1438
revno = revision[0].in_history(b).revno
1439
merge(('.', revno), parse_spec('.'),
1442
backup_files=not no_backup,
1443
file_list=file_list)
1445
Branch.open_containing('.')[0].set_pending_merges([])
1448
class cmd_assert_fail(Command):
1449
"""Test reporting of assertion failures"""
1452
assert False, "always fails"
1455
class cmd_help(Command):
1456
"""Show help on a command or other topic.
1458
For a list of all available commands, say 'bzr help commands'."""
1459
takes_options = ['long']
1460
takes_args = ['topic?']
1464
def run(self, topic=None, long=False):
1466
if topic is None and long:
1471
class cmd_shell_complete(Command):
1472
"""Show appropriate completions for context.
1474
For a list of all available commands, say 'bzr shell-complete'."""
1475
takes_args = ['context?']
1480
def run(self, context=None):
1481
import shellcomplete
1482
shellcomplete.shellcomplete(context)
1485
class cmd_fetch(Command):
1486
"""Copy in history from another branch but don't merge it.
1488
This is an internal method used for pull and merge."""
1490
takes_args = ['from_branch', 'to_branch']
1491
def run(self, from_branch, to_branch):
1492
from bzrlib.fetch import Fetcher
1493
from bzrlib.branch import Branch
1494
from_b = Branch.open(from_branch)
1495
to_b = Branch.open(to_branch)
1500
Fetcher(to_b, from_b)
1507
class cmd_missing(Command):
1508
"""What is missing in this branch relative to other branch.
1510
# TODO: rewrite this in terms of ancestry so that it shows only
1513
takes_args = ['remote?']
1514
aliases = ['mis', 'miss']
1515
# We don't have to add quiet to the list, because
1516
# unknown options are parsed as booleans
1517
takes_options = ['verbose', 'quiet']
1520
def run(self, remote=None, verbose=False, quiet=False):
1521
from bzrlib.errors import BzrCommandError
1522
from bzrlib.missing import show_missing
1524
if verbose and quiet:
1525
raise BzrCommandError('Cannot pass both quiet and verbose')
1527
b = Branch.open_containing('.')[0]
1528
parent = b.get_parent()
1531
raise BzrCommandError("No missing location known or specified.")
1534
print "Using last location: %s" % parent
1536
elif parent is None:
1537
# We only update parent if it did not exist, missing
1538
# should not change the parent
1539
b.set_parent(remote)
1540
br_remote = Branch.open_containing(remote)[0]
1541
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1544
class cmd_plugins(Command):
1549
import bzrlib.plugin
1550
from inspect import getdoc
1551
for plugin in bzrlib.plugin.all_plugins:
1552
if hasattr(plugin, '__path__'):
1553
print plugin.__path__[0]
1554
elif hasattr(plugin, '__file__'):
1555
print plugin.__file__
1561
print '\t', d.split('\n')[0]
1564
class cmd_testament(Command):
1565
"""Show testament (signing-form) of a revision."""
1566
takes_options = ['revision', 'long']
1567
takes_args = ['branch?']
1569
def run(self, branch='.', revision=None, long=False):
1570
from bzrlib.testament import Testament
1571
b = Branch.open_containing(branch)[0]
1574
if revision is None:
1575
rev_id = b.last_revision()
1577
rev_id = revision[0].in_history(b).rev_id
1578
t = Testament.from_revision(b, rev_id)
1580
sys.stdout.writelines(t.as_text_lines())
1582
sys.stdout.write(t.as_short_text())
1587
class cmd_annotate(Command):
1588
"""Show the origin of each line in a file.
1590
This prints out the given file with an annotation on the left side
1591
indicating which revision, author and date introduced the change.
1593
If the origin is the same for a run of consecutive lines, it is
1594
shown only at the top, unless the --all option is given.
1596
# TODO: annotate directories; showing when each file was last changed
1597
# TODO: annotate a previous version of a file
1598
# TODO: if the working copy is modified, show annotations on that
1599
# with new uncommitted lines marked
1600
aliases = ['blame', 'praise']
1601
takes_args = ['filename']
1602
takes_options = [Option('all', help='show annotations on all lines'),
1603
Option('long', help='show date in annotations'),
1607
def run(self, filename, all=False, long=False):
1608
from bzrlib.annotate import annotate_file
1609
b, relpath = Branch.open_containing(filename)
1612
tree = WorkingTree(b.base, b)
1613
tree = b.revision_tree(b.last_revision())
1614
file_id = tree.inventory.path2id(relpath)
1615
file_version = tree.inventory[file_id].revision
1616
annotate_file(b, file_version, file_id, long, all, sys.stdout)
1621
class cmd_re_sign(Command):
1622
"""Create a digital signature for an existing revision."""
1623
# TODO be able to replace existing ones.
1625
hidden = True # is this right ?
1626
takes_args = ['revision_id?']
1627
takes_options = ['revision']
1629
def run(self, revision_id=None, revision=None):
1630
import bzrlib.config as config
1631
import bzrlib.gpg as gpg
1632
if revision_id is not None and revision is not None:
1633
raise BzrCommandError('You can only supply one of revision_id or --revision')
1634
if revision_id is None and revision is None:
1635
raise BzrCommandError('You must supply either --revision or a revision_id')
1636
b = Branch.open_containing('.')[0]
1637
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
1638
if revision_id is not None:
1639
b.sign_revision(revision_id, gpg_strategy)
1640
elif revision is not None:
1641
if len(revision) == 1:
1642
revno, rev_id = revision[0].in_history(b)
1643
b.sign_revision(rev_id, gpg_strategy)
1644
elif len(revision) == 2:
1645
# are they both on rh- if so we can walk between them
1646
# might be nice to have a range helper for arbitrary
1647
# revision paths. hmm.
1648
from_revno, from_revid = revision[0].in_history(b)
1649
to_revno, to_revid = revision[1].in_history(b)
1650
if to_revid is None:
1651
to_revno = b.revno()
1652
if from_revno is None or to_revno is None:
1653
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
1654
for revno in range(from_revno, to_revno + 1):
1655
b.sign_revision(b.get_rev_id(revno), gpg_strategy)
1657
raise BzrCommandError('Please supply either one revision, or a range.')
1660
# these get imported and then picked up by the scan for cmd_*
1661
# TODO: Some more consistent way to split command definitions across files;
1662
# we do need to load at least some information about them to know of
1664
from bzrlib.conflicts import cmd_resolve, cmd_conflicts
added
removed
bzrlib/builtins.py
