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
# FIXME: Reuse to_transport instead of location
1290
existing_bzrdir = bzrdir.BzrDir.open(location)
1291
except errors.NotBranchError:
1292
# really a NotBzrDir error...
1293
# FIXME: Reuse to_transport instead of
1294
# to_transport.base (nastier than above)
1295
branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
1298
from bzrlib.transport.local import LocalTransport
1299
if existing_bzrdir.has_branch():
1300
if (isinstance(to_transport, LocalTransport)
1301
and not existing_bzrdir.has_workingtree()):
1302
raise errors.BranchExistsWithoutWorkingTree(location)
1303
raise errors.AlreadyBranchError(location)
1305
branch = existing_bzrdir.create_branch()
1306
existing_bzrdir.create_workingtree()
1307
if append_revisions_only:
1309
branch.set_append_revisions_only(True)
1310
except errors.UpgradeRequired:
1311
raise errors.BzrCommandError('This branch format cannot be set'
1312
' to append-revisions-only. Try --experimental-branch6')
1315
class cmd_init_repository(Command):
1316
"""Create a shared repository to hold branches.
1318
New branches created under the repository directory will store their revisions
1319
in the repository, not in the branch directory.
1322
bzr init-repo --no-trees repo
1324
bzr checkout --lightweight repo/trunk trunk-checkout
1329
_see_also = ['init', 'branch', 'checkout']
1330
takes_args = ["location"]
1331
takes_options = [RegistryOption('format',
1332
help='Specify a format for this repository. See'
1333
' "bzr help formats" for details',
1334
registry=bzrdir.format_registry,
1335
converter=bzrdir.format_registry.make_bzrdir,
1336
value_switches=True, title='Repository format'),
1338
help='Branches in the repository will default to'
1339
' not having a working tree'),
1341
aliases = ["init-repo"]
1343
def run(self, location, format=None, no_trees=False):
1345
format = bzrdir.format_registry.make_bzrdir('default')
1347
if location is None:
1350
to_transport = transport.get_transport(location)
1351
to_transport.ensure_base()
1353
newdir = format.initialize_on_transport(to_transport)
1354
repo = newdir.create_repository(shared=True)
1355
repo.set_make_working_trees(not no_trees)
1358
class cmd_diff(Command):
1359
"""Show differences in the working tree or between revisions.
1361
If files are listed, only the changes in those files are listed.
1362
Otherwise, all changes for the tree are listed.
1364
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1365
produces patches suitable for "patch -p1".
1369
Shows the difference in the working tree versus the last commit
1371
Difference between the working tree and revision 1
1373
Difference between revision 2 and revision 1
1374
bzr diff --prefix old/:new/
1375
Same as 'bzr diff' but prefix paths with old/ and new/
1376
bzr diff bzr.mine bzr.dev
1377
Show the differences between the two working trees
1379
Show just the differences for 'foo.c'
1381
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1382
# or a graphical diff.
1384
# TODO: Python difflib is not exactly the same as unidiff; should
1385
# either fix it up or prefer to use an external diff.
1387
# TODO: Selected-file diff is inefficient and doesn't show you
1390
# TODO: This probably handles non-Unix newlines poorly.
1392
_see_also = ['status']
1393
takes_args = ['file*']
1394
takes_options = ['revision', 'diff-options',
1395
Option('prefix', type=str,
1397
help='Set prefixes to added to old and new filenames, as '
1398
'two values separated by a colon. (eg "old/:new/")'),
1400
aliases = ['di', 'dif']
1401
encoding_type = 'exact'
1404
def run(self, revision=None, file_list=None, diff_options=None,
1406
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1408
if (prefix is None) or (prefix == '0'):
1416
old_label, new_label = prefix.split(":")
1418
raise errors.BzrCommandError(
1419
'--prefix expects two values separated by a colon'
1420
' (eg "old/:new/")')
1422
if revision and len(revision) > 2:
1423
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1424
' one or two revision specifiers')
1427
tree1, file_list = internal_tree_files(file_list)
1431
except errors.FileInWrongBranch:
1432
if len(file_list) != 2:
1433
raise errors.BzrCommandError("Files are in different branches")
1435
tree1, file1 = WorkingTree.open_containing(file_list[0])
1436
tree2, file2 = WorkingTree.open_containing(file_list[1])
1437
if file1 != "" or file2 != "":
1438
# FIXME diff those two files. rbc 20051123
1439
raise errors.BzrCommandError("Files are in different branches")
1441
except errors.NotBranchError:
1442
if (revision is not None and len(revision) == 2
1443
and not revision[0].needs_branch()
1444
and not revision[1].needs_branch()):
1445
# If both revision specs include a branch, we can
1446
# diff them without needing a local working tree
1447
tree1, tree2 = None, None
1451
if tree2 is not None:
1452
if revision is not None:
1453
# FIXME: but there should be a clean way to diff between
1454
# non-default versions of two trees, it's not hard to do
1456
raise errors.BzrCommandError(
1457
"Sorry, diffing arbitrary revisions across branches "
1458
"is not implemented yet")
1459
return show_diff_trees(tree1, tree2, sys.stdout,
1460
specific_files=file_list,
1461
external_diff_options=diff_options,
1462
old_label=old_label, new_label=new_label)
1464
return diff_cmd_helper(tree1, file_list, diff_options,
1465
revision_specs=revision,
1466
old_label=old_label, new_label=new_label)
1469
class cmd_deleted(Command):
1470
"""List files deleted in the working tree.
1472
# TODO: Show files deleted since a previous revision, or
1473
# between two revisions.
1474
# TODO: Much more efficient way to do this: read in new
1475
# directories with readdir, rather than stating each one. Same
1476
# level of effort but possibly much less IO. (Or possibly not,
1477
# if the directories are very large...)
1478
_see_also = ['status', 'ls']
1479
takes_options = ['show-ids']
1482
def run(self, show_ids=False):
1483
tree = WorkingTree.open_containing(u'.')[0]
1486
old = tree.basis_tree()
1489
for path, ie in old.inventory.iter_entries():
1490
if not tree.has_id(ie.file_id):
1491
self.outf.write(path)
1493
self.outf.write(' ')
1494
self.outf.write(ie.file_id)
1495
self.outf.write('\n')
1502
class cmd_modified(Command):
1503
"""List files modified in working tree.
1507
_see_also = ['status', 'ls']
1511
tree = WorkingTree.open_containing(u'.')[0]
1512
td = tree.changes_from(tree.basis_tree())
1513
for path, id, kind, text_modified, meta_modified in td.modified:
1514
self.outf.write(path + '\n')
1517
class cmd_added(Command):
1518
"""List files added in working tree.
1522
_see_also = ['status', 'ls']
1526
wt = WorkingTree.open_containing(u'.')[0]
1529
basis = wt.basis_tree()
1532
basis_inv = basis.inventory
1535
if file_id in basis_inv:
1537
if inv.is_root(file_id) and len(basis_inv) == 0:
1539
path = inv.id2path(file_id)
1540
if not os.access(osutils.abspath(path), os.F_OK):
1542
self.outf.write(path + '\n')
1549
class cmd_root(Command):
1550
"""Show the tree root directory.
1552
The root is the nearest enclosing directory with a .bzr control
1555
takes_args = ['filename?']
1557
def run(self, filename=None):
1558
"""Print the branch root."""
1559
tree = WorkingTree.open_containing(filename)[0]
1560
self.outf.write(tree.basedir + '\n')
1563
class cmd_log(Command):
1564
"""Show log of a branch, file, or directory.
1566
By default show the log of the branch containing the working directory.
1568
To request a range of logs, you can use the command -r begin..end
1569
-r revision requests a specific revision, -r ..end or -r begin.. are
1575
bzr log -r -10.. http://server/branch
1578
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1580
takes_args = ['location?']
1581
takes_options = [Option('forward',
1582
help='show from oldest to newest'),
1586
help='show files changed in each revision'),
1587
'show-ids', 'revision',
1591
help='show revisions whose message matches this regexp',
1594
encoding_type = 'replace'
1597
def run(self, location=None, timezone='original',
1604
from bzrlib.log import show_log
1605
assert message is None or isinstance(message, basestring), \
1606
"invalid message argument %r" % message
1607
direction = (forward and 'forward') or 'reverse'
1612
# find the file id to log:
1614
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1618
tree = b.basis_tree()
1619
file_id = tree.path2id(fp)
1621
raise errors.BzrCommandError(
1622
"Path does not have any revision history: %s" %
1626
# FIXME ? log the current subdir only RBC 20060203
1627
if revision is not None \
1628
and len(revision) > 0 and revision[0].get_branch():
1629
location = revision[0].get_branch()
1632
dir, relpath = bzrdir.BzrDir.open_containing(location)
1633
b = dir.open_branch()
1637
if revision is None:
1640
elif len(revision) == 1:
1641
rev1 = rev2 = revision[0].in_history(b).revno
1642
elif len(revision) == 2:
1643
if revision[1].get_branch() != revision[0].get_branch():
1644
# b is taken from revision[0].get_branch(), and
1645
# show_log will use its revision_history. Having
1646
# different branches will lead to weird behaviors.
1647
raise errors.BzrCommandError(
1648
"Log doesn't accept two revisions in different"
1650
if revision[0].spec is None:
1651
# missing begin-range means first revision
1654
rev1 = revision[0].in_history(b).revno
1656
if revision[1].spec is None:
1657
# missing end-range means last known revision
1660
rev2 = revision[1].in_history(b).revno
1662
raise errors.BzrCommandError(
1663
'bzr log --revision takes one or two values.')
1665
# By this point, the revision numbers are converted to the +ve
1666
# form if they were supplied in the -ve form, so we can do
1667
# this comparison in relative safety
1669
(rev2, rev1) = (rev1, rev2)
1671
if log_format is None:
1672
log_format = log.log_formatter_registry.get_default(b)
1674
lf = log_format(show_ids=show_ids, to_file=self.outf,
1675
show_timezone=timezone)
1681
direction=direction,
1682
start_revision=rev1,
1689
def get_log_format(long=False, short=False, line=False, default='long'):
1690
log_format = default
1694
log_format = 'short'
1700
class cmd_touching_revisions(Command):
1701
"""Return revision-ids which affected a particular file.
1703
A more user-friendly interface is "bzr log FILE".
1707
takes_args = ["filename"]
1710
def run(self, filename):
1711
tree, relpath = WorkingTree.open_containing(filename)
1713
file_id = tree.path2id(relpath)
1714
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1715
self.outf.write("%6d %s\n" % (revno, what))
1718
class cmd_ls(Command):
1719
"""List files in a tree.
1722
_see_also = ['status', 'cat']
1723
takes_args = ['path?']
1724
# TODO: Take a revision or remote path and list that tree instead.
1725
takes_options = ['verbose', 'revision',
1726
Option('non-recursive',
1727
help='don\'t recurse into sub-directories'),
1729
help='Print all paths from the root of the branch.'),
1730
Option('unknown', help='Print unknown files'),
1731
Option('versioned', help='Print versioned files'),
1732
Option('ignored', help='Print ignored files'),
1734
Option('null', help='Null separate the files'),
1738
def run(self, revision=None, verbose=False,
1739
non_recursive=False, from_root=False,
1740
unknown=False, versioned=False, ignored=False,
1741
null=False, kind=None, show_ids=False, path=None):
1743
if kind and kind not in ('file', 'directory', 'symlink'):
1744
raise errors.BzrCommandError('invalid kind specified')
1746
if verbose and null:
1747
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1748
all = not (unknown or versioned or ignored)
1750
selection = {'I':ignored, '?':unknown, 'V':versioned}
1757
raise errors.BzrCommandError('cannot specify both --from-root'
1761
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1767
if revision is not None:
1768
tree = branch.repository.revision_tree(
1769
revision[0].in_history(branch).rev_id)
1771
tree = branch.basis_tree()
1775
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1776
if fp.startswith(relpath):
1777
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1778
if non_recursive and '/' in fp:
1780
if not all and not selection[fc]:
1782
if kind is not None and fkind != kind:
1785
kindch = entry.kind_character()
1786
outstring = '%-8s %s%s' % (fc, fp, kindch)
1787
if show_ids and fid is not None:
1788
outstring = "%-50s %s" % (outstring, fid)
1789
self.outf.write(outstring + '\n')
1791
self.outf.write(fp + '\0')
1794
self.outf.write(fid)
1795
self.outf.write('\0')
1803
self.outf.write('%-50s %s\n' % (fp, my_id))
1805
self.outf.write(fp + '\n')
1810
class cmd_unknowns(Command):
1811
"""List unknown files.
1819
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1820
self.outf.write(osutils.quotefn(f) + '\n')
1823
class cmd_ignore(Command):
1824
"""Ignore specified files or patterns.
1826
To remove patterns from the ignore list, edit the .bzrignore file.
1828
Trailing slashes on patterns are ignored.
1829
If the pattern contains a slash or is a regular expression, it is compared
1830
to the whole path from the branch root. Otherwise, it is compared to only
1831
the last component of the path. To match a file only in the root
1832
directory, prepend './'.
1834
Ignore patterns specifying absolute paths are not allowed.
1836
Ignore patterns may include globbing wildcards such as:
1837
? - Matches any single character except '/'
1838
* - Matches 0 or more characters except '/'
1839
/**/ - Matches 0 or more directories in a path
1840
[a-z] - Matches a single character from within a group of characters
1842
Ignore patterns may also be Python regular expressions.
1843
Regular expression ignore patterns are identified by a 'RE:' prefix
1844
followed by the regular expression. Regular expression ignore patterns
1845
may not include named or numbered groups.
1847
Note: ignore patterns containing shell wildcards must be quoted from
1851
bzr ignore ./Makefile
1852
bzr ignore '*.class'
1853
bzr ignore 'lib/**/*.o'
1854
bzr ignore 'RE:lib/.*\.o'
1857
_see_also = ['status', 'ignored']
1858
takes_args = ['name_pattern*']
1860
Option('old-default-rules',
1861
help='Out the ignore rules bzr < 0.9 always used.')
1864
def run(self, name_pattern_list=None, old_default_rules=None):
1865
from bzrlib.atomicfile import AtomicFile
1866
if old_default_rules is not None:
1867
# dump the rules and exit
1868
for pattern in ignores.OLD_DEFAULTS:
1871
if not name_pattern_list:
1872
raise errors.BzrCommandError("ignore requires at least one "
1873
"NAME_PATTERN or --old-default-rules")
1874
name_pattern_list = [globbing.normalize_pattern(p)
1875
for p in name_pattern_list]
1876
for name_pattern in name_pattern_list:
1877
if (name_pattern[0] == '/' or
1878
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1879
raise errors.BzrCommandError(
1880
"NAME_PATTERN should not be an absolute path")
1881
tree, relpath = WorkingTree.open_containing(u'.')
1882
ifn = tree.abspath('.bzrignore')
1883
if os.path.exists(ifn):
1886
igns = f.read().decode('utf-8')
1892
# TODO: If the file already uses crlf-style termination, maybe
1893
# we should use that for the newly added lines?
1895
if igns and igns[-1] != '\n':
1897
for name_pattern in name_pattern_list:
1898
igns += name_pattern + '\n'
1900
f = AtomicFile(ifn, 'wb')
1902
f.write(igns.encode('utf-8'))
1907
if not tree.path2id('.bzrignore'):
1908
tree.add(['.bzrignore'])
1911
class cmd_ignored(Command):
1912
"""List ignored files and the patterns that matched them.
1915
_see_also = ['ignore']
1918
tree = WorkingTree.open_containing(u'.')[0]
1921
for path, file_class, kind, file_id, entry in tree.list_files():
1922
if file_class != 'I':
1924
## XXX: Slightly inefficient since this was already calculated
1925
pat = tree.is_ignored(path)
1926
print '%-50s %s' % (path, pat)
1931
class cmd_lookup_revision(Command):
1932
"""Lookup the revision-id from a revision-number
1935
bzr lookup-revision 33
1938
takes_args = ['revno']
1941
def run(self, revno):
1945
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1947
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1950
class cmd_export(Command):
1951
"""Export current or past revision to a destination directory or archive.
1953
If no revision is specified this exports the last committed revision.
1955
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1956
given, try to find the format with the extension. If no extension
1957
is found exports to a directory (equivalent to --format=dir).
1959
If root is supplied, it will be used as the root directory inside
1960
container formats (tar, zip, etc). If it is not supplied it will default
1961
to the exported filename. The root option has no effect for 'dir' format.
1963
If branch is omitted then the branch containing the current working
1964
directory will be used.
1966
Note: Export of tree with non-ASCII filenames to zip is not supported.
1968
Supported formats Autodetected by extension
1969
----------------- -------------------------
1972
tbz2 .tar.bz2, .tbz2
1976
takes_args = ['dest', 'branch?']
1977
takes_options = ['revision', 'format', 'root']
1978
def run(self, dest, branch=None, revision=None, format=None, root=None):
1979
from bzrlib.export import export
1982
tree = WorkingTree.open_containing(u'.')[0]
1985
b = Branch.open(branch)
1987
if revision is None:
1988
# should be tree.last_revision FIXME
1989
rev_id = b.last_revision()
1991
if len(revision) != 1:
1992
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1993
rev_id = revision[0].in_history(b).rev_id
1994
t = b.repository.revision_tree(rev_id)
1996
export(t, dest, format, root)
1997
except errors.NoSuchExportFormat, e:
1998
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2001
class cmd_cat(Command):
2002
"""Write the contents of a file as of a given revision to standard output.
2004
If no revision is nominated, the last revision is used.
2006
Note: Take care to redirect standard output when using this command on a
2011
takes_options = ['revision', 'name-from-revision']
2012
takes_args = ['filename']
2013
encoding_type = 'exact'
2016
def run(self, filename, revision=None, name_from_revision=False):
2017
if revision is not None and len(revision) != 1:
2018
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2023
tree, b, relpath = \
2024
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2025
except errors.NotBranchError:
2028
if revision is not None and revision[0].get_branch() is not None:
2029
b = Branch.open(revision[0].get_branch())
2031
tree = b.basis_tree()
2032
if revision is None:
2033
revision_id = b.last_revision()
2035
revision_id = revision[0].in_history(b).rev_id
2037
cur_file_id = tree.path2id(relpath)
2038
rev_tree = b.repository.revision_tree(revision_id)
2039
old_file_id = rev_tree.path2id(relpath)
2041
if name_from_revision:
2042
if old_file_id is None:
2043
raise errors.BzrCommandError("%r is not present in revision %s"
2044
% (filename, revision_id))
2046
rev_tree.print_file(old_file_id)
2047
elif cur_file_id is not None:
2048
rev_tree.print_file(cur_file_id)
2049
elif old_file_id is not None:
2050
rev_tree.print_file(old_file_id)
2052
raise errors.BzrCommandError("%r is not present in revision %s" %
2053
(filename, revision_id))
2056
class cmd_local_time_offset(Command):
2057
"""Show the offset in seconds from GMT to local time."""
2061
print osutils.local_time_offset()
2065
class cmd_commit(Command):
2066
"""Commit changes into a new revision.
2068
If no arguments are given, the entire tree is committed.
2070
If selected files are specified, only changes to those files are
2071
committed. If a directory is specified then the directory and everything
2072
within it is committed.
2074
A selected-file commit may fail in some cases where the committed
2075
tree would be invalid. Consider::
2080
bzr commit foo -m "committing foo"
2081
bzr mv foo/bar foo/baz
2084
bzr commit foo/bar -m "committing bar but not baz"
2086
In the example above, the last commit will fail by design. This gives
2087
the user the opportunity to decide whether they want to commit the
2088
rename at the same time, separately first, or not at all. (As a general
2089
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2091
Note: A selected-file commit after a merge is not yet supported.
2093
# TODO: Run hooks on tree to-be-committed, and after commit.
2095
# TODO: Strict commit that fails if there are deleted files.
2096
# (what does "deleted files" mean ??)
2098
# TODO: Give better message for -s, --summary, used by tla people
2100
# XXX: verbose currently does nothing
2102
_see_also = ['bugs', 'uncommit']
2103
takes_args = ['selected*']
2104
takes_options = ['message', 'verbose',
2106
help='commit even if nothing has changed'),
2107
Option('file', type=str,
2110
help='file containing commit message'),
2112
help="refuse to commit if there are unknown "
2113
"files in the working tree."),
2114
ListOption('fixes', type=str,
2115
help="mark a bug as being fixed by this "
2118
help="perform a local only commit in a bound "
2119
"branch. Such commits are not pushed to "
2120
"the master branch until a normal commit "
2124
aliases = ['ci', 'checkin']
2126
def _get_bug_fix_properties(self, fixes, branch):
2128
# Configure the properties for bug fixing attributes.
2129
for fixed_bug in fixes:
2130
tokens = fixed_bug.split(':')
2131
if len(tokens) != 2:
2132
raise errors.BzrCommandError(
2133
"Invalid bug %s. Must be in the form of 'tag:id'. "
2134
"Commit refused." % fixed_bug)
2135
tag, bug_id = tokens
2137
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2138
except errors.UnknownBugTrackerAbbreviation:
2139
raise errors.BzrCommandError(
2140
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2141
except errors.MalformedBugIdentifier:
2142
raise errors.BzrCommandError(
2143
"Invalid bug identifier for %s. Commit refused."
2145
properties.append('%s fixed' % bug_url)
2146
return '\n'.join(properties)
2148
def run(self, message=None, file=None, verbose=True, selected_list=None,
2149
unchanged=False, strict=False, local=False, fixes=None):
2150
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2151
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2153
from bzrlib.msgeditor import edit_commit_message, \
2154
make_commit_message_template
2156
# TODO: Need a blackbox test for invoking the external editor; may be
2157
# slightly problematic to run this cross-platform.
2159
# TODO: do more checks that the commit will succeed before
2160
# spending the user's valuable time typing a commit message.
2164
tree, selected_list = tree_files(selected_list)
2165
if selected_list == ['']:
2166
# workaround - commit of root of tree should be exactly the same
2167
# as just default commit in that tree, and succeed even though
2168
# selected-file merge commit is not done yet
2171
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2173
properties['bugs'] = bug_property
2175
if local and not tree.branch.get_bound_location():
2176
raise errors.LocalRequiresBoundBranch()
2178
def get_message(commit_obj):
2179
"""Callback to get commit message"""
2180
my_message = message
2181
if my_message is None and not file:
2182
template = make_commit_message_template(tree, selected_list)
2183
my_message = edit_commit_message(template)
2184
if my_message is None:
2185
raise errors.BzrCommandError("please specify a commit"
2186
" message with either --message or --file")
2187
elif my_message and file:
2188
raise errors.BzrCommandError(
2189
"please specify either --message or --file")
2191
my_message = codecs.open(file, 'rt',
2192
bzrlib.user_encoding).read()
2193
if my_message == "":
2194
raise errors.BzrCommandError("empty commit message specified")
2198
reporter = ReportCommitToLog()
2200
reporter = NullCommitReporter()
2203
tree.commit(message_callback=get_message,
2204
specific_files=selected_list,
2205
allow_pointless=unchanged, strict=strict, local=local,
2206
reporter=reporter, revprops=properties)
2207
except PointlessCommit:
2208
# FIXME: This should really happen before the file is read in;
2209
# perhaps prepare the commit; get the message; then actually commit
2210
raise errors.BzrCommandError("no changes to commit."
2211
" use --unchanged to commit anyhow")
2212
except ConflictsInTree:
2213
raise errors.BzrCommandError('Conflicts detected in working '
2214
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2216
except StrictCommitFailed:
2217
raise errors.BzrCommandError("Commit refused because there are"
2218
" unknown files in the working tree.")
2219
except errors.BoundBranchOutOfDate, e:
2220
raise errors.BzrCommandError(str(e) + "\n"
2221
'To commit to master branch, run update and then commit.\n'
2222
'You can also pass --local to commit to continue working '
2226
class cmd_check(Command):
2227
"""Validate consistency of branch history.
2229
This command checks various invariants about the branch storage to
2230
detect data corruption or bzr bugs.
2233
_see_also = ['reconcile']
2234
takes_args = ['branch?']
2235
takes_options = ['verbose']
2237
def run(self, branch=None, verbose=False):
2238
from bzrlib.check import check
2240
tree = WorkingTree.open_containing()[0]
2241
branch = tree.branch
2243
branch = Branch.open(branch)
2244
check(branch, verbose)
2247
class cmd_upgrade(Command):
2248
"""Upgrade branch storage to current format.
2250
The check command or bzr developers may sometimes advise you to run
2251
this command. When the default format has changed you may also be warned
2252
during other operations to upgrade.
2255
_see_also = ['check']
2256
takes_args = ['url?']
2258
RegistryOption('format',
2259
help='Upgrade to a specific format. See "bzr help'
2260
' formats" for details',
2261
registry=bzrdir.format_registry,
2262
converter=bzrdir.format_registry.make_bzrdir,
2263
value_switches=True, title='Branch format'),
2266
def run(self, url='.', format=None):
2267
from bzrlib.upgrade import upgrade
2269
format = bzrdir.format_registry.make_bzrdir('default')
2270
upgrade(url, format)
2273
class cmd_whoami(Command):
2274
"""Show or set bzr user id.
2278
bzr whoami 'Frank Chu <fchu@example.com>'
2280
takes_options = [ Option('email',
2281
help='display email address only'),
2283
help='set identity for the current branch instead of '
2286
takes_args = ['name?']
2287
encoding_type = 'replace'
2290
def run(self, email=False, branch=False, name=None):
2292
# use branch if we're inside one; otherwise global config
2294
c = Branch.open_containing('.')[0].get_config()
2295
except errors.NotBranchError:
2296
c = config.GlobalConfig()
2298
self.outf.write(c.user_email() + '\n')
2300
self.outf.write(c.username() + '\n')
2303
# display a warning if an email address isn't included in the given name.
2305
config.extract_email_address(name)
2306
except errors.NoEmailInUsername, e:
2307
warning('"%s" does not seem to contain an email address. '
2308
'This is allowed, but not recommended.', name)
2310
# use global config unless --branch given
2312
c = Branch.open_containing('.')[0].get_config()
2314
c = config.GlobalConfig()
2315
c.set_user_option('email', name)
2318
class cmd_nick(Command):
2319
"""Print or set the branch nickname.
2321
If unset, the tree root directory name is used as the nickname
2322
To print the current nickname, execute with no argument.
2325
_see_also = ['info']
2326
takes_args = ['nickname?']
2327
def run(self, nickname=None):
2328
branch = Branch.open_containing(u'.')[0]
2329
if nickname is None:
2330
self.printme(branch)
2332
branch.nick = nickname
2335
def printme(self, branch):
2339
class cmd_selftest(Command):
2340
"""Run internal test suite.
2342
This creates temporary test directories in the working directory, but no
2343
existing data is affected. These directories are deleted if the tests
2344
pass, or left behind to help in debugging if they fail and --keep-output
2347
If arguments are given, they are regular expressions that say which tests
2348
should run. Tests matching any expression are run, and other tests are
2351
Alternatively if --first is given, matching tests are run first and then
2352
all other tests are run. This is useful if you have been working in a
2353
particular area, but want to make sure nothing else was broken.
2355
If --exclude is given, tests that match that regular expression are
2356
excluded, regardless of whether they match --first or not.
2358
To help catch accidential dependencies between tests, the --randomize
2359
option is useful. In most cases, the argument used is the word 'now'.
2360
Note that the seed used for the random number generator is displayed
2361
when this option is used. The seed can be explicitly passed as the
2362
argument to this option if required. This enables reproduction of the
2363
actual ordering used if and when an order sensitive problem is encountered.
2365
If --list-only is given, the tests that would be run are listed. This is
2366
useful when combined with --first, --exclude and/or --randomize to
2367
understand their impact. The test harness reports "Listed nn tests in ..."
2368
instead of "Ran nn tests in ..." when list mode is enabled.
2370
If the global option '--no-plugins' is given, plugins are not loaded
2371
before running the selftests. This has two effects: features provided or
2372
modified by plugins will not be tested, and tests provided by plugins will
2377
run only tests relating to 'ignore'
2378
bzr --no-plugins selftest -v
2379
disable plugins and list tests as they're run
2381
For each test, that needs actual disk access, bzr create their own
2382
subdirectory in the temporary testing directory (testXXXX.tmp).
2383
By default the name of such subdirectory is based on the name of the test.
2384
If option '--numbered-dirs' is given, bzr will use sequent numbers
2385
of running tests to create such subdirectories. This is default behavior
2386
on Windows because of path length limitation.
2388
# NB: this is used from the class without creating an instance, which is
2389
# why it does not have a self parameter.
2390
def get_transport_type(typestring):
2391
"""Parse and return a transport specifier."""
2392
if typestring == "sftp":
2393
from bzrlib.transport.sftp import SFTPAbsoluteServer
2394
return SFTPAbsoluteServer
2395
if typestring == "memory":
2396
from bzrlib.transport.memory import MemoryServer
2398
if typestring == "fakenfs":
2399
from bzrlib.transport.fakenfs import FakeNFSServer
2400
return FakeNFSServer
2401
msg = "No known transport type %s. Supported types are: sftp\n" %\
2403
raise errors.BzrCommandError(msg)
2406
takes_args = ['testspecs*']
2407
takes_options = ['verbose',
2409
help='stop when one test fails',
2412
Option('keep-output',
2413
help='keep output directories when tests fail'),
2415
help='Use a different transport by default '
2416
'throughout the test suite.',
2417
type=get_transport_type),
2418
Option('benchmark', help='run the bzr benchmarks.'),
2419
Option('lsprof-timed',
2420
help='generate lsprof output for benchmarked'
2421
' sections of code.'),
2422
Option('cache-dir', type=str,
2423
help='a directory to cache intermediate'
2424
' benchmark steps'),
2425
Option('clean-output',
2426
help='clean temporary tests directories'
2427
' without running tests'),
2429
help='run all tests, but run specified tests first',
2432
Option('numbered-dirs',
2433
help='use numbered dirs for TestCaseInTempDir'),
2435
help='list the tests instead of running them'),
2436
Option('randomize', type=str, argname="SEED",
2437
help='randomize the order of tests using the given'
2438
' seed or "now" for the current time'),
2439
Option('exclude', type=str, argname="PATTERN",
2441
help='exclude tests that match this regular'
2444
encoding_type = 'replace'
2446
def run(self, testspecs_list=None, verbose=None, one=False,
2447
keep_output=False, transport=None, benchmark=None,
2448
lsprof_timed=None, cache_dir=None, clean_output=False,
2449
first=False, numbered_dirs=None, list_only=False,
2450
randomize=None, exclude=None):
2452
from bzrlib.tests import selftest
2453
import bzrlib.benchmarks as benchmarks
2454
from bzrlib.benchmarks import tree_creator
2457
from bzrlib.tests import clean_selftest_output
2458
clean_selftest_output()
2461
if numbered_dirs is None and sys.platform == 'win32':
2462
numbered_dirs = True
2464
if cache_dir is not None:
2465
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2466
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2467
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2469
if testspecs_list is not None:
2470
pattern = '|'.join(testspecs_list)
2474
test_suite_factory = benchmarks.test_suite
2477
# TODO: should possibly lock the history file...
2478
benchfile = open(".perf_history", "at", buffering=1)
2480
test_suite_factory = None
2485
result = selftest(verbose=verbose,
2487
stop_on_failure=one,
2488
keep_output=keep_output,
2489
transport=transport,
2490
test_suite_factory=test_suite_factory,
2491
lsprof_timed=lsprof_timed,
2492
bench_history=benchfile,
2493
matching_tests_first=first,
2494
numbered_dirs=numbered_dirs,
2495
list_only=list_only,
2496
random_seed=randomize,
2497
exclude_pattern=exclude
2500
if benchfile is not None:
2503
info('tests passed')
2505
info('tests failed')
2506
return int(not result)
2509
class cmd_version(Command):
2510
"""Show version of bzr."""
2514
from bzrlib.version import show_version
2518
class cmd_rocks(Command):
2519
"""Statement of optimism."""
2525
print "It sure does!"
2528
class cmd_find_merge_base(Command):
2529
"""Find and print a base revision for merging two branches."""
2530
# TODO: Options to specify revisions on either side, as if
2531
# merging only part of the history.
2532
takes_args = ['branch', 'other']
2536
def run(self, branch, other):
2537
from bzrlib.revision import MultipleRevisionSources
2539
branch1 = Branch.open_containing(branch)[0]
2540
branch2 = Branch.open_containing(other)[0]
2542
last1 = branch1.last_revision()
2543
last2 = branch2.last_revision()
2545
source = MultipleRevisionSources(branch1.repository,
2548
base_rev_id = common_ancestor(last1, last2, source)
2550
print 'merge base is revision %s' % base_rev_id
2553
class cmd_merge(Command):
2554
"""Perform a three-way merge.
2556
The branch is the branch you will merge from. By default, it will merge
2557
the latest revision. If you specify a revision, that revision will be
2558
merged. If you specify two revisions, the first will be used as a BASE,
2559
and the second one as OTHER. Revision numbers are always relative to the
2562
By default, bzr will try to merge in all new work from the other
2563
branch, automatically determining an appropriate base. If this
2564
fails, you may need to give an explicit base.
2566
Merge will do its best to combine the changes in two branches, but there
2567
are some kinds of problems only a human can fix. When it encounters those,
2568
it will mark a conflict. A conflict means that you need to fix something,
2569
before you should commit.
2571
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2573
If there is no default branch set, the first merge will set it. After
2574
that, you can omit the branch to use the default. To change the
2575
default, use --remember. The value will only be saved if the remote
2576
location can be accessed.
2578
The results of the merge are placed into the destination working
2579
directory, where they can be reviewed (with bzr diff), tested, and then
2580
committed to record the result of the merge.
2584
To merge the latest revision from bzr.dev:
2585
bzr merge ../bzr.dev
2587
To merge changes up to and including revision 82 from bzr.dev:
2588
bzr merge -r 82 ../bzr.dev
2590
To merge the changes introduced by 82, without previous changes:
2591
bzr merge -r 81..82 ../bzr.dev
2593
merge refuses to run if there are any uncommitted changes, unless
2597
_see_also = ['update', 'remerge']
2598
takes_args = ['branch?']
2599
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2600
Option('show-base', help="Show base revision text in "
2602
Option('uncommitted', help='Apply uncommitted changes'
2603
' from a working copy, instead of branch changes'),
2604
Option('pull', help='If the destination is already'
2605
' completely merged into the source, pull from the'
2606
' source rather than merging. When this happens,'
2607
' you do not need to commit the result.'),
2609
help='Branch to merge into, '
2610
'rather than the one containing the working directory',
2616
def run(self, branch=None, revision=None, force=False, merge_type=None,
2617
show_base=False, reprocess=False, remember=False,
2618
uncommitted=False, pull=False,
2621
from bzrlib.tag import _merge_tags_if_possible
2622
other_revision_id = None
2623
if merge_type is None:
2624
merge_type = _mod_merge.Merge3Merger
2626
if directory is None: directory = u'.'
2627
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2628
# inventory. Because merge is a mutating operation, it really
2629
# should be a lock_write() for the whole cmd_merge operation.
2630
# However, cmd_merge open's its own tree in _merge_helper, which
2631
# means if we lock here, the later lock_write() will always block.
2632
# Either the merge helper code should be updated to take a tree,
2633
# (What about tree.merge_from_branch?)
2634
tree = WorkingTree.open_containing(directory)[0]
2635
change_reporter = delta._ChangeReporter(
2636
unversioned_filter=tree.is_ignored)
2638
if branch is not None:
2640
mergeable = bundle.read_mergeable_from_url(
2642
except errors.NotABundle:
2643
pass # Continue on considering this url a Branch
2645
if revision is not None:
2646
raise errors.BzrCommandError(
2647
'Cannot use -r with merge directives or bundles')
2648
other_revision_id = mergeable.install_revisions(
2649
tree.branch.repository)
2650
revision = [RevisionSpec.from_string(
2651
'revid:' + other_revision_id)]
2653
if revision is None \
2654
or len(revision) < 1 or revision[0].needs_branch():
2655
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2657
if revision is None or len(revision) < 1:
2660
other = [branch, None]
2663
other = [branch, -1]
2664
other_branch, path = Branch.open_containing(branch)
2667
raise errors.BzrCommandError('Cannot use --uncommitted and'
2668
' --revision at the same time.')
2669
branch = revision[0].get_branch() or branch
2670
if len(revision) == 1:
2672
if other_revision_id is not None:
2677
other_branch, path = Branch.open_containing(branch)
2678
revno = revision[0].in_history(other_branch).revno
2679
other = [branch, revno]
2681
assert len(revision) == 2
2682
if None in revision:
2683
raise errors.BzrCommandError(
2684
"Merge doesn't permit empty revision specifier.")
2685
base_branch, path = Branch.open_containing(branch)
2686
branch1 = revision[1].get_branch() or branch
2687
other_branch, path1 = Branch.open_containing(branch1)
2688
if revision[0].get_branch() is not None:
2689
# then path was obtained from it, and is None.
2692
base = [branch, revision[0].in_history(base_branch).revno]
2693
other = [branch1, revision[1].in_history(other_branch).revno]
2695
if ((tree.branch.get_parent() is None or remember) and
2696
other_branch is not None):
2697
tree.branch.set_parent(other_branch.base)
2699
# pull tags now... it's a bit inconsistent to do it ahead of copying
2700
# the history but that's done inside the merge code
2701
if other_branch is not None:
2702
_merge_tags_if_possible(other_branch, tree.branch)
2705
interesting_files = [path]
2707
interesting_files = None
2708
pb = ui.ui_factory.nested_progress_bar()
2711
conflict_count = _merge_helper(
2712
other, base, other_rev_id=other_revision_id,
2713
check_clean=(not force),
2714
merge_type=merge_type,
2715
reprocess=reprocess,
2716
show_base=show_base,
2719
pb=pb, file_list=interesting_files,
2720
change_reporter=change_reporter)
2723
if conflict_count != 0:
2727
except errors.AmbiguousBase, e:
2728
m = ("sorry, bzr can't determine the right merge base yet\n"
2729
"candidates are:\n "
2730
+ "\n ".join(e.bases)
2732
"please specify an explicit base with -r,\n"
2733
"and (if you want) report this to the bzr developers\n")
2736
# TODO: move up to common parent; this isn't merge-specific anymore.
2737
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2738
"""Use tree.branch's parent if none was supplied.
2740
Report if the remembered location was used.
2742
if supplied_location is not None:
2743
return supplied_location
2744
stored_location = tree.branch.get_parent()
2745
mutter("%s", stored_location)
2746
if stored_location is None:
2747
raise errors.BzrCommandError("No location specified or remembered")
2748
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2749
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2750
return stored_location
2753
class cmd_remerge(Command):
2756
Use this if you want to try a different merge technique while resolving
2757
conflicts. Some merge techniques are better than others, and remerge
2758
lets you try different ones on different files.
2760
The options for remerge have the same meaning and defaults as the ones for
2761
merge. The difference is that remerge can (only) be run when there is a
2762
pending merge, and it lets you specify particular files.
2766
$ bzr remerge --show-base
2767
Re-do the merge of all conflicted files, and show the base text in
2768
conflict regions, in addition to the usual THIS and OTHER texts.
2770
$ bzr remerge --merge-type weave --reprocess foobar
2771
Re-do the merge of "foobar", using the weave merge algorithm, with
2772
additional processing to reduce the size of conflict regions.
2774
takes_args = ['file*']
2775
takes_options = ['merge-type', 'reprocess',
2776
Option('show-base', help="Show base revision text in "
2779
def run(self, file_list=None, merge_type=None, show_base=False,
2781
if merge_type is None:
2782
merge_type = _mod_merge.Merge3Merger
2783
tree, file_list = tree_files(file_list)
2786
parents = tree.get_parent_ids()
2787
if len(parents) != 2:
2788
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2789
" merges. Not cherrypicking or"
2791
repository = tree.branch.repository
2792
base_revision = common_ancestor(parents[0],
2793
parents[1], repository)
2794
base_tree = repository.revision_tree(base_revision)
2795
other_tree = repository.revision_tree(parents[1])
2796
interesting_ids = None
2798
conflicts = tree.conflicts()
2799
if file_list is not None:
2800
interesting_ids = set()
2801
for filename in file_list:
2802
file_id = tree.path2id(filename)
2804
raise errors.NotVersionedError(filename)
2805
interesting_ids.add(file_id)
2806
if tree.kind(file_id) != "directory":
2809
for name, ie in tree.inventory.iter_entries(file_id):
2810
interesting_ids.add(ie.file_id)
2811
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2813
# Remerge only supports resolving contents conflicts
2814
allowed_conflicts = ('text conflict', 'contents conflict')
2815
restore_files = [c.path for c in conflicts
2816
if c.typestring in allowed_conflicts]
2817
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2818
tree.set_conflicts(ConflictList(new_conflicts))
2819
if file_list is not None:
2820
restore_files = file_list
2821
for filename in restore_files:
2823
restore(tree.abspath(filename))
2824
except errors.NotConflicted:
2826
conflicts = _mod_merge.merge_inner(
2827
tree.branch, other_tree, base_tree,
2829
interesting_ids=interesting_ids,
2830
other_rev_id=parents[1],
2831
merge_type=merge_type,
2832
show_base=show_base,
2833
reprocess=reprocess)
2842
class cmd_revert(Command):
2843
"""Revert files to a previous revision.
2845
Giving a list of files will revert only those files. Otherwise, all files
2846
will be reverted. If the revision is not specified with '--revision', the
2847
last committed revision is used.
2849
To remove only some changes, without reverting to a prior version, use
2850
merge instead. For example, "merge . --r-2..-3" will remove the changes
2851
introduced by -2, without affecting the changes introduced by -1. Or
2852
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2854
By default, any files that have been manually changed will be backed up
2855
first. (Files changed only by merge are not backed up.) Backup files have
2856
'.~#~' appended to their name, where # is a number.
2858
When you provide files, you can use their current pathname or the pathname
2859
from the target revision. So you can use revert to "undelete" a file by
2860
name. If you name a directory, all the contents of that directory will be
2864
_see_also = ['cat', 'export']
2865
takes_options = ['revision', 'no-backup']
2866
takes_args = ['file*']
2868
def run(self, revision=None, no_backup=False, file_list=None):
2869
if file_list is not None:
2870
if len(file_list) == 0:
2871
raise errors.BzrCommandError("No files specified")
2875
tree, file_list = tree_files(file_list)
2876
if revision is None:
2877
# FIXME should be tree.last_revision
2878
rev_id = tree.last_revision()
2879
elif len(revision) != 1:
2880
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2882
rev_id = revision[0].in_history(tree.branch).rev_id
2883
pb = ui.ui_factory.nested_progress_bar()
2885
tree.revert(file_list,
2886
tree.branch.repository.revision_tree(rev_id),
2887
not no_backup, pb, report_changes=True)
2892
class cmd_assert_fail(Command):
2893
"""Test reporting of assertion failures"""
2894
# intended just for use in testing
2899
raise AssertionError("always fails")
2902
class cmd_help(Command):
2903
"""Show help on a command or other topic.
2906
_see_also = ['topics']
2907
takes_options = [Option('long', 'show help on all commands')]
2908
takes_args = ['topic?']
2909
aliases = ['?', '--help', '-?', '-h']
2912
def run(self, topic=None, long=False):
2914
if topic is None and long:
2916
bzrlib.help.help(topic)
2919
class cmd_shell_complete(Command):
2920
"""Show appropriate completions for context.
2922
For a list of all available commands, say 'bzr shell-complete'.
2924
takes_args = ['context?']
2929
def run(self, context=None):
2930
import shellcomplete
2931
shellcomplete.shellcomplete(context)
2934
class cmd_fetch(Command):
2935
"""Copy in history from another branch but don't merge it.
2937
This is an internal method used for pull and merge.
2940
takes_args = ['from_branch', 'to_branch']
2941
def run(self, from_branch, to_branch):
2942
from bzrlib.fetch import Fetcher
2943
from_b = Branch.open(from_branch)
2944
to_b = Branch.open(to_branch)
2945
Fetcher(to_b, from_b)
2948
class cmd_missing(Command):
2949
"""Show unmerged/unpulled revisions between two branches.
2951
OTHER_BRANCH may be local or remote.
2954
_see_also = ['merge', 'pull']
2955
takes_args = ['other_branch?']
2956
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2958
'Display changes in the local branch only'),
2959
Option('theirs-only',
2960
'Display changes in the remote branch only'),
2965
encoding_type = 'replace'
2968
def run(self, other_branch=None, reverse=False, mine_only=False,
2969
theirs_only=False, log_format=None, long=False, short=False, line=False,
2970
show_ids=False, verbose=False):
2971
from bzrlib.missing import find_unmerged, iter_log_data
2972
from bzrlib.log import log_formatter
2973
local_branch = Branch.open_containing(u".")[0]
2974
parent = local_branch.get_parent()
2975
if other_branch is None:
2976
other_branch = parent
2977
if other_branch is None:
2978
raise errors.BzrCommandError("No peer location known or specified.")
2979
display_url = urlutils.unescape_for_display(parent,
2981
print "Using last location: " + display_url
2983
remote_branch = Branch.open(other_branch)
2984
if remote_branch.base == local_branch.base:
2985
remote_branch = local_branch
2986
local_branch.lock_read()
2988
remote_branch.lock_read()
2990
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2991
if (log_format is None):
2992
log_format = log.log_formatter_registry.get_default(
2994
lf = log_format(to_file=self.outf,
2996
show_timezone='original')
2997
if reverse is False:
2998
local_extra.reverse()
2999
remote_extra.reverse()
3000
if local_extra and not theirs_only:
3001
print "You have %d extra revision(s):" % len(local_extra)
3002
for data in iter_log_data(local_extra, local_branch.repository,
3005
printed_local = True
3007
printed_local = False
3008
if remote_extra and not mine_only:
3009
if printed_local is True:
3011
print "You are missing %d revision(s):" % len(remote_extra)
3012
for data in iter_log_data(remote_extra, remote_branch.repository,
3015
if not remote_extra and not local_extra:
3017
print "Branches are up to date."
3021
remote_branch.unlock()
3023
local_branch.unlock()
3024
if not status_code and parent is None and other_branch is not None:
3025
local_branch.lock_write()
3027
# handle race conditions - a parent might be set while we run.
3028
if local_branch.get_parent() is None:
3029
local_branch.set_parent(remote_branch.base)
3031
local_branch.unlock()
3035
class cmd_plugins(Command):
3040
import bzrlib.plugin
3041
from inspect import getdoc
3042
for name, plugin in bzrlib.plugin.all_plugins().items():
3043
if getattr(plugin, '__path__', None) is not None:
3044
print plugin.__path__[0]
3045
elif getattr(plugin, '__file__', None) is not None:
3046
print plugin.__file__
3052
print '\t', d.split('\n')[0]
3055
class cmd_testament(Command):
3056
"""Show testament (signing-form) of a revision."""
3057
takes_options = ['revision',
3058
Option('long', help='Produce long-format testament'),
3059
Option('strict', help='Produce a strict-format'
3061
takes_args = ['branch?']
3063
def run(self, branch=u'.', revision=None, long=False, strict=False):
3064
from bzrlib.testament import Testament, StrictTestament
3066
testament_class = StrictTestament
3068
testament_class = Testament
3069
b = WorkingTree.open_containing(branch)[0].branch
3072
if revision is None:
3073
rev_id = b.last_revision()
3075
rev_id = revision[0].in_history(b).rev_id
3076
t = testament_class.from_revision(b.repository, rev_id)
3078
sys.stdout.writelines(t.as_text_lines())
3080
sys.stdout.write(t.as_short_text())
3085
class cmd_annotate(Command):
3086
"""Show the origin of each line in a file.
3088
This prints out the given file with an annotation on the left side
3089
indicating which revision, author and date introduced the change.
3091
If the origin is the same for a run of consecutive lines, it is
3092
shown only at the top, unless the --all option is given.
3094
# TODO: annotate directories; showing when each file was last changed
3095
# TODO: if the working copy is modified, show annotations on that
3096
# with new uncommitted lines marked
3097
aliases = ['ann', 'blame', 'praise']
3098
takes_args = ['filename']
3099
takes_options = [Option('all', help='show annotations on all lines'),
3100
Option('long', help='show date in annotations'),
3106
def run(self, filename, all=False, long=False, revision=None,
3108
from bzrlib.annotate import annotate_file
3109
tree, relpath = WorkingTree.open_containing(filename)
3110
branch = tree.branch
3113
if revision is None:
3114
revision_id = branch.last_revision()
3115
elif len(revision) != 1:
3116
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3118
revision_id = revision[0].in_history(branch).rev_id
3119
file_id = tree.path2id(relpath)
3120
tree = branch.repository.revision_tree(revision_id)
3121
file_version = tree.inventory[file_id].revision
3122
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3128
class cmd_re_sign(Command):
3129
"""Create a digital signature for an existing revision."""
3130
# TODO be able to replace existing ones.
3132
hidden = True # is this right ?
3133
takes_args = ['revision_id*']
3134
takes_options = ['revision']
3136
def run(self, revision_id_list=None, revision=None):
3137
import bzrlib.gpg as gpg
3138
if revision_id_list is not None and revision is not None:
3139
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3140
if revision_id_list is None and revision is None:
3141
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3142
b = WorkingTree.open_containing(u'.')[0].branch
3143
gpg_strategy = gpg.GPGStrategy(b.get_config())
3144
if revision_id_list is not None:
3145
for revision_id in revision_id_list:
3146
b.repository.sign_revision(revision_id, gpg_strategy)
3147
elif revision is not None:
3148
if len(revision) == 1:
3149
revno, rev_id = revision[0].in_history(b)
3150
b.repository.sign_revision(rev_id, gpg_strategy)
3151
elif len(revision) == 2:
3152
# are they both on rh- if so we can walk between them
3153
# might be nice to have a range helper for arbitrary
3154
# revision paths. hmm.
3155
from_revno, from_revid = revision[0].in_history(b)
3156
to_revno, to_revid = revision[1].in_history(b)
3157
if to_revid is None:
3158
to_revno = b.revno()
3159
if from_revno is None or to_revno is None:
3160
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3161
for revno in range(from_revno, to_revno + 1):
3162
b.repository.sign_revision(b.get_rev_id(revno),
3165
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3168
class cmd_bind(Command):
3169
"""Convert the current branch into a checkout of the supplied branch.
3171
Once converted into a checkout, commits must succeed on the master branch
3172
before they will be applied to the local branch.
3175
_see_also = ['checkouts', 'unbind']
3176
takes_args = ['location?']
3179
def run(self, location=None):
3180
b, relpath = Branch.open_containing(u'.')
3181
if location is None:
3183
location = b.get_old_bound_location()
3184
except errors.UpgradeRequired:
3185
raise errors.BzrCommandError('No location supplied. '
3186
'This format does not remember old locations.')
3188
if location is None:
3189
raise errors.BzrCommandError('No location supplied and no '
3190
'previous location known')
3191
b_other = Branch.open(location)
3194
except errors.DivergedBranches:
3195
raise errors.BzrCommandError('These branches have diverged.'
3196
' Try merging, and then bind again.')
3199
class cmd_unbind(Command):
3200
"""Convert the current checkout into a regular branch.
3202
After unbinding, the local branch is considered independent and subsequent
3203
commits will be local only.
3206
_see_also = ['checkouts', 'bind']
3211
b, relpath = Branch.open_containing(u'.')
3213
raise errors.BzrCommandError('Local branch is not bound')
3216
class cmd_uncommit(Command):
3217
"""Remove the last committed revision.
3219
--verbose will print out what is being removed.
3220
--dry-run will go through all the motions, but not actually
3223
In the future, uncommit will create a revision bundle, which can then
3227
# TODO: jam 20060108 Add an option to allow uncommit to remove
3228
# unreferenced information in 'branch-as-repository' branches.
3229
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3230
# information in shared branches as well.
3231
_see_also = ['commit']
3232
takes_options = ['verbose', 'revision',
3233
Option('dry-run', help='Don\'t actually make changes'),
3234
Option('force', help='Say yes to all questions.')]
3235
takes_args = ['location?']
3238
def run(self, location=None,
3239
dry_run=False, verbose=False,
3240
revision=None, force=False):
3241
from bzrlib.log import log_formatter, show_log
3243
from bzrlib.uncommit import uncommit
3245
if location is None:
3247
control, relpath = bzrdir.BzrDir.open_containing(location)
3249
tree = control.open_workingtree()
3251
except (errors.NoWorkingTree, errors.NotLocalUrl):
3253
b = control.open_branch()
3256
if revision is None:
3259
# 'bzr uncommit -r 10' actually means uncommit
3260
# so that the final tree is at revno 10.
3261
# but bzrlib.uncommit.uncommit() actually uncommits
3262
# the revisions that are supplied.
3263
# So we need to offset it by one
3264
revno = revision[0].in_history(b).revno+1
3266
if revno <= b.revno():
3267
rev_id = b.get_rev_id(revno)
3269
self.outf.write('No revisions to uncommit.\n')
3272
lf = log_formatter('short',
3274
show_timezone='original')
3279
direction='forward',
3280
start_revision=revno,
3281
end_revision=b.revno())
3284
print 'Dry-run, pretending to remove the above revisions.'
3286
val = raw_input('Press <enter> to continue')
3288
print 'The above revision(s) will be removed.'
3290
val = raw_input('Are you sure [y/N]? ')
3291
if val.lower() not in ('y', 'yes'):
3295
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3299
class cmd_break_lock(Command):
3300
"""Break a dead lock on a repository, branch or working directory.
3302
CAUTION: Locks should only be broken when you are sure that the process
3303
holding the lock has been stopped.
3305
You can get information on what locks are open via the 'bzr info' command.
3310
takes_args = ['location?']
3312
def run(self, location=None, show=False):
3313
if location is None:
3315
control, relpath = bzrdir.BzrDir.open_containing(location)
3317
control.break_lock()
3318
except NotImplementedError:
3322
class cmd_wait_until_signalled(Command):
3323
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3325
This just prints a line to signal when it is ready, then blocks on stdin.
3331
sys.stdout.write("running\n")
3333
sys.stdin.readline()
3336
class cmd_serve(Command):
3337
"""Run the bzr server."""
3339
aliases = ['server']
3343
help='serve on stdin/out for use from inetd or sshd'),
3345
help='listen for connections on nominated port of the form '
3346
'[hostname:]portnumber. Passing 0 as the port number will '
3347
'result in a dynamically allocated port. Default port is '
3351
help='serve contents of directory',
3353
Option('allow-writes',
3354
help='By default the server is a readonly server. Supplying '
3355
'--allow-writes enables write access to the contents of '
3356
'the served directory and below. '
3360
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3361
from bzrlib.smart import medium, server
3362
from bzrlib.transport import get_transport
3363
from bzrlib.transport.chroot import ChrootServer
3364
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3365
if directory is None:
3366
directory = os.getcwd()
3367
url = urlutils.local_path_to_url(directory)
3368
if not allow_writes:
3369
url = 'readonly+' + url
3370
chroot_server = ChrootServer(get_transport(url))
3371
chroot_server.setUp()
3372
t = get_transport(chroot_server.get_url())
3374
smart_server = medium.SmartServerPipeStreamMedium(
3375
sys.stdin, sys.stdout, t)
3377
host = BZR_DEFAULT_INTERFACE
3379
port = BZR_DEFAULT_PORT
3382
host, port = port.split(':')
3384
smart_server = server.SmartTCPServer(t, host=host, port=port)
3385
print 'listening on port: ', smart_server.port
3387
# for the duration of this server, no UI output is permitted.
3388
# note that this may cause problems with blackbox tests. This should
3389
# be changed with care though, as we dont want to use bandwidth sending
3390
# progress over stderr to smart server clients!
3391
old_factory = ui.ui_factory
3393
ui.ui_factory = ui.SilentUIFactory()
3394
smart_server.serve()
3396
ui.ui_factory = old_factory
3399
class cmd_join(Command):
3400
"""Combine a subtree into its containing tree.
3402
This command is for experimental use only. It requires the target tree
3403
to be in dirstate-with-subtree format, which cannot be converted into
3406
The TREE argument should be an independent tree, inside another tree, but
3407
not part of it. (Such trees can be produced by "bzr split", but also by
3408
running "bzr branch" with the target inside a tree.)
3410
The result is a combined tree, with the subtree no longer an independant
3411
part. This is marked as a merge of the subtree into the containing tree,
3412
and all history is preserved.
3414
If --reference is specified, the subtree retains its independence. It can
3415
be branched by itself, and can be part of multiple projects at the same
3416
time. But operations performed in the containing tree, such as commit
3417
and merge, will recurse into the subtree.
3420
_see_also = ['split']
3421
takes_args = ['tree']
3422
takes_options = [Option('reference', 'join by reference')]
3425
def run(self, tree, reference=False):
3426
sub_tree = WorkingTree.open(tree)
3427
parent_dir = osutils.dirname(sub_tree.basedir)
3428
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3429
repo = containing_tree.branch.repository
3430
if not repo.supports_rich_root():
3431
raise errors.BzrCommandError(
3432
"Can't join trees because %s doesn't support rich root data.\n"
3433
"You can use bzr upgrade on the repository."
3437
containing_tree.add_reference(sub_tree)
3438
except errors.BadReferenceTarget, e:
3439
# XXX: Would be better to just raise a nicely printable
3440
# exception from the real origin. Also below. mbp 20070306
3441
raise errors.BzrCommandError("Cannot join %s. %s" %
3445
containing_tree.subsume(sub_tree)
3446
except errors.BadSubsumeSource, e:
3447
raise errors.BzrCommandError("Cannot join %s. %s" %
3451
class cmd_split(Command):
3452
"""Split a tree into two trees.
3454
This command is for experimental use only. It requires the target tree
3455
to be in dirstate-with-subtree format, which cannot be converted into
3458
The TREE argument should be a subdirectory of a working tree. That
3459
subdirectory will be converted into an independent tree, with its own
3460
branch. Commits in the top-level tree will not apply to the new subtree.
3461
If you want that behavior, do "bzr join --reference TREE".
3464
_see_also = ['join']
3465
takes_args = ['tree']
3469
def run(self, tree):
3470
containing_tree, subdir = WorkingTree.open_containing(tree)
3471
sub_id = containing_tree.path2id(subdir)
3473
raise errors.NotVersionedError(subdir)
3475
containing_tree.extract(sub_id)
3476
except errors.RootNotRich:
3477
raise errors.UpgradeRequired(containing_tree.branch.base)
3481
class cmd_merge_directive(Command):
3482
"""Generate a merge directive for auto-merge tools.
3484
A directive requests a merge to be performed, and also provides all the
3485
information necessary to do so. This means it must either include a
3486
revision bundle, or the location of a branch containing the desired
3489
A submit branch (the location to merge into) must be supplied the first
3490
time the command is issued. After it has been supplied once, it will
3491
be remembered as the default.
3493
A public branch is optional if a revision bundle is supplied, but required
3494
if --diff or --plain is specified. It will be remembered as the default
3495
after the first use.
3498
takes_args = ['submit_branch?', 'public_branch?']
3501
RegistryOption.from_kwargs('patch-type',
3502
'The type of patch to include in the directive',
3503
title='Patch type', value_switches=True, enum_switch=False,
3504
bundle='Bazaar revision bundle (default)',
3505
diff='Normal unified diff',
3506
plain='No patch, just directive'),
3507
Option('sign', help='GPG-sign the directive'), 'revision',
3508
Option('mail-to', type=str,
3509
help='Instead of printing the directive, email to this address'),
3510
Option('message', type=str, short_name='m',
3511
help='Message to use when committing this merge')
3514
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3515
sign=False, revision=None, mail_to=None, message=None):
3516
if patch_type == 'plain':
3518
branch = Branch.open('.')
3519
stored_submit_branch = branch.get_submit_branch()
3520
if submit_branch is None:
3521
submit_branch = stored_submit_branch
3523
if stored_submit_branch is None:
3524
branch.set_submit_branch(submit_branch)
3525
if submit_branch is None:
3526
submit_branch = branch.get_parent()
3527
if submit_branch is None:
3528
raise errors.BzrCommandError('No submit branch specified or known')
3530
stored_public_branch = branch.get_public_branch()
3531
if public_branch is None:
3532
public_branch = stored_public_branch
3533
elif stored_public_branch is None:
3534
branch.set_public_branch(public_branch)
3535
if patch_type != "bundle" and public_branch is None:
3536
raise errors.BzrCommandError('No public branch specified or'
3538
if revision is not None:
3539
if len(revision) != 1:
3540
raise errors.BzrCommandError('bzr merge-directive takes '
3541
'exactly one revision identifier')
3543
revision_id = revision[0].in_history(branch).rev_id
3545
revision_id = branch.last_revision()
3546
directive = merge_directive.MergeDirective.from_objects(
3547
branch.repository, revision_id, time.time(),
3548
osutils.local_time_offset(), submit_branch,
3549
public_branch=public_branch, patch_type=patch_type,
3553
self.outf.write(directive.to_signed(branch))
3555
self.outf.writelines(directive.to_lines())
3557
message = directive.to_email(mail_to, branch, sign)
3559
server = branch.get_config().get_user_option('smtp_server')
3561
server = 'localhost'
3563
s.sendmail(message['From'], message['To'], message.as_string())
3566
class cmd_tag(Command):
3567
"""Create a tag naming a revision.
3569
Tags give human-meaningful names to revisions. Commands that take a -r
3570
(--revision) option can be given -rtag:X, where X is any previously
3573
Tags are stored in the branch. Tags are copied from one branch to another
3574
along when you branch, push, pull or merge.
3576
It is an error to give a tag name that already exists unless you pass
3577
--force, in which case the tag is moved to point to the new revision.
3580
_see_also = ['commit', 'tags']
3581
takes_args = ['tag_name']
3584
help='Delete this tag rather than placing it.',
3587
help='Branch in which to place the tag.',
3592
help='Replace existing tags',
3597
def run(self, tag_name,
3603
branch, relpath = Branch.open_containing(directory)
3607
branch.tags.delete_tag(tag_name)
3608
self.outf.write('Deleted tag %s.\n' % tag_name)
3611
if len(revision) != 1:
3612
raise errors.BzrCommandError(
3613
"Tags can only be placed on a single revision, "
3615
revision_id = revision[0].in_history(branch).rev_id
3617
revision_id = branch.last_revision()
3618
if (not force) and branch.tags.has_tag(tag_name):
3619
raise errors.TagAlreadyExists(tag_name)
3620
branch.tags.set_tag(tag_name, revision_id)
3621
self.outf.write('Created tag %s.\n' % tag_name)
3626
class cmd_tags(Command):
3629
This tag shows a table of tag names and the revisions they reference.
3635
help='Branch whose tags should be displayed',
3645
branch, relpath = Branch.open_containing(directory)
3646
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3647
self.outf.write('%-20s %s\n' % (tag_name, target))
3650
# command-line interpretation helper for merge-related commands
3651
def _merge_helper(other_revision, base_revision,
3652
check_clean=True, ignore_zero=False,
3653
this_dir=None, backup_files=False,
3655
file_list=None, show_base=False, reprocess=False,
3658
change_reporter=None,
3660
"""Merge changes into a tree.
3663
list(path, revno) Base for three-way merge.
3664
If [None, None] then a base will be automatically determined.
3666
list(path, revno) Other revision for three-way merge.
3668
Directory to merge changes into; '.' by default.
3670
If true, this_dir must have no uncommitted changes before the
3672
ignore_zero - If true, suppress the "zero conflicts" message when
3673
there are no conflicts; should be set when doing something we expect
3674
to complete perfectly.
3675
file_list - If supplied, merge only changes to selected files.
3677
All available ancestors of other_revision and base_revision are
3678
automatically pulled into the branch.
3680
The revno may be -1 to indicate the last revision on the branch, which is
3683
This function is intended for use from the command line; programmatic
3684
clients might prefer to call merge.merge_inner(), which has less magic
3687
# Loading it late, so that we don't always have to import bzrlib.merge
3688
if merge_type is None:
3689
merge_type = _mod_merge.Merge3Merger
3690
if this_dir is None:
3692
this_tree = WorkingTree.open_containing(this_dir)[0]
3693
if show_base and not merge_type is _mod_merge.Merge3Merger:
3694
raise errors.BzrCommandError("Show-base is not supported for this merge"
3695
" type. %s" % merge_type)
3696
if reprocess and not merge_type.supports_reprocess:
3697
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3698
" type %s." % merge_type)
3699
if reprocess and show_base:
3700
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3701
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3702
# only want to take out a lock_tree_write() if we don't have to pull
3703
# any ancestry. But merge might fetch ancestry in the middle, in
3704
# which case we would need a lock_write().
3705
# Because we cannot upgrade locks, for now we live with the fact that
3706
# the tree will be locked multiple times during a merge. (Maybe
3707
# read-only some of the time, but it means things will get read
3710
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3711
pb=pb, change_reporter=change_reporter)
3712
merger.pp = ProgressPhase("Merge phase", 5, pb)
3713
merger.pp.next_phase()
3714
merger.check_basis(check_clean)
3715
if other_rev_id is not None:
3716
merger.set_other_revision(other_rev_id, this_tree.branch)
3718
merger.set_other(other_revision)
3719
merger.pp.next_phase()
3720
merger.set_base(base_revision)
3721
if merger.base_rev_id == merger.other_rev_id:
3722
note('Nothing to do.')
3724
if file_list is None:
3725
if pull and merger.base_rev_id == merger.this_rev_id:
3726
# FIXME: deduplicate with pull
3727
result = merger.this_tree.pull(merger.this_branch,
3728
False, merger.other_rev_id)
3729
if result.old_revid == result.new_revid:
3730
note('No revisions to pull.')
3732
note('Now on revision %d.' % result.new_revno)
3734
merger.backup_files = backup_files
3735
merger.merge_type = merge_type
3736
merger.set_interesting_files(file_list)
3737
merger.show_base = show_base
3738
merger.reprocess = reprocess
3739
conflicts = merger.do_merge()
3740
if file_list is None:
3741
merger.set_pending()
3748
merge = _merge_helper
3751
# these get imported and then picked up by the scan for cmd_*
3752
# TODO: Some more consistent way to split command definitions across files;
3753
# we do need to load at least some information about them to know of
3754
# aliases. ideally we would avoid loading the implementation until the
3755
# details were needed.
3756
from bzrlib.cmd_version_info import cmd_version_info
3757
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3758
from bzrlib.bundle.commands import cmd_bundle_revisions
3759
from bzrlib.sign_my_commits import cmd_sign_my_commits
3760
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3761
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
