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
# TODO: create-prefix
1281
to_transport.ensure_base()
1284
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1285
except errors.NotBranchError:
1286
# really a NotBzrDir error...
1287
create_branch= bzrdir.BzrDir.create_branch_convenience
1288
branch = create_branch(to_transport.base, format=format,
1289
possible_transports=[to_transport])
1291
from bzrlib.transport.local import LocalTransport
1292
if existing_bzrdir.has_branch():
1293
if (isinstance(to_transport, LocalTransport)
1294
and not existing_bzrdir.has_workingtree()):
1295
raise errors.BranchExistsWithoutWorkingTree(location)
1296
raise errors.AlreadyBranchError(location)
1298
branch = existing_bzrdir.create_branch()
1299
existing_bzrdir.create_workingtree()
1300
if append_revisions_only:
1302
branch.set_append_revisions_only(True)
1303
except errors.UpgradeRequired:
1304
raise errors.BzrCommandError('This branch format cannot be set'
1305
' to append-revisions-only. Try --experimental-branch6')
1308
class cmd_init_repository(Command):
1309
"""Create a shared repository to hold branches.
1311
New branches created under the repository directory will store their revisions
1312
in the repository, not in the branch directory.
1315
bzr init-repo --no-trees repo
1317
bzr checkout --lightweight repo/trunk trunk-checkout
1322
_see_also = ['init', 'branch', 'checkout']
1323
takes_args = ["location"]
1324
takes_options = [RegistryOption('format',
1325
help='Specify a format for this repository. See'
1326
' "bzr help formats" for details',
1327
registry=bzrdir.format_registry,
1328
converter=bzrdir.format_registry.make_bzrdir,
1329
value_switches=True, title='Repository format'),
1331
help='Branches in the repository will default to'
1332
' not having a working tree'),
1334
aliases = ["init-repo"]
1336
def run(self, location, format=None, no_trees=False):
1338
format = bzrdir.format_registry.make_bzrdir('default')
1340
if location is None:
1343
to_transport = transport.get_transport(location)
1344
to_transport.ensure_base()
1346
newdir = format.initialize_on_transport(to_transport)
1347
repo = newdir.create_repository(shared=True)
1348
repo.set_make_working_trees(not no_trees)
1351
class cmd_diff(Command):
1352
"""Show differences in the working tree or between revisions.
1354
If files are listed, only the changes in those files are listed.
1355
Otherwise, all changes for the tree are listed.
1357
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1358
produces patches suitable for "patch -p1".
1362
Shows the difference in the working tree versus the last commit
1364
Difference between the working tree and revision 1
1366
Difference between revision 2 and revision 1
1367
bzr diff --prefix old/:new/
1368
Same as 'bzr diff' but prefix paths with old/ and new/
1369
bzr diff bzr.mine bzr.dev
1370
Show the differences between the two working trees
1372
Show just the differences for 'foo.c'
1374
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1375
# or a graphical diff.
1377
# TODO: Python difflib is not exactly the same as unidiff; should
1378
# either fix it up or prefer to use an external diff.
1380
# TODO: Selected-file diff is inefficient and doesn't show you
1383
# TODO: This probably handles non-Unix newlines poorly.
1385
_see_also = ['status']
1386
takes_args = ['file*']
1387
takes_options = ['revision', 'diff-options',
1388
Option('prefix', type=str,
1390
help='Set prefixes to added to old and new filenames, as '
1391
'two values separated by a colon. (eg "old/:new/")'),
1393
aliases = ['di', 'dif']
1394
encoding_type = 'exact'
1397
def run(self, revision=None, file_list=None, diff_options=None,
1399
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1401
if (prefix is None) or (prefix == '0'):
1409
old_label, new_label = prefix.split(":")
1411
raise errors.BzrCommandError(
1412
'--prefix expects two values separated by a colon'
1413
' (eg "old/:new/")')
1415
if revision and len(revision) > 2:
1416
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1417
' one or two revision specifiers')
1420
tree1, file_list = internal_tree_files(file_list)
1424
except errors.FileInWrongBranch:
1425
if len(file_list) != 2:
1426
raise errors.BzrCommandError("Files are in different branches")
1428
tree1, file1 = WorkingTree.open_containing(file_list[0])
1429
tree2, file2 = WorkingTree.open_containing(file_list[1])
1430
if file1 != "" or file2 != "":
1431
# FIXME diff those two files. rbc 20051123
1432
raise errors.BzrCommandError("Files are in different branches")
1434
except errors.NotBranchError:
1435
if (revision is not None and len(revision) == 2
1436
and not revision[0].needs_branch()
1437
and not revision[1].needs_branch()):
1438
# If both revision specs include a branch, we can
1439
# diff them without needing a local working tree
1440
tree1, tree2 = None, None
1444
if tree2 is not None:
1445
if revision is not None:
1446
# FIXME: but there should be a clean way to diff between
1447
# non-default versions of two trees, it's not hard to do
1449
raise errors.BzrCommandError(
1450
"Sorry, diffing arbitrary revisions across branches "
1451
"is not implemented yet")
1452
return show_diff_trees(tree1, tree2, sys.stdout,
1453
specific_files=file_list,
1454
external_diff_options=diff_options,
1455
old_label=old_label, new_label=new_label)
1457
return diff_cmd_helper(tree1, file_list, diff_options,
1458
revision_specs=revision,
1459
old_label=old_label, new_label=new_label)
1462
class cmd_deleted(Command):
1463
"""List files deleted in the working tree.
1465
# TODO: Show files deleted since a previous revision, or
1466
# between two revisions.
1467
# TODO: Much more efficient way to do this: read in new
1468
# directories with readdir, rather than stating each one. Same
1469
# level of effort but possibly much less IO. (Or possibly not,
1470
# if the directories are very large...)
1471
_see_also = ['status', 'ls']
1472
takes_options = ['show-ids']
1475
def run(self, show_ids=False):
1476
tree = WorkingTree.open_containing(u'.')[0]
1479
old = tree.basis_tree()
1482
for path, ie in old.inventory.iter_entries():
1483
if not tree.has_id(ie.file_id):
1484
self.outf.write(path)
1486
self.outf.write(' ')
1487
self.outf.write(ie.file_id)
1488
self.outf.write('\n')
1495
class cmd_modified(Command):
1496
"""List files modified in working tree.
1500
_see_also = ['status', 'ls']
1504
tree = WorkingTree.open_containing(u'.')[0]
1505
td = tree.changes_from(tree.basis_tree())
1506
for path, id, kind, text_modified, meta_modified in td.modified:
1507
self.outf.write(path + '\n')
1510
class cmd_added(Command):
1511
"""List files added in working tree.
1515
_see_also = ['status', 'ls']
1519
wt = WorkingTree.open_containing(u'.')[0]
1522
basis = wt.basis_tree()
1525
basis_inv = basis.inventory
1528
if file_id in basis_inv:
1530
if inv.is_root(file_id) and len(basis_inv) == 0:
1532
path = inv.id2path(file_id)
1533
if not os.access(osutils.abspath(path), os.F_OK):
1535
self.outf.write(path + '\n')
1542
class cmd_root(Command):
1543
"""Show the tree root directory.
1545
The root is the nearest enclosing directory with a .bzr control
1548
takes_args = ['filename?']
1550
def run(self, filename=None):
1551
"""Print the branch root."""
1552
tree = WorkingTree.open_containing(filename)[0]
1553
self.outf.write(tree.basedir + '\n')
1556
class cmd_log(Command):
1557
"""Show log of a branch, file, or directory.
1559
By default show the log of the branch containing the working directory.
1561
To request a range of logs, you can use the command -r begin..end
1562
-r revision requests a specific revision, -r ..end or -r begin.. are
1568
bzr log -r -10.. http://server/branch
1571
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1573
takes_args = ['location?']
1574
takes_options = [Option('forward',
1575
help='show from oldest to newest'),
1579
help='show files changed in each revision'),
1580
'show-ids', 'revision',
1584
help='show revisions whose message matches this regexp',
1587
encoding_type = 'replace'
1590
def run(self, location=None, timezone='original',
1597
from bzrlib.log import show_log
1598
assert message is None or isinstance(message, basestring), \
1599
"invalid message argument %r" % message
1600
direction = (forward and 'forward') or 'reverse'
1605
# find the file id to log:
1607
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1611
tree = b.basis_tree()
1612
file_id = tree.path2id(fp)
1614
raise errors.BzrCommandError(
1615
"Path does not have any revision history: %s" %
1619
# FIXME ? log the current subdir only RBC 20060203
1620
if revision is not None \
1621
and len(revision) > 0 and revision[0].get_branch():
1622
location = revision[0].get_branch()
1625
dir, relpath = bzrdir.BzrDir.open_containing(location)
1626
b = dir.open_branch()
1630
if revision is None:
1633
elif len(revision) == 1:
1634
rev1 = rev2 = revision[0].in_history(b).revno
1635
elif len(revision) == 2:
1636
if revision[1].get_branch() != revision[0].get_branch():
1637
# b is taken from revision[0].get_branch(), and
1638
# show_log will use its revision_history. Having
1639
# different branches will lead to weird behaviors.
1640
raise errors.BzrCommandError(
1641
"Log doesn't accept two revisions in different"
1643
if revision[0].spec is None:
1644
# missing begin-range means first revision
1647
rev1 = revision[0].in_history(b).revno
1649
if revision[1].spec is None:
1650
# missing end-range means last known revision
1653
rev2 = revision[1].in_history(b).revno
1655
raise errors.BzrCommandError(
1656
'bzr log --revision takes one or two values.')
1658
# By this point, the revision numbers are converted to the +ve
1659
# form if they were supplied in the -ve form, so we can do
1660
# this comparison in relative safety
1662
(rev2, rev1) = (rev1, rev2)
1664
if log_format is None:
1665
log_format = log.log_formatter_registry.get_default(b)
1667
lf = log_format(show_ids=show_ids, to_file=self.outf,
1668
show_timezone=timezone)
1674
direction=direction,
1675
start_revision=rev1,
1682
def get_log_format(long=False, short=False, line=False, default='long'):
1683
log_format = default
1687
log_format = 'short'
1693
class cmd_touching_revisions(Command):
1694
"""Return revision-ids which affected a particular file.
1696
A more user-friendly interface is "bzr log FILE".
1700
takes_args = ["filename"]
1703
def run(self, filename):
1704
tree, relpath = WorkingTree.open_containing(filename)
1706
file_id = tree.path2id(relpath)
1707
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1708
self.outf.write("%6d %s\n" % (revno, what))
1711
class cmd_ls(Command):
1712
"""List files in a tree.
1715
_see_also = ['status', 'cat']
1716
takes_args = ['path?']
1717
# TODO: Take a revision or remote path and list that tree instead.
1718
takes_options = ['verbose', 'revision',
1719
Option('non-recursive',
1720
help='don\'t recurse into sub-directories'),
1722
help='Print all paths from the root of the branch.'),
1723
Option('unknown', help='Print unknown files'),
1724
Option('versioned', help='Print versioned files'),
1725
Option('ignored', help='Print ignored files'),
1727
Option('null', help='Null separate the files'),
1731
def run(self, revision=None, verbose=False,
1732
non_recursive=False, from_root=False,
1733
unknown=False, versioned=False, ignored=False,
1734
null=False, kind=None, show_ids=False, path=None):
1736
if kind and kind not in ('file', 'directory', 'symlink'):
1737
raise errors.BzrCommandError('invalid kind specified')
1739
if verbose and null:
1740
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1741
all = not (unknown or versioned or ignored)
1743
selection = {'I':ignored, '?':unknown, 'V':versioned}
1750
raise errors.BzrCommandError('cannot specify both --from-root'
1754
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1760
if revision is not None:
1761
tree = branch.repository.revision_tree(
1762
revision[0].in_history(branch).rev_id)
1764
tree = branch.basis_tree()
1768
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1769
if fp.startswith(relpath):
1770
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1771
if non_recursive and '/' in fp:
1773
if not all and not selection[fc]:
1775
if kind is not None and fkind != kind:
1778
kindch = entry.kind_character()
1779
outstring = '%-8s %s%s' % (fc, fp, kindch)
1780
if show_ids and fid is not None:
1781
outstring = "%-50s %s" % (outstring, fid)
1782
self.outf.write(outstring + '\n')
1784
self.outf.write(fp + '\0')
1787
self.outf.write(fid)
1788
self.outf.write('\0')
1796
self.outf.write('%-50s %s\n' % (fp, my_id))
1798
self.outf.write(fp + '\n')
1803
class cmd_unknowns(Command):
1804
"""List unknown files.
1812
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1813
self.outf.write(osutils.quotefn(f) + '\n')
1816
class cmd_ignore(Command):
1817
"""Ignore specified files or patterns.
1819
To remove patterns from the ignore list, edit the .bzrignore file.
1821
Trailing slashes on patterns are ignored.
1822
If the pattern contains a slash or is a regular expression, it is compared
1823
to the whole path from the branch root. Otherwise, it is compared to only
1824
the last component of the path. To match a file only in the root
1825
directory, prepend './'.
1827
Ignore patterns specifying absolute paths are not allowed.
1829
Ignore patterns may include globbing wildcards such as:
1830
? - Matches any single character except '/'
1831
* - Matches 0 or more characters except '/'
1832
/**/ - Matches 0 or more directories in a path
1833
[a-z] - Matches a single character from within a group of characters
1835
Ignore patterns may also be Python regular expressions.
1836
Regular expression ignore patterns are identified by a 'RE:' prefix
1837
followed by the regular expression. Regular expression ignore patterns
1838
may not include named or numbered groups.
1840
Note: ignore patterns containing shell wildcards must be quoted from
1844
bzr ignore ./Makefile
1845
bzr ignore '*.class'
1846
bzr ignore 'lib/**/*.o'
1847
bzr ignore 'RE:lib/.*\.o'
1850
_see_also = ['status', 'ignored']
1851
takes_args = ['name_pattern*']
1853
Option('old-default-rules',
1854
help='Out the ignore rules bzr < 0.9 always used.')
1857
def run(self, name_pattern_list=None, old_default_rules=None):
1858
from bzrlib.atomicfile import AtomicFile
1859
if old_default_rules is not None:
1860
# dump the rules and exit
1861
for pattern in ignores.OLD_DEFAULTS:
1864
if not name_pattern_list:
1865
raise errors.BzrCommandError("ignore requires at least one "
1866
"NAME_PATTERN or --old-default-rules")
1867
name_pattern_list = [globbing.normalize_pattern(p)
1868
for p in name_pattern_list]
1869
for name_pattern in name_pattern_list:
1870
if (name_pattern[0] == '/' or
1871
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1872
raise errors.BzrCommandError(
1873
"NAME_PATTERN should not be an absolute path")
1874
tree, relpath = WorkingTree.open_containing(u'.')
1875
ifn = tree.abspath('.bzrignore')
1876
if os.path.exists(ifn):
1879
igns = f.read().decode('utf-8')
1885
# TODO: If the file already uses crlf-style termination, maybe
1886
# we should use that for the newly added lines?
1888
if igns and igns[-1] != '\n':
1890
for name_pattern in name_pattern_list:
1891
igns += name_pattern + '\n'
1893
f = AtomicFile(ifn, 'wb')
1895
f.write(igns.encode('utf-8'))
1900
if not tree.path2id('.bzrignore'):
1901
tree.add(['.bzrignore'])
1904
class cmd_ignored(Command):
1905
"""List ignored files and the patterns that matched them.
1908
_see_also = ['ignore']
1911
tree = WorkingTree.open_containing(u'.')[0]
1914
for path, file_class, kind, file_id, entry in tree.list_files():
1915
if file_class != 'I':
1917
## XXX: Slightly inefficient since this was already calculated
1918
pat = tree.is_ignored(path)
1919
print '%-50s %s' % (path, pat)
1924
class cmd_lookup_revision(Command):
1925
"""Lookup the revision-id from a revision-number
1928
bzr lookup-revision 33
1931
takes_args = ['revno']
1934
def run(self, revno):
1938
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1940
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1943
class cmd_export(Command):
1944
"""Export current or past revision to a destination directory or archive.
1946
If no revision is specified this exports the last committed revision.
1948
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1949
given, try to find the format with the extension. If no extension
1950
is found exports to a directory (equivalent to --format=dir).
1952
If root is supplied, it will be used as the root directory inside
1953
container formats (tar, zip, etc). If it is not supplied it will default
1954
to the exported filename. The root option has no effect for 'dir' format.
1956
If branch is omitted then the branch containing the current working
1957
directory will be used.
1959
Note: Export of tree with non-ASCII filenames to zip is not supported.
1961
Supported formats Autodetected by extension
1962
----------------- -------------------------
1965
tbz2 .tar.bz2, .tbz2
1969
takes_args = ['dest', 'branch?']
1970
takes_options = ['revision', 'format', 'root']
1971
def run(self, dest, branch=None, revision=None, format=None, root=None):
1972
from bzrlib.export import export
1975
tree = WorkingTree.open_containing(u'.')[0]
1978
b = Branch.open(branch)
1980
if revision is None:
1981
# should be tree.last_revision FIXME
1982
rev_id = b.last_revision()
1984
if len(revision) != 1:
1985
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
1986
rev_id = revision[0].in_history(b).rev_id
1987
t = b.repository.revision_tree(rev_id)
1989
export(t, dest, format, root)
1990
except errors.NoSuchExportFormat, e:
1991
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1994
class cmd_cat(Command):
1995
"""Write the contents of a file as of a given revision to standard output.
1997
If no revision is nominated, the last revision is used.
1999
Note: Take care to redirect standard output when using this command on a
2004
takes_options = ['revision', 'name-from-revision']
2005
takes_args = ['filename']
2006
encoding_type = 'exact'
2009
def run(self, filename, revision=None, name_from_revision=False):
2010
if revision is not None and len(revision) != 1:
2011
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2016
tree, b, relpath = \
2017
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2018
except errors.NotBranchError:
2021
if revision is not None and revision[0].get_branch() is not None:
2022
b = Branch.open(revision[0].get_branch())
2024
tree = b.basis_tree()
2025
if revision is None:
2026
revision_id = b.last_revision()
2028
revision_id = revision[0].in_history(b).rev_id
2030
cur_file_id = tree.path2id(relpath)
2031
rev_tree = b.repository.revision_tree(revision_id)
2032
old_file_id = rev_tree.path2id(relpath)
2034
if name_from_revision:
2035
if old_file_id is None:
2036
raise errors.BzrCommandError("%r is not present in revision %s"
2037
% (filename, revision_id))
2039
rev_tree.print_file(old_file_id)
2040
elif cur_file_id is not None:
2041
rev_tree.print_file(cur_file_id)
2042
elif old_file_id is not None:
2043
rev_tree.print_file(old_file_id)
2045
raise errors.BzrCommandError("%r is not present in revision %s" %
2046
(filename, revision_id))
2049
class cmd_local_time_offset(Command):
2050
"""Show the offset in seconds from GMT to local time."""
2054
print osutils.local_time_offset()
2058
class cmd_commit(Command):
2059
"""Commit changes into a new revision.
2061
If no arguments are given, the entire tree is committed.
2063
If selected files are specified, only changes to those files are
2064
committed. If a directory is specified then the directory and everything
2065
within it is committed.
2067
A selected-file commit may fail in some cases where the committed
2068
tree would be invalid. Consider::
2073
bzr commit foo -m "committing foo"
2074
bzr mv foo/bar foo/baz
2077
bzr commit foo/bar -m "committing bar but not baz"
2079
In the example above, the last commit will fail by design. This gives
2080
the user the opportunity to decide whether they want to commit the
2081
rename at the same time, separately first, or not at all. (As a general
2082
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2084
Note: A selected-file commit after a merge is not yet supported.
2086
# TODO: Run hooks on tree to-be-committed, and after commit.
2088
# TODO: Strict commit that fails if there are deleted files.
2089
# (what does "deleted files" mean ??)
2091
# TODO: Give better message for -s, --summary, used by tla people
2093
# XXX: verbose currently does nothing
2095
_see_also = ['bugs', 'uncommit']
2096
takes_args = ['selected*']
2097
takes_options = ['message', 'verbose',
2099
help='commit even if nothing has changed'),
2100
Option('file', type=str,
2103
help='file containing commit message'),
2105
help="refuse to commit if there are unknown "
2106
"files in the working tree."),
2107
ListOption('fixes', type=str,
2108
help="mark a bug as being fixed by this "
2111
help="perform a local only commit in a bound "
2112
"branch. Such commits are not pushed to "
2113
"the master branch until a normal commit "
2117
aliases = ['ci', 'checkin']
2119
def _get_bug_fix_properties(self, fixes, branch):
2121
# Configure the properties for bug fixing attributes.
2122
for fixed_bug in fixes:
2123
tokens = fixed_bug.split(':')
2124
if len(tokens) != 2:
2125
raise errors.BzrCommandError(
2126
"Invalid bug %s. Must be in the form of 'tag:id'. "
2127
"Commit refused." % fixed_bug)
2128
tag, bug_id = tokens
2130
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2131
except errors.UnknownBugTrackerAbbreviation:
2132
raise errors.BzrCommandError(
2133
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2134
except errors.MalformedBugIdentifier:
2135
raise errors.BzrCommandError(
2136
"Invalid bug identifier for %s. Commit refused."
2138
properties.append('%s fixed' % bug_url)
2139
return '\n'.join(properties)
2141
def run(self, message=None, file=None, verbose=True, selected_list=None,
2142
unchanged=False, strict=False, local=False, fixes=None):
2143
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2144
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2146
from bzrlib.msgeditor import edit_commit_message, \
2147
make_commit_message_template
2149
# TODO: Need a blackbox test for invoking the external editor; may be
2150
# slightly problematic to run this cross-platform.
2152
# TODO: do more checks that the commit will succeed before
2153
# spending the user's valuable time typing a commit message.
2157
tree, selected_list = tree_files(selected_list)
2158
if selected_list == ['']:
2159
# workaround - commit of root of tree should be exactly the same
2160
# as just default commit in that tree, and succeed even though
2161
# selected-file merge commit is not done yet
2164
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2166
properties['bugs'] = bug_property
2168
if local and not tree.branch.get_bound_location():
2169
raise errors.LocalRequiresBoundBranch()
2171
def get_message(commit_obj):
2172
"""Callback to get commit message"""
2173
my_message = message
2174
if my_message is None and not file:
2175
template = make_commit_message_template(tree, selected_list)
2176
my_message = edit_commit_message(template)
2177
if my_message is None:
2178
raise errors.BzrCommandError("please specify a commit"
2179
" message with either --message or --file")
2180
elif my_message and file:
2181
raise errors.BzrCommandError(
2182
"please specify either --message or --file")
2184
my_message = codecs.open(file, 'rt',
2185
bzrlib.user_encoding).read()
2186
if my_message == "":
2187
raise errors.BzrCommandError("empty commit message specified")
2191
reporter = ReportCommitToLog()
2193
reporter = NullCommitReporter()
2196
tree.commit(message_callback=get_message,
2197
specific_files=selected_list,
2198
allow_pointless=unchanged, strict=strict, local=local,
2199
reporter=reporter, revprops=properties)
2200
except PointlessCommit:
2201
# FIXME: This should really happen before the file is read in;
2202
# perhaps prepare the commit; get the message; then actually commit
2203
raise errors.BzrCommandError("no changes to commit."
2204
" use --unchanged to commit anyhow")
2205
except ConflictsInTree:
2206
raise errors.BzrCommandError('Conflicts detected in working '
2207
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2209
except StrictCommitFailed:
2210
raise errors.BzrCommandError("Commit refused because there are"
2211
" unknown files in the working tree.")
2212
except errors.BoundBranchOutOfDate, e:
2213
raise errors.BzrCommandError(str(e) + "\n"
2214
'To commit to master branch, run update and then commit.\n'
2215
'You can also pass --local to commit to continue working '
2219
class cmd_check(Command):
2220
"""Validate consistency of branch history.
2222
This command checks various invariants about the branch storage to
2223
detect data corruption or bzr bugs.
2226
_see_also = ['reconcile']
2227
takes_args = ['branch?']
2228
takes_options = ['verbose']
2230
def run(self, branch=None, verbose=False):
2231
from bzrlib.check import check
2233
tree = WorkingTree.open_containing()[0]
2234
branch = tree.branch
2236
branch = Branch.open(branch)
2237
check(branch, verbose)
2240
class cmd_upgrade(Command):
2241
"""Upgrade branch storage to current format.
2243
The check command or bzr developers may sometimes advise you to run
2244
this command. When the default format has changed you may also be warned
2245
during other operations to upgrade.
2248
_see_also = ['check']
2249
takes_args = ['url?']
2251
RegistryOption('format',
2252
help='Upgrade to a specific format. See "bzr help'
2253
' formats" for details',
2254
registry=bzrdir.format_registry,
2255
converter=bzrdir.format_registry.make_bzrdir,
2256
value_switches=True, title='Branch format'),
2259
def run(self, url='.', format=None):
2260
from bzrlib.upgrade import upgrade
2262
format = bzrdir.format_registry.make_bzrdir('default')
2263
upgrade(url, format)
2266
class cmd_whoami(Command):
2267
"""Show or set bzr user id.
2271
bzr whoami 'Frank Chu <fchu@example.com>'
2273
takes_options = [ Option('email',
2274
help='display email address only'),
2276
help='set identity for the current branch instead of '
2279
takes_args = ['name?']
2280
encoding_type = 'replace'
2283
def run(self, email=False, branch=False, name=None):
2285
# use branch if we're inside one; otherwise global config
2287
c = Branch.open_containing('.')[0].get_config()
2288
except errors.NotBranchError:
2289
c = config.GlobalConfig()
2291
self.outf.write(c.user_email() + '\n')
2293
self.outf.write(c.username() + '\n')
2296
# display a warning if an email address isn't included in the given name.
2298
config.extract_email_address(name)
2299
except errors.NoEmailInUsername, e:
2300
warning('"%s" does not seem to contain an email address. '
2301
'This is allowed, but not recommended.', name)
2303
# use global config unless --branch given
2305
c = Branch.open_containing('.')[0].get_config()
2307
c = config.GlobalConfig()
2308
c.set_user_option('email', name)
2311
class cmd_nick(Command):
2312
"""Print or set the branch nickname.
2314
If unset, the tree root directory name is used as the nickname
2315
To print the current nickname, execute with no argument.
2318
_see_also = ['info']
2319
takes_args = ['nickname?']
2320
def run(self, nickname=None):
2321
branch = Branch.open_containing(u'.')[0]
2322
if nickname is None:
2323
self.printme(branch)
2325
branch.nick = nickname
2328
def printme(self, branch):
2332
class cmd_selftest(Command):
2333
"""Run internal test suite.
2335
This creates temporary test directories in the working directory, but no
2336
existing data is affected. These directories are deleted if the tests
2337
pass, or left behind to help in debugging if they fail and --keep-output
2340
If arguments are given, they are regular expressions that say which tests
2341
should run. Tests matching any expression are run, and other tests are
2344
Alternatively if --first is given, matching tests are run first and then
2345
all other tests are run. This is useful if you have been working in a
2346
particular area, but want to make sure nothing else was broken.
2348
If --exclude is given, tests that match that regular expression are
2349
excluded, regardless of whether they match --first or not.
2351
To help catch accidential dependencies between tests, the --randomize
2352
option is useful. In most cases, the argument used is the word 'now'.
2353
Note that the seed used for the random number generator is displayed
2354
when this option is used. The seed can be explicitly passed as the
2355
argument to this option if required. This enables reproduction of the
2356
actual ordering used if and when an order sensitive problem is encountered.
2358
If --list-only is given, the tests that would be run are listed. This is
2359
useful when combined with --first, --exclude and/or --randomize to
2360
understand their impact. The test harness reports "Listed nn tests in ..."
2361
instead of "Ran nn tests in ..." when list mode is enabled.
2363
If the global option '--no-plugins' is given, plugins are not loaded
2364
before running the selftests. This has two effects: features provided or
2365
modified by plugins will not be tested, and tests provided by plugins will
2370
run only tests relating to 'ignore'
2371
bzr --no-plugins selftest -v
2372
disable plugins and list tests as they're run
2374
For each test, that needs actual disk access, bzr create their own
2375
subdirectory in the temporary testing directory (testXXXX.tmp).
2376
By default the name of such subdirectory is based on the name of the test.
2377
If option '--numbered-dirs' is given, bzr will use sequent numbers
2378
of running tests to create such subdirectories. This is default behavior
2379
on Windows because of path length limitation.
2381
# NB: this is used from the class without creating an instance, which is
2382
# why it does not have a self parameter.
2383
def get_transport_type(typestring):
2384
"""Parse and return a transport specifier."""
2385
if typestring == "sftp":
2386
from bzrlib.transport.sftp import SFTPAbsoluteServer
2387
return SFTPAbsoluteServer
2388
if typestring == "memory":
2389
from bzrlib.transport.memory import MemoryServer
2391
if typestring == "fakenfs":
2392
from bzrlib.transport.fakenfs import FakeNFSServer
2393
return FakeNFSServer
2394
msg = "No known transport type %s. Supported types are: sftp\n" %\
2396
raise errors.BzrCommandError(msg)
2399
takes_args = ['testspecs*']
2400
takes_options = ['verbose',
2402
help='stop when one test fails',
2405
Option('keep-output',
2406
help='keep output directories when tests fail'),
2408
help='Use a different transport by default '
2409
'throughout the test suite.',
2410
type=get_transport_type),
2411
Option('benchmark', help='run the bzr benchmarks.'),
2412
Option('lsprof-timed',
2413
help='generate lsprof output for benchmarked'
2414
' sections of code.'),
2415
Option('cache-dir', type=str,
2416
help='a directory to cache intermediate'
2417
' benchmark steps'),
2418
Option('clean-output',
2419
help='clean temporary tests directories'
2420
' without running tests'),
2422
help='run all tests, but run specified tests first',
2425
Option('numbered-dirs',
2426
help='use numbered dirs for TestCaseInTempDir'),
2428
help='list the tests instead of running them'),
2429
Option('randomize', type=str, argname="SEED",
2430
help='randomize the order of tests using the given'
2431
' seed or "now" for the current time'),
2432
Option('exclude', type=str, argname="PATTERN",
2434
help='exclude tests that match this regular'
2437
encoding_type = 'replace'
2439
def run(self, testspecs_list=None, verbose=None, one=False,
2440
keep_output=False, transport=None, benchmark=None,
2441
lsprof_timed=None, cache_dir=None, clean_output=False,
2442
first=False, numbered_dirs=None, list_only=False,
2443
randomize=None, exclude=None):
2445
from bzrlib.tests import selftest
2446
import bzrlib.benchmarks as benchmarks
2447
from bzrlib.benchmarks import tree_creator
2450
from bzrlib.tests import clean_selftest_output
2451
clean_selftest_output()
2454
if numbered_dirs is None and sys.platform == 'win32':
2455
numbered_dirs = True
2457
if cache_dir is not None:
2458
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2459
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
2460
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
2462
if testspecs_list is not None:
2463
pattern = '|'.join(testspecs_list)
2467
test_suite_factory = benchmarks.test_suite
2470
# TODO: should possibly lock the history file...
2471
benchfile = open(".perf_history", "at", buffering=1)
2473
test_suite_factory = None
2478
result = selftest(verbose=verbose,
2480
stop_on_failure=one,
2481
keep_output=keep_output,
2482
transport=transport,
2483
test_suite_factory=test_suite_factory,
2484
lsprof_timed=lsprof_timed,
2485
bench_history=benchfile,
2486
matching_tests_first=first,
2487
numbered_dirs=numbered_dirs,
2488
list_only=list_only,
2489
random_seed=randomize,
2490
exclude_pattern=exclude
2493
if benchfile is not None:
2496
info('tests passed')
2498
info('tests failed')
2499
return int(not result)
2502
class cmd_version(Command):
2503
"""Show version of bzr."""
2507
from bzrlib.version import show_version
2511
class cmd_rocks(Command):
2512
"""Statement of optimism."""
2518
print "It sure does!"
2521
class cmd_find_merge_base(Command):
2522
"""Find and print a base revision for merging two branches."""
2523
# TODO: Options to specify revisions on either side, as if
2524
# merging only part of the history.
2525
takes_args = ['branch', 'other']
2529
def run(self, branch, other):
2530
from bzrlib.revision import MultipleRevisionSources
2532
branch1 = Branch.open_containing(branch)[0]
2533
branch2 = Branch.open_containing(other)[0]
2535
last1 = branch1.last_revision()
2536
last2 = branch2.last_revision()
2538
source = MultipleRevisionSources(branch1.repository,
2541
base_rev_id = common_ancestor(last1, last2, source)
2543
print 'merge base is revision %s' % base_rev_id
2546
class cmd_merge(Command):
2547
"""Perform a three-way merge.
2549
The branch is the branch you will merge from. By default, it will merge
2550
the latest revision. If you specify a revision, that revision will be
2551
merged. If you specify two revisions, the first will be used as a BASE,
2552
and the second one as OTHER. Revision numbers are always relative to the
2555
By default, bzr will try to merge in all new work from the other
2556
branch, automatically determining an appropriate base. If this
2557
fails, you may need to give an explicit base.
2559
Merge will do its best to combine the changes in two branches, but there
2560
are some kinds of problems only a human can fix. When it encounters those,
2561
it will mark a conflict. A conflict means that you need to fix something,
2562
before you should commit.
2564
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2566
If there is no default branch set, the first merge will set it. After
2567
that, you can omit the branch to use the default. To change the
2568
default, use --remember. The value will only be saved if the remote
2569
location can be accessed.
2571
The results of the merge are placed into the destination working
2572
directory, where they can be reviewed (with bzr diff), tested, and then
2573
committed to record the result of the merge.
2577
To merge the latest revision from bzr.dev:
2578
bzr merge ../bzr.dev
2580
To merge changes up to and including revision 82 from bzr.dev:
2581
bzr merge -r 82 ../bzr.dev
2583
To merge the changes introduced by 82, without previous changes:
2584
bzr merge -r 81..82 ../bzr.dev
2586
merge refuses to run if there are any uncommitted changes, unless
2590
_see_also = ['update', 'remerge']
2591
takes_args = ['branch?']
2592
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2593
Option('show-base', help="Show base revision text in "
2595
Option('uncommitted', help='Apply uncommitted changes'
2596
' from a working copy, instead of branch changes'),
2597
Option('pull', help='If the destination is already'
2598
' completely merged into the source, pull from the'
2599
' source rather than merging. When this happens,'
2600
' you do not need to commit the result.'),
2602
help='Branch to merge into, '
2603
'rather than the one containing the working directory',
2609
def run(self, branch=None, revision=None, force=False, merge_type=None,
2610
show_base=False, reprocess=False, remember=False,
2611
uncommitted=False, pull=False,
2614
from bzrlib.tag import _merge_tags_if_possible
2615
other_revision_id = None
2616
if merge_type is None:
2617
merge_type = _mod_merge.Merge3Merger
2619
if directory is None: directory = u'.'
2620
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2621
# inventory. Because merge is a mutating operation, it really
2622
# should be a lock_write() for the whole cmd_merge operation.
2623
# However, cmd_merge open's its own tree in _merge_helper, which
2624
# means if we lock here, the later lock_write() will always block.
2625
# Either the merge helper code should be updated to take a tree,
2626
# (What about tree.merge_from_branch?)
2627
tree = WorkingTree.open_containing(directory)[0]
2628
change_reporter = delta._ChangeReporter(
2629
unversioned_filter=tree.is_ignored)
2631
if branch is not None:
2633
mergeable = bundle.read_mergeable_from_url(
2635
except errors.NotABundle:
2636
pass # Continue on considering this url a Branch
2638
if revision is not None:
2639
raise errors.BzrCommandError(
2640
'Cannot use -r with merge directives or bundles')
2641
other_revision_id = mergeable.install_revisions(
2642
tree.branch.repository)
2643
revision = [RevisionSpec.from_string(
2644
'revid:' + other_revision_id)]
2646
if revision is None \
2647
or len(revision) < 1 or revision[0].needs_branch():
2648
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2650
if revision is None or len(revision) < 1:
2653
other = [branch, None]
2656
other = [branch, -1]
2657
other_branch, path = Branch.open_containing(branch)
2660
raise errors.BzrCommandError('Cannot use --uncommitted and'
2661
' --revision at the same time.')
2662
branch = revision[0].get_branch() or branch
2663
if len(revision) == 1:
2665
if other_revision_id is not None:
2670
other_branch, path = Branch.open_containing(branch)
2671
revno = revision[0].in_history(other_branch).revno
2672
other = [branch, revno]
2674
assert len(revision) == 2
2675
if None in revision:
2676
raise errors.BzrCommandError(
2677
"Merge doesn't permit empty revision specifier.")
2678
base_branch, path = Branch.open_containing(branch)
2679
branch1 = revision[1].get_branch() or branch
2680
other_branch, path1 = Branch.open_containing(branch1)
2681
if revision[0].get_branch() is not None:
2682
# then path was obtained from it, and is None.
2685
base = [branch, revision[0].in_history(base_branch).revno]
2686
other = [branch1, revision[1].in_history(other_branch).revno]
2688
if ((tree.branch.get_parent() is None or remember) and
2689
other_branch is not None):
2690
tree.branch.set_parent(other_branch.base)
2692
# pull tags now... it's a bit inconsistent to do it ahead of copying
2693
# the history but that's done inside the merge code
2694
if other_branch is not None:
2695
_merge_tags_if_possible(other_branch, tree.branch)
2698
interesting_files = [path]
2700
interesting_files = None
2701
pb = ui.ui_factory.nested_progress_bar()
2704
conflict_count = _merge_helper(
2705
other, base, other_rev_id=other_revision_id,
2706
check_clean=(not force),
2707
merge_type=merge_type,
2708
reprocess=reprocess,
2709
show_base=show_base,
2712
pb=pb, file_list=interesting_files,
2713
change_reporter=change_reporter)
2716
if conflict_count != 0:
2720
except errors.AmbiguousBase, e:
2721
m = ("sorry, bzr can't determine the right merge base yet\n"
2722
"candidates are:\n "
2723
+ "\n ".join(e.bases)
2725
"please specify an explicit base with -r,\n"
2726
"and (if you want) report this to the bzr developers\n")
2729
# TODO: move up to common parent; this isn't merge-specific anymore.
2730
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2731
"""Use tree.branch's parent if none was supplied.
2733
Report if the remembered location was used.
2735
if supplied_location is not None:
2736
return supplied_location
2737
stored_location = tree.branch.get_parent()
2738
mutter("%s", stored_location)
2739
if stored_location is None:
2740
raise errors.BzrCommandError("No location specified or remembered")
2741
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2742
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2743
return stored_location
2746
class cmd_remerge(Command):
2749
Use this if you want to try a different merge technique while resolving
2750
conflicts. Some merge techniques are better than others, and remerge
2751
lets you try different ones on different files.
2753
The options for remerge have the same meaning and defaults as the ones for
2754
merge. The difference is that remerge can (only) be run when there is a
2755
pending merge, and it lets you specify particular files.
2759
$ bzr remerge --show-base
2760
Re-do the merge of all conflicted files, and show the base text in
2761
conflict regions, in addition to the usual THIS and OTHER texts.
2763
$ bzr remerge --merge-type weave --reprocess foobar
2764
Re-do the merge of "foobar", using the weave merge algorithm, with
2765
additional processing to reduce the size of conflict regions.
2767
takes_args = ['file*']
2768
takes_options = ['merge-type', 'reprocess',
2769
Option('show-base', help="Show base revision text in "
2772
def run(self, file_list=None, merge_type=None, show_base=False,
2774
if merge_type is None:
2775
merge_type = _mod_merge.Merge3Merger
2776
tree, file_list = tree_files(file_list)
2779
parents = tree.get_parent_ids()
2780
if len(parents) != 2:
2781
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2782
" merges. Not cherrypicking or"
2784
repository = tree.branch.repository
2785
base_revision = common_ancestor(parents[0],
2786
parents[1], repository)
2787
base_tree = repository.revision_tree(base_revision)
2788
other_tree = repository.revision_tree(parents[1])
2789
interesting_ids = None
2791
conflicts = tree.conflicts()
2792
if file_list is not None:
2793
interesting_ids = set()
2794
for filename in file_list:
2795
file_id = tree.path2id(filename)
2797
raise errors.NotVersionedError(filename)
2798
interesting_ids.add(file_id)
2799
if tree.kind(file_id) != "directory":
2802
for name, ie in tree.inventory.iter_entries(file_id):
2803
interesting_ids.add(ie.file_id)
2804
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2806
# Remerge only supports resolving contents conflicts
2807
allowed_conflicts = ('text conflict', 'contents conflict')
2808
restore_files = [c.path for c in conflicts
2809
if c.typestring in allowed_conflicts]
2810
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2811
tree.set_conflicts(ConflictList(new_conflicts))
2812
if file_list is not None:
2813
restore_files = file_list
2814
for filename in restore_files:
2816
restore(tree.abspath(filename))
2817
except errors.NotConflicted:
2819
conflicts = _mod_merge.merge_inner(
2820
tree.branch, other_tree, base_tree,
2822
interesting_ids=interesting_ids,
2823
other_rev_id=parents[1],
2824
merge_type=merge_type,
2825
show_base=show_base,
2826
reprocess=reprocess)
2835
class cmd_revert(Command):
2836
"""Revert files to a previous revision.
2838
Giving a list of files will revert only those files. Otherwise, all files
2839
will be reverted. If the revision is not specified with '--revision', the
2840
last committed revision is used.
2842
To remove only some changes, without reverting to a prior version, use
2843
merge instead. For example, "merge . --r-2..-3" will remove the changes
2844
introduced by -2, without affecting the changes introduced by -1. Or
2845
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2847
By default, any files that have been manually changed will be backed up
2848
first. (Files changed only by merge are not backed up.) Backup files have
2849
'.~#~' appended to their name, where # is a number.
2851
When you provide files, you can use their current pathname or the pathname
2852
from the target revision. So you can use revert to "undelete" a file by
2853
name. If you name a directory, all the contents of that directory will be
2857
_see_also = ['cat', 'export']
2858
takes_options = ['revision', 'no-backup']
2859
takes_args = ['file*']
2861
def run(self, revision=None, no_backup=False, file_list=None):
2862
if file_list is not None:
2863
if len(file_list) == 0:
2864
raise errors.BzrCommandError("No files specified")
2868
tree, file_list = tree_files(file_list)
2869
if revision is None:
2870
# FIXME should be tree.last_revision
2871
rev_id = tree.last_revision()
2872
elif len(revision) != 1:
2873
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2875
rev_id = revision[0].in_history(tree.branch).rev_id
2876
pb = ui.ui_factory.nested_progress_bar()
2878
tree.revert(file_list,
2879
tree.branch.repository.revision_tree(rev_id),
2880
not no_backup, pb, report_changes=True)
2885
class cmd_assert_fail(Command):
2886
"""Test reporting of assertion failures"""
2887
# intended just for use in testing
2892
raise AssertionError("always fails")
2895
class cmd_help(Command):
2896
"""Show help on a command or other topic.
2899
_see_also = ['topics']
2900
takes_options = [Option('long', 'show help on all commands')]
2901
takes_args = ['topic?']
2902
aliases = ['?', '--help', '-?', '-h']
2905
def run(self, topic=None, long=False):
2907
if topic is None and long:
2909
bzrlib.help.help(topic)
2912
class cmd_shell_complete(Command):
2913
"""Show appropriate completions for context.
2915
For a list of all available commands, say 'bzr shell-complete'.
2917
takes_args = ['context?']
2922
def run(self, context=None):
2923
import shellcomplete
2924
shellcomplete.shellcomplete(context)
2927
class cmd_fetch(Command):
2928
"""Copy in history from another branch but don't merge it.
2930
This is an internal method used for pull and merge.
2933
takes_args = ['from_branch', 'to_branch']
2934
def run(self, from_branch, to_branch):
2935
from bzrlib.fetch import Fetcher
2936
from_b = Branch.open(from_branch)
2937
to_b = Branch.open(to_branch)
2938
Fetcher(to_b, from_b)
2941
class cmd_missing(Command):
2942
"""Show unmerged/unpulled revisions between two branches.
2944
OTHER_BRANCH may be local or remote.
2947
_see_also = ['merge', 'pull']
2948
takes_args = ['other_branch?']
2949
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2951
'Display changes in the local branch only'),
2952
Option('theirs-only',
2953
'Display changes in the remote branch only'),
2958
encoding_type = 'replace'
2961
def run(self, other_branch=None, reverse=False, mine_only=False,
2962
theirs_only=False, log_format=None, long=False, short=False, line=False,
2963
show_ids=False, verbose=False):
2964
from bzrlib.missing import find_unmerged, iter_log_data
2965
from bzrlib.log import log_formatter
2966
local_branch = Branch.open_containing(u".")[0]
2967
parent = local_branch.get_parent()
2968
if other_branch is None:
2969
other_branch = parent
2970
if other_branch is None:
2971
raise errors.BzrCommandError("No peer location known or specified.")
2972
display_url = urlutils.unescape_for_display(parent,
2974
print "Using last location: " + display_url
2976
remote_branch = Branch.open(other_branch)
2977
if remote_branch.base == local_branch.base:
2978
remote_branch = local_branch
2979
local_branch.lock_read()
2981
remote_branch.lock_read()
2983
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2984
if (log_format is None):
2985
log_format = log.log_formatter_registry.get_default(
2987
lf = log_format(to_file=self.outf,
2989
show_timezone='original')
2990
if reverse is False:
2991
local_extra.reverse()
2992
remote_extra.reverse()
2993
if local_extra and not theirs_only:
2994
print "You have %d extra revision(s):" % len(local_extra)
2995
for data in iter_log_data(local_extra, local_branch.repository,
2998
printed_local = True
3000
printed_local = False
3001
if remote_extra and not mine_only:
3002
if printed_local is True:
3004
print "You are missing %d revision(s):" % len(remote_extra)
3005
for data in iter_log_data(remote_extra, remote_branch.repository,
3008
if not remote_extra and not local_extra:
3010
print "Branches are up to date."
3014
remote_branch.unlock()
3016
local_branch.unlock()
3017
if not status_code and parent is None and other_branch is not None:
3018
local_branch.lock_write()
3020
# handle race conditions - a parent might be set while we run.
3021
if local_branch.get_parent() is None:
3022
local_branch.set_parent(remote_branch.base)
3024
local_branch.unlock()
3028
class cmd_plugins(Command):
3033
import bzrlib.plugin
3034
from inspect import getdoc
3035
for name, plugin in bzrlib.plugin.all_plugins().items():
3036
if getattr(plugin, '__path__', None) is not None:
3037
print plugin.__path__[0]
3038
elif getattr(plugin, '__file__', None) is not None:
3039
print plugin.__file__
3045
print '\t', d.split('\n')[0]
3048
class cmd_testament(Command):
3049
"""Show testament (signing-form) of a revision."""
3050
takes_options = ['revision',
3051
Option('long', help='Produce long-format testament'),
3052
Option('strict', help='Produce a strict-format'
3054
takes_args = ['branch?']
3056
def run(self, branch=u'.', revision=None, long=False, strict=False):
3057
from bzrlib.testament import Testament, StrictTestament
3059
testament_class = StrictTestament
3061
testament_class = Testament
3062
b = WorkingTree.open_containing(branch)[0].branch
3065
if revision is None:
3066
rev_id = b.last_revision()
3068
rev_id = revision[0].in_history(b).rev_id
3069
t = testament_class.from_revision(b.repository, rev_id)
3071
sys.stdout.writelines(t.as_text_lines())
3073
sys.stdout.write(t.as_short_text())
3078
class cmd_annotate(Command):
3079
"""Show the origin of each line in a file.
3081
This prints out the given file with an annotation on the left side
3082
indicating which revision, author and date introduced the change.
3084
If the origin is the same for a run of consecutive lines, it is
3085
shown only at the top, unless the --all option is given.
3087
# TODO: annotate directories; showing when each file was last changed
3088
# TODO: if the working copy is modified, show annotations on that
3089
# with new uncommitted lines marked
3090
aliases = ['ann', 'blame', 'praise']
3091
takes_args = ['filename']
3092
takes_options = [Option('all', help='show annotations on all lines'),
3093
Option('long', help='show date in annotations'),
3099
def run(self, filename, all=False, long=False, revision=None,
3101
from bzrlib.annotate import annotate_file
3102
tree, relpath = WorkingTree.open_containing(filename)
3103
branch = tree.branch
3106
if revision is None:
3107
revision_id = branch.last_revision()
3108
elif len(revision) != 1:
3109
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3111
revision_id = revision[0].in_history(branch).rev_id
3112
file_id = tree.path2id(relpath)
3113
tree = branch.repository.revision_tree(revision_id)
3114
file_version = tree.inventory[file_id].revision
3115
annotate_file(branch, file_version, file_id, long, all, sys.stdout,
3121
class cmd_re_sign(Command):
3122
"""Create a digital signature for an existing revision."""
3123
# TODO be able to replace existing ones.
3125
hidden = True # is this right ?
3126
takes_args = ['revision_id*']
3127
takes_options = ['revision']
3129
def run(self, revision_id_list=None, revision=None):
3130
import bzrlib.gpg as gpg
3131
if revision_id_list is not None and revision is not None:
3132
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3133
if revision_id_list is None and revision is None:
3134
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3135
b = WorkingTree.open_containing(u'.')[0].branch
3136
gpg_strategy = gpg.GPGStrategy(b.get_config())
3137
if revision_id_list is not None:
3138
for revision_id in revision_id_list:
3139
b.repository.sign_revision(revision_id, gpg_strategy)
3140
elif revision is not None:
3141
if len(revision) == 1:
3142
revno, rev_id = revision[0].in_history(b)
3143
b.repository.sign_revision(rev_id, gpg_strategy)
3144
elif len(revision) == 2:
3145
# are they both on rh- if so we can walk between them
3146
# might be nice to have a range helper for arbitrary
3147
# revision paths. hmm.
3148
from_revno, from_revid = revision[0].in_history(b)
3149
to_revno, to_revid = revision[1].in_history(b)
3150
if to_revid is None:
3151
to_revno = b.revno()
3152
if from_revno is None or to_revno is None:
3153
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3154
for revno in range(from_revno, to_revno + 1):
3155
b.repository.sign_revision(b.get_rev_id(revno),
3158
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3161
class cmd_bind(Command):
3162
"""Convert the current branch into a checkout of the supplied branch.
3164
Once converted into a checkout, commits must succeed on the master branch
3165
before they will be applied to the local branch.
3168
_see_also = ['checkouts', 'unbind']
3169
takes_args = ['location?']
3172
def run(self, location=None):
3173
b, relpath = Branch.open_containing(u'.')
3174
if location is None:
3176
location = b.get_old_bound_location()
3177
except errors.UpgradeRequired:
3178
raise errors.BzrCommandError('No location supplied. '
3179
'This format does not remember old locations.')
3181
if location is None:
3182
raise errors.BzrCommandError('No location supplied and no '
3183
'previous location known')
3184
b_other = Branch.open(location)
3187
except errors.DivergedBranches:
3188
raise errors.BzrCommandError('These branches have diverged.'
3189
' Try merging, and then bind again.')
3192
class cmd_unbind(Command):
3193
"""Convert the current checkout into a regular branch.
3195
After unbinding, the local branch is considered independent and subsequent
3196
commits will be local only.
3199
_see_also = ['checkouts', 'bind']
3204
b, relpath = Branch.open_containing(u'.')
3206
raise errors.BzrCommandError('Local branch is not bound')
3209
class cmd_uncommit(Command):
3210
"""Remove the last committed revision.
3212
--verbose will print out what is being removed.
3213
--dry-run will go through all the motions, but not actually
3216
In the future, uncommit will create a revision bundle, which can then
3220
# TODO: jam 20060108 Add an option to allow uncommit to remove
3221
# unreferenced information in 'branch-as-repository' branches.
3222
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3223
# information in shared branches as well.
3224
_see_also = ['commit']
3225
takes_options = ['verbose', 'revision',
3226
Option('dry-run', help='Don\'t actually make changes'),
3227
Option('force', help='Say yes to all questions.')]
3228
takes_args = ['location?']
3231
def run(self, location=None,
3232
dry_run=False, verbose=False,
3233
revision=None, force=False):
3234
from bzrlib.log import log_formatter, show_log
3236
from bzrlib.uncommit import uncommit
3238
if location is None:
3240
control, relpath = bzrdir.BzrDir.open_containing(location)
3242
tree = control.open_workingtree()
3244
except (errors.NoWorkingTree, errors.NotLocalUrl):
3246
b = control.open_branch()
3249
if revision is None:
3252
# 'bzr uncommit -r 10' actually means uncommit
3253
# so that the final tree is at revno 10.
3254
# but bzrlib.uncommit.uncommit() actually uncommits
3255
# the revisions that are supplied.
3256
# So we need to offset it by one
3257
revno = revision[0].in_history(b).revno+1
3259
if revno <= b.revno():
3260
rev_id = b.get_rev_id(revno)
3262
self.outf.write('No revisions to uncommit.\n')
3265
lf = log_formatter('short',
3267
show_timezone='original')
3272
direction='forward',
3273
start_revision=revno,
3274
end_revision=b.revno())
3277
print 'Dry-run, pretending to remove the above revisions.'
3279
val = raw_input('Press <enter> to continue')
3281
print 'The above revision(s) will be removed.'
3283
val = raw_input('Are you sure [y/N]? ')
3284
if val.lower() not in ('y', 'yes'):
3288
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3292
class cmd_break_lock(Command):
3293
"""Break a dead lock on a repository, branch or working directory.
3295
CAUTION: Locks should only be broken when you are sure that the process
3296
holding the lock has been stopped.
3298
You can get information on what locks are open via the 'bzr info' command.
3303
takes_args = ['location?']
3305
def run(self, location=None, show=False):
3306
if location is None:
3308
control, relpath = bzrdir.BzrDir.open_containing(location)
3310
control.break_lock()
3311
except NotImplementedError:
3315
class cmd_wait_until_signalled(Command):
3316
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3318
This just prints a line to signal when it is ready, then blocks on stdin.
3324
sys.stdout.write("running\n")
3326
sys.stdin.readline()
3329
class cmd_serve(Command):
3330
"""Run the bzr server."""
3332
aliases = ['server']
3336
help='serve on stdin/out for use from inetd or sshd'),
3338
help='listen for connections on nominated port of the form '
3339
'[hostname:]portnumber. Passing 0 as the port number will '
3340
'result in a dynamically allocated port. Default port is '
3344
help='serve contents of directory',
3346
Option('allow-writes',
3347
help='By default the server is a readonly server. Supplying '
3348
'--allow-writes enables write access to the contents of '
3349
'the served directory and below. '
3353
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3354
from bzrlib.smart import medium, server
3355
from bzrlib.transport import get_transport
3356
from bzrlib.transport.chroot import ChrootServer
3357
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3358
if directory is None:
3359
directory = os.getcwd()
3360
url = urlutils.local_path_to_url(directory)
3361
if not allow_writes:
3362
url = 'readonly+' + url
3363
chroot_server = ChrootServer(get_transport(url))
3364
chroot_server.setUp()
3365
t = get_transport(chroot_server.get_url())
3367
smart_server = medium.SmartServerPipeStreamMedium(
3368
sys.stdin, sys.stdout, t)
3370
host = BZR_DEFAULT_INTERFACE
3372
port = BZR_DEFAULT_PORT
3375
host, port = port.split(':')
3377
smart_server = server.SmartTCPServer(t, host=host, port=port)
3378
print 'listening on port: ', smart_server.port
3380
# for the duration of this server, no UI output is permitted.
3381
# note that this may cause problems with blackbox tests. This should
3382
# be changed with care though, as we dont want to use bandwidth sending
3383
# progress over stderr to smart server clients!
3384
old_factory = ui.ui_factory
3386
ui.ui_factory = ui.SilentUIFactory()
3387
smart_server.serve()
3389
ui.ui_factory = old_factory
3392
class cmd_join(Command):
3393
"""Combine a subtree into its containing tree.
3395
This command is for experimental use only. It requires the target tree
3396
to be in dirstate-with-subtree format, which cannot be converted into
3399
The TREE argument should be an independent tree, inside another tree, but
3400
not part of it. (Such trees can be produced by "bzr split", but also by
3401
running "bzr branch" with the target inside a tree.)
3403
The result is a combined tree, with the subtree no longer an independant
3404
part. This is marked as a merge of the subtree into the containing tree,
3405
and all history is preserved.
3407
If --reference is specified, the subtree retains its independence. It can
3408
be branched by itself, and can be part of multiple projects at the same
3409
time. But operations performed in the containing tree, such as commit
3410
and merge, will recurse into the subtree.
3413
_see_also = ['split']
3414
takes_args = ['tree']
3415
takes_options = [Option('reference', 'join by reference')]
3418
def run(self, tree, reference=False):
3419
sub_tree = WorkingTree.open(tree)
3420
parent_dir = osutils.dirname(sub_tree.basedir)
3421
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3422
repo = containing_tree.branch.repository
3423
if not repo.supports_rich_root():
3424
raise errors.BzrCommandError(
3425
"Can't join trees because %s doesn't support rich root data.\n"
3426
"You can use bzr upgrade on the repository."
3430
containing_tree.add_reference(sub_tree)
3431
except errors.BadReferenceTarget, e:
3432
# XXX: Would be better to just raise a nicely printable
3433
# exception from the real origin. Also below. mbp 20070306
3434
raise errors.BzrCommandError("Cannot join %s. %s" %
3438
containing_tree.subsume(sub_tree)
3439
except errors.BadSubsumeSource, e:
3440
raise errors.BzrCommandError("Cannot join %s. %s" %
3444
class cmd_split(Command):
3445
"""Split a tree into two trees.
3447
This command is for experimental use only. It requires the target tree
3448
to be in dirstate-with-subtree format, which cannot be converted into
3451
The TREE argument should be a subdirectory of a working tree. That
3452
subdirectory will be converted into an independent tree, with its own
3453
branch. Commits in the top-level tree will not apply to the new subtree.
3454
If you want that behavior, do "bzr join --reference TREE".
3457
_see_also = ['join']
3458
takes_args = ['tree']
3462
def run(self, tree):
3463
containing_tree, subdir = WorkingTree.open_containing(tree)
3464
sub_id = containing_tree.path2id(subdir)
3466
raise errors.NotVersionedError(subdir)
3468
containing_tree.extract(sub_id)
3469
except errors.RootNotRich:
3470
raise errors.UpgradeRequired(containing_tree.branch.base)
3474
class cmd_merge_directive(Command):
3475
"""Generate a merge directive for auto-merge tools.
3477
A directive requests a merge to be performed, and also provides all the
3478
information necessary to do so. This means it must either include a
3479
revision bundle, or the location of a branch containing the desired
3482
A submit branch (the location to merge into) must be supplied the first
3483
time the command is issued. After it has been supplied once, it will
3484
be remembered as the default.
3486
A public branch is optional if a revision bundle is supplied, but required
3487
if --diff or --plain is specified. It will be remembered as the default
3488
after the first use.
3491
takes_args = ['submit_branch?', 'public_branch?']
3494
RegistryOption.from_kwargs('patch-type',
3495
'The type of patch to include in the directive',
3496
title='Patch type', value_switches=True, enum_switch=False,
3497
bundle='Bazaar revision bundle (default)',
3498
diff='Normal unified diff',
3499
plain='No patch, just directive'),
3500
Option('sign', help='GPG-sign the directive'), 'revision',
3501
Option('mail-to', type=str,
3502
help='Instead of printing the directive, email to this address'),
3503
Option('message', type=str, short_name='m',
3504
help='Message to use when committing this merge')
3507
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3508
sign=False, revision=None, mail_to=None, message=None):
3509
if patch_type == 'plain':
3511
branch = Branch.open('.')
3512
stored_submit_branch = branch.get_submit_branch()
3513
if submit_branch is None:
3514
submit_branch = stored_submit_branch
3516
if stored_submit_branch is None:
3517
branch.set_submit_branch(submit_branch)
3518
if submit_branch is None:
3519
submit_branch = branch.get_parent()
3520
if submit_branch is None:
3521
raise errors.BzrCommandError('No submit branch specified or known')
3523
stored_public_branch = branch.get_public_branch()
3524
if public_branch is None:
3525
public_branch = stored_public_branch
3526
elif stored_public_branch is None:
3527
branch.set_public_branch(public_branch)
3528
if patch_type != "bundle" and public_branch is None:
3529
raise errors.BzrCommandError('No public branch specified or'
3531
if revision is not None:
3532
if len(revision) != 1:
3533
raise errors.BzrCommandError('bzr merge-directive takes '
3534
'exactly one revision identifier')
3536
revision_id = revision[0].in_history(branch).rev_id
3538
revision_id = branch.last_revision()
3539
directive = merge_directive.MergeDirective.from_objects(
3540
branch.repository, revision_id, time.time(),
3541
osutils.local_time_offset(), submit_branch,
3542
public_branch=public_branch, patch_type=patch_type,
3546
self.outf.write(directive.to_signed(branch))
3548
self.outf.writelines(directive.to_lines())
3550
message = directive.to_email(mail_to, branch, sign)
3552
server = branch.get_config().get_user_option('smtp_server')
3554
server = 'localhost'
3556
s.sendmail(message['From'], message['To'], message.as_string())
3559
class cmd_tag(Command):
3560
"""Create a tag naming a revision.
3562
Tags give human-meaningful names to revisions. Commands that take a -r
3563
(--revision) option can be given -rtag:X, where X is any previously
3566
Tags are stored in the branch. Tags are copied from one branch to another
3567
along when you branch, push, pull or merge.
3569
It is an error to give a tag name that already exists unless you pass
3570
--force, in which case the tag is moved to point to the new revision.
3573
_see_also = ['commit', 'tags']
3574
takes_args = ['tag_name']
3577
help='Delete this tag rather than placing it.',
3580
help='Branch in which to place the tag.',
3585
help='Replace existing tags',
3590
def run(self, tag_name,
3596
branch, relpath = Branch.open_containing(directory)
3600
branch.tags.delete_tag(tag_name)
3601
self.outf.write('Deleted tag %s.\n' % tag_name)
3604
if len(revision) != 1:
3605
raise errors.BzrCommandError(
3606
"Tags can only be placed on a single revision, "
3608
revision_id = revision[0].in_history(branch).rev_id
3610
revision_id = branch.last_revision()
3611
if (not force) and branch.tags.has_tag(tag_name):
3612
raise errors.TagAlreadyExists(tag_name)
3613
branch.tags.set_tag(tag_name, revision_id)
3614
self.outf.write('Created tag %s.\n' % tag_name)
3619
class cmd_tags(Command):
3622
This tag shows a table of tag names and the revisions they reference.
3628
help='Branch whose tags should be displayed',
3638
branch, relpath = Branch.open_containing(directory)
3639
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3640
self.outf.write('%-20s %s\n' % (tag_name, target))
3643
# command-line interpretation helper for merge-related commands
3644
def _merge_helper(other_revision, base_revision,
3645
check_clean=True, ignore_zero=False,
3646
this_dir=None, backup_files=False,
3648
file_list=None, show_base=False, reprocess=False,
3651
change_reporter=None,
3653
"""Merge changes into a tree.
3656
list(path, revno) Base for three-way merge.
3657
If [None, None] then a base will be automatically determined.
3659
list(path, revno) Other revision for three-way merge.
3661
Directory to merge changes into; '.' by default.
3663
If true, this_dir must have no uncommitted changes before the
3665
ignore_zero - If true, suppress the "zero conflicts" message when
3666
there are no conflicts; should be set when doing something we expect
3667
to complete perfectly.
3668
file_list - If supplied, merge only changes to selected files.
3670
All available ancestors of other_revision and base_revision are
3671
automatically pulled into the branch.
3673
The revno may be -1 to indicate the last revision on the branch, which is
3676
This function is intended for use from the command line; programmatic
3677
clients might prefer to call merge.merge_inner(), which has less magic
3680
# Loading it late, so that we don't always have to import bzrlib.merge
3681
if merge_type is None:
3682
merge_type = _mod_merge.Merge3Merger
3683
if this_dir is None:
3685
this_tree = WorkingTree.open_containing(this_dir)[0]
3686
if show_base and not merge_type is _mod_merge.Merge3Merger:
3687
raise errors.BzrCommandError("Show-base is not supported for this merge"
3688
" type. %s" % merge_type)
3689
if reprocess and not merge_type.supports_reprocess:
3690
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3691
" type %s." % merge_type)
3692
if reprocess and show_base:
3693
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3694
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3695
# only want to take out a lock_tree_write() if we don't have to pull
3696
# any ancestry. But merge might fetch ancestry in the middle, in
3697
# which case we would need a lock_write().
3698
# Because we cannot upgrade locks, for now we live with the fact that
3699
# the tree will be locked multiple times during a merge. (Maybe
3700
# read-only some of the time, but it means things will get read
3703
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3704
pb=pb, change_reporter=change_reporter)
3705
merger.pp = ProgressPhase("Merge phase", 5, pb)
3706
merger.pp.next_phase()
3707
merger.check_basis(check_clean)
3708
if other_rev_id is not None:
3709
merger.set_other_revision(other_rev_id, this_tree.branch)
3711
merger.set_other(other_revision)
3712
merger.pp.next_phase()
3713
merger.set_base(base_revision)
3714
if merger.base_rev_id == merger.other_rev_id:
3715
note('Nothing to do.')
3717
if file_list is None:
3718
if pull and merger.base_rev_id == merger.this_rev_id:
3719
# FIXME: deduplicate with pull
3720
result = merger.this_tree.pull(merger.this_branch,
3721
False, merger.other_rev_id)
3722
if result.old_revid == result.new_revid:
3723
note('No revisions to pull.')
3725
note('Now on revision %d.' % result.new_revno)
3727
merger.backup_files = backup_files
3728
merger.merge_type = merge_type
3729
merger.set_interesting_files(file_list)
3730
merger.show_base = show_base
3731
merger.reprocess = reprocess
3732
conflicts = merger.do_merge()
3733
if file_list is None:
3734
merger.set_pending()
3741
merge = _merge_helper
3744
# these get imported and then picked up by the scan for cmd_*
3745
# TODO: Some more consistent way to split command definitions across files;
3746
# we do need to load at least some information about them to know of
3747
# aliases. ideally we would avoid loading the implementation until the
3748
# details were needed.
3749
from bzrlib.cmd_version_info import cmd_version_info
3750
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
3751
from bzrlib.bundle.commands import cmd_bundle_revisions
3752
from bzrlib.sign_my_commits import cmd_sign_my_commits
3753
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
3754
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
