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.revision import common_ancestor
30
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError,
31
NotBranchError, DivergedBranches, NotConflicted,
32
NoSuchFile, NoWorkingTree)
33
from bzrlib.option import Option
34
from bzrlib.revisionspec import RevisionSpec
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.workingtree import WorkingTree
40
def branch_files(file_list, default_branch='.'):
42
Return a branch and list of branch-relative paths.
43
If supplied file_list is empty or None, the branch default will be used,
44
and returned file_list will match the original.
46
if file_list is None or len(file_list) == 0:
47
return Branch.open_containing(default_branch)[0], file_list
48
b = Branch.open_containing(file_list[0])[0]
50
# note that if this is a remote branch, we would want
51
# relpath against the transport. RBC 20051018
52
# Most branch ops can't meaningfully operate on files in remote branches;
53
# the above comment was in cmd_status. ADHB 20051026
54
tree = WorkingTree(b.base, b)
56
for filename in file_list:
58
new_list.append(tree.relpath(filename))
59
except NotBranchError:
60
raise BzrCommandError("%s is not in the same branch as %s" %
61
(filename, file_list[0]))
65
# TODO: Make sure no commands unconditionally use the working directory as a
66
# branch. If a filename argument is used, the first of them should be used to
67
# specify the branch. (Perhaps this can be factored out into some kind of
68
# Argument class, representing a file in a branch, where the first occurrence
71
class cmd_status(Command):
72
"""Display status summary.
74
This reports on versioned and unknown files, reporting them
75
grouped by state. Possible states are:
78
Versioned in the working copy but not in the previous revision.
81
Versioned in the previous revision but removed or deleted
85
Path of this file changed from the previous revision;
86
the text may also have changed. This includes files whose
87
parent directory was renamed.
90
Text has changed since the previous revision.
93
Nothing about this file has changed since the previous revision.
94
Only shown with --all.
97
Not versioned and not matching an ignore pattern.
99
To see ignored files use 'bzr ignored'. For details in the
100
changes to file texts, use 'bzr diff'.
102
If no arguments are specified, the status of the entire working
103
directory is shown. Otherwise, only the status of the specified
104
files or directories is reported. If a directory is given, status
105
is reported for everything inside that directory.
107
If a revision argument is given, the status is calculated against
108
that revision, or between two revisions if two are provided.
111
# XXX: FIXME: bzr status should accept a -r option to show changes
112
# relative to a revision, or between revisions
114
# TODO: --no-recurse, --recurse options
116
takes_args = ['file*']
117
takes_options = ['all', 'show-ids']
118
aliases = ['st', 'stat']
121
def run(self, all=False, show_ids=False, file_list=None, revision=None):
122
b, file_list = branch_files(file_list)
124
from bzrlib.status import show_status
125
show_status(b, show_unchanged=all, show_ids=show_ids,
126
specific_files=file_list, revision=revision)
129
class cmd_cat_revision(Command):
130
"""Write out metadata for a revision.
132
The revision to print can either be specified by a specific
133
revision identifier, or you can use --revision.
137
takes_args = ['revision_id?']
138
takes_options = ['revision']
141
def run(self, revision_id=None, revision=None):
143
if revision_id is not None and revision is not None:
144
raise BzrCommandError('You can only supply one of revision_id or --revision')
145
if revision_id is None and revision is None:
146
raise BzrCommandError('You must supply either --revision or a revision_id')
147
b = Branch.open_containing('.')[0]
148
if revision_id is not None:
149
sys.stdout.write(b.get_revision_xml_file(revision_id).read())
150
elif revision is not None:
153
raise BzrCommandError('You cannot specify a NULL revision.')
154
revno, rev_id = rev.in_history(b)
155
sys.stdout.write(b.get_revision_xml_file(rev_id).read())
158
class cmd_revno(Command):
159
"""Show current revision number.
161
This is equal to the number of revisions on this branch."""
164
print Branch.open_containing('.')[0].revno()
167
class cmd_revision_info(Command):
168
"""Show revision number and revision id for a given revision identifier.
171
takes_args = ['revision_info*']
172
takes_options = ['revision']
174
def run(self, revision=None, revision_info_list=[]):
177
if revision is not None:
178
revs.extend(revision)
179
if revision_info_list is not None:
180
for rev in revision_info_list:
181
revs.append(RevisionSpec(rev))
183
raise BzrCommandError('You must supply a revision identifier')
185
b = Branch.open_containing('.')[0]
188
revinfo = rev.in_history(b)
189
if revinfo.revno is None:
190
print ' %s' % revinfo.rev_id
192
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
195
class cmd_add(Command):
196
"""Add specified files or directories.
198
In non-recursive mode, all the named items are added, regardless
199
of whether they were previously ignored. A warning is given if
200
any of the named files are already versioned.
202
In recursive mode (the default), files are treated the same way
203
but the behaviour for directories is different. Directories that
204
are already versioned do not give a warning. All directories,
205
whether already versioned or not, are searched for files or
206
subdirectories that are neither versioned or ignored, and these
207
are added. This search proceeds recursively into versioned
208
directories. If no names are given '.' is assumed.
210
Therefore simply saying 'bzr add' will version all files that
211
are currently unknown.
213
Adding a file whose parent directory is not versioned will
214
implicitly add the parent, and so on up to the root. This means
215
you should never need to explictly add a directory, they'll just
216
get added when you add a file in the directory.
218
takes_args = ['file*']
219
takes_options = ['no-recurse', 'quiet']
221
def run(self, file_list, no_recurse=False, quiet=False):
222
from bzrlib.add import smart_add, add_reporter_print, add_reporter_null
224
reporter = add_reporter_null
226
reporter = add_reporter_print
227
smart_add(file_list, not no_recurse, reporter)
230
class cmd_mkdir(Command):
231
"""Create a new versioned directory.
233
This is equivalent to creating the directory and then adding it.
235
takes_args = ['dir+']
237
def run(self, dir_list):
243
b = Branch.open_containing(d)[0]
248
class cmd_relpath(Command):
249
"""Show path of a file relative to root"""
250
takes_args = ['filename']
254
def run(self, filename):
255
branch, relpath = Branch.open_containing(filename)
259
class cmd_inventory(Command):
260
"""Show inventory of the current working copy or a revision."""
261
takes_options = ['revision', 'show-ids']
264
def run(self, revision=None, show_ids=False):
265
b = Branch.open_containing('.')[0]
267
inv = b.working_tree().read_working_inventory()
269
if len(revision) > 1:
270
raise BzrCommandError('bzr inventory --revision takes'
271
' exactly one revision identifier')
272
inv = b.get_revision_inventory(revision[0].in_history(b).rev_id)
274
for path, entry in inv.entries():
276
print '%-50s %s' % (path, entry.file_id)
281
class cmd_move(Command):
282
"""Move files to a different directory.
287
The destination must be a versioned directory in the same branch.
289
takes_args = ['source$', 'dest']
290
def run(self, source_list, dest):
291
b, source_list = branch_files(source_list)
293
# TODO: glob expansion on windows?
294
tree = WorkingTree(b.base, b)
295
b.move(source_list, tree.relpath(dest))
298
class cmd_rename(Command):
299
"""Change the name of an entry.
302
bzr rename frob.c frobber.c
303
bzr rename src/frob.c lib/frob.c
305
It is an error if the destination name exists.
307
See also the 'move' command, which moves files into a different
308
directory without changing their name.
310
# TODO: Some way to rename multiple files without invoking
311
# bzr for each one?"""
312
takes_args = ['from_name', 'to_name']
314
def run(self, from_name, to_name):
315
b, (from_name, to_name) = branch_files((from_name, to_name))
316
b.rename_one(from_name, to_name)
319
class cmd_mv(Command):
320
"""Move or rename a file.
323
bzr mv OLDNAME NEWNAME
324
bzr mv SOURCE... DESTINATION
326
If the last argument is a versioned directory, all the other names
327
are moved into it. Otherwise, there must be exactly two arguments
328
and the file is changed to a new name, which must not already exist.
330
Files cannot be moved between branches.
332
takes_args = ['names*']
333
def run(self, names_list):
334
if len(names_list) < 2:
335
raise BzrCommandError("missing file argument")
336
b, rel_names = branch_files(names_list)
338
if os.path.isdir(names_list[-1]):
339
# move into existing directory
340
for pair in b.move(rel_names[:-1], rel_names[-1]):
341
print "%s => %s" % pair
343
if len(names_list) != 2:
344
raise BzrCommandError('to mv multiple files the destination '
345
'must be a versioned directory')
346
b.rename_one(rel_names[0], rel_names[1])
347
print "%s => %s" % (rel_names[0], rel_names[1])
350
class cmd_pull(Command):
351
"""Pull any changes from another branch into the current one.
353
If there is no default location set, the first pull will set it. After
354
that, you can omit the location to use the default. To change the
355
default, use --remember.
357
This command only works on branches that have not diverged. Branches are
358
considered diverged if both branches have had commits without first
359
pulling from the other.
361
If branches have diverged, you can use 'bzr merge' to pull the text changes
362
from one into the other. Once one branch has merged, the other should
363
be able to pull it again.
365
If you want to forget your local changes and just update your branch to
366
match the remote one, use --overwrite.
368
takes_options = ['remember', 'overwrite']
369
takes_args = ['location?']
371
def run(self, location=None, remember=False, overwrite=False):
372
from bzrlib.merge import merge
373
from shutil import rmtree
376
br_to = Branch.open_containing('.')[0]
377
stored_loc = br_to.get_parent()
379
if stored_loc is None:
380
raise BzrCommandError("No pull location known or specified.")
382
print "Using saved location: %s" % stored_loc
383
location = stored_loc
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."
390
if br_to.get_parent() is None or remember:
391
br_to.set_parent(location)
394
class cmd_push(Command):
395
"""Push this branch into another branch.
397
The remote branch will not have its working tree populated because this
398
is both expensive, and may not be supported on the remote file system.
400
Some smart servers or protocols *may* put the working tree in place.
402
If there is no default push location set, the first push will set it.
403
After that, you can omit the location to use the default. To change the
404
default, use --remember.
406
This command only works on branches that have not diverged. Branches are
407
considered diverged if the branch being pushed to is not an older version
410
If branches have diverged, you can use 'bzr push --overwrite' to replace
411
the other branch completely.
413
If you want to ensure you have the different changes in the other branch,
414
do a merge (see bzr help merge) from the other branch, and commit that
415
before doing a 'push --overwrite'.
417
takes_options = ['remember', 'overwrite',
418
Option('create-prefix',
419
help='Create the path leading up to the branch '
420
'if it does not already exist')]
421
takes_args = ['location?']
423
def run(self, location=None, remember=False, overwrite=False,
424
create_prefix=False):
426
from shutil import rmtree
427
from bzrlib.transport import get_transport
429
br_from = Branch.open_containing('.')[0]
430
stored_loc = br_from.get_push_location()
432
if stored_loc is None:
433
raise BzrCommandError("No push location known or specified.")
435
print "Using saved location: %s" % stored_loc
436
location = stored_loc
438
br_to = Branch.open(location)
439
except NotBranchError:
441
transport = get_transport(location).clone('..')
442
if not create_prefix:
444
transport.mkdir(transport.relpath(location))
446
raise BzrCommandError("Parent directory of %s "
447
"does not exist." % location)
449
current = transport.base
450
needed = [(transport, transport.relpath(location))]
453
transport, relpath = needed[-1]
454
transport.mkdir(relpath)
457
new_transport = transport.clone('..')
458
needed.append((new_transport,
459
new_transport.relpath(transport.base)))
460
if new_transport.base == transport.base:
461
raise BzrCommandError("Could not creeate "
465
br_to = Branch.initialize(location)
467
br_to.pull(br_from, overwrite)
468
except DivergedBranches:
469
raise BzrCommandError("These branches have diverged."
470
" Try a merge then push with overwrite.")
471
if br_from.get_push_location() is None or remember:
472
br_from.set_push_location(location)
475
class cmd_branch(Command):
476
"""Create a new copy of a branch.
478
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
479
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
481
To retrieve the branch as of a particular revision, supply the --revision
482
parameter, as in "branch foo/bar -r 5".
484
--basis is to speed up branching from remote branches. When specified, it
485
copies all the file-contents, inventory and revision data from the basis
486
branch before copying anything from the remote branch.
488
takes_args = ['from_location', 'to_location?']
489
takes_options = ['revision', 'basis']
490
aliases = ['get', 'clone']
492
def run(self, from_location, to_location=None, revision=None, basis=None):
493
from bzrlib.clone import copy_branch
495
from shutil import rmtree
498
elif len(revision) > 1:
499
raise BzrCommandError(
500
'bzr branch --revision takes exactly 1 revision value')
502
br_from = Branch.open(from_location)
504
if e.errno == errno.ENOENT:
505
raise BzrCommandError('Source location "%s" does not'
506
' exist.' % to_location)
511
if basis is not None:
512
basis_branch = Branch.open_containing(basis)[0]
515
if len(revision) == 1 and revision[0] is not None:
516
revision_id = revision[0].in_history(br_from)[1]
519
if to_location is None:
520
to_location = os.path.basename(from_location.rstrip("/\\"))
523
name = os.path.basename(to_location) + '\n'
525
os.mkdir(to_location)
527
if e.errno == errno.EEXIST:
528
raise BzrCommandError('Target directory "%s" already'
529
' exists.' % to_location)
530
if e.errno == errno.ENOENT:
531
raise BzrCommandError('Parent of "%s" does not exist.' %
536
copy_branch(br_from, to_location, revision_id, basis_branch)
537
except bzrlib.errors.NoSuchRevision:
539
msg = "The branch %s has no revision %s." % (from_location, revision[0])
540
raise BzrCommandError(msg)
541
except bzrlib.errors.UnlistableBranch:
543
msg = "The branch %s cannot be used as a --basis"
544
raise BzrCommandError(msg)
546
branch = Branch.open(to_location)
547
name = StringIO(name)
548
branch.put_controlfile('branch-name', name)
553
class cmd_renames(Command):
554
"""Show list of renamed files.
556
# TODO: Option to show renames between two historical versions.
558
# TODO: Only show renames under dir, rather than in the whole branch.
559
takes_args = ['dir?']
562
def run(self, dir='.'):
563
b = Branch.open_containing(dir)[0]
564
old_inv = b.basis_tree().inventory
565
new_inv = b.working_tree().read_working_inventory()
567
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
569
for old_name, new_name in renames:
570
print "%s => %s" % (old_name, new_name)
573
class cmd_info(Command):
574
"""Show statistical information about a branch."""
575
takes_args = ['branch?']
578
def run(self, branch=None):
580
b = Branch.open_containing(branch)[0]
584
class cmd_remove(Command):
585
"""Make a file unversioned.
587
This makes bzr stop tracking changes to a versioned file. It does
588
not delete the working copy.
590
takes_args = ['file+']
591
takes_options = ['verbose']
594
def run(self, file_list, verbose=False):
595
b, file_list = branch_files(file_list)
596
tree = b.working_tree()
597
tree.remove(file_list, verbose=verbose)
600
class cmd_file_id(Command):
601
"""Print file_id of a particular file or directory.
603
The file_id is assigned when the file is first added and remains the
604
same through all revisions where the file exists, even when it is
608
takes_args = ['filename']
610
def run(self, filename):
611
b, relpath = Branch.open_containing(filename)
612
i = b.working_tree().inventory.path2id(relpath)
614
raise BzrError("%r is not a versioned file" % filename)
619
class cmd_file_path(Command):
620
"""Print path of file_ids to a file or directory.
622
This prints one line for each directory down to the target,
623
starting at the branch root."""
625
takes_args = ['filename']
627
def run(self, filename):
628
b, relpath = Branch.open_containing(filename)
630
fid = inv.path2id(relpath)
632
raise BzrError("%r is not a versioned file" % filename)
633
for fip in inv.get_idpath(fid):
637
class cmd_revision_history(Command):
638
"""Display list of revision ids on this branch."""
642
for patchid in Branch.open_containing('.')[0].revision_history():
646
class cmd_ancestry(Command):
647
"""List all revisions merged into this branch."""
651
b = Branch.open_containing('.')[0]
652
for revision_id in b.get_ancestry(b.last_revision()):
656
class cmd_directories(Command):
657
"""Display list of versioned directories in this branch."""
660
for name, ie in (Branch.open_containing('.')[0].working_tree().
661
read_working_inventory().directories()):
668
class cmd_init(Command):
669
"""Make a directory into a versioned branch.
671
Use this to create an empty branch, or before importing an
674
Recipe for importing a tree of files:
679
bzr commit -m 'imported project'
681
takes_args = ['location?']
682
def run(self, location=None):
683
from bzrlib.branch import Branch
687
# The path has to exist to initialize a
688
# branch inside of it.
689
# Just using os.mkdir, since I don't
690
# believe that we want to create a bunch of
691
# locations if the user supplies an extended path
692
if not os.path.exists(location):
694
Branch.initialize(location)
697
class cmd_diff(Command):
698
"""Show differences in working tree.
700
If files are listed, only the changes in those files are listed.
701
Otherwise, all changes for the tree are listed.
708
# TODO: Allow diff across branches.
709
# TODO: Option to use external diff command; could be GNU diff, wdiff,
710
# or a graphical diff.
712
# TODO: Python difflib is not exactly the same as unidiff; should
713
# either fix it up or prefer to use an external diff.
715
# TODO: If a directory is given, diff everything under that.
717
# TODO: Selected-file diff is inefficient and doesn't show you
720
# TODO: This probably handles non-Unix newlines poorly.
722
takes_args = ['file*']
723
takes_options = ['revision', 'diff-options']
724
aliases = ['di', 'dif']
727
def run(self, revision=None, file_list=None, diff_options=None):
728
from bzrlib.diff import show_diff
730
b, file_list = branch_files(file_list)
731
if revision is not None:
732
if len(revision) == 1:
733
return show_diff(b, revision[0], specific_files=file_list,
734
external_diff_options=diff_options)
735
elif len(revision) == 2:
736
return show_diff(b, revision[0], specific_files=file_list,
737
external_diff_options=diff_options,
738
revision2=revision[1])
740
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
742
return show_diff(b, None, specific_files=file_list,
743
external_diff_options=diff_options)
746
class cmd_deleted(Command):
747
"""List files deleted in the working tree.
749
# TODO: Show files deleted since a previous revision, or
750
# between two revisions.
751
# TODO: Much more efficient way to do this: read in new
752
# directories with readdir, rather than stating each one. Same
753
# level of effort but possibly much less IO. (Or possibly not,
754
# if the directories are very large...)
756
def run(self, show_ids=False):
757
b = Branch.open_containing('.')[0]
759
new = b.working_tree()
760
for path, ie in old.inventory.iter_entries():
761
if not new.has_id(ie.file_id):
763
print '%-50s %s' % (path, ie.file_id)
768
class cmd_modified(Command):
769
"""List files modified in working tree."""
773
from bzrlib.delta import compare_trees
775
b = Branch.open_containing('.')[0]
776
td = compare_trees(b.basis_tree(), b.working_tree())
778
for path, id, kind, text_modified, meta_modified in td.modified:
783
class cmd_added(Command):
784
"""List files added in working tree."""
788
b = Branch.open_containing('.')[0]
789
wt = b.working_tree()
790
basis_inv = b.basis_tree().inventory
793
if file_id in basis_inv:
795
path = inv.id2path(file_id)
796
if not os.access(b.abspath(path), os.F_OK):
802
class cmd_root(Command):
803
"""Show the tree root directory.
805
The root is the nearest enclosing directory with a .bzr control
807
takes_args = ['filename?']
809
def run(self, filename=None):
810
"""Print the branch root."""
811
b = Branch.open_containing(filename)[0]
815
class cmd_log(Command):
816
"""Show log of this branch.
818
To request a range of logs, you can use the command -r begin:end
819
-r revision requests a specific revision, -r :end or -r begin: are
823
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
825
takes_args = ['filename?']
826
takes_options = [Option('forward',
827
help='show from oldest to newest'),
828
'timezone', 'verbose',
829
'show-ids', 'revision',
830
Option('line', help='format with one line per revision'),
833
help='show revisions whose message matches this regexp',
835
Option('short', help='use moderately short format'),
838
def run(self, filename=None, timezone='original',
847
from bzrlib.log import log_formatter, show_log
849
assert message is None or isinstance(message, basestring), \
850
"invalid message argument %r" % message
851
direction = (forward and 'forward') or 'reverse'
854
b, fp = Branch.open_containing(filename)
857
inv = b.working_tree().read_working_inventory()
858
except NoWorkingTree:
859
inv = b.get_inventory(b.last_revision())
860
file_id = inv.path2id(fp)
862
file_id = None # points to branch root
864
b, relpath = Branch.open_containing('.')
870
elif len(revision) == 1:
871
rev1 = rev2 = revision[0].in_history(b).revno
872
elif len(revision) == 2:
873
rev1 = revision[0].in_history(b).revno
874
rev2 = revision[1].in_history(b).revno
876
raise BzrCommandError('bzr log --revision takes one or two values.')
883
mutter('encoding log as %r' % bzrlib.user_encoding)
885
# use 'replace' so that we don't abort if trying to write out
886
# in e.g. the default C locale.
887
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
894
lf = log_formatter(log_format,
897
show_timezone=timezone)
910
class cmd_touching_revisions(Command):
911
"""Return revision-ids which affected a particular file.
913
A more user-friendly interface is "bzr log FILE"."""
915
takes_args = ["filename"]
917
def run(self, filename):
918
b, relpath = Branch.open_containing(filename)[0]
919
inv = b.working_tree().read_working_inventory()
920
file_id = inv.path2id(relpath)
921
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
922
print "%6d %s" % (revno, what)
925
class cmd_ls(Command):
926
"""List files in a tree.
928
# TODO: Take a revision or remote path and list that tree instead.
930
takes_options = ['verbose', 'revision',
931
Option('non-recursive',
932
help='don\'t recurse into sub-directories'),
934
help='Print all paths from the root of the branch.'),
935
Option('unknown', help='Print unknown files'),
936
Option('versioned', help='Print versioned files'),
937
Option('ignored', help='Print ignored files'),
939
Option('null', help='Null separate the files'),
942
def run(self, revision=None, verbose=False,
943
non_recursive=False, from_root=False,
944
unknown=False, versioned=False, ignored=False,
948
raise BzrCommandError('Cannot set both --verbose and --null')
949
all = not (unknown or versioned or ignored)
951
selection = {'I':ignored, '?':unknown, 'V':versioned}
953
b, relpath = Branch.open_containing('.')
959
tree = b.working_tree()
961
tree = b.revision_tree(revision[0].in_history(b).rev_id)
962
for fp, fc, kind, fid, entry in tree.list_files():
963
if fp.startswith(relpath):
964
fp = fp[len(relpath):]
965
if non_recursive and '/' in fp:
967
if not all and not selection[fc]:
970
kindch = entry.kind_character()
971
print '%-8s %s%s' % (fc, fp, kindch)
974
sys.stdout.write('\0')
981
class cmd_unknowns(Command):
982
"""List unknown files."""
985
from bzrlib.osutils import quotefn
986
for f in Branch.open_containing('.')[0].unknowns():
991
class cmd_ignore(Command):
992
"""Ignore a command or pattern.
994
To remove patterns from the ignore list, edit the .bzrignore file.
996
If the pattern contains a slash, it is compared to the whole path
997
from the branch root. Otherwise, it is compared to only the last
998
component of the path. To match a file only in the root directory,
1001
Ignore patterns are case-insensitive on case-insensitive systems.
1003
Note: wildcards must be quoted from the shell on Unix.
1006
bzr ignore ./Makefile
1007
bzr ignore '*.class'
1009
# TODO: Complain if the filename is absolute
1010
takes_args = ['name_pattern']
1012
def run(self, name_pattern):
1013
from bzrlib.atomicfile import AtomicFile
1016
b, relpath = Branch.open_containing('.')
1017
ifn = b.abspath('.bzrignore')
1019
if os.path.exists(ifn):
1022
igns = f.read().decode('utf-8')
1028
# TODO: If the file already uses crlf-style termination, maybe
1029
# we should use that for the newly added lines?
1031
if igns and igns[-1] != '\n':
1033
igns += name_pattern + '\n'
1036
f = AtomicFile(ifn, 'wt')
1037
f.write(igns.encode('utf-8'))
1042
inv = b.working_tree().inventory
1043
if inv.path2id('.bzrignore'):
1044
mutter('.bzrignore is already versioned')
1046
mutter('need to make new .bzrignore file versioned')
1047
b.add(['.bzrignore'])
1051
class cmd_ignored(Command):
1052
"""List ignored files and the patterns that matched them.
1054
See also: bzr ignore"""
1057
tree = Branch.open_containing('.')[0].working_tree()
1058
for path, file_class, kind, file_id, entry in tree.list_files():
1059
if file_class != 'I':
1061
## XXX: Slightly inefficient since this was already calculated
1062
pat = tree.is_ignored(path)
1063
print '%-50s %s' % (path, pat)
1066
class cmd_lookup_revision(Command):
1067
"""Lookup the revision-id from a revision-number
1070
bzr lookup-revision 33
1073
takes_args = ['revno']
1076
def run(self, revno):
1080
raise BzrCommandError("not a valid revision-number: %r" % revno)
1082
print Branch.open_containing('.')[0].get_rev_id(revno)
1085
class cmd_export(Command):
1086
"""Export past revision to destination directory.
1088
If no revision is specified this exports the last committed revision.
1090
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1091
given, try to find the format with the extension. If no extension
1092
is found exports to a directory (equivalent to --format=dir).
1094
Root may be the top directory for tar, tgz and tbz2 formats. If none
1095
is given, the top directory will be the root name of the file."""
1096
# TODO: list known exporters
1097
takes_args = ['dest']
1098
takes_options = ['revision', 'format', 'root']
1099
def run(self, dest, revision=None, format=None, root=None):
1101
b = Branch.open_containing('.')[0]
1102
if revision is None:
1103
rev_id = b.last_revision()
1105
if len(revision) != 1:
1106
raise BzrError('bzr export --revision takes exactly 1 argument')
1107
rev_id = revision[0].in_history(b).rev_id
1108
t = b.revision_tree(rev_id)
1109
arg_root, ext = os.path.splitext(os.path.basename(dest))
1110
if ext in ('.gz', '.bz2'):
1111
new_root, new_ext = os.path.splitext(arg_root)
1112
if new_ext == '.tar':
1118
if ext in (".tar",):
1120
elif ext in (".tar.gz", ".tgz"):
1122
elif ext in (".tar.bz2", ".tbz2"):
1126
t.export(dest, format, root)
1129
class cmd_cat(Command):
1130
"""Write a file's text from a previous revision."""
1132
takes_options = ['revision']
1133
takes_args = ['filename']
1136
def run(self, filename, revision=None):
1137
if revision is None:
1138
raise BzrCommandError("bzr cat requires a revision number")
1139
elif len(revision) != 1:
1140
raise BzrCommandError("bzr cat --revision takes exactly one number")
1141
b, relpath = Branch.open_containing(filename)
1142
b.print_file(relpath, revision[0].in_history(b).revno)
1145
class cmd_local_time_offset(Command):
1146
"""Show the offset in seconds from GMT to local time."""
1150
print bzrlib.osutils.local_time_offset()
1154
class cmd_commit(Command):
1155
"""Commit changes into a new revision.
1157
If no arguments are given, the entire tree is committed.
1159
If selected files are specified, only changes to those files are
1160
committed. If a directory is specified then the directory and everything
1161
within it is committed.
1163
A selected-file commit may fail in some cases where the committed
1164
tree would be invalid, such as trying to commit a file in a
1165
newly-added directory that is not itself committed.
1167
# TODO: Run hooks on tree to-be-committed, and after commit.
1169
# TODO: Strict commit that fails if there are deleted files.
1170
# (what does "deleted files" mean ??)
1172
# TODO: Give better message for -s, --summary, used by tla people
1174
# XXX: verbose currently does nothing
1176
takes_args = ['selected*']
1177
takes_options = ['message', 'verbose',
1179
help='commit even if nothing has changed'),
1180
Option('file', type=str,
1182
help='file containing commit message'),
1184
help="refuse to commit if there are unknown "
1185
"files in the working tree."),
1187
aliases = ['ci', 'checkin']
1189
def run(self, message=None, file=None, verbose=True, selected_list=None,
1190
unchanged=False, strict=False):
1191
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1193
from bzrlib.msgeditor import edit_commit_message
1194
from bzrlib.status import show_status
1195
from cStringIO import StringIO
1197
b, selected_list = branch_files(selected_list)
1198
if message is None and not file:
1199
catcher = StringIO()
1200
show_status(b, specific_files=selected_list,
1202
message = edit_commit_message(catcher.getvalue())
1205
raise BzrCommandError("please specify a commit message"
1206
" with either --message or --file")
1207
elif message and file:
1208
raise BzrCommandError("please specify either --message or --file")
1212
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1215
raise BzrCommandError("empty commit message specified")
1218
b.commit(message, specific_files=selected_list,
1219
allow_pointless=unchanged, strict=strict)
1220
except PointlessCommit:
1221
# FIXME: This should really happen before the file is read in;
1222
# perhaps prepare the commit; get the message; then actually commit
1223
raise BzrCommandError("no changes to commit",
1224
["use --unchanged to commit anyhow"])
1225
except ConflictsInTree:
1226
raise BzrCommandError("Conflicts detected in working tree. "
1227
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1228
except StrictCommitFailed:
1229
raise BzrCommandError("Commit refused because there are unknown "
1230
"files in the working tree.")
1233
class cmd_check(Command):
1234
"""Validate consistency of branch history.
1236
This command checks various invariants about the branch storage to
1237
detect data corruption or bzr bugs.
1239
takes_args = ['dir?']
1240
takes_options = ['verbose']
1242
def run(self, dir='.', verbose=False):
1243
from bzrlib.check import check
1244
check(Branch.open_containing(dir)[0], verbose)
1247
class cmd_scan_cache(Command):
1250
from bzrlib.hashcache import HashCache
1256
print '%6d stats' % c.stat_count
1257
print '%6d in hashcache' % len(c._cache)
1258
print '%6d files removed from cache' % c.removed_count
1259
print '%6d hashes updated' % c.update_count
1260
print '%6d files changed too recently to cache' % c.danger_count
1267
class cmd_upgrade(Command):
1268
"""Upgrade branch storage to current format.
1270
The check command or bzr developers may sometimes advise you to run
1273
This version of this command upgrades from the full-text storage
1274
used by bzr 0.0.8 and earlier to the weave format (v5).
1276
takes_args = ['dir?']
1278
def run(self, dir='.'):
1279
from bzrlib.upgrade import upgrade
1283
class cmd_whoami(Command):
1284
"""Show bzr user id."""
1285
takes_options = ['email']
1288
def run(self, email=False):
1290
b = bzrlib.branch.Branch.open_containing('.')[0]
1291
config = bzrlib.config.BranchConfig(b)
1292
except NotBranchError:
1293
config = bzrlib.config.GlobalConfig()
1296
print config.user_email()
1298
print config.username()
1301
class cmd_selftest(Command):
1302
"""Run internal test suite.
1304
This creates temporary test directories in the working directory,
1305
but not existing data is affected. These directories are deleted
1306
if the tests pass, or left behind to help in debugging if they
1309
If arguments are given, they are regular expressions that say
1310
which tests should run.
1312
# TODO: --list should give a list of all available tests
1314
takes_args = ['testspecs*']
1315
takes_options = ['verbose',
1316
Option('one', help='stop when one test fails'),
1319
def run(self, testspecs_list=None, verbose=False, one=False):
1321
from bzrlib.selftest import selftest
1322
# we don't want progress meters from the tests to go to the
1323
# real output; and we don't want log messages cluttering up
1325
save_ui = bzrlib.ui.ui_factory
1326
bzrlib.trace.info('running tests...')
1328
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1329
if testspecs_list is not None:
1330
pattern = '|'.join(testspecs_list)
1333
result = selftest(verbose=verbose,
1335
stop_on_failure=one)
1337
bzrlib.trace.info('tests passed')
1339
bzrlib.trace.info('tests failed')
1340
return int(not result)
1342
bzrlib.ui.ui_factory = save_ui
1346
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1347
# is bzrlib itself in a branch?
1348
bzrrev = bzrlib.get_bzr_revision()
1350
print " (bzr checkout, revision %d {%s})" % bzrrev
1351
print bzrlib.__copyright__
1352
print "http://bazaar-ng.org/"
1354
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1355
print "you may use, modify and redistribute it under the terms of the GNU"
1356
print "General Public License version 2 or later."
1359
class cmd_version(Command):
1360
"""Show version of bzr."""
1365
class cmd_rocks(Command):
1366
"""Statement of optimism."""
1370
print "it sure does!"
1373
class cmd_find_merge_base(Command):
1374
"""Find and print a base revision for merging two branches.
1376
# TODO: Options to specify revisions on either side, as if
1377
# merging only part of the history.
1378
takes_args = ['branch', 'other']
1382
def run(self, branch, other):
1383
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1385
branch1 = Branch.open_containing(branch)[0]
1386
branch2 = Branch.open_containing(other)[0]
1388
history_1 = branch1.revision_history()
1389
history_2 = branch2.revision_history()
1391
last1 = branch1.last_revision()
1392
last2 = branch2.last_revision()
1394
source = MultipleRevisionSources(branch1, branch2)
1396
base_rev_id = common_ancestor(last1, last2, source)
1398
print 'merge base is revision %s' % base_rev_id
1402
if base_revno is None:
1403
raise bzrlib.errors.UnrelatedBranches()
1405
print ' r%-6d in %s' % (base_revno, branch)
1407
other_revno = branch2.revision_id_to_revno(base_revid)
1409
print ' r%-6d in %s' % (other_revno, other)
1413
class cmd_merge(Command):
1414
"""Perform a three-way merge.
1416
The branch is the branch you will merge from. By default, it will
1417
merge the latest revision. If you specify a revision, that
1418
revision will be merged. If you specify two revisions, the first
1419
will be used as a BASE, and the second one as OTHER. Revision
1420
numbers are always relative to the specified branch.
1422
By default bzr will try to merge in all new work from the other
1423
branch, automatically determining an appropriate base. If this
1424
fails, you may need to give an explicit base.
1428
To merge the latest revision from bzr.dev
1429
bzr merge ../bzr.dev
1431
To merge changes up to and including revision 82 from bzr.dev
1432
bzr merge -r 82 ../bzr.dev
1434
To merge the changes introduced by 82, without previous changes:
1435
bzr merge -r 81..82 ../bzr.dev
1437
merge refuses to run if there are any uncommitted changes, unless
1440
takes_args = ['branch?']
1441
takes_options = ['revision', 'force', 'merge-type', 'reprocess',
1442
Option('show-base', help="Show base revision text in "
1445
def run(self, branch=None, revision=None, force=False, merge_type=None,
1446
show_base=False, reprocess=False):
1447
from bzrlib.merge import merge
1448
from bzrlib.merge_core import ApplyMerge3
1449
if merge_type is None:
1450
merge_type = ApplyMerge3
1452
branch = Branch.open_containing('.')[0].get_parent()
1454
raise BzrCommandError("No merge location known or specified.")
1456
print "Using saved location: %s" % branch
1457
if revision is None or len(revision) < 1:
1459
other = [branch, -1]
1461
if len(revision) == 1:
1463
other_branch = Branch.open_containing(branch)[0]
1464
revno = revision[0].in_history(other_branch).revno
1465
other = [branch, revno]
1467
assert len(revision) == 2
1468
if None in revision:
1469
raise BzrCommandError(
1470
"Merge doesn't permit that revision specifier.")
1471
b = Branch.open_containing(branch)[0]
1473
base = [branch, revision[0].in_history(b).revno]
1474
other = [branch, revision[1].in_history(b).revno]
1477
conflict_count = merge(other, base, check_clean=(not force),
1478
merge_type=merge_type, reprocess=reprocess,
1479
show_base=show_base)
1480
if conflict_count != 0:
1484
except bzrlib.errors.AmbiguousBase, e:
1485
m = ("sorry, bzr can't determine the right merge base yet\n"
1486
"candidates are:\n "
1487
+ "\n ".join(e.bases)
1489
"please specify an explicit base with -r,\n"
1490
"and (if you want) report this to the bzr developers\n")
1494
class cmd_remerge(Command):
1497
takes_args = ['file*']
1498
takes_options = ['merge-type', 'reprocess',
1499
Option('show-base', help="Show base revision text in "
1502
def run(self, file_list=None, merge_type=None, show_base=False,
1504
from bzrlib.merge import merge_inner, transform_tree
1505
from bzrlib.merge_core import ApplyMerge3
1506
if merge_type is None:
1507
merge_type = ApplyMerge3
1508
b, file_list = branch_files(file_list)
1511
pending_merges = b.pending_merges()
1512
if len(pending_merges) != 1:
1513
raise BzrCommandError("Sorry, remerge only works after normal"
1514
+ " merges. Not cherrypicking or"
1516
this_tree = b.working_tree()
1517
base_revision = common_ancestor(b.last_revision(),
1518
pending_merges[0], b)
1519
base_tree = b.revision_tree(base_revision)
1520
other_tree = b.revision_tree(pending_merges[0])
1521
interesting_ids = None
1522
if file_list is not None:
1523
interesting_ids = set()
1524
for filename in file_list:
1525
file_id = this_tree.path2id(filename)
1526
interesting_ids.add(file_id)
1527
if this_tree.kind(file_id) != "directory":
1530
for name, ie in this_tree.inventory.iter_entries(file_id):
1531
interesting_ids.add(ie.file_id)
1532
transform_tree(this_tree, b.basis_tree(), interesting_ids)
1533
if file_list is None:
1534
restore_files = list(this_tree.iter_conflicts())
1536
restore_files = file_list
1537
for filename in restore_files:
1539
restore(this_tree.abspath(filename))
1540
except NotConflicted:
1542
conflicts = merge_inner(b, other_tree, base_tree,
1543
interesting_ids = interesting_ids,
1544
other_rev_id=pending_merges[0],
1545
merge_type=merge_type,
1546
show_base=show_base,
1547
reprocess=reprocess)
1555
class cmd_revert(Command):
1556
"""Reverse all changes since the last commit.
1558
Only versioned files are affected. Specify filenames to revert only
1559
those files. By default, any files that are changed will be backed up
1560
first. Backup files have a '~' appended to their name.
1562
takes_options = ['revision', 'no-backup']
1563
takes_args = ['file*']
1564
aliases = ['merge-revert']
1566
def run(self, revision=None, no_backup=False, file_list=None):
1567
from bzrlib.merge import merge
1568
from bzrlib.commands import parse_spec
1570
if file_list is not None:
1571
if len(file_list) == 0:
1572
raise BzrCommandError("No files specified")
1573
if revision is None:
1575
elif len(revision) != 1:
1576
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1578
b, file_list = branch_files(file_list)
1579
revno = revision[0].in_history(b).revno
1580
merge(('.', revno), parse_spec('.'),
1583
backup_files=not no_backup,
1584
file_list=file_list)
1586
Branch.open_containing('.')[0].set_pending_merges([])
1589
class cmd_assert_fail(Command):
1590
"""Test reporting of assertion failures"""
1593
assert False, "always fails"
1596
class cmd_help(Command):
1597
"""Show help on a command or other topic.
1599
For a list of all available commands, say 'bzr help commands'."""
1600
takes_options = ['long']
1601
takes_args = ['topic?']
1605
def run(self, topic=None, long=False):
1607
if topic is None and long:
1612
class cmd_shell_complete(Command):
1613
"""Show appropriate completions for context.
1615
For a list of all available commands, say 'bzr shell-complete'."""
1616
takes_args = ['context?']
1621
def run(self, context=None):
1622
import shellcomplete
1623
shellcomplete.shellcomplete(context)
1626
class cmd_fetch(Command):
1627
"""Copy in history from another branch but don't merge it.
1629
This is an internal method used for pull and merge."""
1631
takes_args = ['from_branch', 'to_branch']
1632
def run(self, from_branch, to_branch):
1633
from bzrlib.fetch import Fetcher
1634
from bzrlib.branch import Branch
1635
from_b = Branch.open(from_branch)
1636
to_b = Branch.open(to_branch)
1641
Fetcher(to_b, from_b)
1648
class cmd_missing(Command):
1649
"""What is missing in this branch relative to other branch.
1651
# TODO: rewrite this in terms of ancestry so that it shows only
1654
takes_args = ['remote?']
1655
aliases = ['mis', 'miss']
1656
# We don't have to add quiet to the list, because
1657
# unknown options are parsed as booleans
1658
takes_options = ['verbose', 'quiet']
1661
def run(self, remote=None, verbose=False, quiet=False):
1662
from bzrlib.errors import BzrCommandError
1663
from bzrlib.missing import show_missing
1665
if verbose and quiet:
1666
raise BzrCommandError('Cannot pass both quiet and verbose')
1668
b = Branch.open_containing('.')[0]
1669
parent = b.get_parent()
1672
raise BzrCommandError("No missing location known or specified.")
1675
print "Using last location: %s" % parent
1677
elif parent is None:
1678
# We only update parent if it did not exist, missing
1679
# should not change the parent
1680
b.set_parent(remote)
1681
br_remote = Branch.open_containing(remote)[0]
1682
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1685
class cmd_plugins(Command):
1690
import bzrlib.plugin
1691
from inspect import getdoc
1692
for plugin in bzrlib.plugin.all_plugins:
1693
if hasattr(plugin, '__path__'):
1694
print plugin.__path__[0]
1695
elif hasattr(plugin, '__file__'):
1696
print plugin.__file__
1702
print '\t', d.split('\n')[0]
1705
class cmd_testament(Command):
1706
"""Show testament (signing-form) of a revision."""
1707
takes_options = ['revision', 'long']
1708
takes_args = ['branch?']
1710
def run(self, branch='.', revision=None, long=False):
1711
from bzrlib.testament import Testament
1712
b = Branch.open_containing(branch)[0]
1715
if revision is None:
1716
rev_id = b.last_revision()
1718
rev_id = revision[0].in_history(b).rev_id
1719
t = Testament.from_revision(b, rev_id)
1721
sys.stdout.writelines(t.as_text_lines())
1723
sys.stdout.write(t.as_short_text())
1728
class cmd_annotate(Command):
1729
"""Show the origin of each line in a file.
1731
This prints out the given file with an annotation on the left side
1732
indicating which revision, author and date introduced the change.
1734
If the origin is the same for a run of consecutive lines, it is
1735
shown only at the top, unless the --all option is given.
1737
# TODO: annotate directories; showing when each file was last changed
1738
# TODO: annotate a previous version of a file
1739
# TODO: if the working copy is modified, show annotations on that
1740
# with new uncommitted lines marked
1741
aliases = ['blame', 'praise']
1742
takes_args = ['filename']
1743
takes_options = [Option('all', help='show annotations on all lines'),
1744
Option('long', help='show date in annotations'),
1748
def run(self, filename, all=False, long=False):
1749
from bzrlib.annotate import annotate_file
1750
b, relpath = Branch.open_containing(filename)
1753
tree = WorkingTree(b.base, b)
1754
tree = b.revision_tree(b.last_revision())
1755
file_id = tree.inventory.path2id(relpath)
1756
file_version = tree.inventory[file_id].revision
1757
annotate_file(b, file_version, file_id, long, all, sys.stdout)
1762
class cmd_re_sign(Command):
1763
"""Create a digital signature for an existing revision."""
1764
# TODO be able to replace existing ones.
1766
hidden = True # is this right ?
1767
takes_args = ['revision_id?']
1768
takes_options = ['revision']
1770
def run(self, revision_id=None, revision=None):
1771
import bzrlib.config as config
1772
import bzrlib.gpg as gpg
1773
if revision_id is not None and revision is not None:
1774
raise BzrCommandError('You can only supply one of revision_id or --revision')
1775
if revision_id is None and revision is None:
1776
raise BzrCommandError('You must supply either --revision or a revision_id')
1777
b = Branch.open_containing('.')[0]
1778
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
1779
if revision_id is not None:
1780
b.sign_revision(revision_id, gpg_strategy)
1781
elif revision is not None:
1782
if len(revision) == 1:
1783
revno, rev_id = revision[0].in_history(b)
1784
b.sign_revision(rev_id, gpg_strategy)
1785
elif len(revision) == 2:
1786
# are they both on rh- if so we can walk between them
1787
# might be nice to have a range helper for arbitrary
1788
# revision paths. hmm.
1789
from_revno, from_revid = revision[0].in_history(b)
1790
to_revno, to_revid = revision[1].in_history(b)
1791
if to_revid is None:
1792
to_revno = b.revno()
1793
if from_revno is None or to_revno is None:
1794
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
1795
for revno in range(from_revno, to_revno + 1):
1796
b.sign_revision(b.get_rev_id(revno), gpg_strategy)
1798
raise BzrCommandError('Please supply either one revision, or a range.')
1801
# these get imported and then picked up by the scan for cmd_*
1802
# TODO: Some more consistent way to split command definitions across files;
1803
# we do need to load at least some information about them to know of
1805
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
added
removed
bzrlib/builtins.py
