1
# Copyright (C) 2004, 2005, 2006, 2007 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
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
54
from bzrlib.branch import Branch
55
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revision import common_ancestor
58
from bzrlib.revisionspec import RevisionSpec
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
68
def tree_files(file_list, default_branch=u'.'):
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
84
The filenames given are not required to exist.
86
:param file_list: Filenames to convert.
88
:param default_branch: Fallback tree path to use if file_list is empty or
91
:return: workingtree, [relative_paths]
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
97
for filename in file_list:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
113
return bzrdir.format_registry.make_bzrdir(typestring)
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
File kind has been changed (e.g. from file to directory).
150
Not versioned and not matching an ignore pattern.
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
155
--short gives a status flags for each item, similar to the SVN's status
158
Column 1: versioning / renames
164
P Entry for a pending merge (not a file)
173
* The execute bit was changed
175
If no arguments are specified, the status of the entire working
176
directory is shown. Otherwise, only the status of the specified
177
files or directories is reported. If a directory is given, status
178
is reported for everything inside that directory.
180
If a revision argument is given, the status is calculated against
181
that revision, or between two revisions if two are provided.
184
# TODO: --no-recurse, --recurse options
186
takes_args = ['file*']
187
takes_options = ['show-ids', 'revision',
188
Option('short', help='Give short SVN-style status lines'),
189
Option('versioned', help='Only show versioned files')]
190
aliases = ['st', 'stat']
192
encoding_type = 'replace'
193
_see_also = ['diff', 'revert']
196
def run(self, show_ids=False, file_list=None, revision=None, short=False,
198
from bzrlib.status import show_tree_status
200
tree, file_list = tree_files(file_list)
202
show_tree_status(tree, show_ids=show_ids,
203
specific_files=file_list, revision=revision,
204
to_file=self.outf, short=short, versioned=versioned)
207
class cmd_cat_revision(Command):
208
"""Write out metadata for a revision.
210
The revision to print can either be specified by a specific
211
revision identifier, or you can use --revision.
215
takes_args = ['revision_id?']
216
takes_options = ['revision']
217
# cat-revision is more for frontends so should be exact
221
def run(self, revision_id=None, revision=None):
223
revision_id = osutils.safe_revision_id(revision_id, warn=False)
224
if revision_id is not None and revision is not None:
225
raise errors.BzrCommandError('You can only supply one of'
226
' revision_id or --revision')
227
if revision_id is None and revision is None:
228
raise errors.BzrCommandError('You must supply either'
229
' --revision or a revision_id')
230
b = WorkingTree.open_containing(u'.')[0].branch
232
# TODO: jam 20060112 should cat-revision always output utf-8?
233
if revision_id is not None:
234
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
235
elif revision is not None:
238
raise errors.BzrCommandError('You cannot specify a NULL'
240
revno, rev_id = rev.in_history(b)
241
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
244
class cmd_remove_tree(Command):
245
"""Remove the working tree from a given branch/checkout.
247
Since a lightweight checkout is little more than a working tree
248
this will refuse to run against one.
250
To re-create the working tree, use "bzr checkout".
252
_see_also = ['checkout']
254
takes_args = ['location?']
256
def run(self, location='.'):
257
d = bzrdir.BzrDir.open(location)
260
working = d.open_workingtree()
261
except errors.NoWorkingTree:
262
raise errors.BzrCommandError("No working tree to remove")
263
except errors.NotLocalUrl:
264
raise errors.BzrCommandError("You cannot remove the working tree of a "
267
working_path = working.bzrdir.root_transport.base
268
branch_path = working.branch.bzrdir.root_transport.base
269
if working_path != branch_path:
270
raise errors.BzrCommandError("You cannot remove the working tree from "
271
"a lightweight checkout")
273
d.destroy_workingtree()
276
class cmd_revno(Command):
277
"""Show current revision number.
279
This is equal to the number of revisions on this branch.
283
takes_args = ['location?']
286
def run(self, location=u'.'):
287
self.outf.write(str(Branch.open_containing(location)[0].revno()))
288
self.outf.write('\n')
291
class cmd_revision_info(Command):
292
"""Show revision number and revision id for a given revision identifier.
295
takes_args = ['revision_info*']
296
takes_options = ['revision']
299
def run(self, revision=None, revision_info_list=[]):
302
if revision is not None:
303
revs.extend(revision)
304
if revision_info_list is not None:
305
for rev in revision_info_list:
306
revs.append(RevisionSpec.from_string(rev))
308
raise errors.BzrCommandError('You must supply a revision identifier')
310
b = WorkingTree.open_containing(u'.')[0].branch
313
revinfo = rev.in_history(b)
314
if revinfo.revno is None:
315
print ' %s' % revinfo.rev_id
317
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
320
class cmd_add(Command):
321
"""Add specified files or directories.
323
In non-recursive mode, all the named items are added, regardless
324
of whether they were previously ignored. A warning is given if
325
any of the named files are already versioned.
327
In recursive mode (the default), files are treated the same way
328
but the behaviour for directories is different. Directories that
329
are already versioned do not give a warning. All directories,
330
whether already versioned or not, are searched for files or
331
subdirectories that are neither versioned or ignored, and these
332
are added. This search proceeds recursively into versioned
333
directories. If no names are given '.' is assumed.
335
Therefore simply saying 'bzr add' will version all files that
336
are currently unknown.
338
Adding a file whose parent directory is not versioned will
339
implicitly add the parent, and so on up to the root. This means
340
you should never need to explicitly add a directory, they'll just
341
get added when you add a file in the directory.
343
--dry-run will show which files would be added, but not actually
346
--file-ids-from will try to use the file ids from the supplied path.
347
It looks up ids trying to find a matching parent directory with the
348
same filename, and then by pure path. This option is rarely needed
349
but can be useful when adding the same logical file into two
350
branches that will be merged later (without showing the two different
351
adds as a conflict). It is also useful when merging another project
352
into a subdirectory of this one.
354
takes_args = ['file*']
355
takes_options = ['no-recurse', 'dry-run', 'verbose',
356
Option('file-ids-from', type=unicode,
357
help='Lookup file ids from here')]
358
encoding_type = 'replace'
359
_see_also = ['remove']
361
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
366
if file_ids_from is not None:
368
base_tree, base_path = WorkingTree.open_containing(
370
except errors.NoWorkingTree:
371
base_branch, base_path = Branch.open_containing(
373
base_tree = base_branch.basis_tree()
375
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
376
to_file=self.outf, should_print=(not is_quiet()))
378
action = bzrlib.add.AddAction(to_file=self.outf,
379
should_print=(not is_quiet()))
382
base_tree.lock_read()
384
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
385
action=action, save=not dry_run)
387
if base_tree is not None:
391
for glob in sorted(ignored.keys()):
392
for path in ignored[glob]:
393
self.outf.write("ignored %s matching \"%s\"\n"
397
for glob, paths in ignored.items():
398
match_len += len(paths)
399
self.outf.write("ignored %d file(s).\n" % match_len)
400
self.outf.write("If you wish to add some of these files,"
401
" please add them by name.\n")
404
class cmd_mkdir(Command):
405
"""Create a new versioned directory.
407
This is equivalent to creating the directory and then adding it.
410
takes_args = ['dir+']
411
encoding_type = 'replace'
413
def run(self, dir_list):
416
wt, dd = WorkingTree.open_containing(d)
418
self.outf.write('added %s\n' % d)
421
class cmd_relpath(Command):
422
"""Show path of a file relative to root"""
424
takes_args = ['filename']
428
def run(self, filename):
429
# TODO: jam 20050106 Can relpath return a munged path if
430
# sys.stdout encoding cannot represent it?
431
tree, relpath = WorkingTree.open_containing(filename)
432
self.outf.write(relpath)
433
self.outf.write('\n')
436
class cmd_inventory(Command):
437
"""Show inventory of the current working copy or a revision.
439
It is possible to limit the output to a particular entry
440
type using the --kind option. For example: --kind file.
442
It is also possible to restrict the list of files to a specific
443
set. For example: bzr inventory --show-ids this/file
448
takes_options = ['revision', 'show-ids', 'kind']
449
takes_args = ['file*']
452
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
453
if kind and kind not in ['file', 'directory', 'symlink']:
454
raise errors.BzrCommandError('invalid kind specified')
456
work_tree, file_list = tree_files(file_list)
457
work_tree.lock_read()
459
if revision is not None:
460
if len(revision) > 1:
461
raise errors.BzrCommandError(
462
'bzr inventory --revision takes exactly one revision'
464
revision_id = revision[0].in_history(work_tree.branch).rev_id
465
tree = work_tree.branch.repository.revision_tree(revision_id)
467
extra_trees = [work_tree]
473
if file_list is not None:
474
file_ids = tree.paths2ids(file_list, trees=extra_trees,
475
require_versioned=True)
476
# find_ids_across_trees may include some paths that don't
478
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
479
for file_id in file_ids if file_id in tree)
481
entries = tree.inventory.entries()
484
if tree is not work_tree:
487
for path, entry in entries:
488
if kind and kind != entry.kind:
491
self.outf.write('%-50s %s\n' % (path, entry.file_id))
493
self.outf.write(path)
494
self.outf.write('\n')
497
class cmd_mv(Command):
498
"""Move or rename a file.
501
bzr mv OLDNAME NEWNAME
502
bzr mv SOURCE... DESTINATION
504
If the last argument is a versioned directory, all the other names
505
are moved into it. Otherwise, there must be exactly two arguments
506
and the file is changed to a new name.
508
If OLDNAME does not exist on the filesystem but is versioned and
509
NEWNAME does exist on the filesystem but is not versioned, mv
510
assumes that the file has been manually moved and only updates
511
its internal inventory to reflect that change.
512
The same is valid when moving many SOURCE files to a DESTINATION.
514
Files cannot be moved between branches.
517
takes_args = ['names*']
518
takes_options = [Option("after", help="move only the bzr identifier"
519
" of the file (file has already been moved). Use this flag if"
520
" bzr is not able to detect this itself.")]
521
aliases = ['move', 'rename']
522
encoding_type = 'replace'
524
def run(self, names_list, after=False):
525
if names_list is None:
528
if len(names_list) < 2:
529
raise errors.BzrCommandError("missing file argument")
530
tree, rel_names = tree_files(names_list)
532
if os.path.isdir(names_list[-1]):
533
# move into existing directory
534
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
535
self.outf.write("%s => %s\n" % pair)
537
if len(names_list) != 2:
538
raise errors.BzrCommandError('to mv multiple files the'
539
' destination must be a versioned'
541
tree.rename_one(rel_names[0], rel_names[1], after=after)
542
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
545
class cmd_pull(Command):
546
"""Turn this branch into a mirror of another branch.
548
This command only works on branches that have not diverged. Branches are
549
considered diverged if the destination branch's most recent commit is one
550
that has not been merged (directly or indirectly) into the parent.
552
If branches have diverged, you can use 'bzr merge' to integrate the changes
553
from one into the other. Once one branch has merged, the other should
554
be able to pull it again.
556
If you want to forget your local changes and just update your branch to
557
match the remote one, use pull --overwrite.
559
If there is no default location set, the first pull will set it. After
560
that, you can omit the location to use the default. To change the
561
default, use --remember. The value will only be saved if the remote
562
location can be accessed.
565
_see_also = ['push', 'update']
566
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
568
help='branch to pull into, '
569
'rather than the one containing the working directory',
574
takes_args = ['location?']
575
encoding_type = 'replace'
577
def run(self, location=None, remember=False, overwrite=False,
578
revision=None, verbose=False,
580
from bzrlib.tag import _merge_tags_if_possible
581
# FIXME: too much stuff is in the command class
584
if directory is None:
587
tree_to = WorkingTree.open_containing(directory)[0]
588
branch_to = tree_to.branch
589
except errors.NoWorkingTree:
591
branch_to = Branch.open_containing(directory)[0]
594
if location is not None:
596
mergeable = bundle.read_mergeable_from_url(
598
except errors.NotABundle:
599
pass # Continue on considering this url a Branch
601
stored_loc = branch_to.get_parent()
603
if stored_loc is None:
604
raise errors.BzrCommandError("No pull location known or"
607
display_url = urlutils.unescape_for_display(stored_loc,
609
self.outf.write("Using saved location: %s\n" % display_url)
610
location = stored_loc
612
if mergeable is not None:
613
if revision is not None:
614
raise errors.BzrCommandError(
615
'Cannot use -r with merge directives or bundles')
616
revision_id = mergeable.install_revisions(branch_to.repository)
617
branch_from = branch_to
619
branch_from = Branch.open(location)
621
if branch_to.get_parent() is None or remember:
622
branch_to.set_parent(branch_from.base)
624
if revision is not None:
625
if len(revision) == 1:
626
revision_id = revision[0].in_history(branch_from).rev_id
628
raise errors.BzrCommandError(
629
'bzr pull --revision takes one value.')
631
old_rh = branch_to.revision_history()
632
if tree_to is not None:
633
result = tree_to.pull(branch_from, overwrite, revision_id,
634
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
636
result = branch_to.pull(branch_from, overwrite, revision_id)
638
result.report(self.outf)
640
from bzrlib.log import show_changed_revisions
641
new_rh = branch_to.revision_history()
642
show_changed_revisions(branch_to, old_rh, new_rh,
646
class cmd_push(Command):
647
"""Update a mirror of this branch.
649
The target branch will not have its working tree populated because this
650
is both expensive, and is not supported on remote file systems.
652
Some smart servers or protocols *may* put the working tree in place in
655
This command only works on branches that have not diverged. Branches are
656
considered diverged if the destination branch's most recent commit is one
657
that has not been merged (directly or indirectly) by the source branch.
659
If branches have diverged, you can use 'bzr push --overwrite' to replace
660
the other branch completely, discarding its unmerged changes.
662
If you want to ensure you have the different changes in the other branch,
663
do a merge (see bzr help merge) from the other branch, and commit that.
664
After that you will be able to do a push without '--overwrite'.
666
If there is no default push location set, the first push will set it.
667
After that, you can omit the location to use the default. To change the
668
default, use --remember. The value will only be saved if the remote
669
location can be accessed.
672
_see_also = ['pull', 'update']
673
takes_options = ['remember', 'overwrite', 'verbose',
674
Option('create-prefix',
675
help='Create the path leading up to the branch '
676
'if it does not already exist'),
678
help='branch to push from, '
679
'rather than the one containing the working directory',
683
Option('use-existing-dir',
684
help='By default push will fail if the target'
685
' directory exists, but does not already'
686
' have a control directory. This flag will'
687
' allow push to proceed.'),
689
takes_args = ['location?']
690
encoding_type = 'replace'
692
def run(self, location=None, remember=False, overwrite=False,
693
create_prefix=False, verbose=False,
694
use_existing_dir=False,
696
# FIXME: Way too big! Put this into a function called from the
698
if directory is None:
700
br_from = Branch.open_containing(directory)[0]
701
stored_loc = br_from.get_push_location()
703
if stored_loc is None:
704
raise errors.BzrCommandError("No push location known or specified.")
706
display_url = urlutils.unescape_for_display(stored_loc,
708
self.outf.write("Using saved location: %s\n" % display_url)
709
location = stored_loc
711
to_transport = transport.get_transport(location)
713
br_to = repository_to = dir_to = None
715
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
716
except errors.NotBranchError:
717
pass # Didn't find anything
719
# If we can open a branch, use its direct repository, otherwise see
720
# if there is a repository without a branch.
722
br_to = dir_to.open_branch()
723
except errors.NotBranchError:
724
# Didn't find a branch, can we find a repository?
726
repository_to = dir_to.find_repository()
727
except errors.NoRepositoryPresent:
730
# Found a branch, so we must have found a repository
731
repository_to = br_to.repository
735
# The destination doesn't exist; create it.
736
# XXX: Refactor the create_prefix/no_create_prefix code into a
737
# common helper function
739
to_transport.mkdir('.')
740
except errors.FileExists:
741
if not use_existing_dir:
742
raise errors.BzrCommandError("Target directory %s"
743
" already exists, but does not have a valid .bzr"
744
" directory. Supply --use-existing-dir to push"
745
" there anyway." % location)
746
except errors.NoSuchFile:
747
if not create_prefix:
748
raise errors.BzrCommandError("Parent directory of %s"
750
"\nYou may supply --create-prefix to create all"
751
" leading parent directories."
754
cur_transport = to_transport
755
needed = [cur_transport]
756
# Recurse upwards until we can create a directory successfully
758
new_transport = cur_transport.clone('..')
759
if new_transport.base == cur_transport.base:
760
raise errors.BzrCommandError("Failed to create path"
764
new_transport.mkdir('.')
765
except errors.NoSuchFile:
766
needed.append(new_transport)
767
cur_transport = new_transport
771
# Now we only need to create child directories
773
cur_transport = needed.pop()
774
cur_transport.ensure_base()
776
# Now the target directory exists, but doesn't have a .bzr
777
# directory. So we need to create it, along with any work to create
778
# all of the dependent branches, etc.
779
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
780
revision_id=br_from.last_revision())
781
br_to = dir_to.open_branch()
782
# TODO: Some more useful message about what was copied
783
note('Created new branch.')
784
# We successfully created the target, remember it
785
if br_from.get_push_location() is None or remember:
786
br_from.set_push_location(br_to.base)
787
elif repository_to is None:
788
# we have a bzrdir but no branch or repository
789
# XXX: Figure out what to do other than complain.
790
raise errors.BzrCommandError("At %s you have a valid .bzr control"
791
" directory, but not a branch or repository. This is an"
792
" unsupported configuration. Please move the target directory"
793
" out of the way and try again."
796
# We have a repository but no branch, copy the revisions, and then
798
last_revision_id = br_from.last_revision()
799
repository_to.fetch(br_from.repository,
800
revision_id=last_revision_id)
801
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
802
note('Created new branch.')
803
if br_from.get_push_location() is None or remember:
804
br_from.set_push_location(br_to.base)
805
else: # We have a valid to branch
806
# We were able to connect to the remote location, so remember it
807
# we don't need to successfully push because of possible divergence.
808
if br_from.get_push_location() is None or remember:
809
br_from.set_push_location(br_to.base)
810
old_rh = br_to.revision_history()
813
tree_to = dir_to.open_workingtree()
814
except errors.NotLocalUrl:
815
warning('This transport does not update the working '
816
'tree of: %s' % (br_to.base,))
817
push_result = br_from.push(br_to, overwrite)
818
except errors.NoWorkingTree:
819
push_result = br_from.push(br_to, overwrite)
823
push_result = br_from.push(tree_to.branch, overwrite)
827
except errors.DivergedBranches:
828
raise errors.BzrCommandError('These branches have diverged.'
829
' Try using "merge" and then "push".')
830
if push_result is not None:
831
push_result.report(self.outf)
833
new_rh = br_to.revision_history()
836
from bzrlib.log import show_changed_revisions
837
show_changed_revisions(br_to, old_rh, new_rh,
840
# we probably did a clone rather than a push, so a message was
845
class cmd_branch(Command):
846
"""Create a new copy of a branch.
848
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
849
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
851
To retrieve the branch as of a particular revision, supply the --revision
852
parameter, as in "branch foo/bar -r 5".
855
_see_also = ['checkout']
856
takes_args = ['from_location', 'to_location?']
857
takes_options = ['revision']
858
aliases = ['get', 'clone']
860
def run(self, from_location, to_location=None, revision=None):
861
from bzrlib.tag import _merge_tags_if_possible
864
elif len(revision) > 1:
865
raise errors.BzrCommandError(
866
'bzr branch --revision takes exactly 1 revision value')
868
br_from = Branch.open(from_location)
871
if len(revision) == 1 and revision[0] is not None:
872
revision_id = revision[0].in_history(br_from)[1]
874
# FIXME - wt.last_revision, fallback to branch, fall back to
875
# None or perhaps NULL_REVISION to mean copy nothing
877
revision_id = br_from.last_revision()
878
if to_location is None:
879
to_location = os.path.basename(from_location.rstrip("/\\"))
882
name = os.path.basename(to_location) + '\n'
884
to_transport = transport.get_transport(to_location)
886
to_transport.mkdir('.')
887
except errors.FileExists:
888
raise errors.BzrCommandError('Target directory "%s" already'
889
' exists.' % to_location)
890
except errors.NoSuchFile:
891
raise errors.BzrCommandError('Parent of "%s" does not exist.'
894
# preserve whatever source format we have.
895
dir = br_from.bzrdir.sprout(to_transport.base, revision_id)
896
branch = dir.open_branch()
897
except errors.NoSuchRevision:
898
to_transport.delete_tree('.')
899
msg = "The branch %s has no revision %s." % (from_location, revision[0])
900
raise errors.BzrCommandError(msg)
902
branch.control_files.put_utf8('branch-name', name)
903
_merge_tags_if_possible(br_from, branch)
904
note('Branched %d revision(s).' % branch.revno())
909
class cmd_checkout(Command):
910
"""Create a new checkout of an existing branch.
912
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
913
the branch found in '.'. This is useful if you have removed the working tree
914
or if it was never created - i.e. if you pushed the branch to its current
917
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
918
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
920
To retrieve the branch as of a particular revision, supply the --revision
921
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
922
out of date [so you cannot commit] but it may be useful (i.e. to examine old
926
_see_also = ['checkouts', 'branch']
927
takes_args = ['branch_location?', 'to_location?']
928
takes_options = ['revision',
929
Option('lightweight',
930
help="perform a lightweight checkout. Lightweight "
931
"checkouts depend on access to the branch for "
932
"every operation. Normal checkouts can perform "
933
"common operations like diff and status without "
934
"such access, and also support local commits."
939
def run(self, branch_location=None, to_location=None, revision=None,
943
elif len(revision) > 1:
944
raise errors.BzrCommandError(
945
'bzr checkout --revision takes exactly 1 revision value')
946
if branch_location is None:
947
branch_location = osutils.getcwd()
948
to_location = branch_location
949
source = Branch.open(branch_location)
950
if len(revision) == 1 and revision[0] is not None:
951
revision_id = revision[0].in_history(source)[1]
954
if to_location is None:
955
to_location = os.path.basename(branch_location.rstrip("/\\"))
956
# if the source and to_location are the same,
957
# and there is no working tree,
958
# then reconstitute a branch
959
if (osutils.abspath(to_location) ==
960
osutils.abspath(branch_location)):
962
source.bzrdir.open_workingtree()
963
except errors.NoWorkingTree:
964
source.bzrdir.create_workingtree()
967
os.mkdir(to_location)
969
if e.errno == errno.EEXIST:
970
raise errors.BzrCommandError('Target directory "%s" already'
971
' exists.' % to_location)
972
if e.errno == errno.ENOENT:
973
raise errors.BzrCommandError('Parent of "%s" does not exist.'
977
source.create_checkout(to_location, revision_id, lightweight)
980
class cmd_renames(Command):
981
"""Show list of renamed files.
983
# TODO: Option to show renames between two historical versions.
985
# TODO: Only show renames under dir, rather than in the whole branch.
986
_see_also = ['status']
987
takes_args = ['dir?']
990
def run(self, dir=u'.'):
991
tree = WorkingTree.open_containing(dir)[0]
994
new_inv = tree.inventory
995
old_tree = tree.basis_tree()
998
old_inv = old_tree.inventory
999
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1001
for old_name, new_name in renames:
1002
self.outf.write("%s => %s\n" % (old_name, new_name))
1009
class cmd_update(Command):
1010
"""Update a tree to have the latest code committed to its branch.
1012
This will perform a merge into the working tree, and may generate
1013
conflicts. If you have any local changes, you will still
1014
need to commit them after the update for the update to be complete.
1016
If you want to discard your local changes, you can just do a
1017
'bzr revert' instead of 'bzr commit' after the update.
1020
_see_also = ['pull']
1021
takes_args = ['dir?']
1024
def run(self, dir='.'):
1025
tree = WorkingTree.open_containing(dir)[0]
1026
master = tree.branch.get_master_branch()
1027
if master is not None:
1030
tree.lock_tree_write()
1032
existing_pending_merges = tree.get_parent_ids()[1:]
1033
last_rev = tree.last_revision()
1034
if last_rev == tree.branch.last_revision():
1035
# may be up to date, check master too.
1036
master = tree.branch.get_master_branch()
1037
if master is None or last_rev == master.last_revision():
1038
revno = tree.branch.revision_id_to_revno(last_rev)
1039
note("Tree is up to date at revision %d." % (revno,))
1041
conflicts = tree.update()
1042
revno = tree.branch.revision_id_to_revno(tree.last_revision())
1043
note('Updated to revision %d.' % (revno,))
1044
if tree.get_parent_ids()[1:] != existing_pending_merges:
1045
note('Your local commits will now show as pending merges with '
1046
"'bzr status', and can be committed with 'bzr commit'.")
1055
class cmd_info(Command):
1056
"""Show information about a working tree, branch or repository.
1058
This command will show all known locations and formats associated to the
1059
tree, branch or repository. Statistical information is included with
1062
Branches and working trees will also report any missing revisions.
1064
_see_also = ['revno']
1065
takes_args = ['location?']
1066
takes_options = ['verbose']
1069
def run(self, location=None, verbose=False):
1070
from bzrlib.info import show_bzrdir_info
1071
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1075
class cmd_remove(Command):
1076
"""Remove files or directories.
1078
This makes bzr stop tracking changes to the specified files and
1079
delete them if they can easily be recovered using revert.
1081
You can specify one or more files, and/or --new. If you specify --new,
1082
only 'added' files will be removed. If you specify both, then new files
1083
in the specified directories will be removed. If the directories are
1084
also new, they will also be removed.
1086
takes_args = ['file*']
1087
takes_options = ['verbose',
1088
Option('new', help='remove newly-added files'),
1089
RegistryOption.from_kwargs('file-deletion-strategy',
1090
'The file deletion mode to be used',
1091
title='Deletion Strategy', value_switches=True, enum_switch=False,
1092
safe='Only delete files if they can be'
1093
' safely recovered (default).',
1094
keep="Don't delete any files.",
1095
force='Delete all the specified files, even if they can not be '
1096
'recovered and even if they are non-empty directories.')]
1098
encoding_type = 'replace'
1100
def run(self, file_list, verbose=False, new=False,
1101
file_deletion_strategy='safe'):
1102
tree, file_list = tree_files(file_list)
1104
if file_list is not None:
1105
file_list = [f for f in file_list if f != '']
1107
raise errors.BzrCommandError('Specify one or more files to'
1108
' remove, or use --new.')
1111
added = tree.changes_from(tree.basis_tree(),
1112
specific_files=file_list).added
1113
file_list = sorted([f[0] for f in added], reverse=True)
1114
if len(file_list) == 0:
1115
raise errors.BzrCommandError('No matching files.')
1116
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1117
keep_files=file_deletion_strategy=='keep',
1118
force=file_deletion_strategy=='force')
1121
class cmd_file_id(Command):
1122
"""Print file_id of a particular file or directory.
1124
The file_id is assigned when the file is first added and remains the
1125
same through all revisions where the file exists, even when it is
1130
_see_also = ['inventory', 'ls']
1131
takes_args = ['filename']
1134
def run(self, filename):
1135
tree, relpath = WorkingTree.open_containing(filename)
1136
i = tree.path2id(relpath)
1138
raise errors.NotVersionedError(filename)
1140
self.outf.write(i + '\n')
1143
class cmd_file_path(Command):
1144
"""Print path of file_ids to a file or directory.
1146
This prints one line for each directory down to the target,
1147
starting at the branch root.
1151
takes_args = ['filename']
1154
def run(self, filename):
1155
tree, relpath = WorkingTree.open_containing(filename)
1156
fid = tree.path2id(relpath)
1158
raise errors.NotVersionedError(filename)
1159
segments = osutils.splitpath(relpath)
1160
for pos in range(1, len(segments) + 1):
1161
path = osutils.joinpath(segments[:pos])
1162
self.outf.write("%s\n" % tree.path2id(path))
1165
class cmd_reconcile(Command):
1166
"""Reconcile bzr metadata in a branch.
1168
This can correct data mismatches that may have been caused by
1169
previous ghost operations or bzr upgrades. You should only
1170
need to run this command if 'bzr check' or a bzr developer
1171
advises you to run it.
1173
If a second branch is provided, cross-branch reconciliation is
1174
also attempted, which will check that data like the tree root
1175
id which was not present in very early bzr versions is represented
1176
correctly in both branches.
1178
At the same time it is run it may recompress data resulting in
1179
a potential saving in disk space or performance gain.
1181
The branch *MUST* be on a listable system such as local disk or sftp.
1184
_see_also = ['check']
1185
takes_args = ['branch?']
1187
def run(self, branch="."):
1188
from bzrlib.reconcile import reconcile
1189
dir = bzrdir.BzrDir.open(branch)
1193
class cmd_revision_history(Command):
1194
"""Display the list of revision ids on a branch."""
1197
takes_args = ['location?']
1202
def run(self, location="."):
1203
branch = Branch.open_containing(location)[0]
1204
for revid in branch.revision_history():
1205
self.outf.write(revid)
1206
self.outf.write('\n')
1209
class cmd_ancestry(Command):
1210
"""List all revisions merged into this branch."""
1212
_see_also = ['log', 'revision-history']
1213
takes_args = ['location?']
1218
def run(self, location="."):
1220
wt = WorkingTree.open_containing(location)[0]
1221
except errors.NoWorkingTree:
1222
b = Branch.open(location)
1223
last_revision = b.last_revision()
1226
last_revision = wt.last_revision()
1228
revision_ids = b.repository.get_ancestry(last_revision)
1229
assert revision_ids[0] is None
1231
for revision_id in revision_ids:
1232
self.outf.write(revision_id + '\n')
1235
class cmd_init(Command):
1236
"""Make a directory into a versioned branch.
1238
Use this to create an empty branch, or before importing an
1241
If there is a repository in a parent directory of the location, then
1242
the history of the branch will be stored in the repository. Otherwise
1243
init creates a standalone branch which carries its own history
1244
in the .bzr directory.
1246
If there is already a branch at the location but it has no working tree,
1247
the tree can be populated with 'bzr checkout'.
1249
Recipe for importing a tree of files:
1254
bzr commit -m 'imported project'
1257
_see_also = ['init-repo', 'branch', 'checkout']
1258
takes_args = ['location?']
1260
RegistryOption('format',
1261
help='Specify a format for this branch. '
1262
'See "help formats".',
1263
registry=bzrdir.format_registry,
1264
converter=bzrdir.format_registry.make_bzrdir,
1265
value_switches=True,
1266
title="Branch Format",
1268
Option('append-revisions-only',
1269
help='Never change revnos or the existing log.'
1270
' Append revisions to it only.')
1272
def run(self, location=None, format=None, append_revisions_only=False):
1274
format = bzrdir.format_registry.make_bzrdir('default')
1275
if location is None:
1278
to_transport = transport.get_transport(location)
1280
# The path has to exist to initialize a
1281
# branch inside of it.
1282
# Just using os.mkdir, since I don't
1283
# believe that we want to create a bunch of
1284
# locations if the user supplies an extended path
1285
# TODO: create-prefix
1286
to_transport.ensure_base()
1289
existing_bzrdir = bzrdir.BzrDir.open(location)
1290
except errors.NotBranchError:
1291
# really a NotBzrDir error...
1292
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1295
from bzrlib.transport.local import LocalTransport
1296
if existing_bzrdir.has_branch():
1297
if (isinstance(to_transport, LocalTransport)
1298
and not existing_bzrdir.has_workingtree()):
1299
raise errors.BranchExistsWithoutWorkingTree(location)
1300
raise errors.AlreadyBranchError(location)
1302
branch = existing_bzrdir.create_branch()
1303
existing_bzrdir.create_workingtree()
1304
if append_revisions_only:
1306
branch.set_append_revisions_only(True)
1307
except errors.UpgradeRequired:
1308
raise errors.BzrCommandError('This branch format cannot be set'
1309
' to append-revisions-only. Try --experimental-branch6')
1312
class cmd_init_repository(Command):
1313
"""Create a shared repository to hold branches.
1315
New branches created under the repository directory will store their revisions
1316
in the repository, not in the branch directory.
1319
bzr init-repo --no-trees repo
1321
bzr checkout --lightweight repo/trunk trunk-checkout
1326
_see_also = ['init', 'branch', 'checkout']
1327
takes_args = ["location"]
1328
takes_options = [RegistryOption('format',
1329
help='Specify a format for this repository. See'
1330
' "bzr help formats" for details',
1331
registry=bzrdir.format_registry,
1332
converter=bzrdir.format_registry.make_bzrdir,
1333
value_switches=True, title='Repository format'),
1335
help='Branches in the repository will default to'
1336
' not having a working tree'),
1338
aliases = ["init-repo"]
1340
def run(self, location, format=None, no_trees=False):
1342
format = bzrdir.format_registry.make_bzrdir('default')
1344
if location is None:
1347
to_transport = transport.get_transport(location)
1348
to_transport.ensure_base()
1350
newdir = format.initialize_on_transport(to_transport)
1351
repo = newdir.create_repository(shared=True)
1352
repo.set_make_working_trees(not no_trees)
1355
class cmd_diff(Command):
1356
"""Show differences in the working tree or between revisions.
1358
If files are listed, only the changes in those files are listed.
1359
Otherwise, all changes for the tree are listed.
1361
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1362
produces patches suitable for "patch -p1".
1366
Shows the difference in the working tree versus the last commit
1368
Difference between the working tree and revision 1
1370
Difference between revision 2 and revision 1
1371
bzr diff --prefix old/:new/
1372
Same as 'bzr diff' but prefix paths with old/ and new/
1373
bzr diff bzr.mine bzr.dev
1374
Show the differences between the two working trees
1376
Show just the differences for 'foo.c'
1378
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1379
# or a graphical diff.
1381
# TODO: Python difflib is not exactly the same as unidiff; should
1382
# either fix it up or prefer to use an external diff.
1384
# TODO: Selected-file diff is inefficient and doesn't show you
1387
# TODO: This probably handles non-Unix newlines poorly.
1389
_see_also = ['status']
1390
takes_args = ['file*']
1391
takes_options = ['revision', 'diff-options',
1392
Option('prefix', type=str,
1394
help='Set prefixes to added to old and new filenames, as '
1395
'two values separated by a colon. (eg "old/:new/")'),
1397
aliases = ['di', 'dif']
1398
encoding_type = 'exact'
1401
def run(self, revision=None, file_list=None, diff_options=None,
1403
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1405
if (prefix is None) or (prefix == '0'):
1413
old_label, new_label = prefix.split(":")
1415
raise errors.BzrCommandError(
1416
'--prefix expects two values separated by a colon'
1417
' (eg "old/:new/")')
1419
if revision and len(revision) > 2:
1420
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1421
' one or two revision specifiers')
1424
tree1, file_list = internal_tree_files(file_list)
1428
except errors.FileInWrongBranch:
1429
if len(file_list) != 2:
1430
raise errors.BzrCommandError("Files are in different branches")
1432
tree1, file1 = WorkingTree.open_containing(file_list[0])
1433
tree2, file2 = WorkingTree.open_containing(file_list[1])
1434
if file1 != "" or file2 != "":
1435
# FIXME diff those two files. rbc 20051123
1436
raise errors.BzrCommandError("Files are in different branches")
1438
except errors.NotBranchError:
1439
if (revision is not None and len(revision) == 2
1440
and not revision[0].needs_branch()
1441
and not revision[1].needs_branch()):
1442
# If both revision specs include a branch, we can
1443
# diff them without needing a local working tree
1444
tree1, tree2 = None, None
1448
if tree2 is not None:
1449
if revision is not None:
1450
# FIXME: but there should be a clean way to diff between
1451
# non-default versions of two trees, it's not hard to do
1453
raise errors.BzrCommandError(
1454
"Sorry, diffing arbitrary revisions across branches "
1455
"is not implemented yet")
1456
return show_diff_trees(tree1, tree2, sys.stdout,
1457
specific_files=file_list,
1458
external_diff_options=diff_options,
1459
old_label=old_label, new_label=new_label)
1461
return diff_cmd_helper(tree1, file_list, diff_options,
1462
revision_specs=revision,
1463
old_label=old_label, new_label=new_label)
1466
class cmd_deleted(Command):
1467
"""List files deleted in the working tree.
1469
# TODO: Show files deleted since a previous revision, or
1470
# between two revisions.
1471
# TODO: Much more efficient way to do this: read in new
1472
# directories with readdir, rather than stating each one. Same
1473
# level of effort but possibly much less IO. (Or possibly not,
1474
# if the directories are very large...)
1475
_see_also = ['status', 'ls']
1476
takes_options = ['show-ids']
1479
def run(self, show_ids=False):
1480
tree = WorkingTree.open_containing(u'.')[0]
1483
old = tree.basis_tree()
1486
for path, ie in old.inventory.iter_entries():
1487
if not tree.has_id(ie.file_id):
1488
self.outf.write(path)
1490
self.outf.write(' ')
1491
self.outf.write(ie.file_id)
1492
self.outf.write('\n')
1499
class cmd_modified(Command):
1500
"""List files modified in working tree.
1504
_see_also = ['status', 'ls']
1508
tree = WorkingTree.open_containing(u'.')[0]
1509
td = tree.changes_from(tree.basis_tree())
1510
for path, id, kind, text_modified, meta_modified in td.modified:
1511
self.outf.write(path + '\n')
1514
class cmd_added(Command):
1515
"""List files added in working tree.
1519
_see_also = ['status', 'ls']
1523
wt = WorkingTree.open_containing(u'.')[0]
1526
basis = wt.basis_tree()
1529
basis_inv = basis.inventory
1532
if file_id in basis_inv:
1534
if inv.is_root(file_id) and len(basis_inv) == 0:
1536
path = inv.id2path(file_id)
1537
if not os.access(osutils.abspath(path), os.F_OK):
1539
self.outf.write(path + '\n')
1546
class cmd_root(Command):
1547
"""Show the tree root directory.
1549
The root is the nearest enclosing directory with a .bzr control
1552
takes_args = ['filename?']
1554
def run(self, filename=None):
1555
"""Print the branch root."""
1556
tree = WorkingTree.open_containing(filename)[0]
1557
self.outf.write(tree.basedir + '\n')
1560
class cmd_log(Command):
1561
"""Show log of a branch, file, or directory.
1563
By default show the log of the branch containing the working directory.
1565
To request a range of logs, you can use the command -r begin..end
1566
-r revision requests a specific revision, -r ..end or -r begin.. are
1572
bzr log -r -10.. http://server/branch
1575
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1577
takes_args = ['location?']
1578
takes_options = [Option('forward',
1579
help='show from oldest to newest'),
1583
help='show files changed in each revision'),
1584
'show-ids', 'revision',
1588
help='show revisions whose message matches this regexp',
1591
encoding_type = 'replace'
1594
def run(self, location=None, timezone='original',
1601
from bzrlib.log import show_log
1602
assert message is None or isinstance(message, basestring), \
1603
"invalid message argument %r" % message
1604
direction = (forward and 'forward') or 'reverse'
1609
# find the file id to log:
1611
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1615
tree = b.basis_tree()
1616
file_id = tree.path2id(fp)
1618
raise errors.BzrCommandError(
1619
"Path does not have any revision history: %s" %
1623
# FIXME ? log the current subdir only RBC 20060203
1624
if revision is not None \
1625
and len(revision) > 0 and revision[0].get_branch():
1626
location = revision[0].get_branch()
1629
dir, relpath = bzrdir.BzrDir.open_containing(location)
1630
b = dir.open_branch()
1634
if revision is None:
1637
elif len(revision) == 1:
1638
rev1 = rev2 = revision[0].in_history(b).revno
1639
elif len(revision) == 2:
1640
if revision[1].get_branch() != revision[0].get_branch():
1641
# b is taken from revision[0].get_branch(), and
1642
# show_log will use its revision_history. Having
1643
# different branches will lead to weird behaviors.
1644
raise errors.BzrCommandError(
1645
"Log doesn't accept two revisions in different"
1647
if revision[0].spec is None:
1648
# missing begin-range means first revision
1651
rev1 = revision[0].in_history(b).revno
1653
if revision[1].spec is None:
1654
# missing end-range means last known revision
1657
rev2 = revision[1].in_history(b).revno
1659
raise errors.BzrCommandError(
1660
'bzr log --revision takes one or two values.')
1662
# By this point, the revision numbers are converted to the +ve
1663
# form if they were supplied in the -ve form, so we can do
1664
# this comparison in relative safety
1666
(rev2, rev1) = (rev1, rev2)
1668
if log_format is None:
1669
log_format = log.log_formatter_registry.get_default(b)
1671
lf = log_format(show_ids=show_ids, to_file=self.outf,
1672
show_timezone=timezone)
1678
direction=direction,
1679
start_revision=rev1,
1686
def get_log_format(long=False, short=False, line=False, default='long'):
1687
log_format = default
1691
log_format = 'short'
1697
class cmd_touching_revisions(Command):
1698
"""Return revision-ids which affected a particular file.
1700
A more user-friendly interface is "bzr log FILE".
1704
takes_args = ["filename"]
1707
def run(self, filename):
1708
tree, relpath = WorkingTree.open_containing(filename)
1710
file_id = tree.path2id(relpath)
1711
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1712
self.outf.write("%6d %s\n" % (revno, what))
1715
class cmd_ls(Command):
1716
"""List files in a tree.
1719
_see_also = ['status', 'cat']
1720
takes_args = ['path?']
1721
# TODO: Take a revision or remote path and list that tree instead.
1722
takes_options = ['verbose', 'revision',
1723
Option('non-recursive',
1724
help='don\'t recurse into sub-directories'),
1726
help='Print all paths from the root of the branch.'),
1727
Option('unknown', help='Print unknown files'),
1728
Option('versioned', help='Print versioned files'),
1729
Option('ignored', help='Print ignored files'),
1731
Option('null', help='Null separate the files'),
1735
def run(self, revision=None, verbose=False,
1736
non_recursive=False, from_root=False,
1737
unknown=False, versioned=False, ignored=False,
1738
null=False, kind=None, show_ids=False, path=None):
1740
if kind and kind not in ('file', 'directory', 'symlink'):
1741
raise errors.BzrCommandError('invalid kind specified')
1743
if verbose and null:
1744
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1745
all = not (unknown or versioned or ignored)
1747
selection = {'I':ignored, '?':unknown, 'V':versioned}
1754
raise errors.BzrCommandError('cannot specify both --from-root'
1758
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1764
if revision is not None:
1765
tree = branch.repository.revision_tree(
1766
revision[0].in_history(branch).rev_id)
1768
tree = branch.basis_tree()
1772
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1773
if fp.startswith(relpath):
1774
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1775
if non_recursive and '/' in fp:
1777
if not all and not selection[fc]:
1779
if kind is not None and fkind != kind:
1782
kindch = entry.kind_character()
1783
outstring = '%-8s %s%s' % (fc, fp, kindch)
1784
if show_ids and fid is not None:
1785
outstring = "%-50s %s" % (outstring, fid)
1786
self.outf.write(outstring + '\n')
1788
self.outf.write(fp + '\0')
1791
self.outf.write(fid)
1792
self.outf.write('\0')
1800
self.outf.write('%-50s %s\n' % (fp, my_id))
1802
self.outf.write(fp + '\n')
1807
class cmd_unknowns(Command):
1808
"""List unknown files.
1816
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1817
self.outf.write(osutils.quotefn(f) + '\n')
1820
class cmd_ignore(Command):
1821
"""Ignore specified files or patterns.
1823
To remove patterns from the ignore list, edit the .bzrignore file.
1825
Trailing slashes on patterns are ignored.
1826
If the pattern contains a slash or is a regular expression, it is compared
1827
to the whole path from the branch root. Otherwise, it is compared to only
1828
the last component of the path. To match a file only in the root
1829
directory, prepend './'.
1831
Ignore patterns specifying absolute paths are not allowed.
1833
Ignore patterns may include globbing wildcards such as:
1834
? - Matches any single character except '/'
1835
* - Matches 0 or more characters except '/'
1836
/**/ - Matches 0 or more directories in a path
1837
[a-z] - Matches a single character from within a group of characters
1839
Ignore patterns may also be Python regular expressions.
1840
Regular expression ignore patterns are identified by a 'RE:' prefix
1841
followed by the regular expression. Regular expression ignore patterns
1842
may not include named or numbered groups.
1844
Note: ignore patterns containing shell wildcards must be quoted from
1848
bzr ignore ./Makefile
1849
bzr ignore '*.class'
1850
bzr ignore 'lib/**/*.o'
1851
bzr ignore 'RE:lib/.*\.o'
1854
_see_also = ['status', 'ignored']
1855
takes_args = ['name_pattern*']
1857
Option('old-default-rules',
1858
help='Out the ignore rules bzr < 0.9 always used.')
1861
def run(self, name_pattern_list=None, old_default_rules=None):
1862
from bzrlib.atomicfile import AtomicFile
1863
if old_default_rules is not None:
1864
# dump the rules and exit
1865
for pattern in ignores.OLD_DEFAULTS:
1868
if not name_pattern_list:
1869
raise errors.BzrCommandError("ignore requires at least one "
1870
"NAME_PATTERN or --old-default-rules")
1871
name_pattern_list = [globbing.normalize_pattern(p)
1872
for p in name_pattern_list]
1873
for name_pattern in name_pattern_list:
1874
if (name_pattern[0] == '/' or
1875
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1876
raise errors.BzrCommandError(
1877
"NAME_PATTERN should not be an absolute path")
1878
tree, relpath = WorkingTree.open_containing(u'.')
1879
ifn = tree.abspath('.bzrignore')
1880
if os.path.exists(ifn):
1883
igns = f.read().decode('utf-8')
1889
# TODO: If the file already uses crlf-style termination, maybe
1890
# we should use that for the newly added lines?
1892
if igns and igns[-1] != '\n':
1894
for name_pattern in name_pattern_list:
1895
igns += name_pattern + '\n'
1897
f = AtomicFile(ifn, 'wb')
1899
f.write(igns.encode('utf-8'))
1904
if not tree.path2id('.bzrignore'):
1905
tree.add(['.bzrignore'])
1908
class cmd_ignored(Command):
1909
"""List ignored files and the patterns that matched them.
1912
_see_also = ['ignore']
1915
tree = WorkingTree.open_containing(u'.')[0]
1918
for path, file_class, kind, file_id, entry in tree.list_files():
1919
if file_class != 'I':
1921
## XXX: Slightly inefficient since this was already calculated
1922
pat = tree.is_ignored(path)
1923
print '%-50s %s' % (path, pat)
1928
class cmd_lookup_revision(Command):
1929
"""Lookup the revision-id from a revision-number
1932
bzr lookup-revision 33
1935
takes_args = ['revno']
1938
def run(self, revno):
1942
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1944
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1947
class cmd_export(Command):
1948
"""Export current or past revision to a destination directory or archive.
1950
If no revision is specified this exports the last committed revision.
1952
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1953
given, try to find the format with the extension. If no extension
1954
is found exports to a directory (equivalent to --format=dir).
1956
If root is supplied, it will be used as the root directory inside
1957
container formats (tar, zip, etc). If it is not supplied it will default
1958
to the exported filename. The root option has no effect for 'dir' format.
1960
If branch is omitted then the branch containing the current working
1961
directory will be used.
1963
Note: Export of tree with non-ASCII filenames to zip is not supported.
1965
Supported formats Autodetected by extension
1966
----------------- -------------------------
1969
tbz2 .tar.bz2, .tbz2
1973
takes_args = ['dest', 'branch?']
1974
takes_options = ['revision', 'format', 'root']
1975
def run(self, dest, branch=None, revision=None, format=None, root=None):
1976
from bzrlib.export import export
1979
tree = WorkingTree.open_containing(u'.')[0]
1982
b = Branch.open(branch)
1984
if revision is None:
1985
# should be tree.last_revision FIXME
1986
rev_id = b.last_revision()
1988
if len(revision) != 1:
1989
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1990
rev_id = revision[0].in_history(b).rev_id
1991
t = b.repository.revision_tree(rev_id)
1993
export(t, dest, format, root)
1994
except errors.NoSuchExportFormat, e:
1995
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1998
class cmd_cat(Command):
1999
"""Write the contents of a file as of a given revision to standard output.
2001
If no revision is nominated, the last revision is used.
2003
Note: Take care to redirect standard output when using this command on a
2008
takes_options = ['revision', 'name-from-revision']
2009
takes_args = ['filename']
2010
encoding_type = 'exact'
2013
def run(self, filename, revision=None, name_from_revision=False):
2014
if revision is not None and len(revision) != 1:
2015
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2020
tree, b, relpath = \
2021
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2022
except errors.NotBranchError:
2025
if revision is not None and revision[0].get_branch() is not None:
2026
b = Branch.open(revision[0].get_branch())
2028
tree = b.basis_tree()
2029
if revision is None:
2030
revision_id = b.last_revision()
2032
revision_id = revision[0].in_history(b).rev_id
2034
cur_file_id = tree.path2id(relpath)
2035
rev_tree = b.repository.revision_tree(revision_id)
2036
old_file_id = rev_tree.path2id(relpath)
2038
if name_from_revision:
2039
if old_file_id is None:
2040
raise errors.BzrCommandError("%r is not present in revision %s"
2041
% (filename, revision_id))
2043
rev_tree.print_file(old_file_id)
2044
elif cur_file_id is not None:
2045
rev_tree.print_file(cur_file_id)
2046
elif old_file_id is not None:
2047
rev_tree.print_file(old_file_id)
2049
raise errors.BzrCommandError("%r is not present in revision %s" %
2050
(filename, revision_id))
2053
class cmd_local_time_offset(Command):
2054
"""Show the offset in seconds from GMT to local time."""
2058
print osutils.local_time_offset()
2062
class cmd_commit(Command):
2063
"""Commit changes into a new revision.
2065
If no arguments are given, the entire tree is committed.
2067
If selected files are specified, only changes to those files are
2068
committed. If a directory is specified then the directory and everything
2069
within it is committed.
2071
A selected-file commit may fail in some cases where the committed
2072
tree would be invalid. Consider::
2077
bzr commit foo -m "committing foo"
2078
bzr mv foo/bar foo/baz
2081
bzr commit foo/bar -m "committing bar but not baz"
2083
In the example above, the last commit will fail by design. This gives
2084
the user the opportunity to decide whether they want to commit the
2085
rename at the same time, separately first, or not at all. (As a general
2086
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2088
Note: A selected-file commit after a merge is not yet supported.
2090
# TODO: Run hooks on tree to-be-committed, and after commit.
2092
# TODO: Strict commit that fails if there are deleted files.
2093
# (what does "deleted files" mean ??)
2095
# TODO: Give better message for -s, --summary, used by tla people
2097
# XXX: verbose currently does nothing
2099
_see_also = ['bugs', 'uncommit']
2100
takes_args = ['selected*']
2101
takes_options = ['message', 'verbose',
2103
help='commit even if nothing has changed'),
2104
Option('file', type=str,
2107
help='file containing commit message'),
2109
help="refuse to commit if there are unknown "
2110
"files in the working tree."),
2111
ListOption('fixes', type=str,
2112
help="mark a bug as being fixed by this "
2115
help="perform a local only commit in a bound "
2116
"branch. Such commits are not pushed to "
2117
"the master branch until a normal commit "
2121
aliases = ['ci', 'checkin']
2123
def _get_bug_fix_properties(self, fixes, branch):
2125
# Configure the properties for bug fixing attributes.
2126
for fixed_bug in fixes:
2127
tokens = fixed_bug.split(':')
2128
if len(tokens) != 2:
2129
raise errors.BzrCommandError(
2130
"Invalid bug %s. Must be in the form of 'tag:id'. "
2131
"Commit refused." % fixed_bug)
2132
tag, bug_id = tokens
2134
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2135
except errors.UnknownBugTrackerAbbreviation:
2136
raise errors.BzrCommandError(
2137
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2138
except errors.MalformedBugIdentifier:
2139
raise errors.BzrCommandError(
2140
"Invalid bug identifier for %s. Commit refused."
2142
properties.append('%s fixed' % bug_url)
2143
return '\n'.join(properties)
2145
def run(self, message=None, file=None, verbose=True, selected_list=None,
2146
unchanged=False, strict=False, local=False, fixes=None):
2147
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2148
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2150
from bzrlib.msgeditor import edit_commit_message, \
2151
make_commit_message_template
2153
# TODO: Need a blackbox test for invoking the external editor; may be
2154
# slightly problematic to run this cross-platform.
2156
# TODO: do more checks that the commit will succeed before
2157
# spending the user's valuable time typing a commit message.
2161
tree, selected_list = tree_files(selected_list)
2162
if selected_list == ['']:
2163
# workaround - commit of root of tree should be exactly the same
2164
# as just default commit in that tree, and succeed even though
2165
# selected-file merge commit is not done yet
2168
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2170
properties['bugs'] = bug_property
2172
if local and not tree.branch.get_bound_location():
2173
raise errors.LocalRequiresBoundBranch()
2175
def get_message(commit_obj):
2176
"""Callback to get commit message"""
2177
my_message = message
2178
if my_message is None and not file:
2179
template = make_commit_message_template(tree, selected_list)
2180
my_message = edit_commit_message(template)
2181
if my_message is None:
2182
raise errors.BzrCommandError("please specify a commit"
2183
" message with either --message or --file")
2184
elif my_message and file:
2185
raise errors.BzrCommandError(
2186
"please specify either --message or --file")
2188
my_message = codecs.open(file, 'rt',
2189
bzrlib.user_encoding).read()
2190
if my_message == "":
2191
raise errors.BzrCommandError("empty commit message specified")
2195
reporter = ReportCommitToLog()
2197
reporter = NullCommitReporter()
2200
tree.commit(message_callback=get_message,
2201
specific_files=selected_list,
2202
allow_pointless=unchanged, strict=strict, local=local,
2203
reporter=reporter, revprops=properties)
2204
except PointlessCommit:
2205
# FIXME: This should really happen before the file is read in;
2206
# perhaps prepare the commit; get the message; then actually commit
2207
raise errors.BzrCommandError("no changes to commit."
2208
" use --unchanged to commit anyhow")
2209
except ConflictsInTree:
2210
raise errors.BzrCommandError('Conflicts detected in working '
2211
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2213
except StrictCommitFailed:
2214
raise errors.BzrCommandError("Commit refused because there are"
2215
" unknown files in the working tree.")
2216
except errors.BoundBranchOutOfDate, e:
2217
raise errors.BzrCommandError(str(e) + "\n"
2218
'To commit to master branch, run update and then commit.\n'
2219
'You can also pass --local to commit to continue working '
2223
class cmd_check(Command):
2224
"""Validate consistency of branch history.
2226
This command checks various invariants about the branch storage to
2227
detect data corruption or bzr bugs.
2230
_see_also = ['reconcile']
2231
takes_args = ['branch?']
2232
takes_options = ['verbose']
2234
def run(self, branch=None, verbose=False):
2235
from bzrlib.check import check
2237
tree = WorkingTree.open_containing()[0]
2238
branch = tree.branch
2240
branch = Branch.open(branch)
2241
check(branch, verbose)
2244
class cmd_upgrade(Command):
2245
"""Upgrade branch storage to current format.
2247
The check command or bzr developers may sometimes advise you to run
2248
this command. When the default format has changed you may also be warned
2249
during other operations to upgrade.
2252
_see_also = ['check']
2253
takes_args = ['url?']
2255
RegistryOption('format',
2256
help='Upgrade to a specific format. See "bzr help'
2257
' formats" for details',
2258
registry=bzrdir.format_registry,
2259
converter=bzrdir.format_registry.make_bzrdir,
2260
value_switches=True, title='Branch format'),
2263
def run(self, url='.', format=None):
2264
from bzrlib.upgrade import upgrade
2266
format = bzrdir.format_registry.make_bzrdir('default')
2267
upgrade(url, format)
2270
class cmd_whoami(Command):
2271
"""Show or set bzr user id.
2275
bzr whoami 'Frank Chu <fchu@example.com>'
2277
takes_options = [ Option('email',
2278
help='display email address only'),
2280
help='set identity for the current branch instead of '
2283
takes_args = ['name?']
2284
encoding_type = 'replace'
2287
def run(self, email=False, branch=False, name=None):
2289
# use branch if we're inside one; otherwise global config
2291
c = Branch.open_containing('.')[0].get_config()
2292
except errors.NotBranchError:
2293
c = config.GlobalConfig()
2295
self.outf.write(c.user_email() + '\n')
2297
self.outf.write(c.username() + '\n')
2300
# display a warning if an email address isn't included in the given name.
2302
config.extract_email_address(name)
2303
except errors.NoEmailInUsername, e:
2304
warning('"%s" does not seem to contain an email address. '
2305
'This is allowed, but not recommended.', name)
2307
# use global config unless --branch given
2309
c = Branch.open_containing('.')[0].get_config()
2311
c = config.GlobalConfig()
2312
c.set_user_option('email', name)
2315
class cmd_nick(Command):
2316
"""Print or set the branch nickname.
2318
If unset, the tree root directory name is used as the nickname
2319
To print the current nickname, execute with no argument.
2322
_see_also = ['info']
2323
takes_args = ['nickname?']
2324
def run(self, nickname=None):
2325
branch = Branch.open_containing(u'.')[0]
2326
if nickname is None:
2327
self.printme(branch)
2329
branch.nick = nickname
2332
def printme(self, branch):
2336
class cmd_selftest(Command):
2337
"""Run internal test suite.
2339
This creates temporary test directories in the working directory, but no
2340
existing data is affected. These directories are deleted if the tests
2341
pass, or left behind to help in debugging if they fail and --keep-output
2344
If arguments are given, they are regular expressions that say which tests
2345
should run. Tests matching any expression are run, and other tests are
2348
Alternatively if --first is given, matching tests are run first and then
2349
all other tests are run. This is useful if you have been working in a
2350
particular area, but want to make sure nothing else was broken.
2352
If --exclude is given, tests that match that regular expression are
2353
excluded, regardless of whether they match --first or not.
2355
To help catch accidential dependencies between tests, the --randomize
2356
option is useful. In most cases, the argument used is the word 'now'.
2357
Note that the seed used for the random number generator is displayed
2358
when this option is used. The seed can be explicitly passed as the
2359
argument to this option if required. This enables reproduction of the
2360
actual ordering used if and when an order sensitive problem is encountered.
2362
If --list-only is given, the tests that would be run are listed. This is
2363
useful when combined with --first, --exclude and/or --randomize to
2364
understand their impact. The test harness reports "Listed nn tests in ..."
2365
instead of "Ran nn tests in ..." when list mode is enabled.
2367
If the global option '--no-plugins' is given, plugins are not loaded
2368
before running the selftests. This has two effects: features provided or
2369
modified by plugins will not be tested, and tests provided by plugins will
2374
run only tests relating to 'ignore'
2375
bzr --no-plugins selftest -v
2376
disable plugins and list tests as they're run
2378
For each test, that needs actual disk access, bzr create their own
2379
subdirectory in the temporary testing directory (testXXXX.tmp).
2380
By default the name of such subdirectory is based on the name of the test.
2381
If option '--numbered-dirs' is given, bzr will use sequent numbers
2382
of running tests to create such subdirectories. This is default behavior
2383
on Windows because of path length limitation.
2385
# NB: this is used from the class without creating an instance, which is
2386
# why it does not have a self parameter.
2387
def get_transport_type(typestring):
2388
"""Parse and return a transport specifier."""
2389
if typestring == "sftp":
2390
from bzrlib.transport.sftp import SFTPAbsoluteServer
2391
return SFTPAbsoluteServer
2392
if typestring == "memory":
2393
from bzrlib.transport.memory import MemoryServer
2395
if typestring == "fakenfs":
2396
from bzrlib.transport.fakenfs import FakeNFSServer
2397
return FakeNFSServer
2398
msg = "No known transport type %s. Supported types are: sftp\n" %\
2400
raise errors.BzrCommandError(msg)
2403
takes_args = ['testspecs*']
2404
takes_options = ['verbose',
2406
help='stop when one test fails',
2409
Option('keep-output',
2410
help='keep output directories when tests fail'),
2412
help='Use a different transport by default '
2413
'throughout the test suite.',
2414
type=get_transport_type),
2415
Option('benchmark', help='run the bzr benchmarks.'),
2416
Option('lsprof-timed',
2417
help='generate lsprof output for benchmarked'
2418
' sections of code.'),
2419
Option('cache-dir', type=str,
2420
help='a directory to cache intermediate'
2421
' benchmark steps'),
2422
Option('clean-output',
2423
help='clean temporary tests directories'
2424
' without running tests'),
2426
help='run all tests, but run specified tests first',
2429
Option('numbered-dirs',
2430
help='use numbered dirs for TestCaseInTempDir'),
2432
help='list the tests instead of running them'),
2433
Option('randomize', type=str, argname="SEED",
2434
help='randomize the order of tests using the given'
2435
' seed or "now" for the current time'),
2436
Option('exclude', type=str, argname="PATTERN",
2438
help='exclude tests that match this regular'
2441
encoding_type = 'replace'
2443
def run(self, testspecs_list=None, verbose=None, one=False,
2444
keep_output=False, transport=None, benchmark=None,
2445
lsprof_timed=None, cache_dir=None, clean_output=False,
2446
first=False, numbered_dirs=None, list_only=False,
2447
randomize=None, exclude=None):
2449
from bzrlib.tests import selftest
2450
import bzrlib.benchmarks as benchmarks
2451
from bzrlib.benchmarks import tree_creator
2454
from bzrlib.tests import clean_selftest_output
2455
clean_selftest_output()
2458
if numbered_dirs is None and sys.platform == 'win32':
2459
numbered_dirs = True
2461
if cache_dir is not None:
2462
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2463
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2464
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2466
if testspecs_list is not None:
2467
pattern = '|'.join(testspecs_list)
2471
test_suite_factory = benchmarks.test_suite
2474
# TODO: should possibly lock the history file...
2475
benchfile = open(".perf_history", "at", buffering=1)
2477
test_suite_factory = None
2482
result = selftest(verbose=verbose,
2484
stop_on_failure=one,
2485
keep_output=keep_output,
2486
transport=transport,
2487
test_suite_factory=test_suite_factory,
2488
lsprof_timed=lsprof_timed,
2489
bench_history=benchfile,
2490
matching_tests_first=first,
2491
numbered_dirs=numbered_dirs,
2492
list_only=list_only,
2493
random_seed=randomize,
2494
exclude_pattern=exclude
2497
if benchfile is not None:
2500
info('tests passed')
2502
info('tests failed')
2503
return int(not result)
2506
class cmd_version(Command):
2507
"""Show version of bzr."""
2511
from bzrlib.version import show_version
2515
class cmd_rocks(Command):
2516
"""Statement of optimism."""
2522
print "It sure does!"
2525
class cmd_find_merge_base(Command):
2526
"""Find and print a base revision for merging two branches."""
2527
# TODO: Options to specify revisions on either side, as if
2528
# merging only part of the history.
2529
takes_args = ['branch', 'other']
2533
def run(self, branch, other):
2534
from bzrlib.revision import MultipleRevisionSources
2536
branch1 = Branch.open_containing(branch)[0]
2537
branch2 = Branch.open_containing(other)[0]
2539
last1 = branch1.last_revision()
2540
last2 = branch2.last_revision()
2542
source = MultipleRevisionSources(branch1.repository,
2545
base_rev_id = common_ancestor(last1, last2, source)
2547
print 'merge base is revision %s' % base_rev_id
2550
class cmd_merge(Command):
2551
"""Perform a three-way merge.
2553
The branch is the branch you will merge from. By default, it will merge
2554
the latest revision. If you specify a revision, that revision will be
2555
merged. If you specify two revisions, the first will be used as a BASE,
2556
and the second one as OTHER. Revision numbers are always relative to the
2559
By default, bzr will try to merge in all new work from the other
2560
branch, automatically determining an appropriate base. If this
2561
fails, you may need to give an explicit base.
2563
Merge will do its best to combine the changes in two branches, but there
2564
are some kinds of problems only a human can fix. When it encounters those,
2565
it will mark a conflict. A conflict means that you need to fix something,
2566
before you should commit.
2568
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2570
If there is no default branch set, the first merge will set it. After
2571
that, you can omit the branch to use the default. To change the
2572
default, use --remember. The value will only be saved if the remote
2573
location can be accessed.
2575
The results of the merge are placed into the destination working
2576
directory, where they can be reviewed (with bzr diff), tested, and then
2577
committed to record the result of the merge.
2581
To merge the latest revision from bzr.dev:
2582
bzr merge ../bzr.dev
2584
To merge changes up to and including revision 82 from bzr.dev:
2585
bzr merge -r 82 ../bzr.dev
2587
To merge the changes introduced by 82, without previous changes:
2588
bzr merge -r 81..82 ../bzr.dev
2590
merge refuses to run if there are any uncommitted changes, unless
2594
_see_also = ['update', 'remerge']
2595
takes_args = ['branch?']
2596
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2597
Option('show-base', help="Show base revision text in "
2599
Option('uncommitted', help='Apply uncommitted changes'
2600
' from a working copy, instead of branch changes'),
2601
Option('pull', help='If the destination is already'
2602
' completely merged into the source, pull from the'
2603
' source rather than merging. When this happens,'
2604
' you do not need to commit the result.'),
2606
help='Branch to merge into, '
2607
'rather than the one containing the working directory',
2613
def run(self, branch=None, revision=None, force=False, merge_type=None,
2614
show_base=False, reprocess=False, remember=False,
2615
uncommitted=False, pull=False,
2618
from bzrlib.tag import _merge_tags_if_possible
2619
other_revision_id = None
2620
if merge_type is None:
2621
merge_type = _mod_merge.Merge3Merger
2623
if directory is None: directory = u'.'
2624
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2625
# inventory. Because merge is a mutating operation, it really
2626
# should be a lock_write() for the whole cmd_merge operation.
2627
# However, cmd_merge open's its own tree in _merge_helper, which
2628
# means if we lock here, the later lock_write() will always block.
2629
# Either the merge helper code should be updated to take a tree,
2630
# (What about tree.merge_from_branch?)
2631
tree = WorkingTree.open_containing(directory)[0]
2632
change_reporter = delta._ChangeReporter(
2633
unversioned_filter=tree.is_ignored)
2635
if branch is not None:
2637
mergeable = bundle.read_mergeable_from_url(
2639
except errors.NotABundle:
2640
pass # Continue on considering this url a Branch
2642
if revision is not None:
2643
raise errors.BzrCommandError(
2644
'Cannot use -r with merge directives or bundles')
2645
other_revision_id = mergeable.install_revisions(
2646
tree.branch.repository)
2647
revision = [RevisionSpec.from_string(
2648
'revid:' + other_revision_id)]
2650
if revision is None \
2651
or len(revision) < 1 or revision[0].needs_branch():
2652
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2654
if revision is None or len(revision) < 1:
2657
other = [branch, None]
2660
other = [branch, -1]
2661
other_branch, path = Branch.open_containing(branch)
2664
raise errors.BzrCommandError('Cannot use --uncommitted and'
2665
' --revision at the same time.')
2666
branch = revision[0].get_branch() or branch
2667
if len(revision) == 1:
2669
if other_revision_id is not None:
2674
other_branch, path = Branch.open_containing(branch)
2675
revno = revision[0].in_history(other_branch).revno
2676
other = [branch, revno]
2678
assert len(revision) == 2
2679
if None in revision:
2680
raise errors.BzrCommandError(
2681
"Merge doesn't permit empty revision specifier.")
2682
base_branch, path = Branch.open_containing(branch)
2683
branch1 = revision[1].get_branch() or branch
2684
other_branch, path1 = Branch.open_containing(branch1)
2685
if revision[0].get_branch() is not None:
2686
# then path was obtained from it, and is None.
2689
base = [branch, revision[0].in_history(base_branch).revno]
2690
other = [branch1, revision[1].in_history(other_branch).revno]
2692
if ((tree.branch.get_parent() is None or remember) and
2693
other_branch is not None):
2694
tree.branch.set_parent(other_branch.base)
2696
# pull tags now... it's a bit inconsistent to do it ahead of copying
2697
# the history but that's done inside the merge code
2698
if other_branch is not None:
2699
_merge_tags_if_possible(other_branch, tree.branch)
2702
interesting_files = [path]
2704
interesting_files = None
2705
pb = ui.ui_factory.nested_progress_bar()
2708
conflict_count = _merge_helper(
2709
other, base, other_rev_id=other_revision_id,
2710
check_clean=(not force),
2711
merge_type=merge_type,
2712
reprocess=reprocess,
2713
show_base=show_base,
2716
pb=pb, file_list=interesting_files,
2717
change_reporter=change_reporter)
2720
if conflict_count != 0:
2724
except errors.AmbiguousBase, e:
2725
m = ("sorry, bzr can't determine the right merge base yet\n"
2726
"candidates are:\n "
2727
+ "\n ".join(e.bases)
2729
"please specify an explicit base with -r,\n"
2730
"and (if you want) report this to the bzr developers\n")
2733
# TODO: move up to common parent; this isn't merge-specific anymore.
2734
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2735
"""Use tree.branch's parent if none was supplied.
2737
Report if the remembered location was used.
2739
if supplied_location is not None:
2740
return supplied_location
2741
stored_location = tree.branch.get_parent()
2742
mutter("%s", stored_location)
2743
if stored_location is None:
2744
raise errors.BzrCommandError("No location specified or remembered")
2745
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2746
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2747
return stored_location
2750
class cmd_remerge(Command):
2753
Use this if you want to try a different merge technique while resolving
2754
conflicts. Some merge techniques are better than others, and remerge
2755
lets you try different ones on different files.
2757
The options for remerge have the same meaning and defaults as the ones for
2758
merge. The difference is that remerge can (only) be run when there is a
2759
pending merge, and it lets you specify particular files.
2763
$ bzr remerge --show-base
2764
Re-do the merge of all conflicted files, and show the base text in
2765
conflict regions, in addition to the usual THIS and OTHER texts.
2767
$ bzr remerge --merge-type weave --reprocess foobar
2768
Re-do the merge of "foobar", using the weave merge algorithm, with
2769
additional processing to reduce the size of conflict regions.
2771
takes_args = ['file*']
2772
takes_options = ['merge-type', 'reprocess',
2773
Option('show-base', help="Show base revision text in "
2776
def run(self, file_list=None, merge_type=None, show_base=False,
2778
if merge_type is None:
2779
merge_type = _mod_merge.Merge3Merger
2780
tree, file_list = tree_files(file_list)
2783
parents = tree.get_parent_ids()
2784
if len(parents) != 2:
2785
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2786
" merges. Not cherrypicking or"
2788
repository = tree.branch.repository
2789
base_revision = common_ancestor(parents[0],
2790
parents[1], repository)
2791
base_tree = repository.revision_tree(base_revision)
2792
other_tree = repository.revision_tree(parents[1])
2793
interesting_ids = None
2795
conflicts = tree.conflicts()
2796
if file_list is not None:
2797
interesting_ids = set()
2798
for filename in file_list:
2799
file_id = tree.path2id(filename)
2801
raise errors.NotVersionedError(filename)
2802
interesting_ids.add(file_id)
2803
if tree.kind(file_id) != "directory":
2806
for name, ie in tree.inventory.iter_entries(file_id):
2807
interesting_ids.add(ie.file_id)
2808
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2810
# Remerge only supports resolving contents conflicts
2811
allowed_conflicts = ('text conflict', 'contents conflict')
2812
restore_files = [c.path for c in conflicts
2813
if c.typestring in allowed_conflicts]
2814
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2815
tree.set_conflicts(ConflictList(new_conflicts))
2816
if file_list is not None:
2817
restore_files = file_list
2818
for filename in restore_files:
2820
restore(tree.abspath(filename))
2821
except errors.NotConflicted:
2823
conflicts = _mod_merge.merge_inner(
2824
tree.branch, other_tree, base_tree,
2826
interesting_ids=interesting_ids,
2827
other_rev_id=parents[1],
2828
merge_type=merge_type,
2829
show_base=show_base,
2830
reprocess=reprocess)
2839
class cmd_revert(Command):
2840
"""Revert files to a previous revision.
2842
Giving a list of files will revert only those files. Otherwise, all files
2843
will be reverted. If the revision is not specified with '--revision', the
2844
last committed revision is used.
2846
To remove only some changes, without reverting to a prior version, use
2847
merge instead. For example, "merge . --r-2..-3" will remove the changes
2848
introduced by -2, without affecting the changes introduced by -1. Or
2849
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2851
By default, any files that have been manually changed will be backed up
2852
first. (Files changed only by merge are not backed up.) Backup files have
2853
'.~#~' appended to their name, where # is a number.
2855
When you provide files, you can use their current pathname or the pathname
2856
from the target revision. So you can use revert to "undelete" a file by
2857
name. If you name a directory, all the contents of that directory will be
2861
_see_also = ['cat', 'export']
2862
takes_options = ['revision', 'no-backup']
2863
takes_args = ['file*']
2865
def run(self, revision=None, no_backup=False, file_list=None):
2866
if file_list is not None:
2867
if len(file_list) == 0:
2868
raise errors.BzrCommandError("No files specified")
2872
tree, file_list = tree_files(file_list)
2873
if revision is None:
2874
# FIXME should be tree.last_revision
2875
rev_id = tree.last_revision()
2876
elif len(revision) != 1:
2877
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2879
rev_id = revision[0].in_history(tree.branch).rev_id
2880
pb = ui.ui_factory.nested_progress_bar()
2882
tree.revert(file_list,
2883
tree.branch.repository.revision_tree(rev_id),
2884
not no_backup, pb, report_changes=True)
2889
class cmd_assert_fail(Command):
2890
"""Test reporting of assertion failures"""
2891
# intended just for use in testing
2896
raise AssertionError("always fails")
2899
class cmd_help(Command):
2900
"""Show help on a command or other topic.
2903
_see_also = ['topics']
2904
takes_options = [Option('long', 'show help on all commands')]
2905
takes_args = ['topic?']
2906
aliases = ['?', '--help', '-?', '-h']
2909
def run(self, topic=None, long=False):
2911
if topic is None and long:
2913
bzrlib.help.help(topic)
2916
class cmd_shell_complete(Command):
2917
"""Show appropriate completions for context.
2919
For a list of all available commands, say 'bzr shell-complete'.
2921
takes_args = ['context?']
2926
def run(self, context=None):
2927
import shellcomplete
2928
shellcomplete.shellcomplete(context)
2931
class cmd_fetch(Command):
2932
"""Copy in history from another branch but don't merge it.
2934
This is an internal method used for pull and merge.
2937
takes_args = ['from_branch', 'to_branch']
2938
def run(self, from_branch, to_branch):
2939
from bzrlib.fetch import Fetcher
2940
from_b = Branch.open(from_branch)
2941
to_b = Branch.open(to_branch)
2942
Fetcher(to_b, from_b)
2945
class cmd_missing(Command):
2946
"""Show unmerged/unpulled revisions between two branches.
2948
OTHER_BRANCH may be local or remote.
2951
_see_also = ['merge', 'pull']
2952
takes_args = ['other_branch?']
2953
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2955
'Display changes in the local branch only'),
2956
Option('theirs-only',
2957
'Display changes in the remote branch only'),
2962
encoding_type = 'replace'
2965
def run(self, other_branch=None, reverse=False, mine_only=False,
2966
theirs_only=False, log_format=None, long=False, short=False, line=False,
2967
show_ids=False, verbose=False):
2968
from bzrlib.missing import find_unmerged, iter_log_data
2969
from bzrlib.log import log_formatter
2970
local_branch = Branch.open_containing(u".")[0]
2971
parent = local_branch.get_parent()
2972
if other_branch is None:
2973
other_branch = parent
2974
if other_branch is None:
2975
raise errors.BzrCommandError("No peer location known or specified.")
2976
display_url = urlutils.unescape_for_display(parent,
2978
print "Using last location: " + display_url
2980
remote_branch = Branch.open(other_branch)
2981
if remote_branch.base == local_branch.base:
2982
remote_branch = local_branch
2983
local_branch.lock_read()
2985
remote_branch.lock_read()
2987
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2988
if (log_format is None):
2989
log_format = log.log_formatter_registry.get_default(
2991
lf = log_format(to_file=self.outf,
2993
show_timezone='original')
2994
if reverse is False:
2995
local_extra.reverse()
2996
remote_extra.reverse()
2997
if local_extra and not theirs_only:
2998
print "You have %d extra revision(s):" % len(local_extra)
2999
for data in iter_log_data(local_extra, local_branch.repository,
3002
printed_local = True
3004
printed_local = False
3005
if remote_extra and not mine_only:
3006
if printed_local is True:
3008
print "You are missing %d revision(s):" % len(remote_extra)
3009
for data in iter_log_data(remote_extra, remote_branch.repository,
3012
if not remote_extra and not local_extra:
3014
print "Branches are up to date."
3018
remote_branch.unlock()
3020
local_branch.unlock()
3021
if not status_code and parent is None and other_branch is not None:
3022
local_branch.lock_write()
3024
# handle race conditions - a parent might be set while we run.
3025
if local_branch.get_parent() is None:
3026
local_branch.set_parent(remote_branch.base)
3028
local_branch.unlock()
3032
class cmd_plugins(Command):
3037
import bzrlib.plugin
3038
from inspect import getdoc
3039
for name, plugin in bzrlib.plugin.all_plugins().items():
3040
if getattr(plugin, '__path__', None) is not None:
3041
print plugin.__path__[0]
3042
elif getattr(plugin, '__file__', None) is not None:
3043
print plugin.__file__
3049
print '\t', d.split('\n')[0]
3052
class cmd_testament(Command):
3053
"""Show testament (signing-form) of a revision."""
3054
takes_options = ['revision',
3055
Option('long', help='Produce long-format testament'),
3056
Option('strict', help='Produce a strict-format'
3058
takes_args = ['branch?']
3060
def run(self, branch=u'.', revision=None, long=False, strict=False):
3061
from bzrlib.testament import Testament, StrictTestament
3063
testament_class = StrictTestament
3065
testament_class = Testament
3066
b = WorkingTree.open_containing(branch)[0].branch
3069
if revision is None:
3070
rev_id = b.last_revision()
3072
rev_id = revision[0].in_history(b).rev_id
3073
t = testament_class.from_revision(b.repository, rev_id)
3075
sys.stdout.writelines(t.as_text_lines())
3077
sys.stdout.write(t.as_short_text())
3082
class cmd_annotate(Command):
3083
"""Show the origin of each line in a file.
3085
This prints out the given file with an annotation on the left side
3086
indicating which revision, author and date introduced the change.
3088
If the origin is the same for a run of consecutive lines, it is
3089
shown only at the top, unless the --all option is given.
3091
# TODO: annotate directories; showing when each file was last changed
3092
# TODO: if the working copy is modified, show annotations on that
3093
# with new uncommitted lines marked
3094
aliases = ['ann', 'blame', 'praise']
3095
takes_args = ['filename']
3096
takes_options = [Option('all', help='show annotations on all lines'),
3097
Option('long', help='show date in annotations'),
3103
def run(self, filename, all=False, long=False, revision=None,
3105
from bzrlib.annotate import annotate_file
3106
tree, relpath = WorkingTree.open_containing(filename)
3107
branch = tree.branch
3110
if revision is None:
3111
revision_id = branch.last_revision()
3112
elif len(revision) != 1:
3113
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3115
revision_id = revision[0].in_history(branch).rev_id
3116
file_id = tree.path2id(relpath)
3117
tree = branch.repository.revision_tree(revision_id)
3118
file_version = tree.inventory[file_id].revision
3119
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3125
class cmd_re_sign(Command):
3126
"""Create a digital signature for an existing revision."""
3127
# TODO be able to replace existing ones.
3129
hidden = True # is this right ?
3130
takes_args = ['revision_id*']
3131
takes_options = ['revision']
3133
def run(self, revision_id_list=None, revision=None):
3134
import bzrlib.gpg as gpg
3135
if revision_id_list is not None and revision is not None:
3136
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3137
if revision_id_list is None and revision is None:
3138
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3139
b = WorkingTree.open_containing(u'.')[0].branch
3140
gpg_strategy = gpg.GPGStrategy(b.get_config())
3141
if revision_id_list is not None:
3142
for revision_id in revision_id_list:
3143
b.repository.sign_revision(revision_id, gpg_strategy)
3144
elif revision is not None:
3145
if len(revision) == 1:
3146
revno, rev_id = revision[0].in_history(b)
3147
b.repository.sign_revision(rev_id, gpg_strategy)
3148
elif len(revision) == 2:
3149
# are they both on rh- if so we can walk between them
3150
# might be nice to have a range helper for arbitrary
3151
# revision paths. hmm.
3152
from_revno, from_revid = revision[0].in_history(b)
3153
to_revno, to_revid = revision[1].in_history(b)
3154
if to_revid is None:
3155
to_revno = b.revno()
3156
if from_revno is None or to_revno is None:
3157
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3158
for revno in range(from_revno, to_revno + 1):
3159
b.repository.sign_revision(b.get_rev_id(revno),
3162
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3165
class cmd_bind(Command):
3166
"""Convert the current branch into a checkout of the supplied branch.
3168
Once converted into a checkout, commits must succeed on the master branch
3169
before they will be applied to the local branch.
3172
_see_also = ['checkouts', 'unbind']
3173
takes_args = ['location?']
3176
def run(self, location=None):
3177
b, relpath = Branch.open_containing(u'.')
3178
if location is None:
3180
location = b.get_old_bound_location()
3181
except errors.UpgradeRequired:
3182
raise errors.BzrCommandError('No location supplied. '
3183
'This format does not remember old locations.')
3185
if location is None:
3186
raise errors.BzrCommandError('No location supplied and no '
3187
'previous location known')
3188
b_other = Branch.open(location)
3191
except errors.DivergedBranches:
3192
raise errors.BzrCommandError('These branches have diverged.'
3193
' Try merging, and then bind again.')
3196
class cmd_unbind(Command):
3197
"""Convert the current checkout into a regular branch.
3199
After unbinding, the local branch is considered independent and subsequent
3200
commits will be local only.
3203
_see_also = ['checkouts', 'bind']
3208
b, relpath = Branch.open_containing(u'.')
3210
raise errors.BzrCommandError('Local branch is not bound')
3213
class cmd_uncommit(Command):
3214
"""Remove the last committed revision.
3216
--verbose will print out what is being removed.
3217
--dry-run will go through all the motions, but not actually
3220
In the future, uncommit will create a revision bundle, which can then
3224
# TODO: jam 20060108 Add an option to allow uncommit to remove
3225
# unreferenced information in 'branch-as-repository' branches.
3226
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3227
# information in shared branches as well.
3228
_see_also = ['commit']
3229
takes_options = ['verbose', 'revision',
3230
Option('dry-run', help='Don\'t actually make changes'),
3231
Option('force', help='Say yes to all questions.')]
3232
takes_args = ['location?']
3235
def run(self, location=None,
3236
dry_run=False, verbose=False,
3237
revision=None, force=False):
3238
from bzrlib.log import log_formatter, show_log
3240
from bzrlib.uncommit import uncommit
3242
if location is None:
3244
control, relpath = bzrdir.BzrDir.open_containing(location)
3246
tree = control.open_workingtree()
3248
except (errors.NoWorkingTree, errors.NotLocalUrl):
3250
b = control.open_branch()
3253
if revision is None:
3256
# 'bzr uncommit -r 10' actually means uncommit
3257
# so that the final tree is at revno 10.
3258
# but bzrlib.uncommit.uncommit() actually uncommits
3259
# the revisions that are supplied.
3260
# So we need to offset it by one
3261
revno = revision[0].in_history(b).revno+1
3263
if revno <= b.revno():
3264
rev_id = b.get_rev_id(revno)
3266
self.outf.write('No revisions to uncommit.\n')
3269
lf = log_formatter('short',
3271
show_timezone='original')
3276
direction='forward',
3277
start_revision=revno,
3278
end_revision=b.revno())
3281
print 'Dry-run, pretending to remove the above revisions.'
3283
val = raw_input('Press <enter> to continue')
3285
print 'The above revision(s) will be removed.'
3287
val = raw_input('Are you sure [y/N]? ')
3288
if val.lower() not in ('y', 'yes'):
3292
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3296
class cmd_break_lock(Command):
3297
"""Break a dead lock on a repository, branch or working directory.
3299
CAUTION: Locks should only be broken when you are sure that the process
3300
holding the lock has been stopped.
3302
You can get information on what locks are open via the 'bzr info' command.
3307
takes_args = ['location?']
3309
def run(self, location=None, show=False):
3310
if location is None:
3312
control, relpath = bzrdir.BzrDir.open_containing(location)
3314
control.break_lock()
3315
except NotImplementedError:
3319
class cmd_wait_until_signalled(Command):
3320
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3322
This just prints a line to signal when it is ready, then blocks on stdin.
3328
sys.stdout.write("running\n")
3330
sys.stdin.readline()
3333
class cmd_serve(Command):
3334
"""Run the bzr server."""
3336
aliases = ['server']
3340
help='serve on stdin/out for use from inetd or sshd'),
3342
help='listen for connections on nominated port of the form '
3343
'[hostname:]portnumber. Passing 0 as the port number will '
3344
'result in a dynamically allocated port. Default port is '
3348
help='serve contents of directory',
3350
Option('allow-writes',
3351
help='By default the server is a readonly server. Supplying '
3352
'--allow-writes enables write access to the contents of '
3353
'the served directory and below. '
3357
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3358
from bzrlib.smart import medium, server
3359
from bzrlib.transport import get_transport
3360
from bzrlib.transport.chroot import ChrootServer
3361
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3362
if directory is None:
3363
directory = os.getcwd()
3364
url = urlutils.local_path_to_url(directory)
3365
if not allow_writes:
3366
url = 'readonly+' + url
3367
chroot_server = ChrootServer(get_transport(url))
3368
chroot_server.setUp()
3369
t = get_transport(chroot_server.get_url())
3371
smart_server = medium.SmartServerPipeStreamMedium(
3372
sys.stdin, sys.stdout, t)
3374
host = BZR_DEFAULT_INTERFACE
3376
port = BZR_DEFAULT_PORT
3379
host, port = port.split(':')
3381
smart_server = server.SmartTCPServer(t, host=host, port=port)
3382
print 'listening on port: ', smart_server.port
3384
# for the duration of this server, no UI output is permitted.
3385
# note that this may cause problems with blackbox tests. This should
3386
# be changed with care though, as we dont want to use bandwidth sending
3387
# progress over stderr to smart server clients!
3388
old_factory = ui.ui_factory
3390
ui.ui_factory = ui.SilentUIFactory()
3391
smart_server.serve()
3393
ui.ui_factory = old_factory
3396
class cmd_join(Command):
3397
"""Combine a subtree into its containing tree.
3399
This command is for experimental use only. It requires the target tree
3400
to be in dirstate-with-subtree format, which cannot be converted into
3403
The TREE argument should be an independent tree, inside another tree, but
3404
not part of it. (Such trees can be produced by "bzr split", but also by
3405
running "bzr branch" with the target inside a tree.)
3407
The result is a combined tree, with the subtree no longer an independant
3408
part. This is marked as a merge of the subtree into the containing tree,
3409
and all history is preserved.
3411
If --reference is specified, the subtree retains its independence. It can
3412
be branched by itself, and can be part of multiple projects at the same
3413
time. But operations performed in the containing tree, such as commit
3414
and merge, will recurse into the subtree.
3417
_see_also = ['split']
3418
takes_args = ['tree']
3419
takes_options = [Option('reference', 'join by reference')]
3422
def run(self, tree, reference=False):
3423
sub_tree = WorkingTree.open(tree)
3424
parent_dir = osutils.dirname(sub_tree.basedir)
3425
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3426
repo = containing_tree.branch.repository
3427
if not repo.supports_rich_root():
3428
raise errors.BzrCommandError(
3429
"Can't join trees because %s doesn't support rich root data.\n"
3430
"You can use bzr upgrade on the repository."
3434
containing_tree.add_reference(sub_tree)
3435
except errors.BadReferenceTarget, e:
3436
# XXX: Would be better to just raise a nicely printable
3437
# exception from the real origin. Also below. mbp 20070306
3438
raise errors.BzrCommandError("Cannot join %s. %s" %
3442
containing_tree.subsume(sub_tree)
3443
except errors.BadSubsumeSource, e:
3444
raise errors.BzrCommandError("Cannot join %s. %s" %
3448
class cmd_split(Command):
3449
"""Split a tree into two trees.
3451
This command is for experimental use only. It requires the target tree
3452
to be in dirstate-with-subtree format, which cannot be converted into
3455
The TREE argument should be a subdirectory of a working tree. That
3456
subdirectory will be converted into an independent tree, with its own
3457
branch. Commits in the top-level tree will not apply to the new subtree.
3458
If you want that behavior, do "bzr join --reference TREE".
3461
_see_also = ['join']
3462
takes_args = ['tree']
3466
def run(self, tree):
3467
containing_tree, subdir = WorkingTree.open_containing(tree)
3468
sub_id = containing_tree.path2id(subdir)
3470
raise errors.NotVersionedError(subdir)
3472
containing_tree.extract(sub_id)
3473
except errors.RootNotRich:
3474
raise errors.UpgradeRequired(containing_tree.branch.base)
3478
class cmd_merge_directive(Command):
3479
"""Generate a merge directive for auto-merge tools.
3481
A directive requests a merge to be performed, and also provides all the
3482
information necessary to do so. This means it must either include a
3483
revision bundle, or the location of a branch containing the desired
3486
A submit branch (the location to merge into) must be supplied the first
3487
time the command is issued. After it has been supplied once, it will
3488
be remembered as the default.
3490
A public branch is optional if a revision bundle is supplied, but required
3491
if --diff or --plain is specified. It will be remembered as the default
3492
after the first use.
3495
takes_args = ['submit_branch?', 'public_branch?']
3498
RegistryOption.from_kwargs('patch-type',
3499
'The type of patch to include in the directive',
3500
title='Patch type', value_switches=True, enum_switch=False,
3501
bundle='Bazaar revision bundle (default)',
3502
diff='Normal unified diff',
3503
plain='No patch, just directive'),
3504
Option('sign', help='GPG-sign the directive'), 'revision',
3505
Option('mail-to', type=str,
3506
help='Instead of printing the directive, email to this address'),
3507
Option('message', type=str, short_name='m',
3508
help='Message to use when committing this merge')
3511
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3512
sign=False, revision=None, mail_to=None, message=None):
3513
if patch_type == 'plain':
3515
branch = Branch.open('.')
3516
stored_submit_branch = branch.get_submit_branch()
3517
if submit_branch is None:
3518
submit_branch = stored_submit_branch
3520
if stored_submit_branch is None:
3521
branch.set_submit_branch(submit_branch)
3522
if submit_branch is None:
3523
submit_branch = branch.get_parent()
3524
if submit_branch is None:
3525
raise errors.BzrCommandError('No submit branch specified or known')
3527
stored_public_branch = branch.get_public_branch()
3528
if public_branch is None:
3529
public_branch = stored_public_branch
3530
elif stored_public_branch is None:
3531
branch.set_public_branch(public_branch)
3532
if patch_type != "bundle" and public_branch is None:
3533
raise errors.BzrCommandError('No public branch specified or'
3535
if revision is not None:
3536
if len(revision) != 1:
3537
raise errors.BzrCommandError('bzr merge-directive takes '
3538
'exactly one revision identifier')
3540
revision_id = revision[0].in_history(branch).rev_id
3542
revision_id = branch.last_revision()
3543
directive = merge_directive.MergeDirective.from_objects(
3544
branch.repository, revision_id, time.time(),
3545
osutils.local_time_offset(), submit_branch,
3546
public_branch=public_branch, patch_type=patch_type,
3550
self.outf.write(directive.to_signed(branch))
3552
self.outf.writelines(directive.to_lines())
3554
message = directive.to_email(mail_to, branch, sign)
3556
server = branch.get_config().get_user_option('smtp_server')
3558
server = 'localhost'
3560
s.sendmail(message['From'], message['To'], message.as_string())
3563
class cmd_tag(Command):
3564
"""Create a tag naming a revision.
3566
Tags give human-meaningful names to revisions. Commands that take a -r
3567
(--revision) option can be given -rtag:X, where X is any previously
3570
Tags are stored in the branch. Tags are copied from one branch to another
3571
along when you branch, push, pull or merge.
3573
It is an error to give a tag name that already exists unless you pass
3574
--force, in which case the tag is moved to point to the new revision.
3577
_see_also = ['commit', 'tags']
3578
takes_args = ['tag_name']
3581
help='Delete this tag rather than placing it.',
3584
help='Branch in which to place the tag.',
3589
help='Replace existing tags',
3594
def run(self, tag_name,
3600
branch, relpath = Branch.open_containing(directory)
3604
branch.tags.delete_tag(tag_name)
3605
self.outf.write('Deleted tag %s.\n' % tag_name)
3608
if len(revision) != 1:
3609
raise errors.BzrCommandError(
3610
"Tags can only be placed on a single revision, "
3612
revision_id = revision[0].in_history(branch).rev_id
3614
revision_id = branch.last_revision()
3615
if (not force) and branch.tags.has_tag(tag_name):
3616
raise errors.TagAlreadyExists(tag_name)
3617
branch.tags.set_tag(tag_name, revision_id)
3618
self.outf.write('Created tag %s.\n' % tag_name)
3623
class cmd_tags(Command):
3626
This tag shows a table of tag names and the revisions they reference.
3632
help='Branch whose tags should be displayed',
3642
branch, relpath = Branch.open_containing(directory)
3643
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3644
self.outf.write('%-20s %s\n' % (tag_name, target))
3647
# command-line interpretation helper for merge-related commands
3648
def _merge_helper(other_revision, base_revision,
3649
check_clean=True, ignore_zero=False,
3650
this_dir=None, backup_files=False,
3652
file_list=None, show_base=False, reprocess=False,
3655
change_reporter=None,
3657
"""Merge changes into a tree.
3660
list(path, revno) Base for three-way merge.
3661
If [None, None] then a base will be automatically determined.
3663
list(path, revno) Other revision for three-way merge.
3665
Directory to merge changes into; '.' by default.
3667
If true, this_dir must have no uncommitted changes before the
3669
ignore_zero - If true, suppress the "zero conflicts" message when
3670
there are no conflicts; should be set when doing something we expect
3671
to complete perfectly.
3672
file_list - If supplied, merge only changes to selected files.
3674
All available ancestors of other_revision and base_revision are
3675
automatically pulled into the branch.
3677
The revno may be -1 to indicate the last revision on the branch, which is
3680
This function is intended for use from the command line; programmatic
3681
clients might prefer to call merge.merge_inner(), which has less magic
3684
# Loading it late, so that we don't always have to import bzrlib.merge
3685
if merge_type is None:
3686
merge_type = _mod_merge.Merge3Merger
3687
if this_dir is None:
3689
this_tree = WorkingTree.open_containing(this_dir)[0]
3690
if show_base and not merge_type is _mod_merge.Merge3Merger:
3691
raise errors.BzrCommandError("Show-base is not supported for this merge"
3692
" type. %s" % merge_type)
3693
if reprocess and not merge_type.supports_reprocess:
3694
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3695
" type %s." % merge_type)
3696
if reprocess and show_base:
3697
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3698
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3699
# only want to take out a lock_tree_write() if we don't have to pull
3700
# any ancestry. But merge might fetch ancestry in the middle, in
3701
# which case we would need a lock_write().
3702
# Because we cannot upgrade locks, for now we live with the fact that
3703
# the tree will be locked multiple times during a merge. (Maybe
3704
# read-only some of the time, but it means things will get read
3707
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3708
pb=pb, change_reporter=change_reporter)
3709
merger.pp = ProgressPhase("Merge phase", 5, pb)
3710
merger.pp.next_phase()
3711
merger.check_basis(check_clean)
3712
if other_rev_id is not None:
3713
merger.set_other_revision(other_rev_id, this_tree.branch)
3715
merger.set_other(other_revision)
3716
merger.pp.next_phase()
3717
merger.set_base(base_revision)
3718
if merger.base_rev_id == merger.other_rev_id:
3719
note('Nothing to do.')
3721
if file_list is None:
3722
if pull and merger.base_rev_id == merger.this_rev_id:
3723
# FIXME: deduplicate with pull
3724
result = merger.this_tree.pull(merger.this_branch,
3725
False, merger.other_rev_id)
3726
if result.old_revid == result.new_revid:
3727
note('No revisions to pull.')
3729
note('Now on revision %d.' % result.new_revno)
3731
merger.backup_files = backup_files
3732
merger.merge_type = merge_type
3733
merger.set_interesting_files(file_list)
3734
merger.show_base = show_base
3735
merger.reprocess = reprocess
3736
conflicts = merger.do_merge()
3737
if file_list is None:
3738
merger.set_pending()
3745
merge = _merge_helper
3748
# these get imported and then picked up by the scan for cmd_*
3749
# TODO: Some more consistent way to split command definitions across files;
3750
# we do need to load at least some information about them to know of
3751
# aliases. ideally we would avoid loading the implementation until the
3752
# details were needed.
3753
from bzrlib.cmd_version_info import cmd_version_info
3754
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3755
from bzrlib.bundle.commands import cmd_bundle_revisions
3756
from bzrlib.sign_my_commits import cmd_sign_my_commits
3757
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3758
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
