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, NoSuchFile
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
br_from = Branch.open(location)
384
br_to.working_tree().pull(br_from, overwrite)
385
except DivergedBranches:
386
raise BzrCommandError("These branches have diverged."
388
if br_to.get_parent() is None or remember:
389
br_to.set_parent(location)
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
Option('create-prefix',
417
help='Create the path leading up to the branch '
418
'if it does not already exist')]
419
takes_args = ['location?']
421
def run(self, location=None, remember=False, overwrite=False,
422
create_prefix=False):
424
from shutil import rmtree
425
from bzrlib.transport import get_transport
427
br_from = Branch.open_containing('.')[0]
428
stored_loc = br_from.get_push_location()
430
if stored_loc is None:
431
raise BzrCommandError("No push location known or specified.")
433
print "Using saved location: %s" % stored_loc
434
location = stored_loc
436
br_to = Branch.open(location)
437
except NotBranchError:
439
transport = get_transport(location).clone('..')
440
if not create_prefix:
442
transport.mkdir(transport.relpath(location))
444
raise BzrCommandError("Parent directory of %s "
445
"does not exist." % location)
447
current = transport.base
448
needed = [(transport, transport.relpath(location))]
451
transport, relpath = needed[-1]
452
transport.mkdir(relpath)
455
new_transport = transport.clone('..')
456
needed.append((new_transport,
457
new_transport.relpath(transport.base)))
458
if new_transport.base == transport.base:
459
raise BzrCommandError("Could not creeate "
463
br_to = Branch.initialize(location)
465
br_to.pull(br_from, overwrite)
466
except DivergedBranches:
467
raise BzrCommandError("These branches have diverged."
468
" Try a merge then push with overwrite.")
469
if br_from.get_push_location() is None or remember:
470
br_from.set_push_location(location)
473
class cmd_branch(Command):
474
"""Create a new copy of a branch.
476
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
477
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
479
To retrieve the branch as of a particular revision, supply the --revision
480
parameter, as in "branch foo/bar -r 5".
482
--basis is to speed up branching from remote branches. When specified, it
483
copies all the file-contents, inventory and revision data from the basis
484
branch before copying anything from the remote branch.
486
takes_args = ['from_location', 'to_location?']
487
takes_options = ['revision', 'basis']
488
aliases = ['get', 'clone']
490
def run(self, from_location, to_location=None, revision=None, basis=None):
491
from bzrlib.clone import copy_branch
493
from shutil import rmtree
496
elif len(revision) > 1:
497
raise BzrCommandError(
498
'bzr branch --revision takes exactly 1 revision value')
500
br_from = Branch.open(from_location)
502
if e.errno == errno.ENOENT:
503
raise BzrCommandError('Source location "%s" does not'
504
' exist.' % to_location)
509
if basis is not None:
510
basis_branch = Branch.open_containing(basis)[0]
513
if len(revision) == 1 and revision[0] is not None:
514
revision_id = revision[0].in_history(br_from)[1]
517
if to_location is None:
518
to_location = os.path.basename(from_location.rstrip("/\\"))
521
name = os.path.basename(to_location) + '\n'
523
os.mkdir(to_location)
525
if e.errno == errno.EEXIST:
526
raise BzrCommandError('Target directory "%s" already'
527
' exists.' % to_location)
528
if e.errno == errno.ENOENT:
529
raise BzrCommandError('Parent of "%s" does not exist.' %
534
copy_branch(br_from, to_location, revision_id, basis_branch)
535
except bzrlib.errors.NoSuchRevision:
537
msg = "The branch %s has no revision %s." % (from_location, revision[0])
538
raise BzrCommandError(msg)
539
except bzrlib.errors.UnlistableBranch:
541
msg = "The branch %s cannot be used as a --basis"
542
raise BzrCommandError(msg)
544
branch = Branch.open(to_location)
545
name = StringIO(name)
546
branch.put_controlfile('branch-name', name)
551
class cmd_renames(Command):
552
"""Show list of renamed files.
554
# TODO: Option to show renames between two historical versions.
556
# TODO: Only show renames under dir, rather than in the whole branch.
557
takes_args = ['dir?']
560
def run(self, dir='.'):
561
b = Branch.open_containing(dir)[0]
562
old_inv = b.basis_tree().inventory
563
new_inv = b.read_working_inventory()
565
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
567
for old_name, new_name in renames:
568
print "%s => %s" % (old_name, new_name)
571
class cmd_info(Command):
572
"""Show statistical information about a branch."""
573
takes_args = ['branch?']
576
def run(self, branch=None):
578
b = Branch.open_containing(branch)[0]
582
class cmd_remove(Command):
583
"""Make a file unversioned.
585
This makes bzr stop tracking changes to a versioned file. It does
586
not delete the working copy.
588
takes_args = ['file+']
589
takes_options = ['verbose']
592
def run(self, file_list, verbose=False):
593
b, file_list = branch_files(file_list)
594
tree = b.working_tree()
595
tree.remove(file_list, verbose=verbose)
598
class cmd_file_id(Command):
599
"""Print file_id of a particular file or directory.
601
The file_id is assigned when the file is first added and remains the
602
same through all revisions where the file exists, even when it is
606
takes_args = ['filename']
608
def run(self, filename):
609
b, relpath = Branch.open_containing(filename)
610
i = b.inventory.path2id(relpath)
612
raise BzrError("%r is not a versioned file" % filename)
617
class cmd_file_path(Command):
618
"""Print path of file_ids to a file or directory.
620
This prints one line for each directory down to the target,
621
starting at the branch root."""
623
takes_args = ['filename']
625
def run(self, filename):
626
b, relpath = Branch.open_containing(filename)
628
fid = inv.path2id(relpath)
630
raise BzrError("%r is not a versioned file" % filename)
631
for fip in inv.get_idpath(fid):
635
class cmd_revision_history(Command):
636
"""Display list of revision ids on this branch."""
640
for patchid in Branch.open_containing('.')[0].revision_history():
644
class cmd_ancestry(Command):
645
"""List all revisions merged into this branch."""
649
b = Branch.open_containing('.')[0]
650
for revision_id in b.get_ancestry(b.last_revision()):
654
class cmd_directories(Command):
655
"""Display list of versioned directories in this branch."""
658
for name, ie in Branch.open_containing('.')[0].read_working_inventory().directories():
665
class cmd_init(Command):
666
"""Make a directory into a versioned branch.
668
Use this to create an empty branch, or before importing an
671
Recipe for importing a tree of files:
676
bzr commit -m 'imported project'
679
Branch.initialize('.')
682
class cmd_diff(Command):
683
"""Show differences in working tree.
685
If files are listed, only the changes in those files are listed.
686
Otherwise, all changes for the tree are listed.
693
# TODO: Allow diff across branches.
694
# TODO: Option to use external diff command; could be GNU diff, wdiff,
695
# or a graphical diff.
697
# TODO: Python difflib is not exactly the same as unidiff; should
698
# either fix it up or prefer to use an external diff.
700
# TODO: If a directory is given, diff everything under that.
702
# TODO: Selected-file diff is inefficient and doesn't show you
705
# TODO: This probably handles non-Unix newlines poorly.
707
takes_args = ['file*']
708
takes_options = ['revision', 'diff-options']
709
aliases = ['di', 'dif']
712
def run(self, revision=None, file_list=None, diff_options=None):
713
from bzrlib.diff import show_diff
715
b, file_list = branch_files(file_list)
716
if revision is not None:
717
if len(revision) == 1:
718
return show_diff(b, revision[0], specific_files=file_list,
719
external_diff_options=diff_options)
720
elif len(revision) == 2:
721
return show_diff(b, revision[0], specific_files=file_list,
722
external_diff_options=diff_options,
723
revision2=revision[1])
725
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
727
return show_diff(b, None, specific_files=file_list,
728
external_diff_options=diff_options)
731
class cmd_deleted(Command):
732
"""List files deleted in the working tree.
734
# TODO: Show files deleted since a previous revision, or
735
# between two revisions.
736
# TODO: Much more efficient way to do this: read in new
737
# directories with readdir, rather than stating each one. Same
738
# level of effort but possibly much less IO. (Or possibly not,
739
# if the directories are very large...)
741
def run(self, show_ids=False):
742
b = Branch.open_containing('.')[0]
744
new = b.working_tree()
745
for path, ie in old.inventory.iter_entries():
746
if not new.has_id(ie.file_id):
748
print '%-50s %s' % (path, ie.file_id)
753
class cmd_modified(Command):
754
"""List files modified in working tree."""
758
from bzrlib.delta import compare_trees
760
b = Branch.open_containing('.')[0]
761
td = compare_trees(b.basis_tree(), b.working_tree())
763
for path, id, kind, text_modified, meta_modified in td.modified:
768
class cmd_added(Command):
769
"""List files added in working tree."""
773
b = Branch.open_containing('.')[0]
774
wt = b.working_tree()
775
basis_inv = b.basis_tree().inventory
778
if file_id in basis_inv:
780
path = inv.id2path(file_id)
781
if not os.access(b.abspath(path), os.F_OK):
787
class cmd_root(Command):
788
"""Show the tree root directory.
790
The root is the nearest enclosing directory with a .bzr control
792
takes_args = ['filename?']
794
def run(self, filename=None):
795
"""Print the branch root."""
796
b = Branch.open_containing(filename)[0]
800
class cmd_log(Command):
801
"""Show log of this branch.
803
To request a range of logs, you can use the command -r begin:end
804
-r revision requests a specific revision, -r :end or -r begin: are
808
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
810
takes_args = ['filename?']
811
takes_options = [Option('forward',
812
help='show from oldest to newest'),
813
'timezone', 'verbose',
814
'show-ids', 'revision',
815
Option('line', help='format with one line per revision'),
818
help='show revisions whose message matches this regexp',
820
Option('short', help='use moderately short format'),
823
def run(self, filename=None, timezone='original',
832
from bzrlib.log import log_formatter, show_log
834
assert message is None or isinstance(message, basestring), \
835
"invalid message argument %r" % message
836
direction = (forward and 'forward') or 'reverse'
839
b, fp = Branch.open_containing(filename)
841
file_id = b.read_working_inventory().path2id(fp)
843
file_id = None # points to branch root
845
b, relpath = Branch.open_containing('.')
851
elif len(revision) == 1:
852
rev1 = rev2 = revision[0].in_history(b).revno
853
elif len(revision) == 2:
854
rev1 = revision[0].in_history(b).revno
855
rev2 = revision[1].in_history(b).revno
857
raise BzrCommandError('bzr log --revision takes one or two values.')
864
mutter('encoding log as %r' % bzrlib.user_encoding)
866
# use 'replace' so that we don't abort if trying to write out
867
# in e.g. the default C locale.
868
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
875
lf = log_formatter(log_format,
878
show_timezone=timezone)
891
class cmd_touching_revisions(Command):
892
"""Return revision-ids which affected a particular file.
894
A more user-friendly interface is "bzr log FILE"."""
896
takes_args = ["filename"]
898
def run(self, filename):
899
b, relpath = Branch.open_containing(filename)[0]
900
inv = b.read_working_inventory()
901
file_id = inv.path2id(relpath)
902
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
903
print "%6d %s" % (revno, what)
906
class cmd_ls(Command):
907
"""List files in a tree.
909
# TODO: Take a revision or remote path and list that tree instead.
911
takes_options = ['verbose', 'revision',
912
Option('non-recursive',
913
help='don\'t recurse into sub-directories'),
915
help='Print all paths from the root of the branch.'),
916
Option('unknown', help='Print unknown files'),
917
Option('versioned', help='Print versioned files'),
918
Option('ignored', help='Print ignored files'),
920
Option('null', help='Null separate the files'),
923
def run(self, revision=None, verbose=False,
924
non_recursive=False, from_root=False,
925
unknown=False, versioned=False, ignored=False,
929
raise BzrCommandError('Cannot set both --verbose and --null')
930
all = not (unknown or versioned or ignored)
932
selection = {'I':ignored, '?':unknown, 'V':versioned}
934
b, relpath = Branch.open_containing('.')
940
tree = b.working_tree()
942
tree = b.revision_tree(revision[0].in_history(b).rev_id)
943
for fp, fc, kind, fid, entry in tree.list_files():
944
if fp.startswith(relpath):
945
fp = fp[len(relpath):]
946
if non_recursive and '/' in fp:
948
if not all and not selection[fc]:
951
kindch = entry.kind_character()
952
print '%-8s %s%s' % (fc, fp, kindch)
955
sys.stdout.write('\0')
962
class cmd_unknowns(Command):
963
"""List unknown files."""
966
from bzrlib.osutils import quotefn
967
for f in Branch.open_containing('.')[0].unknowns():
972
class cmd_ignore(Command):
973
"""Ignore a command or pattern.
975
To remove patterns from the ignore list, edit the .bzrignore file.
977
If the pattern contains a slash, it is compared to the whole path
978
from the branch root. Otherwise, it is compared to only the last
979
component of the path. To match a file only in the root directory,
982
Ignore patterns are case-insensitive on case-insensitive systems.
984
Note: wildcards must be quoted from the shell on Unix.
987
bzr ignore ./Makefile
990
# TODO: Complain if the filename is absolute
991
takes_args = ['name_pattern']
993
def run(self, name_pattern):
994
from bzrlib.atomicfile import AtomicFile
997
b, relpath = Branch.open_containing('.')
998
ifn = b.abspath('.bzrignore')
1000
if os.path.exists(ifn):
1003
igns = f.read().decode('utf-8')
1009
# TODO: If the file already uses crlf-style termination, maybe
1010
# we should use that for the newly added lines?
1012
if igns and igns[-1] != '\n':
1014
igns += name_pattern + '\n'
1017
f = AtomicFile(ifn, 'wt')
1018
f.write(igns.encode('utf-8'))
1023
inv = b.working_tree().inventory
1024
if inv.path2id('.bzrignore'):
1025
mutter('.bzrignore is already versioned')
1027
mutter('need to make new .bzrignore file versioned')
1028
b.add(['.bzrignore'])
1032
class cmd_ignored(Command):
1033
"""List ignored files and the patterns that matched them.
1035
See also: bzr ignore"""
1038
tree = Branch.open_containing('.')[0].working_tree()
1039
for path, file_class, kind, file_id, entry in tree.list_files():
1040
if file_class != 'I':
1042
## XXX: Slightly inefficient since this was already calculated
1043
pat = tree.is_ignored(path)
1044
print '%-50s %s' % (path, pat)
1047
class cmd_lookup_revision(Command):
1048
"""Lookup the revision-id from a revision-number
1051
bzr lookup-revision 33
1054
takes_args = ['revno']
1057
def run(self, revno):
1061
raise BzrCommandError("not a valid revision-number: %r" % revno)
1063
print Branch.open_containing('.')[0].get_rev_id(revno)
1066
class cmd_export(Command):
1067
"""Export past revision to destination directory.
1069
If no revision is specified this exports the last committed revision.
1071
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1072
given, try to find the format with the extension. If no extension
1073
is found exports to a directory (equivalent to --format=dir).
1075
Root may be the top directory for tar, tgz and tbz2 formats. If none
1076
is given, the top directory will be the root name of the file."""
1077
# TODO: list known exporters
1078
takes_args = ['dest']
1079
takes_options = ['revision', 'format', 'root']
1080
def run(self, dest, revision=None, format=None, root=None):
1082
b = Branch.open_containing('.')[0]
1083
if revision is None:
1084
rev_id = b.last_revision()
1086
if len(revision) != 1:
1087
raise BzrError('bzr export --revision takes exactly 1 argument')
1088
rev_id = revision[0].in_history(b).rev_id
1089
t = b.revision_tree(rev_id)
1090
arg_root, ext = os.path.splitext(os.path.basename(dest))
1091
if ext in ('.gz', '.bz2'):
1092
new_root, new_ext = os.path.splitext(arg_root)
1093
if new_ext == '.tar':
1099
if ext in (".tar",):
1101
elif ext in (".tar.gz", ".tgz"):
1103
elif ext in (".tar.bz2", ".tbz2"):
1107
t.export(dest, format, root)
1110
class cmd_cat(Command):
1111
"""Write a file's text from a previous revision."""
1113
takes_options = ['revision']
1114
takes_args = ['filename']
1117
def run(self, filename, revision=None):
1118
if revision is None:
1119
raise BzrCommandError("bzr cat requires a revision number")
1120
elif len(revision) != 1:
1121
raise BzrCommandError("bzr cat --revision takes exactly one number")
1122
b, relpath = Branch.open_containing(filename)
1123
b.print_file(relpath, revision[0].in_history(b).revno)
1126
class cmd_local_time_offset(Command):
1127
"""Show the offset in seconds from GMT to local time."""
1131
print bzrlib.osutils.local_time_offset()
1135
class cmd_commit(Command):
1136
"""Commit changes into a new revision.
1138
If no arguments are given, the entire tree is committed.
1140
If selected files are specified, only changes to those files are
1141
committed. If a directory is specified then the directory and everything
1142
within it is committed.
1144
A selected-file commit may fail in some cases where the committed
1145
tree would be invalid, such as trying to commit a file in a
1146
newly-added directory that is not itself committed.
1148
# TODO: Run hooks on tree to-be-committed, and after commit.
1150
# TODO: Strict commit that fails if there are deleted files.
1151
# (what does "deleted files" mean ??)
1153
# TODO: Give better message for -s, --summary, used by tla people
1155
# XXX: verbose currently does nothing
1157
takes_args = ['selected*']
1158
takes_options = ['message', 'verbose',
1160
help='commit even if nothing has changed'),
1161
Option('file', type=str,
1163
help='file containing commit message'),
1165
help="refuse to commit if there are unknown "
1166
"files in the working tree."),
1168
aliases = ['ci', 'checkin']
1170
def run(self, message=None, file=None, verbose=True, selected_list=None,
1171
unchanged=False, strict=False):
1172
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1174
from bzrlib.msgeditor import edit_commit_message
1175
from bzrlib.status import show_status
1176
from cStringIO import StringIO
1178
b, selected_list = branch_files(selected_list)
1179
if message is None and not file:
1180
catcher = StringIO()
1181
show_status(b, specific_files=selected_list,
1183
message = edit_commit_message(catcher.getvalue())
1186
raise BzrCommandError("please specify a commit message"
1187
" with either --message or --file")
1188
elif message and file:
1189
raise BzrCommandError("please specify either --message or --file")
1193
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1196
raise BzrCommandError("empty commit message specified")
1199
b.commit(message, specific_files=selected_list,
1200
allow_pointless=unchanged, strict=strict)
1201
except PointlessCommit:
1202
# FIXME: This should really happen before the file is read in;
1203
# perhaps prepare the commit; get the message; then actually commit
1204
raise BzrCommandError("no changes to commit",
1205
["use --unchanged to commit anyhow"])
1206
except ConflictsInTree:
1207
raise BzrCommandError("Conflicts detected in working tree. "
1208
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
1209
except StrictCommitFailed:
1210
raise BzrCommandError("Commit refused because there are unknown "
1211
"files in the working tree.")
1214
class cmd_check(Command):
1215
"""Validate consistency of branch history.
1217
This command checks various invariants about the branch storage to
1218
detect data corruption or bzr bugs.
1220
takes_args = ['dir?']
1221
takes_options = ['verbose']
1223
def run(self, dir='.', verbose=False):
1224
from bzrlib.check import check
1225
check(Branch.open_containing(dir)[0], verbose)
1228
class cmd_scan_cache(Command):
1231
from bzrlib.hashcache import HashCache
1237
print '%6d stats' % c.stat_count
1238
print '%6d in hashcache' % len(c._cache)
1239
print '%6d files removed from cache' % c.removed_count
1240
print '%6d hashes updated' % c.update_count
1241
print '%6d files changed too recently to cache' % c.danger_count
1248
class cmd_upgrade(Command):
1249
"""Upgrade branch storage to current format.
1251
The check command or bzr developers may sometimes advise you to run
1254
This version of this command upgrades from the full-text storage
1255
used by bzr 0.0.8 and earlier to the weave format (v5).
1257
takes_args = ['dir?']
1259
def run(self, dir='.'):
1260
from bzrlib.upgrade import upgrade
1264
class cmd_whoami(Command):
1265
"""Show bzr user id."""
1266
takes_options = ['email']
1269
def run(self, email=False):
1271
b = bzrlib.branch.Branch.open_containing('.')[0]
1272
config = bzrlib.config.BranchConfig(b)
1273
except NotBranchError:
1274
config = bzrlib.config.GlobalConfig()
1277
print config.user_email()
1279
print config.username()
1282
class cmd_selftest(Command):
1283
"""Run internal test suite.
1285
This creates temporary test directories in the working directory,
1286
but not existing data is affected. These directories are deleted
1287
if the tests pass, or left behind to help in debugging if they
1290
If arguments are given, they are regular expressions that say
1291
which tests should run.
1293
# TODO: --list should give a list of all available tests
1295
takes_args = ['testspecs*']
1296
takes_options = ['verbose',
1297
Option('one', help='stop when one test fails'),
1300
def run(self, testspecs_list=None, verbose=False, one=False):
1302
from bzrlib.selftest import selftest
1303
# we don't want progress meters from the tests to go to the
1304
# real output; and we don't want log messages cluttering up
1306
save_ui = bzrlib.ui.ui_factory
1307
bzrlib.trace.info('running tests...')
1309
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1310
if testspecs_list is not None:
1311
pattern = '|'.join(testspecs_list)
1314
result = selftest(verbose=verbose,
1316
stop_on_failure=one)
1318
bzrlib.trace.info('tests passed')
1320
bzrlib.trace.info('tests failed')
1321
return int(not result)
1323
bzrlib.ui.ui_factory = save_ui
1327
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1328
# is bzrlib itself in a branch?
1329
bzrrev = bzrlib.get_bzr_revision()
1331
print " (bzr checkout, revision %d {%s})" % bzrrev
1332
print bzrlib.__copyright__
1333
print "http://bazaar-ng.org/"
1335
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1336
print "you may use, modify and redistribute it under the terms of the GNU"
1337
print "General Public License version 2 or later."
1340
class cmd_version(Command):
1341
"""Show version of bzr."""
1346
class cmd_rocks(Command):
1347
"""Statement of optimism."""
1351
print "it sure does!"
1354
class cmd_find_merge_base(Command):
1355
"""Find and print a base revision for merging two branches.
1357
# TODO: Options to specify revisions on either side, as if
1358
# merging only part of the history.
1359
takes_args = ['branch', 'other']
1363
def run(self, branch, other):
1364
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1366
branch1 = Branch.open_containing(branch)[0]
1367
branch2 = Branch.open_containing(other)[0]
1369
history_1 = branch1.revision_history()
1370
history_2 = branch2.revision_history()
1372
last1 = branch1.last_revision()
1373
last2 = branch2.last_revision()
1375
source = MultipleRevisionSources(branch1, branch2)
1377
base_rev_id = common_ancestor(last1, last2, source)
1379
print 'merge base is revision %s' % base_rev_id
1383
if base_revno is None:
1384
raise bzrlib.errors.UnrelatedBranches()
1386
print ' r%-6d in %s' % (base_revno, branch)
1388
other_revno = branch2.revision_id_to_revno(base_revid)
1390
print ' r%-6d in %s' % (other_revno, other)
1394
class cmd_merge(Command):
1395
"""Perform a three-way merge.
1397
The branch is the branch you will merge from. By default, it will
1398
merge the latest revision. If you specify a revision, that
1399
revision will be merged. If you specify two revisions, the first
1400
will be used as a BASE, and the second one as OTHER. Revision
1401
numbers are always relative to the specified branch.
1403
By default bzr will try to merge in all new work from the other
1404
branch, automatically determining an appropriate base. If this
1405
fails, you may need to give an explicit base.
1409
To merge the latest revision from bzr.dev
1410
bzr merge ../bzr.dev
1412
To merge changes up to and including revision 82 from bzr.dev
1413
bzr merge -r 82 ../bzr.dev
1415
To merge the changes introduced by 82, without previous changes:
1416
bzr merge -r 81..82 ../bzr.dev
1418
merge refuses to run if there are any uncommitted changes, unless
1421
takes_args = ['branch?']
1422
takes_options = ['revision', 'force', 'merge-type', 'reprocess',
1423
Option('show-base', help="Show base revision text in "
1426
def run(self, branch=None, revision=None, force=False, merge_type=None,
1427
show_base=False, reprocess=False):
1428
from bzrlib.merge import merge
1429
from bzrlib.merge_core import ApplyMerge3
1430
if merge_type is None:
1431
merge_type = ApplyMerge3
1433
branch = Branch.open_containing('.')[0].get_parent()
1435
raise BzrCommandError("No merge location known or specified.")
1437
print "Using saved location: %s" % branch
1438
if revision is None or len(revision) < 1:
1440
other = [branch, -1]
1442
if len(revision) == 1:
1444
other_branch = Branch.open_containing(branch)[0]
1445
revno = revision[0].in_history(other_branch).revno
1446
other = [branch, revno]
1448
assert len(revision) == 2
1449
if None in revision:
1450
raise BzrCommandError(
1451
"Merge doesn't permit that revision specifier.")
1452
b = Branch.open_containing(branch)[0]
1454
base = [branch, revision[0].in_history(b).revno]
1455
other = [branch, revision[1].in_history(b).revno]
1458
conflict_count = merge(other, base, check_clean=(not force),
1459
merge_type=merge_type, reprocess=reprocess,
1460
show_base=show_base)
1461
if conflict_count != 0:
1465
except bzrlib.errors.AmbiguousBase, e:
1466
m = ("sorry, bzr can't determine the right merge base yet\n"
1467
"candidates are:\n "
1468
+ "\n ".join(e.bases)
1470
"please specify an explicit base with -r,\n"
1471
"and (if you want) report this to the bzr developers\n")
1475
class cmd_revert(Command):
1476
"""Reverse all changes since the last commit.
1478
Only versioned files are affected. Specify filenames to revert only
1479
those files. By default, any files that are changed will be backed up
1480
first. Backup files have a '~' appended to their name.
1482
takes_options = ['revision', 'no-backup']
1483
takes_args = ['file*']
1484
aliases = ['merge-revert']
1486
def run(self, revision=None, no_backup=False, file_list=None):
1487
from bzrlib.merge import merge
1488
from bzrlib.commands import parse_spec
1490
if file_list is not None:
1491
if len(file_list) == 0:
1492
raise BzrCommandError("No files specified")
1493
if revision is None:
1495
elif len(revision) != 1:
1496
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1498
b, file_list = branch_files(file_list)
1499
revno = revision[0].in_history(b).revno
1500
merge(('.', revno), parse_spec('.'),
1503
backup_files=not no_backup,
1504
file_list=file_list)
1506
Branch.open_containing('.')[0].set_pending_merges([])
1509
class cmd_assert_fail(Command):
1510
"""Test reporting of assertion failures"""
1513
assert False, "always fails"
1516
class cmd_help(Command):
1517
"""Show help on a command or other topic.
1519
For a list of all available commands, say 'bzr help commands'."""
1520
takes_options = ['long']
1521
takes_args = ['topic?']
1525
def run(self, topic=None, long=False):
1527
if topic is None and long:
1532
class cmd_shell_complete(Command):
1533
"""Show appropriate completions for context.
1535
For a list of all available commands, say 'bzr shell-complete'."""
1536
takes_args = ['context?']
1541
def run(self, context=None):
1542
import shellcomplete
1543
shellcomplete.shellcomplete(context)
1546
class cmd_fetch(Command):
1547
"""Copy in history from another branch but don't merge it.
1549
This is an internal method used for pull and merge."""
1551
takes_args = ['from_branch', 'to_branch']
1552
def run(self, from_branch, to_branch):
1553
from bzrlib.fetch import Fetcher
1554
from bzrlib.branch import Branch
1555
from_b = Branch.open(from_branch)
1556
to_b = Branch.open(to_branch)
1561
Fetcher(to_b, from_b)
1568
class cmd_missing(Command):
1569
"""What is missing in this branch relative to other branch.
1571
# TODO: rewrite this in terms of ancestry so that it shows only
1574
takes_args = ['remote?']
1575
aliases = ['mis', 'miss']
1576
# We don't have to add quiet to the list, because
1577
# unknown options are parsed as booleans
1578
takes_options = ['verbose', 'quiet']
1581
def run(self, remote=None, verbose=False, quiet=False):
1582
from bzrlib.errors import BzrCommandError
1583
from bzrlib.missing import show_missing
1585
if verbose and quiet:
1586
raise BzrCommandError('Cannot pass both quiet and verbose')
1588
b = Branch.open_containing('.')[0]
1589
parent = b.get_parent()
1592
raise BzrCommandError("No missing location known or specified.")
1595
print "Using last location: %s" % parent
1597
elif parent is None:
1598
# We only update parent if it did not exist, missing
1599
# should not change the parent
1600
b.set_parent(remote)
1601
br_remote = Branch.open_containing(remote)[0]
1602
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1605
class cmd_plugins(Command):
1610
import bzrlib.plugin
1611
from inspect import getdoc
1612
for plugin in bzrlib.plugin.all_plugins:
1613
if hasattr(plugin, '__path__'):
1614
print plugin.__path__[0]
1615
elif hasattr(plugin, '__file__'):
1616
print plugin.__file__
1622
print '\t', d.split('\n')[0]
1625
class cmd_testament(Command):
1626
"""Show testament (signing-form) of a revision."""
1627
takes_options = ['revision', 'long']
1628
takes_args = ['branch?']
1630
def run(self, branch='.', revision=None, long=False):
1631
from bzrlib.testament import Testament
1632
b = Branch.open_containing(branch)[0]
1635
if revision is None:
1636
rev_id = b.last_revision()
1638
rev_id = revision[0].in_history(b).rev_id
1639
t = Testament.from_revision(b, rev_id)
1641
sys.stdout.writelines(t.as_text_lines())
1643
sys.stdout.write(t.as_short_text())
1648
class cmd_annotate(Command):
1649
"""Show the origin of each line in a file.
1651
This prints out the given file with an annotation on the left side
1652
indicating which revision, author and date introduced the change.
1654
If the origin is the same for a run of consecutive lines, it is
1655
shown only at the top, unless the --all option is given.
1657
# TODO: annotate directories; showing when each file was last changed
1658
# TODO: annotate a previous version of a file
1659
# TODO: if the working copy is modified, show annotations on that
1660
# with new uncommitted lines marked
1661
aliases = ['blame', 'praise']
1662
takes_args = ['filename']
1663
takes_options = [Option('all', help='show annotations on all lines'),
1664
Option('long', help='show date in annotations'),
1668
def run(self, filename, all=False, long=False):
1669
from bzrlib.annotate import annotate_file
1670
b, relpath = Branch.open_containing(filename)
1673
tree = WorkingTree(b.base, b)
1674
tree = b.revision_tree(b.last_revision())
1675
file_id = tree.inventory.path2id(relpath)
1676
file_version = tree.inventory[file_id].revision
1677
annotate_file(b, file_version, file_id, long, all, sys.stdout)
1682
class cmd_re_sign(Command):
1683
"""Create a digital signature for an existing revision."""
1684
# TODO be able to replace existing ones.
1686
hidden = True # is this right ?
1687
takes_args = ['revision_id?']
1688
takes_options = ['revision']
1690
def run(self, revision_id=None, revision=None):
1691
import bzrlib.config as config
1692
import bzrlib.gpg as gpg
1693
if revision_id is not None and revision is not None:
1694
raise BzrCommandError('You can only supply one of revision_id or --revision')
1695
if revision_id is None and revision is None:
1696
raise BzrCommandError('You must supply either --revision or a revision_id')
1697
b = Branch.open_containing('.')[0]
1698
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
1699
if revision_id is not None:
1700
b.sign_revision(revision_id, gpg_strategy)
1701
elif revision is not None:
1702
if len(revision) == 1:
1703
revno, rev_id = revision[0].in_history(b)
1704
b.sign_revision(rev_id, gpg_strategy)
1705
elif len(revision) == 2:
1706
# are they both on rh- if so we can walk between them
1707
# might be nice to have a range helper for arbitrary
1708
# revision paths. hmm.
1709
from_revno, from_revid = revision[0].in_history(b)
1710
to_revno, to_revid = revision[1].in_history(b)
1711
if to_revid is None:
1712
to_revno = b.revno()
1713
if from_revno is None or to_revno is None:
1714
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
1715
for revno in range(from_revno, to_revno + 1):
1716
b.sign_revision(b.get_rev_id(revno), gpg_strategy)
1718
raise BzrCommandError('Please supply either one revision, or a range.')
1721
# these get imported and then picked up by the scan for cmd_*
1722
# TODO: Some more consistent way to split command definitions across files;
1723
# we do need to load at least some information about them to know of
1725
from bzrlib.conflicts import cmd_resolve, cmd_conflicts
added
removed
bzrlib/builtins.py
