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(), """
43
revision as _mod_revision,
50
from bzrlib.branch import Branch
51
from bzrlib.conflicts import ConflictList
52
from bzrlib.revisionspec import RevisionSpec
53
from bzrlib.smtp_connection import SMTPConnection
54
from bzrlib.workingtree import WorkingTree
57
from bzrlib.commands import Command, display_command
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
62
def tree_files(file_list, default_branch=u'.'):
64
return internal_tree_files(file_list, default_branch)
65
except errors.FileInWrongBranch, e:
66
raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
(e.path, file_list[0]))
70
# XXX: Bad function name; should possibly also be a class method of
71
# WorkingTree rather than a function.
72
def internal_tree_files(file_list, default_branch=u'.'):
73
"""Convert command-line paths to a WorkingTree and relative paths.
75
This is typically used for command-line processors that take one or
76
more filenames, and infer the workingtree that contains them.
78
The filenames given are not required to exist.
80
:param file_list: Filenames to convert.
82
:param default_branch: Fallback tree path to use if file_list is empty or
85
:return: workingtree, [relative_paths]
87
if file_list is None or len(file_list) == 0:
88
return WorkingTree.open_containing(default_branch)[0], file_list
89
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
91
for filename in file_list:
93
new_list.append(tree.relpath(osutils.dereference_path(filename)))
94
except errors.PathNotChild:
95
raise errors.FileInWrongBranch(tree.branch, filename)
99
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
100
def get_format_type(typestring):
101
"""Parse and return a format specifier."""
102
# Have to use BzrDirMetaFormat1 directly, so that
103
# RepositoryFormat.set_default_format works
104
if typestring == "default":
105
return bzrdir.BzrDirMetaFormat1()
107
return bzrdir.format_registry.make_bzrdir(typestring)
109
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
110
raise errors.BzrCommandError(msg)
113
# TODO: Make sure no commands unconditionally use the working directory as a
114
# branch. If a filename argument is used, the first of them should be used to
115
# specify the branch. (Perhaps this can be factored out into some kind of
116
# Argument class, representing a file in a branch, where the first occurrence
119
class cmd_status(Command):
120
"""Display status summary.
122
This reports on versioned and unknown files, reporting them
123
grouped by state. Possible states are:
126
Versioned in the working copy but not in the previous revision.
129
Versioned in the previous revision but removed or deleted
133
Path of this file changed from the previous revision;
134
the text may also have changed. This includes files whose
135
parent directory was renamed.
138
Text has changed since the previous revision.
141
File kind has been changed (e.g. from file to directory).
144
Not versioned and not matching an ignore pattern.
146
To see ignored files use 'bzr ignored'. For details on the
147
changes to file texts, use 'bzr diff'.
149
Note that --short or -S gives status flags for each item, similar
150
to Subversion's status command. To get output similar to svn -q,
153
If no arguments are specified, the status of the entire working
154
directory is shown. Otherwise, only the status of the specified
155
files or directories is reported. If a directory is given, status
156
is reported for everything inside that directory.
158
If a revision argument is given, the status is calculated against
159
that revision, or between two revisions if two are provided.
162
# TODO: --no-recurse, --recurse options
164
takes_args = ['file*']
165
takes_options = ['show-ids', 'revision', 'change',
166
Option('short', help='Use short status indicators.',
168
Option('versioned', help='Only show versioned files.',
171
aliases = ['st', 'stat']
173
encoding_type = 'replace'
174
_see_also = ['diff', 'revert', 'status-flags']
177
def run(self, show_ids=False, file_list=None, revision=None, short=False,
179
from bzrlib.status import show_tree_status
181
if revision and len(revision) > 2:
182
raise errors.BzrCommandError('bzr status --revision takes exactly'
183
' one or two revision specifiers')
185
tree, file_list = tree_files(file_list)
187
show_tree_status(tree, show_ids=show_ids,
188
specific_files=file_list, revision=revision,
189
to_file=self.outf, short=short, versioned=versioned)
192
class cmd_cat_revision(Command):
193
"""Write out metadata for a revision.
195
The revision to print can either be specified by a specific
196
revision identifier, or you can use --revision.
200
takes_args = ['revision_id?']
201
takes_options = ['revision']
202
# cat-revision is more for frontends so should be exact
206
def run(self, revision_id=None, revision=None):
208
revision_id = osutils.safe_revision_id(revision_id, warn=False)
209
if revision_id is not None and revision is not None:
210
raise errors.BzrCommandError('You can only supply one of'
211
' revision_id or --revision')
212
if revision_id is None and revision is None:
213
raise errors.BzrCommandError('You must supply either'
214
' --revision or a revision_id')
215
b = WorkingTree.open_containing(u'.')[0].branch
217
# TODO: jam 20060112 should cat-revision always output utf-8?
218
if revision_id is not None:
219
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
220
elif revision is not None:
223
raise errors.BzrCommandError('You cannot specify a NULL'
225
revno, rev_id = rev.in_history(b)
226
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
229
class cmd_remove_tree(Command):
230
"""Remove the working tree from a given branch/checkout.
232
Since a lightweight checkout is little more than a working tree
233
this will refuse to run against one.
235
To re-create the working tree, use "bzr checkout".
237
_see_also = ['checkout', 'working-trees']
239
takes_args = ['location?']
241
def run(self, location='.'):
242
d = bzrdir.BzrDir.open(location)
245
working = d.open_workingtree()
246
except errors.NoWorkingTree:
247
raise errors.BzrCommandError("No working tree to remove")
248
except errors.NotLocalUrl:
249
raise errors.BzrCommandError("You cannot remove the working tree of a "
252
working_path = working.bzrdir.root_transport.base
253
branch_path = working.branch.bzrdir.root_transport.base
254
if working_path != branch_path:
255
raise errors.BzrCommandError("You cannot remove the working tree from "
256
"a lightweight checkout")
258
d.destroy_workingtree()
261
class cmd_revno(Command):
262
"""Show current revision number.
264
This is equal to the number of revisions on this branch.
268
takes_args = ['location?']
271
def run(self, location=u'.'):
272
self.outf.write(str(Branch.open_containing(location)[0].revno()))
273
self.outf.write('\n')
276
class cmd_revision_info(Command):
277
"""Show revision number and revision id for a given revision identifier.
280
takes_args = ['revision_info*']
281
takes_options = ['revision']
284
def run(self, revision=None, revision_info_list=[]):
287
if revision is not None:
288
revs.extend(revision)
289
if revision_info_list is not None:
290
for rev in revision_info_list:
291
revs.append(RevisionSpec.from_string(rev))
293
b = Branch.open_containing(u'.')[0]
296
revs.append(RevisionSpec.from_string('-1'))
299
revinfo = rev.in_history(b)
300
if revinfo.revno is None:
301
dotted_map = b.get_revision_id_to_revno_map()
302
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
303
print '%s %s' % (revno, revinfo.rev_id)
305
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
308
class cmd_add(Command):
309
"""Add specified files or directories.
311
In non-recursive mode, all the named items are added, regardless
312
of whether they were previously ignored. A warning is given if
313
any of the named files are already versioned.
315
In recursive mode (the default), files are treated the same way
316
but the behaviour for directories is different. Directories that
317
are already versioned do not give a warning. All directories,
318
whether already versioned or not, are searched for files or
319
subdirectories that are neither versioned or ignored, and these
320
are added. This search proceeds recursively into versioned
321
directories. If no names are given '.' is assumed.
323
Therefore simply saying 'bzr add' will version all files that
324
are currently unknown.
326
Adding a file whose parent directory is not versioned will
327
implicitly add the parent, and so on up to the root. This means
328
you should never need to explicitly add a directory, they'll just
329
get added when you add a file in the directory.
331
--dry-run will show which files would be added, but not actually
334
--file-ids-from will try to use the file ids from the supplied path.
335
It looks up ids trying to find a matching parent directory with the
336
same filename, and then by pure path. This option is rarely needed
337
but can be useful when adding the same logical file into two
338
branches that will be merged later (without showing the two different
339
adds as a conflict). It is also useful when merging another project
340
into a subdirectory of this one.
342
takes_args = ['file*']
345
help="Don't recursively add the contents of directories."),
347
help="Show what would be done, but don't actually do anything."),
349
Option('file-ids-from',
351
help='Lookup file ids from this tree.'),
353
encoding_type = 'replace'
354
_see_also = ['remove']
356
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
361
if file_ids_from is not None:
363
base_tree, base_path = WorkingTree.open_containing(
365
except errors.NoWorkingTree:
366
base_branch, base_path = Branch.open_containing(
368
base_tree = base_branch.basis_tree()
370
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
371
to_file=self.outf, should_print=(not is_quiet()))
373
action = bzrlib.add.AddAction(to_file=self.outf,
374
should_print=(not is_quiet()))
377
base_tree.lock_read()
379
file_list = self._maybe_expand_globs(file_list)
381
tree = WorkingTree.open_containing(file_list[0])[0]
383
tree = WorkingTree.open_containing(u'.')[0]
384
added, ignored = tree.smart_add(file_list, not
385
no_recurse, 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
452
help='List entries of a particular kind: file, directory, symlink.',
455
takes_args = ['file*']
458
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
459
if kind and kind not in ['file', 'directory', 'symlink']:
460
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
462
work_tree, file_list = tree_files(file_list)
463
work_tree.lock_read()
465
if revision is not None:
466
if len(revision) > 1:
467
raise errors.BzrCommandError(
468
'bzr inventory --revision takes exactly one revision'
470
revision_id = revision[0].in_history(work_tree.branch).rev_id
471
tree = work_tree.branch.repository.revision_tree(revision_id)
473
extra_trees = [work_tree]
479
if file_list is not None:
480
file_ids = tree.paths2ids(file_list, trees=extra_trees,
481
require_versioned=True)
482
# find_ids_across_trees may include some paths that don't
484
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
485
for file_id in file_ids if file_id in tree)
487
entries = tree.inventory.entries()
490
if tree is not work_tree:
493
for path, entry in entries:
494
if kind and kind != entry.kind:
497
self.outf.write('%-50s %s\n' % (path, entry.file_id))
499
self.outf.write(path)
500
self.outf.write('\n')
503
class cmd_mv(Command):
504
"""Move or rename a file.
507
bzr mv OLDNAME NEWNAME
509
bzr mv SOURCE... DESTINATION
511
If the last argument is a versioned directory, all the other names
512
are moved into it. Otherwise, there must be exactly two arguments
513
and the file is changed to a new name.
515
If OLDNAME does not exist on the filesystem but is versioned and
516
NEWNAME does exist on the filesystem but is not versioned, mv
517
assumes that the file has been manually moved and only updates
518
its internal inventory to reflect that change.
519
The same is valid when moving many SOURCE files to a DESTINATION.
521
Files cannot be moved between branches.
524
takes_args = ['names*']
525
takes_options = [Option("after", help="Move only the bzr identifier"
526
" of the file, because the file has already been moved."),
528
aliases = ['move', 'rename']
529
encoding_type = 'replace'
531
def run(self, names_list, after=False):
532
if names_list is None:
535
if len(names_list) < 2:
536
raise errors.BzrCommandError("missing file argument")
537
tree, rel_names = tree_files(names_list)
539
if os.path.isdir(names_list[-1]):
540
# move into existing directory
541
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
542
self.outf.write("%s => %s\n" % pair)
544
if len(names_list) != 2:
545
raise errors.BzrCommandError('to mv multiple files the'
546
' destination must be a versioned'
548
tree.rename_one(rel_names[0], rel_names[1], after=after)
549
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
552
class cmd_pull(Command):
553
"""Turn this branch into a mirror of another branch.
555
This command only works on branches that have not diverged. Branches are
556
considered diverged if the destination branch's most recent commit is one
557
that has not been merged (directly or indirectly) into the parent.
559
If branches have diverged, you can use 'bzr merge' to integrate the changes
560
from one into the other. Once one branch has merged, the other should
561
be able to pull it again.
563
If you want to forget your local changes and just update your branch to
564
match the remote one, use pull --overwrite.
566
If there is no default location set, the first pull will set it. After
567
that, you can omit the location to use the default. To change the
568
default, use --remember. The value will only be saved if the remote
569
location can be accessed.
572
_see_also = ['push', 'update', 'status-flags']
573
takes_options = ['remember', 'overwrite', 'revision',
574
custom_help('verbose',
575
help='Show logs of pulled revisions.'),
577
help='Branch to pull into, '
578
'rather than the one containing the working directory.',
583
takes_args = ['location?']
584
encoding_type = 'replace'
586
def run(self, location=None, remember=False, overwrite=False,
587
revision=None, verbose=False,
589
# FIXME: too much stuff is in the command class
592
if directory is None:
595
tree_to = WorkingTree.open_containing(directory)[0]
596
branch_to = tree_to.branch
597
except errors.NoWorkingTree:
599
branch_to = Branch.open_containing(directory)[0]
601
possible_transports = []
602
if location is not None:
603
mergeable, location_transport = _get_mergeable_helper(location)
604
possible_transports.append(location_transport)
606
stored_loc = branch_to.get_parent()
608
if stored_loc is None:
609
raise errors.BzrCommandError("No pull location known or"
612
display_url = urlutils.unescape_for_display(stored_loc,
614
self.outf.write("Using saved location: %s\n" % display_url)
615
location = stored_loc
616
location_transport = transport.get_transport(
617
location, possible_transports=possible_transports)
619
if mergeable is not None:
620
if revision is not None:
621
raise errors.BzrCommandError(
622
'Cannot use -r with merge directives or bundles')
623
mergeable.install_revisions(branch_to.repository)
624
base_revision_id, revision_id, verified = \
625
mergeable.get_merge_request(branch_to.repository)
626
branch_from = branch_to
628
branch_from = Branch.open_from_transport(location_transport)
630
if branch_to.get_parent() is None or remember:
631
branch_to.set_parent(branch_from.base)
633
if revision is not None:
634
if len(revision) == 1:
635
revision_id = revision[0].in_history(branch_from).rev_id
637
raise errors.BzrCommandError(
638
'bzr pull --revision takes one value.')
641
old_rh = branch_to.revision_history()
642
if tree_to is not None:
643
change_reporter = delta._ChangeReporter(
644
unversioned_filter=tree_to.is_ignored)
645
result = tree_to.pull(branch_from, overwrite, revision_id,
647
possible_transports=possible_transports)
649
result = branch_to.pull(branch_from, overwrite, revision_id)
651
result.report(self.outf)
653
new_rh = branch_to.revision_history()
654
log.show_changed_revisions(branch_to, old_rh, new_rh,
658
class cmd_push(Command):
659
"""Update a mirror of this branch.
661
The target branch will not have its working tree populated because this
662
is both expensive, and is not supported on remote file systems.
664
Some smart servers or protocols *may* put the working tree in place in
667
This command only works on branches that have not diverged. Branches are
668
considered diverged if the destination branch's most recent commit is one
669
that has not been merged (directly or indirectly) by the source branch.
671
If branches have diverged, you can use 'bzr push --overwrite' to replace
672
the other branch completely, discarding its unmerged changes.
674
If you want to ensure you have the different changes in the other branch,
675
do a merge (see bzr help merge) from the other branch, and commit that.
676
After that you will be able to do a push without '--overwrite'.
678
If there is no default push location set, the first push will set it.
679
After that, you can omit the location to use the default. To change the
680
default, use --remember. The value will only be saved if the remote
681
location can be accessed.
684
_see_also = ['pull', 'update', 'working-trees']
685
takes_options = ['remember', 'overwrite', 'verbose',
686
Option('create-prefix',
687
help='Create the path leading up to the branch '
688
'if it does not already exist.'),
690
help='Branch to push from, '
691
'rather than the one containing the working directory.',
695
Option('use-existing-dir',
696
help='By default push will fail if the target'
697
' directory exists, but does not already'
698
' have a control directory. This flag will'
699
' allow push to proceed.'),
701
takes_args = ['location?']
702
encoding_type = 'replace'
704
def run(self, location=None, remember=False, overwrite=False,
705
create_prefix=False, verbose=False,
706
use_existing_dir=False,
708
# FIXME: Way too big! Put this into a function called from the
710
if directory is None:
712
br_from = Branch.open_containing(directory)[0]
713
stored_loc = br_from.get_push_location()
715
if stored_loc is None:
716
raise errors.BzrCommandError("No push location known or specified.")
718
display_url = urlutils.unescape_for_display(stored_loc,
720
self.outf.write("Using saved location: %s\n" % display_url)
721
location = stored_loc
723
to_transport = transport.get_transport(location)
725
br_to = repository_to = dir_to = None
727
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
728
except errors.NotBranchError:
729
pass # Didn't find anything
731
# If we can open a branch, use its direct repository, otherwise see
732
# if there is a repository without a branch.
734
br_to = dir_to.open_branch()
735
except errors.NotBranchError:
736
# Didn't find a branch, can we find a repository?
738
repository_to = dir_to.find_repository()
739
except errors.NoRepositoryPresent:
742
# Found a branch, so we must have found a repository
743
repository_to = br_to.repository
748
# The destination doesn't exist; create it.
749
# XXX: Refactor the create_prefix/no_create_prefix code into a
750
# common helper function
752
to_transport.mkdir('.')
753
except errors.FileExists:
754
if not use_existing_dir:
755
raise errors.BzrCommandError("Target directory %s"
756
" already exists, but does not have a valid .bzr"
757
" directory. Supply --use-existing-dir to push"
758
" there anyway." % location)
759
except errors.NoSuchFile:
760
if not create_prefix:
761
raise errors.BzrCommandError("Parent directory of %s"
763
"\nYou may supply --create-prefix to create all"
764
" leading parent directories."
766
_create_prefix(to_transport)
768
# Now the target directory exists, but doesn't have a .bzr
769
# directory. So we need to create it, along with any work to create
770
# all of the dependent branches, etc.
771
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
772
revision_id=br_from.last_revision())
773
br_to = dir_to.open_branch()
774
# TODO: Some more useful message about what was copied
775
note('Created new branch.')
776
# We successfully created the target, remember it
777
if br_from.get_push_location() is None or remember:
778
br_from.set_push_location(br_to.base)
779
elif repository_to is None:
780
# we have a bzrdir but no branch or repository
781
# XXX: Figure out what to do other than complain.
782
raise errors.BzrCommandError("At %s you have a valid .bzr control"
783
" directory, but not a branch or repository. This is an"
784
" unsupported configuration. Please move the target directory"
785
" out of the way and try again."
788
# We have a repository but no branch, copy the revisions, and then
790
last_revision_id = br_from.last_revision()
791
repository_to.fetch(br_from.repository,
792
revision_id=last_revision_id)
793
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
794
note('Created new branch.')
795
if br_from.get_push_location() is None or remember:
796
br_from.set_push_location(br_to.base)
797
else: # We have a valid to branch
798
# We were able to connect to the remote location, so remember it
799
# we don't need to successfully push because of possible divergence.
800
if br_from.get_push_location() is None or remember:
801
br_from.set_push_location(br_to.base)
803
old_rh = br_to.revision_history()
806
tree_to = dir_to.open_workingtree()
807
except errors.NotLocalUrl:
808
warning("This transport does not update the working "
809
"tree of: %s. See 'bzr help working-trees' for "
810
"more information." % br_to.base)
811
push_result = br_from.push(br_to, overwrite)
812
except errors.NoWorkingTree:
813
push_result = br_from.push(br_to, overwrite)
817
push_result = br_from.push(tree_to.branch, overwrite)
821
except errors.DivergedBranches:
822
raise errors.BzrCommandError('These branches have diverged.'
823
' Try using "merge" and then "push".')
824
if push_result is not None:
825
push_result.report(self.outf)
827
new_rh = br_to.revision_history()
830
from bzrlib.log import show_changed_revisions
831
show_changed_revisions(br_to, old_rh, new_rh,
834
# we probably did a clone rather than a push, so a message was
839
class cmd_branch(Command):
840
"""Create a new copy of a branch.
842
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
843
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
844
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
845
is derived from the FROM_LOCATION by stripping a leading scheme or drive
846
identifier, if any. For example, "branch lp:foo-bar" will attempt to
849
To retrieve the branch as of a particular revision, supply the --revision
850
parameter, as in "branch foo/bar -r 5".
853
_see_also = ['checkout']
854
takes_args = ['from_location', 'to_location?']
855
takes_options = ['revision']
856
aliases = ['get', 'clone']
858
def run(self, from_location, to_location=None, revision=None):
859
from bzrlib.tag import _merge_tags_if_possible
862
elif len(revision) > 1:
863
raise errors.BzrCommandError(
864
'bzr branch --revision takes exactly 1 revision value')
866
br_from = Branch.open(from_location)
869
if len(revision) == 1 and revision[0] is not None:
870
revision_id = revision[0].in_history(br_from)[1]
872
# FIXME - wt.last_revision, fallback to branch, fall back to
873
# None or perhaps NULL_REVISION to mean copy nothing
875
revision_id = br_from.last_revision()
876
if to_location is None:
877
to_location = urlutils.derive_to_location(from_location)
880
name = os.path.basename(to_location) + '\n'
882
to_transport = transport.get_transport(to_location)
884
to_transport.mkdir('.')
885
except errors.FileExists:
886
raise errors.BzrCommandError('Target directory "%s" already'
887
' exists.' % to_location)
888
except errors.NoSuchFile:
889
raise errors.BzrCommandError('Parent of "%s" does not exist.'
892
# preserve whatever source format we have.
893
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
894
possible_transports=[to_transport])
895
branch = dir.open_branch()
896
except errors.NoSuchRevision:
897
to_transport.delete_tree('.')
898
msg = "The branch %s has no revision %s." % (from_location, revision[0])
899
raise errors.BzrCommandError(msg)
901
branch.control_files.put_utf8('branch-name', name)
902
_merge_tags_if_possible(br_from, branch)
903
note('Branched %d revision(s).' % branch.revno())
908
class cmd_checkout(Command):
909
"""Create a new checkout of an existing branch.
911
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
912
the branch found in '.'. This is useful if you have removed the working tree
913
or if it was never created - i.e. if you pushed the branch to its current
916
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
917
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
918
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
919
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
920
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
923
To retrieve the branch as of a particular revision, supply the --revision
924
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
925
out of date [so you cannot commit] but it may be useful (i.e. to examine old
929
_see_also = ['checkouts', 'branch']
930
takes_args = ['branch_location?', 'to_location?']
931
takes_options = ['revision',
932
Option('lightweight',
933
help="Perform a lightweight checkout. Lightweight "
934
"checkouts depend on access to the branch for "
935
"every operation. Normal checkouts can perform "
936
"common operations like diff and status without "
937
"such access, and also support local commits."
942
def run(self, branch_location=None, to_location=None, revision=None,
946
elif len(revision) > 1:
947
raise errors.BzrCommandError(
948
'bzr checkout --revision takes exactly 1 revision value')
949
if branch_location is None:
950
branch_location = osutils.getcwd()
951
to_location = branch_location
952
source = Branch.open(branch_location)
953
if len(revision) == 1 and revision[0] is not None:
954
revision_id = _mod_revision.ensure_null(
955
revision[0].in_history(source)[1])
958
if to_location is None:
959
to_location = urlutils.derive_to_location(branch_location)
960
# if the source and to_location are the same,
961
# and there is no working tree,
962
# then reconstitute a branch
963
if (osutils.abspath(to_location) ==
964
osutils.abspath(branch_location)):
966
source.bzrdir.open_workingtree()
967
except errors.NoWorkingTree:
968
source.bzrdir.create_workingtree(revision_id)
970
source.create_checkout(to_location, revision_id, lightweight)
973
class cmd_renames(Command):
974
"""Show list of renamed files.
976
# TODO: Option to show renames between two historical versions.
978
# TODO: Only show renames under dir, rather than in the whole branch.
979
_see_also = ['status']
980
takes_args = ['dir?']
983
def run(self, dir=u'.'):
984
tree = WorkingTree.open_containing(dir)[0]
987
new_inv = tree.inventory
988
old_tree = tree.basis_tree()
991
old_inv = old_tree.inventory
992
renames = list(_mod_tree.find_renames(old_inv, new_inv))
994
for old_name, new_name in renames:
995
self.outf.write("%s => %s\n" % (old_name, new_name))
1002
class cmd_update(Command):
1003
"""Update a tree to have the latest code committed to its branch.
1005
This will perform a merge into the working tree, and may generate
1006
conflicts. If you have any local changes, you will still
1007
need to commit them after the update for the update to be complete.
1009
If you want to discard your local changes, you can just do a
1010
'bzr revert' instead of 'bzr commit' after the update.
1013
_see_also = ['pull', 'working-trees', 'status-flags']
1014
takes_args = ['dir?']
1017
def run(self, dir='.'):
1018
tree = WorkingTree.open_containing(dir)[0]
1019
possible_transports = []
1020
master = tree.branch.get_master_branch(
1021
possible_transports=possible_transports)
1022
if master is not None:
1025
tree.lock_tree_write()
1027
existing_pending_merges = tree.get_parent_ids()[1:]
1028
last_rev = _mod_revision.ensure_null(tree.last_revision())
1029
if last_rev == _mod_revision.ensure_null(
1030
tree.branch.last_revision()):
1031
# may be up to date, check master too.
1032
if master is None or last_rev == _mod_revision.ensure_null(
1033
master.last_revision()):
1034
revno = tree.branch.revision_id_to_revno(last_rev)
1035
note("Tree is up to date at revision %d." % (revno,))
1037
conflicts = tree.update(
1038
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1039
possible_transports=possible_transports)
1040
revno = tree.branch.revision_id_to_revno(
1041
_mod_revision.ensure_null(tree.last_revision()))
1042
note('Updated to revision %d.' % (revno,))
1043
if tree.get_parent_ids()[1:] != existing_pending_merges:
1044
note('Your local commits will now show as pending merges with '
1045
"'bzr status', and can be committed with 'bzr commit'.")
1054
class cmd_info(Command):
1055
"""Show information about a working tree, branch or repository.
1057
This command will show all known locations and formats associated to the
1058
tree, branch or repository. Statistical information is included with
1061
Branches and working trees will also report any missing revisions.
1063
_see_also = ['revno', 'working-trees', 'repositories']
1064
takes_args = ['location?']
1065
takes_options = ['verbose']
1068
def run(self, location=None, verbose=False):
1073
from bzrlib.info import show_bzrdir_info
1074
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1075
verbose=noise_level)
1078
class cmd_remove(Command):
1079
"""Remove files or directories.
1081
This makes bzr stop tracking changes to the specified files and
1082
delete them if they can easily be recovered using revert.
1084
You can specify one or more files, and/or --new. If you specify --new,
1085
only 'added' files will be removed. If you specify both, then new files
1086
in the specified directories will be removed. If the directories are
1087
also new, they will also be removed.
1089
takes_args = ['file*']
1090
takes_options = ['verbose',
1091
Option('new', help='Remove newly-added files.'),
1092
RegistryOption.from_kwargs('file-deletion-strategy',
1093
'The file deletion mode to be used.',
1094
title='Deletion Strategy', value_switches=True, enum_switch=False,
1095
safe='Only delete files if they can be'
1096
' safely recovered (default).',
1097
keep="Don't delete any files.",
1098
force='Delete all the specified files, even if they can not be '
1099
'recovered and even if they are non-empty directories.')]
1101
encoding_type = 'replace'
1103
def run(self, file_list, verbose=False, new=False,
1104
file_deletion_strategy='safe'):
1105
tree, file_list = tree_files(file_list)
1107
if file_list is not None:
1108
file_list = [f for f in file_list]
1110
raise errors.BzrCommandError('Specify one or more files to'
1111
' remove, or use --new.')
1114
added = tree.changes_from(tree.basis_tree(),
1115
specific_files=file_list).added
1116
file_list = sorted([f[0] for f in added], reverse=True)
1117
if len(file_list) == 0:
1118
raise errors.BzrCommandError('No matching files.')
1119
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1120
keep_files=file_deletion_strategy=='keep',
1121
force=file_deletion_strategy=='force')
1124
class cmd_file_id(Command):
1125
"""Print file_id of a particular file or directory.
1127
The file_id is assigned when the file is first added and remains the
1128
same through all revisions where the file exists, even when it is
1133
_see_also = ['inventory', 'ls']
1134
takes_args = ['filename']
1137
def run(self, filename):
1138
tree, relpath = WorkingTree.open_containing(filename)
1139
i = tree.path2id(relpath)
1141
raise errors.NotVersionedError(filename)
1143
self.outf.write(i + '\n')
1146
class cmd_file_path(Command):
1147
"""Print path of file_ids to a file or directory.
1149
This prints one line for each directory down to the target,
1150
starting at the branch root.
1154
takes_args = ['filename']
1157
def run(self, filename):
1158
tree, relpath = WorkingTree.open_containing(filename)
1159
fid = tree.path2id(relpath)
1161
raise errors.NotVersionedError(filename)
1162
segments = osutils.splitpath(relpath)
1163
for pos in range(1, len(segments) + 1):
1164
path = osutils.joinpath(segments[:pos])
1165
self.outf.write("%s\n" % tree.path2id(path))
1168
class cmd_reconcile(Command):
1169
"""Reconcile bzr metadata in a branch.
1171
This can correct data mismatches that may have been caused by
1172
previous ghost operations or bzr upgrades. You should only
1173
need to run this command if 'bzr check' or a bzr developer
1174
advises you to run it.
1176
If a second branch is provided, cross-branch reconciliation is
1177
also attempted, which will check that data like the tree root
1178
id which was not present in very early bzr versions is represented
1179
correctly in both branches.
1181
At the same time it is run it may recompress data resulting in
1182
a potential saving in disk space or performance gain.
1184
The branch *MUST* be on a listable system such as local disk or sftp.
1187
_see_also = ['check']
1188
takes_args = ['branch?']
1190
def run(self, branch="."):
1191
from bzrlib.reconcile import reconcile
1192
dir = bzrdir.BzrDir.open(branch)
1196
class cmd_revision_history(Command):
1197
"""Display the list of revision ids on a branch."""
1200
takes_args = ['location?']
1205
def run(self, location="."):
1206
branch = Branch.open_containing(location)[0]
1207
for revid in branch.revision_history():
1208
self.outf.write(revid)
1209
self.outf.write('\n')
1212
class cmd_ancestry(Command):
1213
"""List all revisions merged into this branch."""
1215
_see_also = ['log', 'revision-history']
1216
takes_args = ['location?']
1221
def run(self, location="."):
1223
wt = WorkingTree.open_containing(location)[0]
1224
except errors.NoWorkingTree:
1225
b = Branch.open(location)
1226
last_revision = b.last_revision()
1229
last_revision = wt.last_revision()
1231
revision_ids = b.repository.get_ancestry(last_revision)
1232
assert revision_ids[0] is None
1234
for revision_id in revision_ids:
1235
self.outf.write(revision_id + '\n')
1238
class cmd_init(Command):
1239
"""Make a directory into a versioned branch.
1241
Use this to create an empty branch, or before importing an
1244
If there is a repository in a parent directory of the location, then
1245
the history of the branch will be stored in the repository. Otherwise
1246
init creates a standalone branch which carries its own history
1247
in the .bzr directory.
1249
If there is already a branch at the location but it has no working tree,
1250
the tree can be populated with 'bzr checkout'.
1252
Recipe for importing a tree of files::
1258
bzr commit -m 'imported project'
1261
_see_also = ['init-repository', 'branch', 'checkout']
1262
takes_args = ['location?']
1264
Option('create-prefix',
1265
help='Create the path leading up to the branch '
1266
'if it does not already exist.'),
1267
RegistryOption('format',
1268
help='Specify a format for this branch. '
1269
'See "help formats".',
1270
registry=bzrdir.format_registry,
1271
converter=bzrdir.format_registry.make_bzrdir,
1272
value_switches=True,
1273
title="Branch Format",
1275
Option('append-revisions-only',
1276
help='Never change revnos or the existing log.'
1277
' Append revisions to it only.')
1279
def run(self, location=None, format=None, append_revisions_only=False,
1280
create_prefix=False):
1282
format = bzrdir.format_registry.make_bzrdir('default')
1283
if location is None:
1286
to_transport = transport.get_transport(location)
1288
# The path has to exist to initialize a
1289
# branch inside of it.
1290
# Just using os.mkdir, since I don't
1291
# believe that we want to create a bunch of
1292
# locations if the user supplies an extended path
1294
to_transport.ensure_base()
1295
except errors.NoSuchFile:
1296
if not create_prefix:
1297
raise errors.BzrCommandError("Parent directory of %s"
1299
"\nYou may supply --create-prefix to create all"
1300
" leading parent directories."
1302
_create_prefix(to_transport)
1305
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1306
except errors.NotBranchError:
1307
# really a NotBzrDir error...
1308
create_branch = bzrdir.BzrDir.create_branch_convenience
1309
branch = create_branch(to_transport.base, format=format,
1310
possible_transports=[to_transport])
1312
from bzrlib.transport.local import LocalTransport
1313
if existing_bzrdir.has_branch():
1314
if (isinstance(to_transport, LocalTransport)
1315
and not existing_bzrdir.has_workingtree()):
1316
raise errors.BranchExistsWithoutWorkingTree(location)
1317
raise errors.AlreadyBranchError(location)
1319
branch = existing_bzrdir.create_branch()
1320
existing_bzrdir.create_workingtree()
1321
if append_revisions_only:
1323
branch.set_append_revisions_only(True)
1324
except errors.UpgradeRequired:
1325
raise errors.BzrCommandError('This branch format cannot be set'
1326
' to append-revisions-only. Try --experimental-branch6')
1329
class cmd_init_repository(Command):
1330
"""Create a shared repository to hold branches.
1332
New branches created under the repository directory will store their
1333
revisions in the repository, not in the branch directory.
1335
If the --no-trees option is used then the branches in the repository
1336
will not have working trees by default.
1339
Create a shared repositories holding just branches::
1341
bzr init-repo --no-trees repo
1344
Make a lightweight checkout elsewhere::
1346
bzr checkout --lightweight repo/trunk trunk-checkout
1351
_see_also = ['init', 'branch', 'checkout', 'repositories']
1352
takes_args = ["location"]
1353
takes_options = [RegistryOption('format',
1354
help='Specify a format for this repository. See'
1355
' "bzr help formats" for details.',
1356
registry=bzrdir.format_registry,
1357
converter=bzrdir.format_registry.make_bzrdir,
1358
value_switches=True, title='Repository format'),
1360
help='Branches in the repository will default to'
1361
' not having a working tree.'),
1363
aliases = ["init-repo"]
1365
def run(self, location, format=None, no_trees=False):
1367
format = bzrdir.format_registry.make_bzrdir('default')
1369
if location is None:
1372
to_transport = transport.get_transport(location)
1373
to_transport.ensure_base()
1375
newdir = format.initialize_on_transport(to_transport)
1376
repo = newdir.create_repository(shared=True)
1377
repo.set_make_working_trees(not no_trees)
1380
class cmd_diff(Command):
1381
"""Show differences in the working tree or between revisions.
1383
If files are listed, only the changes in those files are listed.
1384
Otherwise, all changes for the tree are listed.
1386
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1387
produces patches suitable for "patch -p1".
1390
Shows the difference in the working tree versus the last commit::
1394
Difference between the working tree and revision 1::
1398
Difference between revision 2 and revision 1::
1402
Same as 'bzr diff' but prefix paths with old/ and new/::
1404
bzr diff --prefix old/:new/
1406
Show the differences between the two working trees::
1408
bzr diff bzr.mine bzr.dev
1410
Show just the differences for 'foo.c'::
1414
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1415
# or a graphical diff.
1417
# TODO: Python difflib is not exactly the same as unidiff; should
1418
# either fix it up or prefer to use an external diff.
1420
# TODO: Selected-file diff is inefficient and doesn't show you
1423
# TODO: This probably handles non-Unix newlines poorly.
1425
_see_also = ['status']
1426
takes_args = ['file*']
1428
Option('diff-options', type=str,
1429
help='Pass these options to the external diff program.'),
1430
Option('prefix', type=str,
1432
help='Set prefixes added to old and new filenames, as '
1433
'two values separated by a colon. (eg "old/:new/").'),
1437
aliases = ['di', 'dif']
1438
encoding_type = 'exact'
1441
def run(self, revision=None, file_list=None, diff_options=None,
1443
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1445
if (prefix is None) or (prefix == '0'):
1453
old_label, new_label = prefix.split(":")
1455
raise errors.BzrCommandError(
1456
'--prefix expects two values separated by a colon'
1457
' (eg "old/:new/")')
1459
if revision and len(revision) > 2:
1460
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1461
' one or two revision specifiers')
1464
tree1, file_list = internal_tree_files(file_list)
1468
except errors.FileInWrongBranch:
1469
if len(file_list) != 2:
1470
raise errors.BzrCommandError("Files are in different branches")
1472
tree1, file1 = WorkingTree.open_containing(file_list[0])
1473
tree2, file2 = WorkingTree.open_containing(file_list[1])
1474
if file1 != "" or file2 != "":
1475
# FIXME diff those two files. rbc 20051123
1476
raise errors.BzrCommandError("Files are in different branches")
1478
except errors.NotBranchError:
1479
if (revision is not None and len(revision) == 2
1480
and not revision[0].needs_branch()
1481
and not revision[1].needs_branch()):
1482
# If both revision specs include a branch, we can
1483
# diff them without needing a local working tree
1484
tree1, tree2 = None, None
1488
if tree2 is not None:
1489
if revision is not None:
1490
# FIXME: but there should be a clean way to diff between
1491
# non-default versions of two trees, it's not hard to do
1493
raise errors.BzrCommandError(
1494
"Sorry, diffing arbitrary revisions across branches "
1495
"is not implemented yet")
1496
return show_diff_trees(tree1, tree2, sys.stdout,
1497
specific_files=file_list,
1498
external_diff_options=diff_options,
1499
old_label=old_label, new_label=new_label)
1501
return diff_cmd_helper(tree1, file_list, diff_options,
1502
revision_specs=revision,
1503
old_label=old_label, new_label=new_label)
1506
class cmd_deleted(Command):
1507
"""List files deleted in the working tree.
1509
# TODO: Show files deleted since a previous revision, or
1510
# between two revisions.
1511
# TODO: Much more efficient way to do this: read in new
1512
# directories with readdir, rather than stating each one. Same
1513
# level of effort but possibly much less IO. (Or possibly not,
1514
# if the directories are very large...)
1515
_see_also = ['status', 'ls']
1516
takes_options = ['show-ids']
1519
def run(self, show_ids=False):
1520
tree = WorkingTree.open_containing(u'.')[0]
1523
old = tree.basis_tree()
1526
for path, ie in old.inventory.iter_entries():
1527
if not tree.has_id(ie.file_id):
1528
self.outf.write(path)
1530
self.outf.write(' ')
1531
self.outf.write(ie.file_id)
1532
self.outf.write('\n')
1539
class cmd_modified(Command):
1540
"""List files modified in working tree.
1544
_see_also = ['status', 'ls']
1548
tree = WorkingTree.open_containing(u'.')[0]
1549
td = tree.changes_from(tree.basis_tree())
1550
for path, id, kind, text_modified, meta_modified in td.modified:
1551
self.outf.write(path + '\n')
1554
class cmd_added(Command):
1555
"""List files added in working tree.
1559
_see_also = ['status', 'ls']
1563
wt = WorkingTree.open_containing(u'.')[0]
1566
basis = wt.basis_tree()
1569
basis_inv = basis.inventory
1572
if file_id in basis_inv:
1574
if inv.is_root(file_id) and len(basis_inv) == 0:
1576
path = inv.id2path(file_id)
1577
if not os.access(osutils.abspath(path), os.F_OK):
1579
self.outf.write(path + '\n')
1586
class cmd_root(Command):
1587
"""Show the tree root directory.
1589
The root is the nearest enclosing directory with a .bzr control
1592
takes_args = ['filename?']
1594
def run(self, filename=None):
1595
"""Print the branch root."""
1596
tree = WorkingTree.open_containing(filename)[0]
1597
self.outf.write(tree.basedir + '\n')
1600
def _parse_limit(limitstring):
1602
return int(limitstring)
1604
msg = "The limit argument must be an integer."
1605
raise errors.BzrCommandError(msg)
1608
class cmd_log(Command):
1609
"""Show log of a branch, file, or directory.
1611
By default show the log of the branch containing the working directory.
1613
To request a range of logs, you can use the command -r begin..end
1614
-r revision requests a specific revision, -r ..end or -r begin.. are
1618
Log the current branch::
1626
Log the last 10 revisions of a branch::
1628
bzr log -r -10.. http://server/branch
1631
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1633
takes_args = ['location?']
1636
help='Show from oldest to newest.'),
1639
help='Display timezone as local, original, or utc.'),
1640
custom_help('verbose',
1641
help='Show files changed in each revision.'),
1647
help='Show revisions whose message matches this '
1648
'regular expression.',
1651
help='Limit the output to the first N revisions.',
1655
encoding_type = 'replace'
1658
def run(self, location=None, timezone='original',
1666
from bzrlib.log import show_log
1667
assert message is None or isinstance(message, basestring), \
1668
"invalid message argument %r" % message
1669
direction = (forward and 'forward') or 'reverse'
1674
# find the file id to log:
1676
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1680
tree = b.basis_tree()
1681
file_id = tree.path2id(fp)
1683
raise errors.BzrCommandError(
1684
"Path does not have any revision history: %s" %
1688
# FIXME ? log the current subdir only RBC 20060203
1689
if revision is not None \
1690
and len(revision) > 0 and revision[0].get_branch():
1691
location = revision[0].get_branch()
1694
dir, relpath = bzrdir.BzrDir.open_containing(location)
1695
b = dir.open_branch()
1699
if revision is None:
1702
elif len(revision) == 1:
1703
rev1 = rev2 = revision[0].in_history(b)
1704
elif len(revision) == 2:
1705
if revision[1].get_branch() != revision[0].get_branch():
1706
# b is taken from revision[0].get_branch(), and
1707
# show_log will use its revision_history. Having
1708
# different branches will lead to weird behaviors.
1709
raise errors.BzrCommandError(
1710
"Log doesn't accept two revisions in different"
1712
rev1 = revision[0].in_history(b)
1713
rev2 = revision[1].in_history(b)
1715
raise errors.BzrCommandError(
1716
'bzr log --revision takes one or two values.')
1718
if log_format is None:
1719
log_format = log.log_formatter_registry.get_default(b)
1721
lf = log_format(show_ids=show_ids, to_file=self.outf,
1722
show_timezone=timezone)
1728
direction=direction,
1729
start_revision=rev1,
1737
def get_log_format(long=False, short=False, line=False, default='long'):
1738
log_format = default
1742
log_format = 'short'
1748
class cmd_touching_revisions(Command):
1749
"""Return revision-ids which affected a particular file.
1751
A more user-friendly interface is "bzr log FILE".
1755
takes_args = ["filename"]
1758
def run(self, filename):
1759
tree, relpath = WorkingTree.open_containing(filename)
1761
file_id = tree.path2id(relpath)
1762
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1763
self.outf.write("%6d %s\n" % (revno, what))
1766
class cmd_ls(Command):
1767
"""List files in a tree.
1770
_see_also = ['status', 'cat']
1771
takes_args = ['path?']
1772
# TODO: Take a revision or remote path and list that tree instead.
1776
Option('non-recursive',
1777
help='Don\'t recurse into subdirectories.'),
1779
help='Print paths relative to the root of the branch.'),
1780
Option('unknown', help='Print unknown files.'),
1781
Option('versioned', help='Print versioned files.'),
1782
Option('ignored', help='Print ignored files.'),
1784
help='Write an ascii NUL (\\0) separator '
1785
'between files rather than a newline.'),
1787
help='List entries of a particular kind: file, directory, symlink.',
1792
def run(self, revision=None, verbose=False,
1793
non_recursive=False, from_root=False,
1794
unknown=False, versioned=False, ignored=False,
1795
null=False, kind=None, show_ids=False, path=None):
1797
if kind and kind not in ('file', 'directory', 'symlink'):
1798
raise errors.BzrCommandError('invalid kind specified')
1800
if verbose and null:
1801
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1802
all = not (unknown or versioned or ignored)
1804
selection = {'I':ignored, '?':unknown, 'V':versioned}
1811
raise errors.BzrCommandError('cannot specify both --from-root'
1815
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1821
if revision is not None:
1822
tree = branch.repository.revision_tree(
1823
revision[0].in_history(branch).rev_id)
1825
tree = branch.basis_tree()
1829
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1830
if fp.startswith(relpath):
1831
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1832
if non_recursive and '/' in fp:
1834
if not all and not selection[fc]:
1836
if kind is not None and fkind != kind:
1839
kindch = entry.kind_character()
1840
outstring = '%-8s %s%s' % (fc, fp, kindch)
1841
if show_ids and fid is not None:
1842
outstring = "%-50s %s" % (outstring, fid)
1843
self.outf.write(outstring + '\n')
1845
self.outf.write(fp + '\0')
1848
self.outf.write(fid)
1849
self.outf.write('\0')
1857
self.outf.write('%-50s %s\n' % (fp, my_id))
1859
self.outf.write(fp + '\n')
1864
class cmd_unknowns(Command):
1865
"""List unknown files.
1873
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1874
self.outf.write(osutils.quotefn(f) + '\n')
1877
class cmd_ignore(Command):
1878
"""Ignore specified files or patterns.
1880
To remove patterns from the ignore list, edit the .bzrignore file.
1882
Trailing slashes on patterns are ignored.
1883
If the pattern contains a slash or is a regular expression, it is compared
1884
to the whole path from the branch root. Otherwise, it is compared to only
1885
the last component of the path. To match a file only in the root
1886
directory, prepend './'.
1888
Ignore patterns specifying absolute paths are not allowed.
1890
Ignore patterns may include globbing wildcards such as::
1892
? - Matches any single character except '/'
1893
* - Matches 0 or more characters except '/'
1894
/**/ - Matches 0 or more directories in a path
1895
[a-z] - Matches a single character from within a group of characters
1897
Ignore patterns may also be Python regular expressions.
1898
Regular expression ignore patterns are identified by a 'RE:' prefix
1899
followed by the regular expression. Regular expression ignore patterns
1900
may not include named or numbered groups.
1902
Note: ignore patterns containing shell wildcards must be quoted from
1906
Ignore the top level Makefile::
1908
bzr ignore ./Makefile
1910
Ignore class files in all directories::
1912
bzr ignore '*.class'
1914
Ignore .o files under the lib directory::
1916
bzr ignore 'lib/**/*.o'
1918
Ignore .o files under the lib directory::
1920
bzr ignore 'RE:lib/.*\.o'
1923
_see_also = ['status', 'ignored']
1924
takes_args = ['name_pattern*']
1926
Option('old-default-rules',
1927
help='Write out the ignore rules bzr < 0.9 always used.')
1930
def run(self, name_pattern_list=None, old_default_rules=None):
1931
from bzrlib.atomicfile import AtomicFile
1932
if old_default_rules is not None:
1933
# dump the rules and exit
1934
for pattern in ignores.OLD_DEFAULTS:
1937
if not name_pattern_list:
1938
raise errors.BzrCommandError("ignore requires at least one "
1939
"NAME_PATTERN or --old-default-rules")
1940
name_pattern_list = [globbing.normalize_pattern(p)
1941
for p in name_pattern_list]
1942
for name_pattern in name_pattern_list:
1943
if (name_pattern[0] == '/' or
1944
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1945
raise errors.BzrCommandError(
1946
"NAME_PATTERN should not be an absolute path")
1947
tree, relpath = WorkingTree.open_containing(u'.')
1948
ifn = tree.abspath('.bzrignore')
1949
if os.path.exists(ifn):
1952
igns = f.read().decode('utf-8')
1958
# TODO: If the file already uses crlf-style termination, maybe
1959
# we should use that for the newly added lines?
1961
if igns and igns[-1] != '\n':
1963
for name_pattern in name_pattern_list:
1964
igns += name_pattern + '\n'
1966
f = AtomicFile(ifn, 'wb')
1968
f.write(igns.encode('utf-8'))
1973
if not tree.path2id('.bzrignore'):
1974
tree.add(['.bzrignore'])
1976
ignored = globbing.Globster(name_pattern_list)
1979
for entry in tree.list_files():
1983
if ignored.match(filename):
1984
matches.append(filename.encode('utf-8'))
1986
if len(matches) > 0:
1987
print "Warning: the following files are version controlled and" \
1988
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1990
class cmd_ignored(Command):
1991
"""List ignored files and the patterns that matched them.
1994
_see_also = ['ignore']
1997
tree = WorkingTree.open_containing(u'.')[0]
2000
for path, file_class, kind, file_id, entry in tree.list_files():
2001
if file_class != 'I':
2003
## XXX: Slightly inefficient since this was already calculated
2004
pat = tree.is_ignored(path)
2005
print '%-50s %s' % (path, pat)
2010
class cmd_lookup_revision(Command):
2011
"""Lookup the revision-id from a revision-number
2014
bzr lookup-revision 33
2017
takes_args = ['revno']
2020
def run(self, revno):
2024
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2026
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2029
class cmd_export(Command):
2030
"""Export current or past revision to a destination directory or archive.
2032
If no revision is specified this exports the last committed revision.
2034
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2035
given, try to find the format with the extension. If no extension
2036
is found exports to a directory (equivalent to --format=dir).
2038
If root is supplied, it will be used as the root directory inside
2039
container formats (tar, zip, etc). If it is not supplied it will default
2040
to the exported filename. The root option has no effect for 'dir' format.
2042
If branch is omitted then the branch containing the current working
2043
directory will be used.
2045
Note: Export of tree with non-ASCII filenames to zip is not supported.
2047
================= =========================
2048
Supported formats Autodetected by extension
2049
================= =========================
2052
tbz2 .tar.bz2, .tbz2
2055
================= =========================
2057
takes_args = ['dest', 'branch?']
2060
help="Type of file to export to.",
2065
help="Name of the root directory inside the exported file."),
2067
def run(self, dest, branch=None, revision=None, format=None, root=None):
2068
from bzrlib.export import export
2071
tree = WorkingTree.open_containing(u'.')[0]
2074
b = Branch.open(branch)
2076
if revision is None:
2077
# should be tree.last_revision FIXME
2078
rev_id = b.last_revision()
2080
if len(revision) != 1:
2081
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2082
rev_id = revision[0].in_history(b).rev_id
2083
t = b.repository.revision_tree(rev_id)
2085
export(t, dest, format, root)
2086
except errors.NoSuchExportFormat, e:
2087
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2090
class cmd_cat(Command):
2091
"""Write the contents of a file as of a given revision to standard output.
2093
If no revision is nominated, the last revision is used.
2095
Note: Take care to redirect standard output when using this command on a
2101
Option('name-from-revision', help='The path name in the old tree.'),
2104
takes_args = ['filename']
2105
encoding_type = 'exact'
2108
def run(self, filename, revision=None, name_from_revision=False):
2109
if revision is not None and len(revision) != 1:
2110
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2115
tree, b, relpath = \
2116
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2117
except errors.NotBranchError:
2120
if revision is not None and revision[0].get_branch() is not None:
2121
b = Branch.open(revision[0].get_branch())
2123
tree = b.basis_tree()
2124
if revision is None:
2125
revision_id = b.last_revision()
2127
revision_id = revision[0].in_history(b).rev_id
2129
cur_file_id = tree.path2id(relpath)
2130
rev_tree = b.repository.revision_tree(revision_id)
2131
old_file_id = rev_tree.path2id(relpath)
2133
if name_from_revision:
2134
if old_file_id is None:
2135
raise errors.BzrCommandError("%r is not present in revision %s"
2136
% (filename, revision_id))
2138
rev_tree.print_file(old_file_id)
2139
elif cur_file_id is not None:
2140
rev_tree.print_file(cur_file_id)
2141
elif old_file_id is not None:
2142
rev_tree.print_file(old_file_id)
2144
raise errors.BzrCommandError("%r is not present in revision %s" %
2145
(filename, revision_id))
2148
class cmd_local_time_offset(Command):
2149
"""Show the offset in seconds from GMT to local time."""
2153
print osutils.local_time_offset()
2157
class cmd_commit(Command):
2158
"""Commit changes into a new revision.
2160
If no arguments are given, the entire tree is committed.
2162
If selected files are specified, only changes to those files are
2163
committed. If a directory is specified then the directory and everything
2164
within it is committed.
2166
If author of the change is not the same person as the committer, you can
2167
specify the author's name using the --author option. The name should be
2168
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2170
A selected-file commit may fail in some cases where the committed
2171
tree would be invalid. Consider::
2176
bzr commit foo -m "committing foo"
2177
bzr mv foo/bar foo/baz
2180
bzr commit foo/bar -m "committing bar but not baz"
2182
In the example above, the last commit will fail by design. This gives
2183
the user the opportunity to decide whether they want to commit the
2184
rename at the same time, separately first, or not at all. (As a general
2185
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2187
Note: A selected-file commit after a merge is not yet supported.
2189
# TODO: Run hooks on tree to-be-committed, and after commit.
2191
# TODO: Strict commit that fails if there are deleted files.
2192
# (what does "deleted files" mean ??)
2194
# TODO: Give better message for -s, --summary, used by tla people
2196
# XXX: verbose currently does nothing
2198
_see_also = ['bugs', 'uncommit']
2199
takes_args = ['selected*']
2201
Option('message', type=unicode,
2203
help="Description of the new revision."),
2206
help='Commit even if nothing has changed.'),
2207
Option('file', type=str,
2210
help='Take commit message from this file.'),
2212
help="Refuse to commit if there are unknown "
2213
"files in the working tree."),
2214
ListOption('fixes', type=str,
2215
help="Mark a bug as being fixed by this revision."),
2216
Option('author', type=str,
2217
help="Set the author's name, if it's different "
2218
"from the committer."),
2220
help="Perform a local commit in a bound "
2221
"branch. Local commits are not pushed to "
2222
"the master branch until a normal commit "
2226
help='When no message is supplied, show the diff along'
2227
' with the status summary in the message editor.'),
2229
aliases = ['ci', 'checkin']
2231
def _get_bug_fix_properties(self, fixes, branch):
2233
# Configure the properties for bug fixing attributes.
2234
for fixed_bug in fixes:
2235
tokens = fixed_bug.split(':')
2236
if len(tokens) != 2:
2237
raise errors.BzrCommandError(
2238
"Invalid bug %s. Must be in the form of 'tag:id'. "
2239
"Commit refused." % fixed_bug)
2240
tag, bug_id = tokens
2242
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2243
except errors.UnknownBugTrackerAbbreviation:
2244
raise errors.BzrCommandError(
2245
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2246
except errors.MalformedBugIdentifier:
2247
raise errors.BzrCommandError(
2248
"Invalid bug identifier for %s. Commit refused."
2250
properties.append('%s fixed' % bug_url)
2251
return '\n'.join(properties)
2253
def run(self, message=None, file=None, verbose=False, selected_list=None,
2254
unchanged=False, strict=False, local=False, fixes=None,
2255
author=None, show_diff=False):
2256
from bzrlib.errors import (
2261
from bzrlib.msgeditor import (
2262
edit_commit_message_encoded,
2263
make_commit_message_template_encoded
2266
# TODO: Need a blackbox test for invoking the external editor; may be
2267
# slightly problematic to run this cross-platform.
2269
# TODO: do more checks that the commit will succeed before
2270
# spending the user's valuable time typing a commit message.
2274
tree, selected_list = tree_files(selected_list)
2275
if selected_list == ['']:
2276
# workaround - commit of root of tree should be exactly the same
2277
# as just default commit in that tree, and succeed even though
2278
# selected-file merge commit is not done yet
2283
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2285
properties['bugs'] = bug_property
2287
if local and not tree.branch.get_bound_location():
2288
raise errors.LocalRequiresBoundBranch()
2290
def get_message(commit_obj):
2291
"""Callback to get commit message"""
2292
my_message = message
2293
if my_message is None and not file:
2294
t = make_commit_message_template_encoded(tree,
2295
selected_list, diff=show_diff,
2296
output_encoding=bzrlib.user_encoding)
2297
my_message = edit_commit_message_encoded(t)
2298
if my_message is None:
2299
raise errors.BzrCommandError("please specify a commit"
2300
" message with either --message or --file")
2301
elif my_message and file:
2302
raise errors.BzrCommandError(
2303
"please specify either --message or --file")
2305
my_message = codecs.open(file, 'rt',
2306
bzrlib.user_encoding).read()
2307
if my_message == "":
2308
raise errors.BzrCommandError("empty commit message specified")
2312
tree.commit(message_callback=get_message,
2313
specific_files=selected_list,
2314
allow_pointless=unchanged, strict=strict, local=local,
2315
reporter=None, verbose=verbose, revprops=properties,
2317
except PointlessCommit:
2318
# FIXME: This should really happen before the file is read in;
2319
# perhaps prepare the commit; get the message; then actually commit
2320
raise errors.BzrCommandError("no changes to commit."
2321
" use --unchanged to commit anyhow")
2322
except ConflictsInTree:
2323
raise errors.BzrCommandError('Conflicts detected in working '
2324
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2326
except StrictCommitFailed:
2327
raise errors.BzrCommandError("Commit refused because there are"
2328
" unknown files in the working tree.")
2329
except errors.BoundBranchOutOfDate, e:
2330
raise errors.BzrCommandError(str(e) + "\n"
2331
'To commit to master branch, run update and then commit.\n'
2332
'You can also pass --local to commit to continue working '
2336
class cmd_check(Command):
2337
"""Validate consistency of branch history.
2339
This command checks various invariants about the branch storage to
2340
detect data corruption or bzr bugs.
2344
revisions: This is just the number of revisions checked. It doesn't
2346
versionedfiles: This is just the number of versionedfiles checked. It
2347
doesn't indicate a problem.
2348
unreferenced ancestors: Texts that are ancestors of other texts, but
2349
are not properly referenced by the revision ancestry. This is a
2350
subtle problem that Bazaar can work around.
2351
unique file texts: This is the total number of unique file contents
2352
seen in the checked revisions. It does not indicate a problem.
2353
repeated file texts: This is the total number of repeated texts seen
2354
in the checked revisions. Texts can be repeated when their file
2355
entries are modified, but the file contents are not. It does not
2359
_see_also = ['reconcile']
2360
takes_args = ['branch?']
2361
takes_options = ['verbose']
2363
def run(self, branch=None, verbose=False):
2364
from bzrlib.check import check
2366
branch = Branch.open_containing('.')[0]
2368
branch = Branch.open(branch)
2369
check(branch, verbose)
2372
class cmd_upgrade(Command):
2373
"""Upgrade branch storage to current format.
2375
The check command or bzr developers may sometimes advise you to run
2376
this command. When the default format has changed you may also be warned
2377
during other operations to upgrade.
2380
_see_also = ['check']
2381
takes_args = ['url?']
2383
RegistryOption('format',
2384
help='Upgrade to a specific format. See "bzr help'
2385
' formats" for details.',
2386
registry=bzrdir.format_registry,
2387
converter=bzrdir.format_registry.make_bzrdir,
2388
value_switches=True, title='Branch format'),
2391
def run(self, url='.', format=None):
2392
from bzrlib.upgrade import upgrade
2394
format = bzrdir.format_registry.make_bzrdir('default')
2395
upgrade(url, format)
2398
class cmd_whoami(Command):
2399
"""Show or set bzr user id.
2402
Show the email of the current user::
2406
Set the current user::
2408
bzr whoami 'Frank Chu <fchu@example.com>'
2410
takes_options = [ Option('email',
2411
help='Display email address only.'),
2413
help='Set identity for the current branch instead of '
2416
takes_args = ['name?']
2417
encoding_type = 'replace'
2420
def run(self, email=False, branch=False, name=None):
2422
# use branch if we're inside one; otherwise global config
2424
c = Branch.open_containing('.')[0].get_config()
2425
except errors.NotBranchError:
2426
c = config.GlobalConfig()
2428
self.outf.write(c.user_email() + '\n')
2430
self.outf.write(c.username() + '\n')
2433
# display a warning if an email address isn't included in the given name.
2435
config.extract_email_address(name)
2436
except errors.NoEmailInUsername, e:
2437
warning('"%s" does not seem to contain an email address. '
2438
'This is allowed, but not recommended.', name)
2440
# use global config unless --branch given
2442
c = Branch.open_containing('.')[0].get_config()
2444
c = config.GlobalConfig()
2445
c.set_user_option('email', name)
2448
class cmd_nick(Command):
2449
"""Print or set the branch nickname.
2451
If unset, the tree root directory name is used as the nickname
2452
To print the current nickname, execute with no argument.
2455
_see_also = ['info']
2456
takes_args = ['nickname?']
2457
def run(self, nickname=None):
2458
branch = Branch.open_containing(u'.')[0]
2459
if nickname is None:
2460
self.printme(branch)
2462
branch.nick = nickname
2465
def printme(self, branch):
2469
class cmd_selftest(Command):
2470
"""Run internal test suite.
2472
If arguments are given, they are regular expressions that say which tests
2473
should run. Tests matching any expression are run, and other tests are
2476
Alternatively if --first is given, matching tests are run first and then
2477
all other tests are run. This is useful if you have been working in a
2478
particular area, but want to make sure nothing else was broken.
2480
If --exclude is given, tests that match that regular expression are
2481
excluded, regardless of whether they match --first or not.
2483
To help catch accidential dependencies between tests, the --randomize
2484
option is useful. In most cases, the argument used is the word 'now'.
2485
Note that the seed used for the random number generator is displayed
2486
when this option is used. The seed can be explicitly passed as the
2487
argument to this option if required. This enables reproduction of the
2488
actual ordering used if and when an order sensitive problem is encountered.
2490
If --list-only is given, the tests that would be run are listed. This is
2491
useful when combined with --first, --exclude and/or --randomize to
2492
understand their impact. The test harness reports "Listed nn tests in ..."
2493
instead of "Ran nn tests in ..." when list mode is enabled.
2495
If the global option '--no-plugins' is given, plugins are not loaded
2496
before running the selftests. This has two effects: features provided or
2497
modified by plugins will not be tested, and tests provided by plugins will
2500
Tests that need working space on disk use a common temporary directory,
2501
typically inside $TMPDIR or /tmp.
2504
Run only tests relating to 'ignore'::
2508
Disable plugins and list tests as they're run::
2510
bzr --no-plugins selftest -v
2512
# NB: this is used from the class without creating an instance, which is
2513
# why it does not have a self parameter.
2514
def get_transport_type(typestring):
2515
"""Parse and return a transport specifier."""
2516
if typestring == "sftp":
2517
from bzrlib.transport.sftp import SFTPAbsoluteServer
2518
return SFTPAbsoluteServer
2519
if typestring == "memory":
2520
from bzrlib.transport.memory import MemoryServer
2522
if typestring == "fakenfs":
2523
from bzrlib.transport.fakenfs import FakeNFSServer
2524
return FakeNFSServer
2525
msg = "No known transport type %s. Supported types are: sftp\n" %\
2527
raise errors.BzrCommandError(msg)
2530
takes_args = ['testspecs*']
2531
takes_options = ['verbose',
2533
help='Stop when one test fails.',
2537
help='Use a different transport by default '
2538
'throughout the test suite.',
2539
type=get_transport_type),
2541
help='Run the benchmarks rather than selftests.'),
2542
Option('lsprof-timed',
2543
help='Generate lsprof output for benchmarked'
2544
' sections of code.'),
2545
Option('cache-dir', type=str,
2546
help='Cache intermediate benchmark output in this '
2549
help='Run all tests, but run specified tests first.',
2553
help='List the tests instead of running them.'),
2554
Option('randomize', type=str, argname="SEED",
2555
help='Randomize the order of tests using the given'
2556
' seed or "now" for the current time.'),
2557
Option('exclude', type=str, argname="PATTERN",
2559
help='Exclude tests that match this regular'
2561
Option('strict', help='Fail on missing dependencies or '
2564
encoding_type = 'replace'
2566
def run(self, testspecs_list=None, verbose=False, one=False,
2567
transport=None, benchmark=None,
2568
lsprof_timed=None, cache_dir=None,
2569
first=False, list_only=False,
2570
randomize=None, exclude=None, strict=False):
2572
from bzrlib.tests import selftest
2573
import bzrlib.benchmarks as benchmarks
2574
from bzrlib.benchmarks import tree_creator
2576
if cache_dir is not None:
2577
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2579
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2580
print ' %s (%s python%s)' % (
2582
bzrlib.version_string,
2583
'.'.join(map(str, sys.version_info)),
2586
if testspecs_list is not None:
2587
pattern = '|'.join(testspecs_list)
2591
test_suite_factory = benchmarks.test_suite
2592
# Unless user explicitly asks for quiet, be verbose in benchmarks
2593
verbose = not is_quiet()
2594
# TODO: should possibly lock the history file...
2595
benchfile = open(".perf_history", "at", buffering=1)
2597
test_suite_factory = None
2600
result = selftest(verbose=verbose,
2602
stop_on_failure=one,
2603
transport=transport,
2604
test_suite_factory=test_suite_factory,
2605
lsprof_timed=lsprof_timed,
2606
bench_history=benchfile,
2607
matching_tests_first=first,
2608
list_only=list_only,
2609
random_seed=randomize,
2610
exclude_pattern=exclude,
2614
if benchfile is not None:
2617
info('tests passed')
2619
info('tests failed')
2620
return int(not result)
2623
class cmd_version(Command):
2624
"""Show version of bzr."""
2626
encoding_type = 'replace'
2630
from bzrlib.version import show_version
2631
show_version(to_file=self.outf)
2634
class cmd_rocks(Command):
2635
"""Statement of optimism."""
2641
print "It sure does!"
2644
class cmd_find_merge_base(Command):
2645
"""Find and print a base revision for merging two branches."""
2646
# TODO: Options to specify revisions on either side, as if
2647
# merging only part of the history.
2648
takes_args = ['branch', 'other']
2652
def run(self, branch, other):
2653
from bzrlib.revision import ensure_null
2655
branch1 = Branch.open_containing(branch)[0]
2656
branch2 = Branch.open_containing(other)[0]
2658
last1 = ensure_null(branch1.last_revision())
2659
last2 = ensure_null(branch2.last_revision())
2661
graph = branch1.repository.get_graph(branch2.repository)
2662
base_rev_id = graph.find_unique_lca(last1, last2)
2664
print 'merge base is revision %s' % base_rev_id
2667
class cmd_merge(Command):
2668
"""Perform a three-way merge.
2670
The branch is the branch you will merge from. By default, it will merge
2671
the latest revision. If you specify a revision, that revision will be
2672
merged. If you specify two revisions, the first will be used as a BASE,
2673
and the second one as OTHER. Revision numbers are always relative to the
2676
By default, bzr will try to merge in all new work from the other
2677
branch, automatically determining an appropriate base. If this
2678
fails, you may need to give an explicit base.
2680
Merge will do its best to combine the changes in two branches, but there
2681
are some kinds of problems only a human can fix. When it encounters those,
2682
it will mark a conflict. A conflict means that you need to fix something,
2683
before you should commit.
2685
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2687
If there is no default branch set, the first merge will set it. After
2688
that, you can omit the branch to use the default. To change the
2689
default, use --remember. The value will only be saved if the remote
2690
location can be accessed.
2692
The results of the merge are placed into the destination working
2693
directory, where they can be reviewed (with bzr diff), tested, and then
2694
committed to record the result of the merge.
2696
merge refuses to run if there are any uncommitted changes, unless
2700
To merge the latest revision from bzr.dev::
2702
bzr merge ../bzr.dev
2704
To merge changes up to and including revision 82 from bzr.dev::
2706
bzr merge -r 82 ../bzr.dev
2708
To merge the changes introduced by 82, without previous changes::
2710
bzr merge -r 81..82 ../bzr.dev
2713
_see_also = ['update', 'remerge', 'status-flags']
2714
takes_args = ['branch?']
2719
help='Merge even if the destination tree has uncommitted changes.'),
2723
Option('show-base', help="Show base revision text in "
2725
Option('uncommitted', help='Apply uncommitted changes'
2726
' from a working copy, instead of branch changes.'),
2727
Option('pull', help='If the destination is already'
2728
' completely merged into the source, pull from the'
2729
' source rather than merging. When this happens,'
2730
' you do not need to commit the result.'),
2732
help='Branch to merge into, '
2733
'rather than the one containing the working directory.',
2739
def run(self, branch=None, revision=None, force=False, merge_type=None,
2740
show_base=False, reprocess=False, remember=False,
2741
uncommitted=False, pull=False,
2744
# This is actually a branch (or merge-directive) *location*.
2748
if merge_type is None:
2749
merge_type = _mod_merge.Merge3Merger
2751
if directory is None: directory = u'.'
2752
possible_transports = []
2754
allow_pending = True
2755
verified = 'inapplicable'
2756
tree = WorkingTree.open_containing(directory)[0]
2757
change_reporter = delta._ChangeReporter(
2758
unversioned_filter=tree.is_ignored)
2761
pb = ui.ui_factory.nested_progress_bar()
2762
cleanups.append(pb.finished)
2764
cleanups.append(tree.unlock)
2765
if location is not None:
2766
mergeable, other_transport = _get_mergeable_helper(location)
2769
raise errors.BzrCommandError('Cannot use --uncommitted'
2770
' with bundles or merge directives.')
2772
if revision is not None:
2773
raise errors.BzrCommandError(
2774
'Cannot use -r with merge directives or bundles')
2775
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2777
possible_transports.append(other_transport)
2779
if merger is None and uncommitted:
2780
if revision is not None and len(revision) > 0:
2781
raise errors.BzrCommandError('Cannot use --uncommitted and'
2782
' --revision at the same time.')
2783
location = self._select_branch_location(tree, location)[0]
2784
other_tree, other_path = WorkingTree.open_containing(location)
2785
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2787
allow_pending = False
2790
merger, allow_pending = self._get_merger_from_branch(tree,
2791
location, revision, remember, possible_transports, pb)
2793
merger.merge_type = merge_type
2794
merger.reprocess = reprocess
2795
merger.show_base = show_base
2796
merger.change_reporter = change_reporter
2797
self.sanity_check_merger(merger)
2798
if (merger.base_rev_id == merger.other_rev_id and
2799
merger.other_rev_id != None):
2800
note('Nothing to do.')
2803
if merger.interesting_files is not None:
2804
raise errors.BzrCommandError('Cannot pull individual files')
2805
if (merger.base_rev_id == tree.last_revision()):
2806
result = tree.pull(merger.other_branch, False,
2807
merger.other_rev_id)
2808
result.report(self.outf)
2810
merger.check_basis(not force)
2811
conflict_count = merger.do_merge()
2813
merger.set_pending()
2814
if verified == 'failed':
2815
warning('Preview patch does not match changes')
2816
if conflict_count != 0:
2821
for cleanup in reversed(cleanups):
2824
def sanity_check_merger(self, merger):
2825
if (merger.show_base and
2826
not merger.merge_type is _mod_merge.Merge3Merger):
2827
raise errors.BzrCommandError("Show-base is not supported for this"
2828
" merge type. %s" % merger.merge_type)
2829
if merger.reprocess and not merger.merge_type.supports_reprocess:
2830
raise errors.BzrCommandError("Conflict reduction is not supported"
2831
" for merge type %s." %
2833
if merger.reprocess and merger.show_base:
2834
raise errors.BzrCommandError("Cannot do conflict reduction and"
2837
def _get_merger_from_branch(self, tree, location, revision, remember,
2838
possible_transports, pb):
2839
"""Produce a merger from a location, assuming it refers to a branch."""
2840
from bzrlib.tag import _merge_tags_if_possible
2841
assert revision is None or len(revision) < 3
2842
# find the branch locations
2843
other_loc, location = self._select_branch_location(tree, location,
2845
if revision is not None and len(revision) == 2:
2846
base_loc, location = self._select_branch_location(tree, location,
2849
base_loc = other_loc
2851
other_branch, other_path = Branch.open_containing(other_loc,
2852
possible_transports)
2853
if base_loc == other_loc:
2854
base_branch = other_branch
2856
base_branch, base_path = Branch.open_containing(base_loc,
2857
possible_transports)
2858
# Find the revision ids
2859
if revision is None or len(revision) < 1 or revision[-1] is None:
2860
other_revision_id = _mod_revision.ensure_null(
2861
other_branch.last_revision())
2863
other_revision_id = \
2864
_mod_revision.ensure_null(
2865
revision[-1].in_history(other_branch).rev_id)
2866
if (revision is not None and len(revision) == 2
2867
and revision[0] is not None):
2868
base_revision_id = \
2869
_mod_revision.ensure_null(
2870
revision[0].in_history(base_branch).rev_id)
2872
base_revision_id = None
2873
# Remember where we merge from
2874
if ((tree.branch.get_parent() is None or remember) and
2875
other_branch is not None):
2876
tree.branch.set_parent(other_branch.base)
2877
_merge_tags_if_possible(other_branch, tree.branch)
2878
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2879
other_revision_id, base_revision_id, other_branch, base_branch)
2880
if other_path != '':
2881
allow_pending = False
2882
merger.interesting_files = [other_path]
2884
allow_pending = True
2885
return merger, allow_pending
2887
def _select_branch_location(self, tree, location, revision=None,
2889
"""Select a branch location, according to possible inputs.
2891
If provided, branches from ``revision`` are preferred. (Both
2892
``revision`` and ``index`` must be supplied.)
2894
Otherwise, the ``location`` parameter is used. If it is None, then the
2895
``parent`` location is used, and a note is printed.
2897
:param tree: The working tree to select a branch for merging into
2898
:param location: The location entered by the user
2899
:param revision: The revision parameter to the command
2900
:param index: The index to use for the revision parameter. Negative
2901
indices are permitted.
2902
:return: (selected_location, default_location). The default location
2903
will be the user-entered location, if any, or else the remembered
2906
if (revision is not None and index is not None
2907
and revision[index] is not None):
2908
branch = revision[index].get_branch()
2909
if branch is not None:
2910
return branch, location
2911
location = self._get_remembered_parent(tree, location, 'Merging from')
2912
return location, location
2914
# TODO: move up to common parent; this isn't merge-specific anymore.
2915
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2916
"""Use tree.branch's parent if none was supplied.
2918
Report if the remembered location was used.
2920
if supplied_location is not None:
2921
return supplied_location
2922
stored_location = tree.branch.get_parent()
2923
mutter("%s", stored_location)
2924
if stored_location is None:
2925
raise errors.BzrCommandError("No location specified or remembered")
2926
display_url = urlutils.unescape_for_display(stored_location,
2928
self.outf.write("%s remembered location %s\n" % (verb_string,
2930
return stored_location
2933
class cmd_remerge(Command):
2936
Use this if you want to try a different merge technique while resolving
2937
conflicts. Some merge techniques are better than others, and remerge
2938
lets you try different ones on different files.
2940
The options for remerge have the same meaning and defaults as the ones for
2941
merge. The difference is that remerge can (only) be run when there is a
2942
pending merge, and it lets you specify particular files.
2945
Re-do the merge of all conflicted files, and show the base text in
2946
conflict regions, in addition to the usual THIS and OTHER texts::
2948
bzr remerge --show-base
2950
Re-do the merge of "foobar", using the weave merge algorithm, with
2951
additional processing to reduce the size of conflict regions::
2953
bzr remerge --merge-type weave --reprocess foobar
2955
takes_args = ['file*']
2960
help="Show base revision text in conflicts."),
2963
def run(self, file_list=None, merge_type=None, show_base=False,
2965
if merge_type is None:
2966
merge_type = _mod_merge.Merge3Merger
2967
tree, file_list = tree_files(file_list)
2970
parents = tree.get_parent_ids()
2971
if len(parents) != 2:
2972
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2973
" merges. Not cherrypicking or"
2975
repository = tree.branch.repository
2976
graph = repository.get_graph()
2977
base_revision = graph.find_unique_lca(parents[0], parents[1])
2978
base_tree = repository.revision_tree(base_revision)
2979
other_tree = repository.revision_tree(parents[1])
2980
interesting_ids = None
2982
conflicts = tree.conflicts()
2983
if file_list is not None:
2984
interesting_ids = set()
2985
for filename in file_list:
2986
file_id = tree.path2id(filename)
2988
raise errors.NotVersionedError(filename)
2989
interesting_ids.add(file_id)
2990
if tree.kind(file_id) != "directory":
2993
for name, ie in tree.inventory.iter_entries(file_id):
2994
interesting_ids.add(ie.file_id)
2995
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2997
# Remerge only supports resolving contents conflicts
2998
allowed_conflicts = ('text conflict', 'contents conflict')
2999
restore_files = [c.path for c in conflicts
3000
if c.typestring in allowed_conflicts]
3001
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3002
tree.set_conflicts(ConflictList(new_conflicts))
3003
if file_list is not None:
3004
restore_files = file_list
3005
for filename in restore_files:
3007
restore(tree.abspath(filename))
3008
except errors.NotConflicted:
3010
# Disable pending merges, because the file texts we are remerging
3011
# have not had those merges performed. If we use the wrong parents
3012
# list, we imply that the working tree text has seen and rejected
3013
# all the changes from the other tree, when in fact those changes
3014
# have not yet been seen.
3015
tree.set_parent_ids(parents[:1])
3017
conflicts = _mod_merge.merge_inner(
3018
tree.branch, other_tree, base_tree,
3020
interesting_ids=interesting_ids,
3021
other_rev_id=parents[1],
3022
merge_type=merge_type,
3023
show_base=show_base,
3024
reprocess=reprocess)
3026
tree.set_parent_ids(parents)
3035
class cmd_revert(Command):
3036
"""Revert files to a previous revision.
3038
Giving a list of files will revert only those files. Otherwise, all files
3039
will be reverted. If the revision is not specified with '--revision', the
3040
last committed revision is used.
3042
To remove only some changes, without reverting to a prior version, use
3043
merge instead. For example, "merge . --r-2..-3" will remove the changes
3044
introduced by -2, without affecting the changes introduced by -1. Or
3045
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3047
By default, any files that have been manually changed will be backed up
3048
first. (Files changed only by merge are not backed up.) Backup files have
3049
'.~#~' appended to their name, where # is a number.
3051
When you provide files, you can use their current pathname or the pathname
3052
from the target revision. So you can use revert to "undelete" a file by
3053
name. If you name a directory, all the contents of that directory will be
3056
Any files that have been newly added since that revision will be deleted,
3057
with a backup kept if appropriate. Directories containing unknown files
3058
will not be deleted.
3061
_see_also = ['cat', 'export']
3064
Option('no-backup', "Do not save backups of reverted files."),
3065
Option('forget-merges',
3066
'Remove pending merge marker, without changing any files.'),
3068
takes_args = ['file*']
3070
def run(self, revision=None, no_backup=False, file_list=None,
3071
forget_merges=None):
3072
tree, file_list = tree_files(file_list)
3074
tree.set_parent_ids(tree.get_parent_ids()[:1])
3076
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3079
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3080
if revision is None:
3081
rev_id = tree.last_revision()
3082
elif len(revision) != 1:
3083
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3085
rev_id = revision[0].in_history(tree.branch).rev_id
3086
pb = ui.ui_factory.nested_progress_bar()
3088
tree.revert(file_list,
3089
tree.branch.repository.revision_tree(rev_id),
3090
not no_backup, pb, report_changes=True)
3095
class cmd_assert_fail(Command):
3096
"""Test reporting of assertion failures"""
3097
# intended just for use in testing
3102
raise AssertionError("always fails")
3105
class cmd_help(Command):
3106
"""Show help on a command or other topic.
3109
_see_also = ['topics']
3111
Option('long', 'Show help on all commands.'),
3113
takes_args = ['topic?']
3114
aliases = ['?', '--help', '-?', '-h']
3117
def run(self, topic=None, long=False):
3119
if topic is None and long:
3121
bzrlib.help.help(topic)
3124
class cmd_shell_complete(Command):
3125
"""Show appropriate completions for context.
3127
For a list of all available commands, say 'bzr shell-complete'.
3129
takes_args = ['context?']
3134
def run(self, context=None):
3135
import shellcomplete
3136
shellcomplete.shellcomplete(context)
3139
class cmd_fetch(Command):
3140
"""Copy in history from another branch but don't merge it.
3142
This is an internal method used for pull and merge.
3145
takes_args = ['from_branch', 'to_branch']
3146
def run(self, from_branch, to_branch):
3147
from bzrlib.fetch import Fetcher
3148
from_b = Branch.open(from_branch)
3149
to_b = Branch.open(to_branch)
3150
Fetcher(to_b, from_b)
3153
class cmd_missing(Command):
3154
"""Show unmerged/unpulled revisions between two branches.
3156
OTHER_BRANCH may be local or remote.
3159
_see_also = ['merge', 'pull']
3160
takes_args = ['other_branch?']
3162
Option('reverse', 'Reverse the order of revisions.'),
3164
'Display changes in the local branch only.'),
3165
Option('this' , 'Same as --mine-only.'),
3166
Option('theirs-only',
3167
'Display changes in the remote branch only.'),
3168
Option('other', 'Same as --theirs-only.'),
3173
encoding_type = 'replace'
3176
def run(self, other_branch=None, reverse=False, mine_only=False,
3177
theirs_only=False, log_format=None, long=False, short=False, line=False,
3178
show_ids=False, verbose=False, this=False, other=False):
3179
from bzrlib.missing import find_unmerged, iter_log_revisions
3186
local_branch = Branch.open_containing(u".")[0]
3187
parent = local_branch.get_parent()
3188
if other_branch is None:
3189
other_branch = parent
3190
if other_branch is None:
3191
raise errors.BzrCommandError("No peer location known"
3193
display_url = urlutils.unescape_for_display(parent,
3195
self.outf.write("Using last location: " + display_url + "\n")
3197
remote_branch = Branch.open(other_branch)
3198
if remote_branch.base == local_branch.base:
3199
remote_branch = local_branch
3200
local_branch.lock_read()
3202
remote_branch.lock_read()
3204
local_extra, remote_extra = find_unmerged(local_branch,
3206
if log_format is None:
3207
registry = log.log_formatter_registry
3208
log_format = registry.get_default(local_branch)
3209
lf = log_format(to_file=self.outf,
3211
show_timezone='original')
3212
if reverse is False:
3213
local_extra.reverse()
3214
remote_extra.reverse()
3215
if local_extra and not theirs_only:
3216
self.outf.write("You have %d extra revision(s):\n" %
3218
for revision in iter_log_revisions(local_extra,
3219
local_branch.repository,
3221
lf.log_revision(revision)
3222
printed_local = True
3224
printed_local = False
3225
if remote_extra and not mine_only:
3226
if printed_local is True:
3227
self.outf.write("\n\n\n")
3228
self.outf.write("You are missing %d revision(s):\n" %
3230
for revision in iter_log_revisions(remote_extra,
3231
remote_branch.repository,
3233
lf.log_revision(revision)
3234
if not remote_extra and not local_extra:
3236
self.outf.write("Branches are up to date.\n")
3240
remote_branch.unlock()
3242
local_branch.unlock()
3243
if not status_code and parent is None and other_branch is not None:
3244
local_branch.lock_write()
3246
# handle race conditions - a parent might be set while we run.
3247
if local_branch.get_parent() is None:
3248
local_branch.set_parent(remote_branch.base)
3250
local_branch.unlock()
3254
class cmd_pack(Command):
3255
"""Compress the data within a repository."""
3257
_see_also = ['repositories']
3258
takes_args = ['branch_or_repo?']
3260
def run(self, branch_or_repo='.'):
3261
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3263
branch = dir.open_branch()
3264
repository = branch.repository
3265
except errors.NotBranchError:
3266
repository = dir.open_repository()
3270
class cmd_plugins(Command):
3271
"""List the installed plugins.
3273
This command displays the list of installed plugins including the
3274
path where each one is located and a short description of each.
3276
A plugin is an external component for Bazaar that extends the
3277
revision control system, by adding or replacing code in Bazaar.
3278
Plugins can do a variety of things, including overriding commands,
3279
adding new commands, providing additional network transports and
3280
customizing log output.
3282
See the Bazaar web site, http://bazaar-vcs.org, for further
3283
information on plugins including where to find them and how to
3284
install them. Instructions are also provided there on how to
3285
write new plugins using the Python programming language.
3290
import bzrlib.plugin
3291
from inspect import getdoc
3292
for name, plugin in bzrlib.plugin.plugins().items():
3293
print plugin.path(), "[%s]" % plugin.__version__
3294
d = getdoc(plugin.module)
3296
print '\t', d.split('\n')[0]
3299
class cmd_testament(Command):
3300
"""Show testament (signing-form) of a revision."""
3303
Option('long', help='Produce long-format testament.'),
3305
help='Produce a strict-format testament.')]
3306
takes_args = ['branch?']
3308
def run(self, branch=u'.', revision=None, long=False, strict=False):
3309
from bzrlib.testament import Testament, StrictTestament
3311
testament_class = StrictTestament
3313
testament_class = Testament
3314
b = WorkingTree.open_containing(branch)[0].branch
3317
if revision is None:
3318
rev_id = b.last_revision()
3320
rev_id = revision[0].in_history(b).rev_id
3321
t = testament_class.from_revision(b.repository, rev_id)
3323
sys.stdout.writelines(t.as_text_lines())
3325
sys.stdout.write(t.as_short_text())
3330
class cmd_annotate(Command):
3331
"""Show the origin of each line in a file.
3333
This prints out the given file with an annotation on the left side
3334
indicating which revision, author and date introduced the change.
3336
If the origin is the same for a run of consecutive lines, it is
3337
shown only at the top, unless the --all option is given.
3339
# TODO: annotate directories; showing when each file was last changed
3340
# TODO: if the working copy is modified, show annotations on that
3341
# with new uncommitted lines marked
3342
aliases = ['ann', 'blame', 'praise']
3343
takes_args = ['filename']
3344
takes_options = [Option('all', help='Show annotations on all lines.'),
3345
Option('long', help='Show commit date in annotations.'),
3349
encoding_type = 'exact'
3352
def run(self, filename, all=False, long=False, revision=None,
3354
from bzrlib.annotate import annotate_file
3355
tree, relpath = WorkingTree.open_containing(filename)
3356
branch = tree.branch
3359
if revision is None:
3360
revision_id = branch.last_revision()
3361
elif len(revision) != 1:
3362
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3364
revision_id = revision[0].in_history(branch).rev_id
3365
file_id = tree.path2id(relpath)
3367
raise errors.NotVersionedError(filename)
3368
tree = branch.repository.revision_tree(revision_id)
3369
file_version = tree.inventory[file_id].revision
3370
annotate_file(branch, file_version, file_id, long, all, self.outf,
3376
class cmd_re_sign(Command):
3377
"""Create a digital signature for an existing revision."""
3378
# TODO be able to replace existing ones.
3380
hidden = True # is this right ?
3381
takes_args = ['revision_id*']
3382
takes_options = ['revision']
3384
def run(self, revision_id_list=None, revision=None):
3385
import bzrlib.gpg as gpg
3386
if revision_id_list is not None and revision is not None:
3387
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3388
if revision_id_list is None and revision is None:
3389
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3390
b = WorkingTree.open_containing(u'.')[0].branch
3391
gpg_strategy = gpg.GPGStrategy(b.get_config())
3392
if revision_id_list is not None:
3393
for revision_id in revision_id_list:
3394
b.repository.sign_revision(revision_id, gpg_strategy)
3395
elif revision is not None:
3396
if len(revision) == 1:
3397
revno, rev_id = revision[0].in_history(b)
3398
b.repository.sign_revision(rev_id, gpg_strategy)
3399
elif len(revision) == 2:
3400
# are they both on rh- if so we can walk between them
3401
# might be nice to have a range helper for arbitrary
3402
# revision paths. hmm.
3403
from_revno, from_revid = revision[0].in_history(b)
3404
to_revno, to_revid = revision[1].in_history(b)
3405
if to_revid is None:
3406
to_revno = b.revno()
3407
if from_revno is None or to_revno is None:
3408
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3409
for revno in range(from_revno, to_revno + 1):
3410
b.repository.sign_revision(b.get_rev_id(revno),
3413
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3416
class cmd_bind(Command):
3417
"""Convert the current branch into a checkout of the supplied branch.
3419
Once converted into a checkout, commits must succeed on the master branch
3420
before they will be applied to the local branch.
3423
_see_also = ['checkouts', 'unbind']
3424
takes_args = ['location?']
3427
def run(self, location=None):
3428
b, relpath = Branch.open_containing(u'.')
3429
if location is None:
3431
location = b.get_old_bound_location()
3432
except errors.UpgradeRequired:
3433
raise errors.BzrCommandError('No location supplied. '
3434
'This format does not remember old locations.')
3436
if location is None:
3437
raise errors.BzrCommandError('No location supplied and no '
3438
'previous location known')
3439
b_other = Branch.open(location)
3442
except errors.DivergedBranches:
3443
raise errors.BzrCommandError('These branches have diverged.'
3444
' Try merging, and then bind again.')
3447
class cmd_unbind(Command):
3448
"""Convert the current checkout into a regular branch.
3450
After unbinding, the local branch is considered independent and subsequent
3451
commits will be local only.
3454
_see_also = ['checkouts', 'bind']
3459
b, relpath = Branch.open_containing(u'.')
3461
raise errors.BzrCommandError('Local branch is not bound')
3464
class cmd_uncommit(Command):
3465
"""Remove the last committed revision.
3467
--verbose will print out what is being removed.
3468
--dry-run will go through all the motions, but not actually
3471
If --revision is specified, uncommit revisions to leave the branch at the
3472
specified revision. For example, "bzr uncommit -r 15" will leave the
3473
branch at revision 15.
3475
In the future, uncommit will create a revision bundle, which can then
3479
# TODO: jam 20060108 Add an option to allow uncommit to remove
3480
# unreferenced information in 'branch-as-repository' branches.
3481
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3482
# information in shared branches as well.
3483
_see_also = ['commit']
3484
takes_options = ['verbose', 'revision',
3485
Option('dry-run', help='Don\'t actually make changes.'),
3486
Option('force', help='Say yes to all questions.')]
3487
takes_args = ['location?']
3490
def run(self, location=None,
3491
dry_run=False, verbose=False,
3492
revision=None, force=False):
3493
from bzrlib.log import log_formatter, show_log
3494
from bzrlib.uncommit import uncommit
3496
if location is None:
3498
control, relpath = bzrdir.BzrDir.open_containing(location)
3500
tree = control.open_workingtree()
3502
except (errors.NoWorkingTree, errors.NotLocalUrl):
3504
b = control.open_branch()
3507
if revision is None:
3510
# 'bzr uncommit -r 10' actually means uncommit
3511
# so that the final tree is at revno 10.
3512
# but bzrlib.uncommit.uncommit() actually uncommits
3513
# the revisions that are supplied.
3514
# So we need to offset it by one
3515
revno = revision[0].in_history(b).revno+1
3517
if revno <= b.revno():
3518
rev_id = b.get_rev_id(revno)
3520
self.outf.write('No revisions to uncommit.\n')
3523
lf = log_formatter('short',
3525
show_timezone='original')
3530
direction='forward',
3531
start_revision=revno,
3532
end_revision=b.revno())
3535
print 'Dry-run, pretending to remove the above revisions.'
3537
val = raw_input('Press <enter> to continue')
3539
print 'The above revision(s) will be removed.'
3541
val = raw_input('Are you sure [y/N]? ')
3542
if val.lower() not in ('y', 'yes'):
3546
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3550
class cmd_break_lock(Command):
3551
"""Break a dead lock on a repository, branch or working directory.
3553
CAUTION: Locks should only be broken when you are sure that the process
3554
holding the lock has been stopped.
3556
You can get information on what locks are open via the 'bzr info' command.
3561
takes_args = ['location?']
3563
def run(self, location=None, show=False):
3564
if location is None:
3566
control, relpath = bzrdir.BzrDir.open_containing(location)
3568
control.break_lock()
3569
except NotImplementedError:
3573
class cmd_wait_until_signalled(Command):
3574
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3576
This just prints a line to signal when it is ready, then blocks on stdin.
3582
sys.stdout.write("running\n")
3584
sys.stdin.readline()
3587
class cmd_serve(Command):
3588
"""Run the bzr server."""
3590
aliases = ['server']
3594
help='Serve on stdin/out for use from inetd or sshd.'),
3596
help='Listen for connections on nominated port of the form '
3597
'[hostname:]portnumber. Passing 0 as the port number will '
3598
'result in a dynamically allocated port. The default port is '
3602
help='Serve contents of this directory.',
3604
Option('allow-writes',
3605
help='By default the server is a readonly server. Supplying '
3606
'--allow-writes enables write access to the contents of '
3607
'the served directory and below.'
3611
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3612
from bzrlib.smart import medium, server
3613
from bzrlib.transport import get_transport
3614
from bzrlib.transport.chroot import ChrootServer
3615
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3616
if directory is None:
3617
directory = os.getcwd()
3618
url = urlutils.local_path_to_url(directory)
3619
if not allow_writes:
3620
url = 'readonly+' + url
3621
chroot_server = ChrootServer(get_transport(url))
3622
chroot_server.setUp()
3623
t = get_transport(chroot_server.get_url())
3625
smart_server = medium.SmartServerPipeStreamMedium(
3626
sys.stdin, sys.stdout, t)
3628
host = BZR_DEFAULT_INTERFACE
3630
port = BZR_DEFAULT_PORT
3633
host, port = port.split(':')
3635
smart_server = server.SmartTCPServer(t, host=host, port=port)
3636
print 'listening on port: ', smart_server.port
3638
# for the duration of this server, no UI output is permitted.
3639
# note that this may cause problems with blackbox tests. This should
3640
# be changed with care though, as we dont want to use bandwidth sending
3641
# progress over stderr to smart server clients!
3642
old_factory = ui.ui_factory
3644
ui.ui_factory = ui.SilentUIFactory()
3645
smart_server.serve()
3647
ui.ui_factory = old_factory
3650
class cmd_join(Command):
3651
"""Combine a subtree into its containing tree.
3653
This command is for experimental use only. It requires the target tree
3654
to be in dirstate-with-subtree format, which cannot be converted into
3657
The TREE argument should be an independent tree, inside another tree, but
3658
not part of it. (Such trees can be produced by "bzr split", but also by
3659
running "bzr branch" with the target inside a tree.)
3661
The result is a combined tree, with the subtree no longer an independant
3662
part. This is marked as a merge of the subtree into the containing tree,
3663
and all history is preserved.
3665
If --reference is specified, the subtree retains its independence. It can
3666
be branched by itself, and can be part of multiple projects at the same
3667
time. But operations performed in the containing tree, such as commit
3668
and merge, will recurse into the subtree.
3671
_see_also = ['split']
3672
takes_args = ['tree']
3674
Option('reference', help='Join by reference.'),
3678
def run(self, tree, reference=False):
3679
sub_tree = WorkingTree.open(tree)
3680
parent_dir = osutils.dirname(sub_tree.basedir)
3681
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3682
repo = containing_tree.branch.repository
3683
if not repo.supports_rich_root():
3684
raise errors.BzrCommandError(
3685
"Can't join trees because %s doesn't support rich root data.\n"
3686
"You can use bzr upgrade on the repository."
3690
containing_tree.add_reference(sub_tree)
3691
except errors.BadReferenceTarget, e:
3692
# XXX: Would be better to just raise a nicely printable
3693
# exception from the real origin. Also below. mbp 20070306
3694
raise errors.BzrCommandError("Cannot join %s. %s" %
3698
containing_tree.subsume(sub_tree)
3699
except errors.BadSubsumeSource, e:
3700
raise errors.BzrCommandError("Cannot join %s. %s" %
3704
class cmd_split(Command):
3705
"""Split a tree into two trees.
3707
This command is for experimental use only. It requires the target tree
3708
to be in dirstate-with-subtree format, which cannot be converted into
3711
The TREE argument should be a subdirectory of a working tree. That
3712
subdirectory will be converted into an independent tree, with its own
3713
branch. Commits in the top-level tree will not apply to the new subtree.
3714
If you want that behavior, do "bzr join --reference TREE".
3717
_see_also = ['join']
3718
takes_args = ['tree']
3722
def run(self, tree):
3723
containing_tree, subdir = WorkingTree.open_containing(tree)
3724
sub_id = containing_tree.path2id(subdir)
3726
raise errors.NotVersionedError(subdir)
3728
containing_tree.extract(sub_id)
3729
except errors.RootNotRich:
3730
raise errors.UpgradeRequired(containing_tree.branch.base)
3734
class cmd_merge_directive(Command):
3735
"""Generate a merge directive for auto-merge tools.
3737
A directive requests a merge to be performed, and also provides all the
3738
information necessary to do so. This means it must either include a
3739
revision bundle, or the location of a branch containing the desired
3742
A submit branch (the location to merge into) must be supplied the first
3743
time the command is issued. After it has been supplied once, it will
3744
be remembered as the default.
3746
A public branch is optional if a revision bundle is supplied, but required
3747
if --diff or --plain is specified. It will be remembered as the default
3748
after the first use.
3751
takes_args = ['submit_branch?', 'public_branch?']
3755
_see_also = ['send']
3758
RegistryOption.from_kwargs('patch-type',
3759
'The type of patch to include in the directive.',
3761
value_switches=True,
3763
bundle='Bazaar revision bundle (default).',
3764
diff='Normal unified diff.',
3765
plain='No patch, just directive.'),
3766
Option('sign', help='GPG-sign the directive.'), 'revision',
3767
Option('mail-to', type=str,
3768
help='Instead of printing the directive, email to this address.'),
3769
Option('message', type=str, short_name='m',
3770
help='Message to use when committing this merge.')
3773
encoding_type = 'exact'
3775
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3776
sign=False, revision=None, mail_to=None, message=None):
3777
from bzrlib.revision import ensure_null, NULL_REVISION
3778
include_patch, include_bundle = {
3779
'plain': (False, False),
3780
'diff': (True, False),
3781
'bundle': (True, True),
3783
branch = Branch.open('.')
3784
stored_submit_branch = branch.get_submit_branch()
3785
if submit_branch is None:
3786
submit_branch = stored_submit_branch
3788
if stored_submit_branch is None:
3789
branch.set_submit_branch(submit_branch)
3790
if submit_branch is None:
3791
submit_branch = branch.get_parent()
3792
if submit_branch is None:
3793
raise errors.BzrCommandError('No submit branch specified or known')
3795
stored_public_branch = branch.get_public_branch()
3796
if public_branch is None:
3797
public_branch = stored_public_branch
3798
elif stored_public_branch is None:
3799
branch.set_public_branch(public_branch)
3800
if not include_bundle and public_branch is None:
3801
raise errors.BzrCommandError('No public branch specified or'
3803
base_revision_id = None
3804
if revision is not None:
3805
if len(revision) > 2:
3806
raise errors.BzrCommandError('bzr merge-directive takes '
3807
'at most two one revision identifiers')
3808
revision_id = revision[-1].in_history(branch).rev_id
3809
if len(revision) == 2:
3810
base_revision_id = revision[0].in_history(branch).rev_id
3811
base_revision_id = ensure_null(base_revision_id)
3813
revision_id = branch.last_revision()
3814
revision_id = ensure_null(revision_id)
3815
if revision_id == NULL_REVISION:
3816
raise errors.BzrCommandError('No revisions to bundle.')
3817
directive = merge_directive.MergeDirective2.from_objects(
3818
branch.repository, revision_id, time.time(),
3819
osutils.local_time_offset(), submit_branch,
3820
public_branch=public_branch, include_patch=include_patch,
3821
include_bundle=include_bundle, message=message,
3822
base_revision_id=base_revision_id)
3825
self.outf.write(directive.to_signed(branch))
3827
self.outf.writelines(directive.to_lines())
3829
message = directive.to_email(mail_to, branch, sign)
3830
s = SMTPConnection(branch.get_config())
3831
s.send_email(message)
3834
class cmd_send(Command):
3835
"""Mail or create a merge-directive for submiting changes.
3837
A merge directive provides many things needed for requesting merges:
3839
* A machine-readable description of the merge to perform
3841
* An optional patch that is a preview of the changes requested
3843
* An optional bundle of revision data, so that the changes can be applied
3844
directly from the merge directive, without retrieving data from a
3847
If --no-bundle is specified, then public_branch is needed (and must be
3848
up-to-date), so that the receiver can perform the merge using the
3849
public_branch. The public_branch is always included if known, so that
3850
people can check it later.
3852
The submit branch defaults to the parent, but can be overridden. Both
3853
submit branch and public branch will be remembered if supplied.
3855
If a public_branch is known for the submit_branch, that public submit
3856
branch is used in the merge instructions. This means that a local mirror
3857
can be used as your actual submit branch, once you have set public_branch
3860
Mail is sent using your preferred mail program. This should be transparent
3861
on Windows (it uses MAPI). On *nix, it requires the xdg-email utility. If
3862
the preferred client can't be found (or used), your editor will be used.
3864
To use a specific mail program, set the mail_client configuration option.
3865
(For Thunderbird 1.5, this works around some bugs.) Supported values for
3866
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
3867
generic options are "default", "editor", "mapi", and "xdg-email".
3869
If mail is being sent, a to address is required. This can be supplied
3870
either on the commandline, or by setting the submit_to configuration
3873
Two formats are currently supported: "4" uses revision bundle format 4 and
3874
merge directive format 2. It is significantly faster and smaller than
3875
older formats. It is compatible with Bazaar 0.19 and later. It is the
3876
default. "0.9" uses revision bundle format 0.9 and merge directive
3877
format 1. It is compatible with Bazaar 0.12 - 0.18.
3880
encoding_type = 'exact'
3882
_see_also = ['merge']
3884
takes_args = ['submit_branch?', 'public_branch?']
3888
help='Do not include a bundle in the merge directive.'),
3889
Option('no-patch', help='Do not include a preview patch in the merge'
3892
help='Remember submit and public branch.'),
3894
help='Branch to generate the submission from, '
3895
'rather than the one containing the working directory.',
3898
Option('output', short_name='o', help='Write directive to this file.',
3900
Option('mail-to', help='Mail the request to this address.',
3904
RegistryOption.from_kwargs('format',
3905
'Use the specified output format.',
3906
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
3907
'0.9': 'Bundle format 0.9, Merge Directive 1',})
3910
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3911
no_patch=False, revision=None, remember=False, output=None,
3912
format='4', mail_to=None, message=None, **kwargs):
3913
return self._run(submit_branch, revision, public_branch, remember,
3914
format, no_bundle, no_patch, output,
3915
kwargs.get('from', '.'), mail_to, message)
3917
def _run(self, submit_branch, revision, public_branch, remember, format,
3918
no_bundle, no_patch, output, from_, mail_to, message):
3919
from bzrlib.revision import NULL_REVISION
3921
outfile = StringIO()
3925
outfile = open(output, 'wb')
3927
branch = Branch.open_containing(from_)[0]
3929
config = branch.get_config()
3931
mail_to = config.get_user_option('submit_to')
3933
raise errors.BzrCommandError('No mail-to address'
3935
mail_client = config.get_mail_client()
3936
if remember and submit_branch is None:
3937
raise errors.BzrCommandError(
3938
'--remember requires a branch to be specified.')
3939
stored_submit_branch = branch.get_submit_branch()
3940
remembered_submit_branch = False
3941
if submit_branch is None:
3942
submit_branch = stored_submit_branch
3943
remembered_submit_branch = True
3945
if stored_submit_branch is None or remember:
3946
branch.set_submit_branch(submit_branch)
3947
if submit_branch is None:
3948
submit_branch = branch.get_parent()
3949
remembered_submit_branch = True
3950
if submit_branch is None:
3951
raise errors.BzrCommandError('No submit branch known or'
3953
if remembered_submit_branch:
3954
note('Using saved location: %s', submit_branch)
3956
stored_public_branch = branch.get_public_branch()
3957
if public_branch is None:
3958
public_branch = stored_public_branch
3959
elif stored_public_branch is None or remember:
3960
branch.set_public_branch(public_branch)
3961
if no_bundle and public_branch is None:
3962
raise errors.BzrCommandError('No public branch specified or'
3964
base_revision_id = None
3966
if revision is not None:
3967
if len(revision) > 2:
3968
raise errors.BzrCommandError('bzr send takes '
3969
'at most two one revision identifiers')
3970
revision_id = revision[-1].in_history(branch).rev_id
3971
if len(revision) == 2:
3972
base_revision_id = revision[0].in_history(branch).rev_id
3973
if revision_id is None:
3974
revision_id = branch.last_revision()
3975
if revision_id == NULL_REVISION:
3976
raise errors.BzrCommandError('No revisions to submit.')
3978
directive = merge_directive.MergeDirective2.from_objects(
3979
branch.repository, revision_id, time.time(),
3980
osutils.local_time_offset(), submit_branch,
3981
public_branch=public_branch, include_patch=not no_patch,
3982
include_bundle=not no_bundle, message=message,
3983
base_revision_id=base_revision_id)
3984
elif format == '0.9':
3987
patch_type = 'bundle'
3989
raise errors.BzrCommandError('Format 0.9 does not'
3990
' permit bundle with no patch')
3996
directive = merge_directive.MergeDirective.from_objects(
3997
branch.repository, revision_id, time.time(),
3998
osutils.local_time_offset(), submit_branch,
3999
public_branch=public_branch, patch_type=patch_type,
4002
outfile.writelines(directive.to_lines())
4004
subject = '[MERGE] '
4005
if message is not None:
4008
revision = branch.repository.get_revision(revision_id)
4009
subject += revision.get_summary()
4010
mail_client.compose_merge_request(mail_to, subject,
4017
class cmd_bundle_revisions(cmd_send):
4019
"""Create a merge-directive for submiting changes.
4021
A merge directive provides many things needed for requesting merges:
4023
* A machine-readable description of the merge to perform
4025
* An optional patch that is a preview of the changes requested
4027
* An optional bundle of revision data, so that the changes can be applied
4028
directly from the merge directive, without retrieving data from a
4031
If --no-bundle is specified, then public_branch is needed (and must be
4032
up-to-date), so that the receiver can perform the merge using the
4033
public_branch. The public_branch is always included if known, so that
4034
people can check it later.
4036
The submit branch defaults to the parent, but can be overridden. Both
4037
submit branch and public branch will be remembered if supplied.
4039
If a public_branch is known for the submit_branch, that public submit
4040
branch is used in the merge instructions. This means that a local mirror
4041
can be used as your actual submit branch, once you have set public_branch
4044
Two formats are currently supported: "4" uses revision bundle format 4 and
4045
merge directive format 2. It is significantly faster and smaller than
4046
older formats. It is compatible with Bazaar 0.19 and later. It is the
4047
default. "0.9" uses revision bundle format 0.9 and merge directive
4048
format 1. It is compatible with Bazaar 0.12 - 0.18.
4053
help='Do not include a bundle in the merge directive.'),
4054
Option('no-patch', help='Do not include a preview patch in the merge'
4057
help='Remember submit and public branch.'),
4059
help='Branch to generate the submission from, '
4060
'rather than the one containing the working directory.',
4063
Option('output', short_name='o', help='Write directive to this file.',
4066
RegistryOption.from_kwargs('format',
4067
'Use the specified output format.',
4068
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4069
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4071
aliases = ['bundle']
4073
_see_also = ['send', 'merge']
4077
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4078
no_patch=False, revision=None, remember=False, output=None,
4079
format='4', **kwargs):
4082
return self._run(submit_branch, revision, public_branch, remember,
4083
format, no_bundle, no_patch, output,
4084
kwargs.get('from', '.'), None, None)
4087
class cmd_tag(Command):
4088
"""Create, remove or modify a tag naming a revision.
4090
Tags give human-meaningful names to revisions. Commands that take a -r
4091
(--revision) option can be given -rtag:X, where X is any previously
4094
Tags are stored in the branch. Tags are copied from one branch to another
4095
along when you branch, push, pull or merge.
4097
It is an error to give a tag name that already exists unless you pass
4098
--force, in which case the tag is moved to point to the new revision.
4101
_see_also = ['commit', 'tags']
4102
takes_args = ['tag_name']
4105
help='Delete this tag rather than placing it.',
4108
help='Branch in which to place the tag.',
4113
help='Replace existing tags.',
4118
def run(self, tag_name,
4124
branch, relpath = Branch.open_containing(directory)
4128
branch.tags.delete_tag(tag_name)
4129
self.outf.write('Deleted tag %s.\n' % tag_name)
4132
if len(revision) != 1:
4133
raise errors.BzrCommandError(
4134
"Tags can only be placed on a single revision, "
4136
revision_id = revision[0].in_history(branch).rev_id
4138
revision_id = branch.last_revision()
4139
if (not force) and branch.tags.has_tag(tag_name):
4140
raise errors.TagAlreadyExists(tag_name)
4141
branch.tags.set_tag(tag_name, revision_id)
4142
self.outf.write('Created tag %s.\n' % tag_name)
4147
class cmd_tags(Command):
4150
This tag shows a table of tag names and the revisions they reference.
4156
help='Branch whose tags should be displayed.',
4166
branch, relpath = Branch.open_containing(directory)
4167
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
4168
self.outf.write('%-20s %s\n' % (tag_name, target))
4171
class cmd_reconfigure(Command):
4172
"""Reconfigure the type of a bzr directory.
4174
A target configuration must be specified.
4176
For checkouts, the bind-to location will be auto-detected if not specified.
4177
The order of preference is
4178
1. For a lightweight checkout, the current bound location.
4179
2. For branches that used to be checkouts, the previously-bound location.
4180
3. The push location.
4181
4. The parent location.
4182
If none of these is available, --bind-to must be specified.
4185
takes_args = ['location?']
4186
takes_options = [RegistryOption.from_kwargs('target_type',
4187
title='Target type',
4188
help='The type to reconfigure the directory to.',
4189
value_switches=True, enum_switch=False,
4190
branch='Reconfigure to a branch.',
4191
tree='Reconfigure to a tree.',
4192
checkout='Reconfigure to a checkout.'),
4193
Option('bind-to', help='Branch to bind checkout to.',
4196
help='Perform reconfiguration even if local changes'
4200
def run(self, location=None, target_type=None, bind_to=None, force=False):
4201
directory = bzrdir.BzrDir.open(location)
4202
if target_type is None:
4203
raise errors.BzrCommandError('No target configuration specified')
4204
elif target_type == 'branch':
4205
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4206
elif target_type == 'tree':
4207
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4208
elif target_type == 'checkout':
4209
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4211
reconfiguration.apply(force)
4214
def _create_prefix(cur_transport):
4215
needed = [cur_transport]
4216
# Recurse upwards until we can create a directory successfully
4218
new_transport = cur_transport.clone('..')
4219
if new_transport.base == cur_transport.base:
4220
raise errors.BzrCommandError(
4221
"Failed to create path prefix for %s."
4222
% cur_transport.base)
4224
new_transport.mkdir('.')
4225
except errors.NoSuchFile:
4226
needed.append(new_transport)
4227
cur_transport = new_transport
4230
# Now we only need to create child directories
4232
cur_transport = needed.pop()
4233
cur_transport.ensure_base()
4236
def _get_mergeable_helper(location):
4237
"""Get a merge directive or bundle if 'location' points to one.
4239
Try try to identify a bundle and returns its mergeable form. If it's not,
4240
we return the tried transport anyway so that it can reused to access the
4243
:param location: can point to a bundle or a branch.
4245
:return: mergeable, transport
4248
url = urlutils.normalize_url(location)
4249
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4250
location_transport = transport.get_transport(url)
4253
# There may be redirections but we ignore the intermediate
4254
# and final transports used
4255
read = bundle.read_mergeable_from_transport
4256
mergeable, t = read(location_transport, filename)
4257
except errors.NotABundle:
4258
# Continue on considering this url a Branch but adjust the
4259
# location_transport
4260
location_transport = location_transport.clone(filename)
4261
return mergeable, location_transport
4264
# these get imported and then picked up by the scan for cmd_*
4265
# TODO: Some more consistent way to split command definitions across files;
4266
# we do need to load at least some information about them to know of
4267
# aliases. ideally we would avoid loading the implementation until the
4268
# details were needed.
4269
from bzrlib.cmd_version_info import cmd_version_info
4270
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4271
from bzrlib.bundle.commands import (
4274
from bzrlib.sign_my_commits import cmd_sign_my_commits
4275
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4276
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
