1
# Copyright (C) 2004, 2005, 2006, 2007, 2008 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
# TODO: Make sure no commands unconditionally use the working directory as a
100
# branch. If a filename argument is used, the first of them should be used to
101
# specify the branch. (Perhaps this can be factored out into some kind of
102
# Argument class, representing a file in a branch, where the first occurrence
105
class cmd_status(Command):
106
"""Display status summary.
108
This reports on versioned and unknown files, reporting them
109
grouped by state. Possible states are:
112
Versioned in the working copy but not in the previous revision.
115
Versioned in the previous revision but removed or deleted
119
Path of this file changed from the previous revision;
120
the text may also have changed. This includes files whose
121
parent directory was renamed.
124
Text has changed since the previous revision.
127
File kind has been changed (e.g. from file to directory).
130
Not versioned and not matching an ignore pattern.
132
To see ignored files use 'bzr ignored'. For details on the
133
changes to file texts, use 'bzr diff'.
135
Note that --short or -S gives status flags for each item, similar
136
to Subversion's status command. To get output similar to svn -q,
139
If no arguments are specified, the status of the entire working
140
directory is shown. Otherwise, only the status of the specified
141
files or directories is reported. If a directory is given, status
142
is reported for everything inside that directory.
144
If a revision argument is given, the status is calculated against
145
that revision, or between two revisions if two are provided.
148
# TODO: --no-recurse, --recurse options
150
takes_args = ['file*']
151
takes_options = ['show-ids', 'revision', 'change',
152
Option('short', help='Use short status indicators.',
154
Option('versioned', help='Only show versioned files.',
156
Option('no-pending', help='Don\'t show pending merges.',
159
aliases = ['st', 'stat']
161
encoding_type = 'replace'
162
_see_also = ['diff', 'revert', 'status-flags']
165
def run(self, show_ids=False, file_list=None, revision=None, short=False,
166
versioned=False, no_pending=False):
167
from bzrlib.status import show_tree_status
169
if revision and len(revision) > 2:
170
raise errors.BzrCommandError('bzr status --revision takes exactly'
171
' one or two revision specifiers')
173
tree, file_list = tree_files(file_list)
175
show_tree_status(tree, show_ids=show_ids,
176
specific_files=file_list, revision=revision,
177
to_file=self.outf, short=short, versioned=versioned,
178
show_pending=not no_pending)
181
class cmd_cat_revision(Command):
182
"""Write out metadata for a revision.
184
The revision to print can either be specified by a specific
185
revision identifier, or you can use --revision.
189
takes_args = ['revision_id?']
190
takes_options = ['revision']
191
# cat-revision is more for frontends so should be exact
195
def run(self, revision_id=None, revision=None):
196
if revision_id is not None and revision is not None:
197
raise errors.BzrCommandError('You can only supply one of'
198
' revision_id or --revision')
199
if revision_id is None and revision is None:
200
raise errors.BzrCommandError('You must supply either'
201
' --revision or a revision_id')
202
b = WorkingTree.open_containing(u'.')[0].branch
204
# TODO: jam 20060112 should cat-revision always output utf-8?
205
if revision_id is not None:
206
revision_id = osutils.safe_revision_id(revision_id, warn=False)
207
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
208
elif revision is not None:
211
raise errors.BzrCommandError('You cannot specify a NULL'
213
rev_id = rev.as_revision_id(b)
214
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
217
class cmd_remove_tree(Command):
218
"""Remove the working tree from a given branch/checkout.
220
Since a lightweight checkout is little more than a working tree
221
this will refuse to run against one.
223
To re-create the working tree, use "bzr checkout".
225
_see_also = ['checkout', 'working-trees']
227
takes_args = ['location?']
229
def run(self, location='.'):
230
d = bzrdir.BzrDir.open(location)
233
working = d.open_workingtree()
234
except errors.NoWorkingTree:
235
raise errors.BzrCommandError("No working tree to remove")
236
except errors.NotLocalUrl:
237
raise errors.BzrCommandError("You cannot remove the working tree of a "
240
working_path = working.bzrdir.root_transport.base
241
branch_path = working.branch.bzrdir.root_transport.base
242
if working_path != branch_path:
243
raise errors.BzrCommandError("You cannot remove the working tree from "
244
"a lightweight checkout")
246
d.destroy_workingtree()
249
class cmd_revno(Command):
250
"""Show current revision number.
252
This is equal to the number of revisions on this branch.
256
takes_args = ['location?']
259
def run(self, location=u'.'):
260
self.outf.write(str(Branch.open_containing(location)[0].revno()))
261
self.outf.write('\n')
264
class cmd_revision_info(Command):
265
"""Show revision number and revision id for a given revision identifier.
268
takes_args = ['revision_info*']
269
takes_options = ['revision']
272
def run(self, revision=None, revision_info_list=[]):
275
if revision is not None:
276
revs.extend(revision)
277
if revision_info_list is not None:
278
for rev in revision_info_list:
279
revs.append(RevisionSpec.from_string(rev))
281
b = Branch.open_containing(u'.')[0]
284
revs.append(RevisionSpec.from_string('-1'))
287
revision_id = rev.as_revision_id(b)
289
revno = '%4d' % (b.revision_id_to_revno(revision_id))
290
except errors.NoSuchRevision:
291
dotted_map = b.get_revision_id_to_revno_map()
292
revno = '.'.join(str(i) for i in dotted_map[revision_id])
293
print '%s %s' % (revno, revision_id)
296
class cmd_add(Command):
297
"""Add specified files or directories.
299
In non-recursive mode, all the named items are added, regardless
300
of whether they were previously ignored. A warning is given if
301
any of the named files are already versioned.
303
In recursive mode (the default), files are treated the same way
304
but the behaviour for directories is different. Directories that
305
are already versioned do not give a warning. All directories,
306
whether already versioned or not, are searched for files or
307
subdirectories that are neither versioned or ignored, and these
308
are added. This search proceeds recursively into versioned
309
directories. If no names are given '.' is assumed.
311
Therefore simply saying 'bzr add' will version all files that
312
are currently unknown.
314
Adding a file whose parent directory is not versioned will
315
implicitly add the parent, and so on up to the root. This means
316
you should never need to explicitly add a directory, they'll just
317
get added when you add a file in the directory.
319
--dry-run will show which files would be added, but not actually
322
--file-ids-from will try to use the file ids from the supplied path.
323
It looks up ids trying to find a matching parent directory with the
324
same filename, and then by pure path. This option is rarely needed
325
but can be useful when adding the same logical file into two
326
branches that will be merged later (without showing the two different
327
adds as a conflict). It is also useful when merging another project
328
into a subdirectory of this one.
330
takes_args = ['file*']
333
help="Don't recursively add the contents of directories."),
335
help="Show what would be done, but don't actually do anything."),
337
Option('file-ids-from',
339
help='Lookup file ids from this tree.'),
341
encoding_type = 'replace'
342
_see_also = ['remove']
344
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
349
if file_ids_from is not None:
351
base_tree, base_path = WorkingTree.open_containing(
353
except errors.NoWorkingTree:
354
base_branch, base_path = Branch.open_containing(
356
base_tree = base_branch.basis_tree()
358
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
359
to_file=self.outf, should_print=(not is_quiet()))
361
action = bzrlib.add.AddAction(to_file=self.outf,
362
should_print=(not is_quiet()))
365
base_tree.lock_read()
367
file_list = self._maybe_expand_globs(file_list)
369
tree = WorkingTree.open_containing(file_list[0])[0]
371
tree = WorkingTree.open_containing(u'.')[0]
372
added, ignored = tree.smart_add(file_list, not
373
no_recurse, action=action, save=not dry_run)
375
if base_tree is not None:
379
for glob in sorted(ignored.keys()):
380
for path in ignored[glob]:
381
self.outf.write("ignored %s matching \"%s\"\n"
385
for glob, paths in ignored.items():
386
match_len += len(paths)
387
self.outf.write("ignored %d file(s).\n" % match_len)
388
self.outf.write("If you wish to add some of these files,"
389
" please add them by name.\n")
392
class cmd_mkdir(Command):
393
"""Create a new versioned directory.
395
This is equivalent to creating the directory and then adding it.
398
takes_args = ['dir+']
399
encoding_type = 'replace'
401
def run(self, dir_list):
404
wt, dd = WorkingTree.open_containing(d)
406
self.outf.write('added %s\n' % d)
409
class cmd_relpath(Command):
410
"""Show path of a file relative to root"""
412
takes_args = ['filename']
416
def run(self, filename):
417
# TODO: jam 20050106 Can relpath return a munged path if
418
# sys.stdout encoding cannot represent it?
419
tree, relpath = WorkingTree.open_containing(filename)
420
self.outf.write(relpath)
421
self.outf.write('\n')
424
class cmd_inventory(Command):
425
"""Show inventory of the current working copy or a revision.
427
It is possible to limit the output to a particular entry
428
type using the --kind option. For example: --kind file.
430
It is also possible to restrict the list of files to a specific
431
set. For example: bzr inventory --show-ids this/file
440
help='List entries of a particular kind: file, directory, symlink.',
443
takes_args = ['file*']
446
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
447
if kind and kind not in ['file', 'directory', 'symlink']:
448
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
450
work_tree, file_list = tree_files(file_list)
451
work_tree.lock_read()
453
if revision is not None:
454
if len(revision) > 1:
455
raise errors.BzrCommandError(
456
'bzr inventory --revision takes exactly one revision'
458
revision_id = revision[0].as_revision_id(work_tree.branch)
459
tree = work_tree.branch.repository.revision_tree(revision_id)
461
extra_trees = [work_tree]
467
if file_list is not None:
468
file_ids = tree.paths2ids(file_list, trees=extra_trees,
469
require_versioned=True)
470
# find_ids_across_trees may include some paths that don't
472
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
473
for file_id in file_ids if file_id in tree)
475
entries = tree.inventory.entries()
478
if tree is not work_tree:
481
for path, entry in entries:
482
if kind and kind != entry.kind:
485
self.outf.write('%-50s %s\n' % (path, entry.file_id))
487
self.outf.write(path)
488
self.outf.write('\n')
491
class cmd_mv(Command):
492
"""Move or rename a file.
495
bzr mv OLDNAME NEWNAME
497
bzr mv SOURCE... DESTINATION
499
If the last argument is a versioned directory, all the other names
500
are moved into it. Otherwise, there must be exactly two arguments
501
and the file is changed to a new name.
503
If OLDNAME does not exist on the filesystem but is versioned and
504
NEWNAME does exist on the filesystem but is not versioned, mv
505
assumes that the file has been manually moved and only updates
506
its internal inventory to reflect that change.
507
The same is valid when moving many SOURCE files to a DESTINATION.
509
Files cannot be moved between branches.
512
takes_args = ['names*']
513
takes_options = [Option("after", help="Move only the bzr identifier"
514
" of the file, because the file has already been moved."),
516
aliases = ['move', 'rename']
517
encoding_type = 'replace'
519
def run(self, names_list, after=False):
520
if names_list is None:
523
if len(names_list) < 2:
524
raise errors.BzrCommandError("missing file argument")
525
tree, rel_names = tree_files(names_list)
528
self._run(tree, names_list, rel_names, after)
532
def _run(self, tree, names_list, rel_names, after):
533
into_existing = osutils.isdir(names_list[-1])
534
if into_existing and len(names_list) == 2:
536
# a. case-insensitive filesystem and change case of dir
537
# b. move directory after the fact (if the source used to be
538
# a directory, but now doesn't exist in the working tree
539
# and the target is an existing directory, just rename it)
540
if (not tree.case_sensitive
541
and rel_names[0].lower() == rel_names[1].lower()):
542
into_existing = False
545
from_id = tree.path2id(rel_names[0])
546
if (not osutils.lexists(names_list[0]) and
547
from_id and inv.get_file_kind(from_id) == "directory"):
548
into_existing = False
551
# move into existing directory
552
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
553
self.outf.write("%s => %s\n" % pair)
555
if len(names_list) != 2:
556
raise errors.BzrCommandError('to mv multiple files the'
557
' destination must be a versioned'
559
tree.rename_one(rel_names[0], rel_names[1], after=after)
560
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
563
class cmd_pull(Command):
564
"""Turn this branch into a mirror of another branch.
566
This command only works on branches that have not diverged. Branches are
567
considered diverged if the destination branch's most recent commit is one
568
that has not been merged (directly or indirectly) into the parent.
570
If branches have diverged, you can use 'bzr merge' to integrate the changes
571
from one into the other. Once one branch has merged, the other should
572
be able to pull it again.
574
If you want to forget your local changes and just update your branch to
575
match the remote one, use pull --overwrite.
577
If there is no default location set, the first pull will set it. After
578
that, you can omit the location to use the default. To change the
579
default, use --remember. The value will only be saved if the remote
580
location can be accessed.
582
Note: The location can be specified either in the form of a branch,
583
or in the form of a path to a file containing a merge directive generated
587
_see_also = ['push', 'update', 'status-flags']
588
takes_options = ['remember', 'overwrite', 'revision',
589
custom_help('verbose',
590
help='Show logs of pulled revisions.'),
592
help='Branch to pull into, '
593
'rather than the one containing the working directory.',
598
takes_args = ['location?']
599
encoding_type = 'replace'
601
def run(self, location=None, remember=False, overwrite=False,
602
revision=None, verbose=False,
604
# FIXME: too much stuff is in the command class
607
if directory is None:
610
tree_to = WorkingTree.open_containing(directory)[0]
611
branch_to = tree_to.branch
612
except errors.NoWorkingTree:
614
branch_to = Branch.open_containing(directory)[0]
616
possible_transports = []
617
if location is not None:
619
mergeable = bundle.read_mergeable_from_url(location,
620
possible_transports=possible_transports)
621
except errors.NotABundle:
624
stored_loc = branch_to.get_parent()
626
if stored_loc is None:
627
raise errors.BzrCommandError("No pull location known or"
630
display_url = urlutils.unescape_for_display(stored_loc,
633
self.outf.write("Using saved location: %s\n" % display_url)
634
location = stored_loc
636
if mergeable is not None:
637
if revision is not None:
638
raise errors.BzrCommandError(
639
'Cannot use -r with merge directives or bundles')
640
mergeable.install_revisions(branch_to.repository)
641
base_revision_id, revision_id, verified = \
642
mergeable.get_merge_request(branch_to.repository)
643
branch_from = branch_to
645
branch_from = Branch.open(location,
646
possible_transports=possible_transports)
648
if branch_to.get_parent() is None or remember:
649
branch_to.set_parent(branch_from.base)
651
if revision is not None:
652
if len(revision) == 1:
653
revision_id = revision[0].as_revision_id(branch_from)
655
raise errors.BzrCommandError(
656
'bzr pull --revision takes one value.')
658
branch_to.lock_write()
660
if tree_to is not None:
661
change_reporter = delta._ChangeReporter(
662
unversioned_filter=tree_to.is_ignored)
663
result = tree_to.pull(branch_from, overwrite, revision_id,
665
possible_transports=possible_transports)
667
result = branch_to.pull(branch_from, overwrite, revision_id)
669
result.report(self.outf)
670
if verbose and result.old_revid != result.new_revid:
672
branch_to.repository.iter_reverse_revision_history(
675
new_rh = branch_to.revision_history()
676
log.show_changed_revisions(branch_to, old_rh, new_rh,
682
class cmd_push(Command):
683
"""Update a mirror of this branch.
685
The target branch will not have its working tree populated because this
686
is both expensive, and is not supported on remote file systems.
688
Some smart servers or protocols *may* put the working tree in place in
691
This command only works on branches that have not diverged. Branches are
692
considered diverged if the destination branch's most recent commit is one
693
that has not been merged (directly or indirectly) by the source branch.
695
If branches have diverged, you can use 'bzr push --overwrite' to replace
696
the other branch completely, discarding its unmerged changes.
698
If you want to ensure you have the different changes in the other branch,
699
do a merge (see bzr help merge) from the other branch, and commit that.
700
After that you will be able to do a push without '--overwrite'.
702
If there is no default push location set, the first push will set it.
703
After that, you can omit the location to use the default. To change the
704
default, use --remember. The value will only be saved if the remote
705
location can be accessed.
708
_see_also = ['pull', 'update', 'working-trees']
709
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
710
Option('create-prefix',
711
help='Create the path leading up to the branch '
712
'if it does not already exist.'),
714
help='Branch to push from, '
715
'rather than the one containing the working directory.',
719
Option('use-existing-dir',
720
help='By default push will fail if the target'
721
' directory exists, but does not already'
722
' have a control directory. This flag will'
723
' allow push to proceed.'),
725
help='Create a stacked branch that references the public location '
726
'of the parent branch.'),
728
help='Create a stacked branch that refers to another branch '
729
'for the commit history. Only the work not present in the '
730
'referenced branch is included in the branch created.',
733
takes_args = ['location?']
734
encoding_type = 'replace'
736
def run(self, location=None, remember=False, overwrite=False,
737
create_prefix=False, verbose=False, revision=None,
738
use_existing_dir=False, directory=None, stacked_on=None,
740
from bzrlib.push import _show_push_branch
742
# Get the source branch and revision_id
743
if directory is None:
745
br_from = Branch.open_containing(directory)[0]
746
if revision is not None:
747
if len(revision) == 1:
748
revision_id = revision[0].in_history(br_from).rev_id
750
raise errors.BzrCommandError(
751
'bzr push --revision takes one value.')
753
revision_id = br_from.last_revision()
755
# Get the stacked_on branch, if any
756
if stacked_on is not None:
757
stacked_on = urlutils.normalize_url(stacked_on)
759
parent_url = br_from.get_parent()
761
parent = Branch.open(parent_url)
762
stacked_on = parent.get_public_branch()
764
# I considered excluding non-http url's here, thus forcing
765
# 'public' branches only, but that only works for some
766
# users, so it's best to just depend on the user spotting an
767
# error by the feedback given to them. RBC 20080227.
768
stacked_on = parent_url
770
raise errors.BzrCommandError(
771
"Could not determine branch to refer to.")
773
# Get the destination location
775
stored_loc = br_from.get_push_location()
776
if stored_loc is None:
777
raise errors.BzrCommandError(
778
"No push location known or specified.")
780
display_url = urlutils.unescape_for_display(stored_loc,
782
self.outf.write("Using saved location: %s\n" % display_url)
783
location = stored_loc
785
_show_push_branch(br_from, revision_id, location, self.outf,
786
verbose=verbose, overwrite=overwrite, remember=remember,
787
stacked_on=stacked_on, create_prefix=create_prefix,
788
use_existing_dir=use_existing_dir)
791
class cmd_branch(Command):
792
"""Create a new copy of a branch.
794
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
795
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
796
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
797
is derived from the FROM_LOCATION by stripping a leading scheme or drive
798
identifier, if any. For example, "branch lp:foo-bar" will attempt to
801
To retrieve the branch as of a particular revision, supply the --revision
802
parameter, as in "branch foo/bar -r 5".
805
_see_also = ['checkout']
806
takes_args = ['from_location', 'to_location?']
807
takes_options = ['revision', Option('hardlink',
808
help='Hard-link working tree files where possible.'),
810
help='Create a stacked branch referring to the source branch. '
811
'The new branch will depend on the availability of the source '
812
'branch for all operations.'),
814
aliases = ['get', 'clone']
816
def run(self, from_location, to_location=None, revision=None,
817
hardlink=False, stacked=False):
818
from bzrlib.tag import _merge_tags_if_possible
821
elif len(revision) > 1:
822
raise errors.BzrCommandError(
823
'bzr branch --revision takes exactly 1 revision value')
825
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
829
if len(revision) == 1 and revision[0] is not None:
830
revision_id = revision[0].as_revision_id(br_from)
832
# FIXME - wt.last_revision, fallback to branch, fall back to
833
# None or perhaps NULL_REVISION to mean copy nothing
835
revision_id = br_from.last_revision()
836
if to_location is None:
837
to_location = urlutils.derive_to_location(from_location)
838
to_transport = transport.get_transport(to_location)
840
to_transport.mkdir('.')
841
except errors.FileExists:
842
raise errors.BzrCommandError('Target directory "%s" already'
843
' exists.' % to_location)
844
except errors.NoSuchFile:
845
raise errors.BzrCommandError('Parent of "%s" does not exist.'
848
# preserve whatever source format we have.
849
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
850
possible_transports=[to_transport],
851
accelerator_tree=accelerator_tree,
852
hardlink=hardlink, stacked=stacked)
853
branch = dir.open_branch()
854
except errors.NoSuchRevision:
855
to_transport.delete_tree('.')
856
msg = "The branch %s has no revision %s." % (from_location,
858
raise errors.BzrCommandError(msg)
859
_merge_tags_if_possible(br_from, branch)
860
# If the source branch is stacked, the new branch may
861
# be stacked whether we asked for that explicitly or not.
862
# We therefore need a try/except here and not just 'if stacked:'
864
note('Created new stacked branch referring to %s.' %
865
branch.get_stacked_on_url())
866
except (errors.NotStacked, errors.UnstackableBranchFormat,
867
errors.UnstackableRepositoryFormat), e:
868
note('Branched %d revision(s).' % branch.revno())
873
class cmd_checkout(Command):
874
"""Create a new checkout of an existing branch.
876
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
877
the branch found in '.'. This is useful if you have removed the working tree
878
or if it was never created - i.e. if you pushed the branch to its current
881
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
882
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
883
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
884
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
885
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
888
To retrieve the branch as of a particular revision, supply the --revision
889
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
890
out of date [so you cannot commit] but it may be useful (i.e. to examine old
894
_see_also = ['checkouts', 'branch']
895
takes_args = ['branch_location?', 'to_location?']
896
takes_options = ['revision',
897
Option('lightweight',
898
help="Perform a lightweight checkout. Lightweight "
899
"checkouts depend on access to the branch for "
900
"every operation. Normal checkouts can perform "
901
"common operations like diff and status without "
902
"such access, and also support local commits."
904
Option('files-from', type=str,
905
help="Get file contents from this tree."),
907
help='Hard-link working tree files where possible.'
912
def run(self, branch_location=None, to_location=None, revision=None,
913
lightweight=False, files_from=None, hardlink=False):
916
elif len(revision) > 1:
917
raise errors.BzrCommandError(
918
'bzr checkout --revision takes exactly 1 revision value')
919
if branch_location is None:
920
branch_location = osutils.getcwd()
921
to_location = branch_location
922
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
924
if files_from is not None:
925
accelerator_tree = WorkingTree.open(files_from)
926
if len(revision) == 1 and revision[0] is not None:
927
revision_id = revision[0].as_revision_id(source)
930
if to_location is None:
931
to_location = urlutils.derive_to_location(branch_location)
932
# if the source and to_location are the same,
933
# and there is no working tree,
934
# then reconstitute a branch
935
if (osutils.abspath(to_location) ==
936
osutils.abspath(branch_location)):
938
source.bzrdir.open_workingtree()
939
except errors.NoWorkingTree:
940
source.bzrdir.create_workingtree(revision_id)
942
source.create_checkout(to_location, revision_id, lightweight,
943
accelerator_tree, hardlink)
946
class cmd_renames(Command):
947
"""Show list of renamed files.
949
# TODO: Option to show renames between two historical versions.
951
# TODO: Only show renames under dir, rather than in the whole branch.
952
_see_also = ['status']
953
takes_args = ['dir?']
956
def run(self, dir=u'.'):
957
tree = WorkingTree.open_containing(dir)[0]
960
new_inv = tree.inventory
961
old_tree = tree.basis_tree()
964
old_inv = old_tree.inventory
965
renames = list(_mod_tree.find_renames(old_inv, new_inv))
967
for old_name, new_name in renames:
968
self.outf.write("%s => %s\n" % (old_name, new_name))
975
class cmd_update(Command):
976
"""Update a tree to have the latest code committed to its branch.
978
This will perform a merge into the working tree, and may generate
979
conflicts. If you have any local changes, you will still
980
need to commit them after the update for the update to be complete.
982
If you want to discard your local changes, you can just do a
983
'bzr revert' instead of 'bzr commit' after the update.
986
_see_also = ['pull', 'working-trees', 'status-flags']
987
takes_args = ['dir?']
990
def run(self, dir='.'):
991
tree = WorkingTree.open_containing(dir)[0]
992
possible_transports = []
993
master = tree.branch.get_master_branch(
994
possible_transports=possible_transports)
995
if master is not None:
998
tree.lock_tree_write()
1000
existing_pending_merges = tree.get_parent_ids()[1:]
1001
last_rev = _mod_revision.ensure_null(tree.last_revision())
1002
if last_rev == _mod_revision.ensure_null(
1003
tree.branch.last_revision()):
1004
# may be up to date, check master too.
1005
if master is None or last_rev == _mod_revision.ensure_null(
1006
master.last_revision()):
1007
revno = tree.branch.revision_id_to_revno(last_rev)
1008
note("Tree is up to date at revision %d." % (revno,))
1010
conflicts = tree.update(
1011
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1012
possible_transports=possible_transports)
1013
revno = tree.branch.revision_id_to_revno(
1014
_mod_revision.ensure_null(tree.last_revision()))
1015
note('Updated to revision %d.' % (revno,))
1016
if tree.get_parent_ids()[1:] != existing_pending_merges:
1017
note('Your local commits will now show as pending merges with '
1018
"'bzr status', and can be committed with 'bzr commit'.")
1027
class cmd_info(Command):
1028
"""Show information about a working tree, branch or repository.
1030
This command will show all known locations and formats associated to the
1031
tree, branch or repository. Statistical information is included with
1034
Branches and working trees will also report any missing revisions.
1036
_see_also = ['revno', 'working-trees', 'repositories']
1037
takes_args = ['location?']
1038
takes_options = ['verbose']
1039
encoding_type = 'replace'
1042
def run(self, location=None, verbose=False):
1047
from bzrlib.info import show_bzrdir_info
1048
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1049
verbose=noise_level, outfile=self.outf)
1052
class cmd_remove(Command):
1053
"""Remove files or directories.
1055
This makes bzr stop tracking changes to the specified files and
1056
delete them if they can easily be recovered using revert.
1058
You can specify one or more files, and/or --new. If you specify --new,
1059
only 'added' files will be removed. If you specify both, then new files
1060
in the specified directories will be removed. If the directories are
1061
also new, they will also be removed.
1063
takes_args = ['file*']
1064
takes_options = ['verbose',
1065
Option('new', help='Remove newly-added files.'),
1066
RegistryOption.from_kwargs('file-deletion-strategy',
1067
'The file deletion mode to be used.',
1068
title='Deletion Strategy', value_switches=True, enum_switch=False,
1069
safe='Only delete files if they can be'
1070
' safely recovered (default).',
1071
keep="Don't delete any files.",
1072
force='Delete all the specified files, even if they can not be '
1073
'recovered and even if they are non-empty directories.')]
1075
encoding_type = 'replace'
1077
def run(self, file_list, verbose=False, new=False,
1078
file_deletion_strategy='safe'):
1079
tree, file_list = tree_files(file_list)
1081
if file_list is not None:
1082
file_list = [f for f in file_list]
1084
raise errors.BzrCommandError('Specify one or more files to'
1085
' remove, or use --new.')
1088
added = tree.changes_from(tree.basis_tree(),
1089
specific_files=file_list).added
1090
file_list = sorted([f[0] for f in added], reverse=True)
1091
if len(file_list) == 0:
1092
raise errors.BzrCommandError('No matching files.')
1093
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1094
keep_files=file_deletion_strategy=='keep',
1095
force=file_deletion_strategy=='force')
1098
class cmd_file_id(Command):
1099
"""Print file_id of a particular file or directory.
1101
The file_id is assigned when the file is first added and remains the
1102
same through all revisions where the file exists, even when it is
1107
_see_also = ['inventory', 'ls']
1108
takes_args = ['filename']
1111
def run(self, filename):
1112
tree, relpath = WorkingTree.open_containing(filename)
1113
i = tree.path2id(relpath)
1115
raise errors.NotVersionedError(filename)
1117
self.outf.write(i + '\n')
1120
class cmd_file_path(Command):
1121
"""Print path of file_ids to a file or directory.
1123
This prints one line for each directory down to the target,
1124
starting at the branch root.
1128
takes_args = ['filename']
1131
def run(self, filename):
1132
tree, relpath = WorkingTree.open_containing(filename)
1133
fid = tree.path2id(relpath)
1135
raise errors.NotVersionedError(filename)
1136
segments = osutils.splitpath(relpath)
1137
for pos in range(1, len(segments) + 1):
1138
path = osutils.joinpath(segments[:pos])
1139
self.outf.write("%s\n" % tree.path2id(path))
1142
class cmd_reconcile(Command):
1143
"""Reconcile bzr metadata in a branch.
1145
This can correct data mismatches that may have been caused by
1146
previous ghost operations or bzr upgrades. You should only
1147
need to run this command if 'bzr check' or a bzr developer
1148
advises you to run it.
1150
If a second branch is provided, cross-branch reconciliation is
1151
also attempted, which will check that data like the tree root
1152
id which was not present in very early bzr versions is represented
1153
correctly in both branches.
1155
At the same time it is run it may recompress data resulting in
1156
a potential saving in disk space or performance gain.
1158
The branch *MUST* be on a listable system such as local disk or sftp.
1161
_see_also = ['check']
1162
takes_args = ['branch?']
1164
def run(self, branch="."):
1165
from bzrlib.reconcile import reconcile
1166
dir = bzrdir.BzrDir.open(branch)
1170
class cmd_revision_history(Command):
1171
"""Display the list of revision ids on a branch."""
1174
takes_args = ['location?']
1179
def run(self, location="."):
1180
branch = Branch.open_containing(location)[0]
1181
for revid in branch.revision_history():
1182
self.outf.write(revid)
1183
self.outf.write('\n')
1186
class cmd_ancestry(Command):
1187
"""List all revisions merged into this branch."""
1189
_see_also = ['log', 'revision-history']
1190
takes_args = ['location?']
1195
def run(self, location="."):
1197
wt = WorkingTree.open_containing(location)[0]
1198
except errors.NoWorkingTree:
1199
b = Branch.open(location)
1200
last_revision = b.last_revision()
1203
last_revision = wt.last_revision()
1205
revision_ids = b.repository.get_ancestry(last_revision)
1207
for revision_id in revision_ids:
1208
self.outf.write(revision_id + '\n')
1211
class cmd_init(Command):
1212
"""Make a directory into a versioned branch.
1214
Use this to create an empty branch, or before importing an
1217
If there is a repository in a parent directory of the location, then
1218
the history of the branch will be stored in the repository. Otherwise
1219
init creates a standalone branch which carries its own history
1220
in the .bzr directory.
1222
If there is already a branch at the location but it has no working tree,
1223
the tree can be populated with 'bzr checkout'.
1225
Recipe for importing a tree of files::
1231
bzr commit -m "imported project"
1234
_see_also = ['init-repository', 'branch', 'checkout']
1235
takes_args = ['location?']
1237
Option('create-prefix',
1238
help='Create the path leading up to the branch '
1239
'if it does not already exist.'),
1240
RegistryOption('format',
1241
help='Specify a format for this branch. '
1242
'See "help formats".',
1243
registry=bzrdir.format_registry,
1244
converter=bzrdir.format_registry.make_bzrdir,
1245
value_switches=True,
1246
title="Branch Format",
1248
Option('append-revisions-only',
1249
help='Never change revnos or the existing log.'
1250
' Append revisions to it only.')
1252
def run(self, location=None, format=None, append_revisions_only=False,
1253
create_prefix=False):
1255
format = bzrdir.format_registry.make_bzrdir('default')
1256
if location is None:
1259
to_transport = transport.get_transport(location)
1261
# The path has to exist to initialize a
1262
# branch inside of it.
1263
# Just using os.mkdir, since I don't
1264
# believe that we want to create a bunch of
1265
# locations if the user supplies an extended path
1267
to_transport.ensure_base()
1268
except errors.NoSuchFile:
1269
if not create_prefix:
1270
raise errors.BzrCommandError("Parent directory of %s"
1272
"\nYou may supply --create-prefix to create all"
1273
" leading parent directories."
1275
_create_prefix(to_transport)
1278
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1279
except errors.NotBranchError:
1280
# really a NotBzrDir error...
1281
create_branch = bzrdir.BzrDir.create_branch_convenience
1282
branch = create_branch(to_transport.base, format=format,
1283
possible_transports=[to_transport])
1285
from bzrlib.transport.local import LocalTransport
1286
if existing_bzrdir.has_branch():
1287
if (isinstance(to_transport, LocalTransport)
1288
and not existing_bzrdir.has_workingtree()):
1289
raise errors.BranchExistsWithoutWorkingTree(location)
1290
raise errors.AlreadyBranchError(location)
1292
branch = existing_bzrdir.create_branch()
1293
existing_bzrdir.create_workingtree()
1294
if append_revisions_only:
1296
branch.set_append_revisions_only(True)
1297
except errors.UpgradeRequired:
1298
raise errors.BzrCommandError('This branch format cannot be set'
1299
' to append-revisions-only. Try --experimental-branch6')
1302
class cmd_init_repository(Command):
1303
"""Create a shared repository to hold branches.
1305
New branches created under the repository directory will store their
1306
revisions in the repository, not in the branch directory.
1308
If the --no-trees option is used then the branches in the repository
1309
will not have working trees by default.
1312
Create a shared repositories holding just branches::
1314
bzr init-repo --no-trees repo
1317
Make a lightweight checkout elsewhere::
1319
bzr checkout --lightweight repo/trunk trunk-checkout
1324
_see_also = ['init', 'branch', 'checkout', 'repositories']
1325
takes_args = ["location"]
1326
takes_options = [RegistryOption('format',
1327
help='Specify a format for this repository. See'
1328
' "bzr help formats" for details.',
1329
registry=bzrdir.format_registry,
1330
converter=bzrdir.format_registry.make_bzrdir,
1331
value_switches=True, title='Repository format'),
1333
help='Branches in the repository will default to'
1334
' not having a working tree.'),
1336
aliases = ["init-repo"]
1338
def run(self, location, format=None, no_trees=False):
1340
format = bzrdir.format_registry.make_bzrdir('default')
1342
if location is None:
1345
to_transport = transport.get_transport(location)
1346
to_transport.ensure_base()
1348
newdir = format.initialize_on_transport(to_transport)
1349
repo = newdir.create_repository(shared=True)
1350
repo.set_make_working_trees(not no_trees)
1353
class cmd_diff(Command):
1354
"""Show differences in the working tree, between revisions or branches.
1356
If no arguments are given, all changes for the current tree are listed.
1357
If files are given, only the changes in those files are listed.
1358
Remote and multiple branches can be compared by using the --old and
1359
--new options. If not provided, the default for both is derived from
1360
the first argument, if any, or the current tree if no arguments are
1363
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1364
produces patches suitable for "patch -p1".
1368
2 - unrepresentable changes
1373
Shows the difference in the working tree versus the last commit::
1377
Difference between the working tree and revision 1::
1381
Difference between revision 2 and revision 1::
1385
Difference between revision 2 and revision 1 for branch xxx::
1389
Show just the differences for file NEWS::
1393
Show the differences in working tree xxx for file NEWS::
1397
Show the differences from branch xxx to this working tree:
1401
Show the differences between two branches for file NEWS::
1403
bzr diff --old xxx --new yyy NEWS
1405
Same as 'bzr diff' but prefix paths with old/ and new/::
1407
bzr diff --prefix old/:new/
1409
_see_also = ['status']
1410
takes_args = ['file*']
1412
Option('diff-options', type=str,
1413
help='Pass these options to the external diff program.'),
1414
Option('prefix', type=str,
1416
help='Set prefixes added to old and new filenames, as '
1417
'two values separated by a colon. (eg "old/:new/").'),
1419
help='Branch/tree to compare from.',
1423
help='Branch/tree to compare to.',
1429
help='Use this command to compare files.',
1433
aliases = ['di', 'dif']
1434
encoding_type = 'exact'
1437
def run(self, revision=None, file_list=None, diff_options=None,
1438
prefix=None, old=None, new=None, using=None):
1439
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1441
if (prefix is None) or (prefix == '0'):
1449
old_label, new_label = prefix.split(":")
1451
raise errors.BzrCommandError(
1452
'--prefix expects two values separated by a colon'
1453
' (eg "old/:new/")')
1455
if revision and len(revision) > 2:
1456
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1457
' one or two revision specifiers')
1459
old_tree, new_tree, specific_files, extra_trees = \
1460
_get_trees_to_diff(file_list, revision, old, new)
1461
return show_diff_trees(old_tree, new_tree, sys.stdout,
1462
specific_files=specific_files,
1463
external_diff_options=diff_options,
1464
old_label=old_label, new_label=new_label,
1465
extra_trees=extra_trees, using=using)
1468
class cmd_deleted(Command):
1469
"""List files deleted in the working tree.
1471
# TODO: Show files deleted since a previous revision, or
1472
# between two revisions.
1473
# TODO: Much more efficient way to do this: read in new
1474
# directories with readdir, rather than stating each one. Same
1475
# level of effort but possibly much less IO. (Or possibly not,
1476
# if the directories are very large...)
1477
_see_also = ['status', 'ls']
1478
takes_options = ['show-ids']
1481
def run(self, show_ids=False):
1482
tree = WorkingTree.open_containing(u'.')[0]
1485
old = tree.basis_tree()
1488
for path, ie in old.inventory.iter_entries():
1489
if not tree.has_id(ie.file_id):
1490
self.outf.write(path)
1492
self.outf.write(' ')
1493
self.outf.write(ie.file_id)
1494
self.outf.write('\n')
1501
class cmd_modified(Command):
1502
"""List files modified in working tree.
1506
_see_also = ['status', 'ls']
1509
help='Write an ascii NUL (\\0) separator '
1510
'between files rather than a newline.')
1514
def run(self, null=False):
1515
tree = WorkingTree.open_containing(u'.')[0]
1516
td = tree.changes_from(tree.basis_tree())
1517
for path, id, kind, text_modified, meta_modified in td.modified:
1519
self.outf.write(path + '\0')
1521
self.outf.write(osutils.quotefn(path) + '\n')
1524
class cmd_added(Command):
1525
"""List files added in working tree.
1529
_see_also = ['status', 'ls']
1532
help='Write an ascii NUL (\\0) separator '
1533
'between files rather than a newline.')
1537
def run(self, null=False):
1538
wt = WorkingTree.open_containing(u'.')[0]
1541
basis = wt.basis_tree()
1544
basis_inv = basis.inventory
1547
if file_id in basis_inv:
1549
if inv.is_root(file_id) and len(basis_inv) == 0:
1551
path = inv.id2path(file_id)
1552
if not os.access(osutils.abspath(path), os.F_OK):
1555
self.outf.write(path + '\0')
1557
self.outf.write(osutils.quotefn(path) + '\n')
1564
class cmd_root(Command):
1565
"""Show the tree root directory.
1567
The root is the nearest enclosing directory with a .bzr control
1570
takes_args = ['filename?']
1572
def run(self, filename=None):
1573
"""Print the branch root."""
1574
tree = WorkingTree.open_containing(filename)[0]
1575
self.outf.write(tree.basedir + '\n')
1578
def _parse_limit(limitstring):
1580
return int(limitstring)
1582
msg = "The limit argument must be an integer."
1583
raise errors.BzrCommandError(msg)
1586
class cmd_log(Command):
1587
"""Show log of a branch, file, or directory.
1589
By default show the log of the branch containing the working directory.
1591
To request a range of logs, you can use the command -r begin..end
1592
-r revision requests a specific revision, -r ..end or -r begin.. are
1596
Log the current branch::
1604
Log the last 10 revisions of a branch::
1606
bzr log -r -10.. http://server/branch
1609
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1611
takes_args = ['location?']
1614
help='Show from oldest to newest.'),
1617
help='Display timezone as local, original, or utc.'),
1618
custom_help('verbose',
1619
help='Show files changed in each revision.'),
1625
help='Show revisions whose message matches this '
1626
'regular expression.',
1630
help='Limit the output to the first N revisions.',
1634
encoding_type = 'replace'
1637
def run(self, location=None, timezone='original',
1645
from bzrlib.log import show_log
1646
direction = (forward and 'forward') or 'reverse'
1651
# find the file id to log:
1653
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1657
tree = b.basis_tree()
1658
file_id = tree.path2id(fp)
1660
raise errors.BzrCommandError(
1661
"Path does not have any revision history: %s" %
1665
# FIXME ? log the current subdir only RBC 20060203
1666
if revision is not None \
1667
and len(revision) > 0 and revision[0].get_branch():
1668
location = revision[0].get_branch()
1671
dir, relpath = bzrdir.BzrDir.open_containing(location)
1672
b = dir.open_branch()
1676
if revision is None:
1679
elif len(revision) == 1:
1680
rev1 = rev2 = revision[0].in_history(b)
1681
elif len(revision) == 2:
1682
if revision[1].get_branch() != revision[0].get_branch():
1683
# b is taken from revision[0].get_branch(), and
1684
# show_log will use its revision_history. Having
1685
# different branches will lead to weird behaviors.
1686
raise errors.BzrCommandError(
1687
"Log doesn't accept two revisions in different"
1689
rev1 = revision[0].in_history(b)
1690
rev2 = revision[1].in_history(b)
1692
raise errors.BzrCommandError(
1693
'bzr log --revision takes one or two values.')
1695
if log_format is None:
1696
log_format = log.log_formatter_registry.get_default(b)
1698
lf = log_format(show_ids=show_ids, to_file=self.outf,
1699
show_timezone=timezone)
1705
direction=direction,
1706
start_revision=rev1,
1714
def get_log_format(long=False, short=False, line=False, default='long'):
1715
log_format = default
1719
log_format = 'short'
1725
class cmd_touching_revisions(Command):
1726
"""Return revision-ids which affected a particular file.
1728
A more user-friendly interface is "bzr log FILE".
1732
takes_args = ["filename"]
1735
def run(self, filename):
1736
tree, relpath = WorkingTree.open_containing(filename)
1738
file_id = tree.path2id(relpath)
1739
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1740
self.outf.write("%6d %s\n" % (revno, what))
1743
class cmd_ls(Command):
1744
"""List files in a tree.
1747
_see_also = ['status', 'cat']
1748
takes_args = ['path?']
1749
# TODO: Take a revision or remote path and list that tree instead.
1753
Option('non-recursive',
1754
help='Don\'t recurse into subdirectories.'),
1756
help='Print paths relative to the root of the branch.'),
1757
Option('unknown', help='Print unknown files.'),
1758
Option('versioned', help='Print versioned files.',
1760
Option('ignored', help='Print ignored files.'),
1762
help='Write an ascii NUL (\\0) separator '
1763
'between files rather than a newline.'),
1765
help='List entries of a particular kind: file, directory, symlink.',
1770
def run(self, revision=None, verbose=False,
1771
non_recursive=False, from_root=False,
1772
unknown=False, versioned=False, ignored=False,
1773
null=False, kind=None, show_ids=False, path=None):
1775
if kind and kind not in ('file', 'directory', 'symlink'):
1776
raise errors.BzrCommandError('invalid kind specified')
1778
if verbose and null:
1779
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1780
all = not (unknown or versioned or ignored)
1782
selection = {'I':ignored, '?':unknown, 'V':versioned}
1789
raise errors.BzrCommandError('cannot specify both --from-root'
1793
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1799
if revision is not None:
1800
tree = branch.repository.revision_tree(
1801
revision[0].as_revision_id(branch))
1803
tree = branch.basis_tree()
1807
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1808
if fp.startswith(relpath):
1809
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1810
if non_recursive and '/' in fp:
1812
if not all and not selection[fc]:
1814
if kind is not None and fkind != kind:
1817
kindch = entry.kind_character()
1818
outstring = '%-8s %s%s' % (fc, fp, kindch)
1819
if show_ids and fid is not None:
1820
outstring = "%-50s %s" % (outstring, fid)
1821
self.outf.write(outstring + '\n')
1823
self.outf.write(fp + '\0')
1826
self.outf.write(fid)
1827
self.outf.write('\0')
1835
self.outf.write('%-50s %s\n' % (fp, my_id))
1837
self.outf.write(fp + '\n')
1842
class cmd_unknowns(Command):
1843
"""List unknown files.
1851
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1852
self.outf.write(osutils.quotefn(f) + '\n')
1855
class cmd_ignore(Command):
1856
"""Ignore specified files or patterns.
1858
See ``bzr help patterns`` for details on the syntax of patterns.
1860
To remove patterns from the ignore list, edit the .bzrignore file.
1861
After adding, editing or deleting that file either indirectly by
1862
using this command or directly by using an editor, be sure to commit
1865
Note: ignore patterns containing shell wildcards must be quoted from
1869
Ignore the top level Makefile::
1871
bzr ignore ./Makefile
1873
Ignore class files in all directories::
1875
bzr ignore "*.class"
1877
Ignore .o files under the lib directory::
1879
bzr ignore "lib/**/*.o"
1881
Ignore .o files under the lib directory::
1883
bzr ignore "RE:lib/.*\.o"
1885
Ignore everything but the "debian" toplevel directory::
1887
bzr ignore "RE:(?!debian/).*"
1890
_see_also = ['status', 'ignored', 'patterns']
1891
takes_args = ['name_pattern*']
1893
Option('old-default-rules',
1894
help='Write out the ignore rules bzr < 0.9 always used.')
1897
def run(self, name_pattern_list=None, old_default_rules=None):
1898
from bzrlib import ignores
1899
if old_default_rules is not None:
1900
# dump the rules and exit
1901
for pattern in ignores.OLD_DEFAULTS:
1904
if not name_pattern_list:
1905
raise errors.BzrCommandError("ignore requires at least one "
1906
"NAME_PATTERN or --old-default-rules")
1907
name_pattern_list = [globbing.normalize_pattern(p)
1908
for p in name_pattern_list]
1909
for name_pattern in name_pattern_list:
1910
if (name_pattern[0] == '/' or
1911
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1912
raise errors.BzrCommandError(
1913
"NAME_PATTERN should not be an absolute path")
1914
tree, relpath = WorkingTree.open_containing(u'.')
1915
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1916
ignored = globbing.Globster(name_pattern_list)
1919
for entry in tree.list_files():
1923
if ignored.match(filename):
1924
matches.append(filename.encode('utf-8'))
1926
if len(matches) > 0:
1927
print "Warning: the following files are version controlled and" \
1928
" match your ignore pattern:\n%s" % ("\n".join(matches),)
1930
class cmd_ignored(Command):
1931
"""List ignored files and the patterns that matched them.
1934
encoding_type = 'replace'
1935
_see_also = ['ignore']
1939
tree = WorkingTree.open_containing(u'.')[0]
1942
for path, file_class, kind, file_id, entry in tree.list_files():
1943
if file_class != 'I':
1945
## XXX: Slightly inefficient since this was already calculated
1946
pat = tree.is_ignored(path)
1947
self.outf.write('%-50s %s\n' % (path, pat))
1952
class cmd_lookup_revision(Command):
1953
"""Lookup the revision-id from a revision-number
1956
bzr lookup-revision 33
1959
takes_args = ['revno']
1962
def run(self, revno):
1966
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1968
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1971
class cmd_export(Command):
1972
"""Export current or past revision to a destination directory or archive.
1974
If no revision is specified this exports the last committed revision.
1976
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1977
given, try to find the format with the extension. If no extension
1978
is found exports to a directory (equivalent to --format=dir).
1980
If root is supplied, it will be used as the root directory inside
1981
container formats (tar, zip, etc). If it is not supplied it will default
1982
to the exported filename. The root option has no effect for 'dir' format.
1984
If branch is omitted then the branch containing the current working
1985
directory will be used.
1987
Note: Export of tree with non-ASCII filenames to zip is not supported.
1989
================= =========================
1990
Supported formats Autodetected by extension
1991
================= =========================
1994
tbz2 .tar.bz2, .tbz2
1997
================= =========================
1999
takes_args = ['dest', 'branch?']
2002
help="Type of file to export to.",
2007
help="Name of the root directory inside the exported file."),
2009
def run(self, dest, branch=None, revision=None, format=None, root=None):
2010
from bzrlib.export import export
2013
tree = WorkingTree.open_containing(u'.')[0]
2016
b = Branch.open(branch)
2018
if revision is None:
2019
# should be tree.last_revision FIXME
2020
rev_id = b.last_revision()
2022
if len(revision) != 1:
2023
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2024
rev_id = revision[0].as_revision_id(b)
2025
t = b.repository.revision_tree(rev_id)
2027
export(t, dest, format, root)
2028
except errors.NoSuchExportFormat, e:
2029
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2032
class cmd_cat(Command):
2033
"""Write the contents of a file as of a given revision to standard output.
2035
If no revision is nominated, the last revision is used.
2037
Note: Take care to redirect standard output when using this command on a
2043
Option('name-from-revision', help='The path name in the old tree.'),
2046
takes_args = ['filename']
2047
encoding_type = 'exact'
2050
def run(self, filename, revision=None, name_from_revision=False):
2051
if revision is not None and len(revision) != 1:
2052
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2053
" one revision specifier")
2054
tree, branch, relpath = \
2055
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2058
return self._run(tree, branch, relpath, filename, revision,
2063
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2065
tree = b.basis_tree()
2066
if revision is None:
2067
revision_id = b.last_revision()
2069
revision_id = revision[0].as_revision_id(b)
2071
cur_file_id = tree.path2id(relpath)
2072
rev_tree = b.repository.revision_tree(revision_id)
2073
old_file_id = rev_tree.path2id(relpath)
2075
if name_from_revision:
2076
if old_file_id is None:
2077
raise errors.BzrCommandError("%r is not present in revision %s"
2078
% (filename, revision_id))
2080
content = rev_tree.get_file_text(old_file_id)
2081
elif cur_file_id is not None:
2082
content = rev_tree.get_file_text(cur_file_id)
2083
elif old_file_id is not None:
2084
content = rev_tree.get_file_text(old_file_id)
2086
raise errors.BzrCommandError("%r is not present in revision %s" %
2087
(filename, revision_id))
2088
self.outf.write(content)
2091
class cmd_local_time_offset(Command):
2092
"""Show the offset in seconds from GMT to local time."""
2096
print osutils.local_time_offset()
2100
class cmd_commit(Command):
2101
"""Commit changes into a new revision.
2103
If no arguments are given, the entire tree is committed.
2105
If selected files are specified, only changes to those files are
2106
committed. If a directory is specified then the directory and everything
2107
within it is committed.
2109
If author of the change is not the same person as the committer, you can
2110
specify the author's name using the --author option. The name should be
2111
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2113
A selected-file commit may fail in some cases where the committed
2114
tree would be invalid. Consider::
2119
bzr commit foo -m "committing foo"
2120
bzr mv foo/bar foo/baz
2123
bzr commit foo/bar -m "committing bar but not baz"
2125
In the example above, the last commit will fail by design. This gives
2126
the user the opportunity to decide whether they want to commit the
2127
rename at the same time, separately first, or not at all. (As a general
2128
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2130
Note: A selected-file commit after a merge is not yet supported.
2132
# TODO: Run hooks on tree to-be-committed, and after commit.
2134
# TODO: Strict commit that fails if there are deleted files.
2135
# (what does "deleted files" mean ??)
2137
# TODO: Give better message for -s, --summary, used by tla people
2139
# XXX: verbose currently does nothing
2141
_see_also = ['bugs', 'uncommit']
2142
takes_args = ['selected*']
2144
Option('message', type=unicode,
2146
help="Description of the new revision."),
2149
help='Commit even if nothing has changed.'),
2150
Option('file', type=str,
2153
help='Take commit message from this file.'),
2155
help="Refuse to commit if there are unknown "
2156
"files in the working tree."),
2157
ListOption('fixes', type=str,
2158
help="Mark a bug as being fixed by this revision."),
2159
Option('author', type=unicode,
2160
help="Set the author's name, if it's different "
2161
"from the committer."),
2163
help="Perform a local commit in a bound "
2164
"branch. Local commits are not pushed to "
2165
"the master branch until a normal commit "
2169
help='When no message is supplied, show the diff along'
2170
' with the status summary in the message editor.'),
2172
aliases = ['ci', 'checkin']
2174
def _get_bug_fix_properties(self, fixes, branch):
2176
# Configure the properties for bug fixing attributes.
2177
for fixed_bug in fixes:
2178
tokens = fixed_bug.split(':')
2179
if len(tokens) != 2:
2180
raise errors.BzrCommandError(
2181
"Invalid bug %s. Must be in the form of 'tag:id'. "
2182
"Commit refused." % fixed_bug)
2183
tag, bug_id = tokens
2185
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2186
except errors.UnknownBugTrackerAbbreviation:
2187
raise errors.BzrCommandError(
2188
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2189
except errors.MalformedBugIdentifier:
2190
raise errors.BzrCommandError(
2191
"Invalid bug identifier for %s. Commit refused."
2193
properties.append('%s fixed' % bug_url)
2194
return '\n'.join(properties)
2196
def run(self, message=None, file=None, verbose=False, selected_list=None,
2197
unchanged=False, strict=False, local=False, fixes=None,
2198
author=None, show_diff=False):
2199
from bzrlib.errors import (
2204
from bzrlib.msgeditor import (
2205
edit_commit_message_encoded,
2206
make_commit_message_template_encoded
2209
# TODO: Need a blackbox test for invoking the external editor; may be
2210
# slightly problematic to run this cross-platform.
2212
# TODO: do more checks that the commit will succeed before
2213
# spending the user's valuable time typing a commit message.
2217
tree, selected_list = tree_files(selected_list)
2218
if selected_list == ['']:
2219
# workaround - commit of root of tree should be exactly the same
2220
# as just default commit in that tree, and succeed even though
2221
# selected-file merge commit is not done yet
2226
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2228
properties['bugs'] = bug_property
2230
if local and not tree.branch.get_bound_location():
2231
raise errors.LocalRequiresBoundBranch()
2233
def get_message(commit_obj):
2234
"""Callback to get commit message"""
2235
my_message = message
2236
if my_message is None and not file:
2237
t = make_commit_message_template_encoded(tree,
2238
selected_list, diff=show_diff,
2239
output_encoding=bzrlib.user_encoding)
2240
my_message = edit_commit_message_encoded(t)
2241
if my_message is None:
2242
raise errors.BzrCommandError("please specify a commit"
2243
" message with either --message or --file")
2244
elif my_message and file:
2245
raise errors.BzrCommandError(
2246
"please specify either --message or --file")
2248
my_message = codecs.open(file, 'rt',
2249
bzrlib.user_encoding).read()
2250
if my_message == "":
2251
raise errors.BzrCommandError("empty commit message specified")
2255
tree.commit(message_callback=get_message,
2256
specific_files=selected_list,
2257
allow_pointless=unchanged, strict=strict, local=local,
2258
reporter=None, verbose=verbose, revprops=properties,
2260
except PointlessCommit:
2261
# FIXME: This should really happen before the file is read in;
2262
# perhaps prepare the commit; get the message; then actually commit
2263
raise errors.BzrCommandError("no changes to commit."
2264
" use --unchanged to commit anyhow")
2265
except ConflictsInTree:
2266
raise errors.BzrCommandError('Conflicts detected in working '
2267
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2269
except StrictCommitFailed:
2270
raise errors.BzrCommandError("Commit refused because there are"
2271
" unknown files in the working tree.")
2272
except errors.BoundBranchOutOfDate, e:
2273
raise errors.BzrCommandError(str(e) + "\n"
2274
'To commit to master branch, run update and then commit.\n'
2275
'You can also pass --local to commit to continue working '
2279
class cmd_check(Command):
2280
"""Validate working tree structure, branch consistency and repository
2283
This command checks various invariants about branch and repository storage
2284
to detect data corruption or bzr bugs.
2286
The working tree and branch checks will only give output if a problem is
2287
detected. The output fields of the repository check are:
2289
revisions: This is just the number of revisions checked. It doesn't
2291
versionedfiles: This is just the number of versionedfiles checked. It
2292
doesn't indicate a problem.
2293
unreferenced ancestors: Texts that are ancestors of other texts, but
2294
are not properly referenced by the revision ancestry. This is a
2295
subtle problem that Bazaar can work around.
2296
unique file texts: This is the total number of unique file contents
2297
seen in the checked revisions. It does not indicate a problem.
2298
repeated file texts: This is the total number of repeated texts seen
2299
in the checked revisions. Texts can be repeated when their file
2300
entries are modified, but the file contents are not. It does not
2304
_see_also = ['reconcile']
2305
takes_args = ['path?']
2306
takes_options = ['verbose']
2308
def run(self, path=None, verbose=False):
2309
from bzrlib.check import check_dwim
2312
check_dwim(path, verbose)
2315
class cmd_upgrade(Command):
2316
"""Upgrade branch storage to current format.
2318
The check command or bzr developers may sometimes advise you to run
2319
this command. When the default format has changed you may also be warned
2320
during other operations to upgrade.
2323
_see_also = ['check']
2324
takes_args = ['url?']
2326
RegistryOption('format',
2327
help='Upgrade to a specific format. See "bzr help'
2328
' formats" for details.',
2329
registry=bzrdir.format_registry,
2330
converter=bzrdir.format_registry.make_bzrdir,
2331
value_switches=True, title='Branch format'),
2334
def run(self, url='.', format=None):
2335
from bzrlib.upgrade import upgrade
2337
format = bzrdir.format_registry.make_bzrdir('default')
2338
upgrade(url, format)
2341
class cmd_whoami(Command):
2342
"""Show or set bzr user id.
2345
Show the email of the current user::
2349
Set the current user::
2351
bzr whoami "Frank Chu <fchu@example.com>"
2353
takes_options = [ Option('email',
2354
help='Display email address only.'),
2356
help='Set identity for the current branch instead of '
2359
takes_args = ['name?']
2360
encoding_type = 'replace'
2363
def run(self, email=False, branch=False, name=None):
2365
# use branch if we're inside one; otherwise global config
2367
c = Branch.open_containing('.')[0].get_config()
2368
except errors.NotBranchError:
2369
c = config.GlobalConfig()
2371
self.outf.write(c.user_email() + '\n')
2373
self.outf.write(c.username() + '\n')
2376
# display a warning if an email address isn't included in the given name.
2378
config.extract_email_address(name)
2379
except errors.NoEmailInUsername, e:
2380
warning('"%s" does not seem to contain an email address. '
2381
'This is allowed, but not recommended.', name)
2383
# use global config unless --branch given
2385
c = Branch.open_containing('.')[0].get_config()
2387
c = config.GlobalConfig()
2388
c.set_user_option('email', name)
2391
class cmd_nick(Command):
2392
"""Print or set the branch nickname.
2394
If unset, the tree root directory name is used as the nickname
2395
To print the current nickname, execute with no argument.
2398
_see_also = ['info']
2399
takes_args = ['nickname?']
2400
def run(self, nickname=None):
2401
branch = Branch.open_containing(u'.')[0]
2402
if nickname is None:
2403
self.printme(branch)
2405
branch.nick = nickname
2408
def printme(self, branch):
2412
class cmd_alias(Command):
2413
"""Set/unset and display aliases.
2416
Show the current aliases::
2420
Show the alias specified for 'll'::
2424
Set an alias for 'll'::
2426
bzr alias ll="log --line -r-10..-1"
2428
To remove an alias for 'll'::
2430
bzr alias --remove ll
2433
takes_args = ['name?']
2435
Option('remove', help='Remove the alias.'),
2438
def run(self, name=None, remove=False):
2440
self.remove_alias(name)
2442
self.print_aliases()
2444
equal_pos = name.find('=')
2446
self.print_alias(name)
2448
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2450
def remove_alias(self, alias_name):
2451
if alias_name is None:
2452
raise errors.BzrCommandError(
2453
'bzr alias --remove expects an alias to remove.')
2454
# If alias is not found, print something like:
2455
# unalias: foo: not found
2456
c = config.GlobalConfig()
2457
c.unset_alias(alias_name)
2460
def print_aliases(self):
2461
"""Print out the defined aliases in a similar format to bash."""
2462
aliases = config.GlobalConfig().get_aliases()
2463
for key, value in sorted(aliases.iteritems()):
2464
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2467
def print_alias(self, alias_name):
2468
from bzrlib.commands import get_alias
2469
alias = get_alias(alias_name)
2471
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2474
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2476
def set_alias(self, alias_name, alias_command):
2477
"""Save the alias in the global config."""
2478
c = config.GlobalConfig()
2479
c.set_alias(alias_name, alias_command)
2482
class cmd_selftest(Command):
2483
"""Run internal test suite.
2485
If arguments are given, they are regular expressions that say which tests
2486
should run. Tests matching any expression are run, and other tests are
2489
Alternatively if --first is given, matching tests are run first and then
2490
all other tests are run. This is useful if you have been working in a
2491
particular area, but want to make sure nothing else was broken.
2493
If --exclude is given, tests that match that regular expression are
2494
excluded, regardless of whether they match --first or not.
2496
To help catch accidential dependencies between tests, the --randomize
2497
option is useful. In most cases, the argument used is the word 'now'.
2498
Note that the seed used for the random number generator is displayed
2499
when this option is used. The seed can be explicitly passed as the
2500
argument to this option if required. This enables reproduction of the
2501
actual ordering used if and when an order sensitive problem is encountered.
2503
If --list-only is given, the tests that would be run are listed. This is
2504
useful when combined with --first, --exclude and/or --randomize to
2505
understand their impact. The test harness reports "Listed nn tests in ..."
2506
instead of "Ran nn tests in ..." when list mode is enabled.
2508
If the global option '--no-plugins' is given, plugins are not loaded
2509
before running the selftests. This has two effects: features provided or
2510
modified by plugins will not be tested, and tests provided by plugins will
2513
Tests that need working space on disk use a common temporary directory,
2514
typically inside $TMPDIR or /tmp.
2517
Run only tests relating to 'ignore'::
2521
Disable plugins and list tests as they're run::
2523
bzr --no-plugins selftest -v
2525
# NB: this is used from the class without creating an instance, which is
2526
# why it does not have a self parameter.
2527
def get_transport_type(typestring):
2528
"""Parse and return a transport specifier."""
2529
if typestring == "sftp":
2530
from bzrlib.transport.sftp import SFTPAbsoluteServer
2531
return SFTPAbsoluteServer
2532
if typestring == "memory":
2533
from bzrlib.transport.memory import MemoryServer
2535
if typestring == "fakenfs":
2536
from bzrlib.transport.fakenfs import FakeNFSServer
2537
return FakeNFSServer
2538
msg = "No known transport type %s. Supported types are: sftp\n" %\
2540
raise errors.BzrCommandError(msg)
2543
takes_args = ['testspecs*']
2544
takes_options = ['verbose',
2546
help='Stop when one test fails.',
2550
help='Use a different transport by default '
2551
'throughout the test suite.',
2552
type=get_transport_type),
2554
help='Run the benchmarks rather than selftests.'),
2555
Option('lsprof-timed',
2556
help='Generate lsprof output for benchmarked'
2557
' sections of code.'),
2558
Option('cache-dir', type=str,
2559
help='Cache intermediate benchmark output in this '
2562
help='Run all tests, but run specified tests first.',
2566
help='List the tests instead of running them.'),
2567
Option('randomize', type=str, argname="SEED",
2568
help='Randomize the order of tests using the given'
2569
' seed or "now" for the current time.'),
2570
Option('exclude', type=str, argname="PATTERN",
2572
help='Exclude tests that match this regular'
2574
Option('strict', help='Fail on missing dependencies or '
2576
Option('load-list', type=str, argname='TESTLISTFILE',
2577
help='Load a test id list from a text file.'),
2578
ListOption('debugflag', type=str, short_name='E',
2579
help='Turn on a selftest debug flag.'),
2580
Option('starting-with', type=str, argname='TESTID',
2582
help='Load only the tests starting with TESTID.'),
2584
encoding_type = 'replace'
2586
def run(self, testspecs_list=None, verbose=False, one=False,
2587
transport=None, benchmark=None,
2588
lsprof_timed=None, cache_dir=None,
2589
first=False, list_only=False,
2590
randomize=None, exclude=None, strict=False,
2591
load_list=None, debugflag=None, starting_with=None):
2593
from bzrlib.tests import selftest
2594
import bzrlib.benchmarks as benchmarks
2595
from bzrlib.benchmarks import tree_creator
2597
# Make deprecation warnings visible, unless -Werror is set
2598
symbol_versioning.activate_deprecation_warnings(override=False)
2600
if cache_dir is not None:
2601
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2603
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2604
print ' %s (%s python%s)' % (
2606
bzrlib.version_string,
2607
bzrlib._format_version_tuple(sys.version_info),
2610
if testspecs_list is not None:
2611
pattern = '|'.join(testspecs_list)
2615
test_suite_factory = benchmarks.test_suite
2616
# Unless user explicitly asks for quiet, be verbose in benchmarks
2617
verbose = not is_quiet()
2618
# TODO: should possibly lock the history file...
2619
benchfile = open(".perf_history", "at", buffering=1)
2621
test_suite_factory = None
2624
result = selftest(verbose=verbose,
2626
stop_on_failure=one,
2627
transport=transport,
2628
test_suite_factory=test_suite_factory,
2629
lsprof_timed=lsprof_timed,
2630
bench_history=benchfile,
2631
matching_tests_first=first,
2632
list_only=list_only,
2633
random_seed=randomize,
2634
exclude_pattern=exclude,
2636
load_list=load_list,
2637
debug_flags=debugflag,
2638
starting_with=starting_with,
2641
if benchfile is not None:
2644
note('tests passed')
2646
note('tests failed')
2647
return int(not result)
2650
class cmd_version(Command):
2651
"""Show version of bzr."""
2653
encoding_type = 'replace'
2655
Option("short", help="Print just the version number."),
2659
def run(self, short=False):
2660
from bzrlib.version import show_version
2662
self.outf.write(bzrlib.version_string + '\n')
2664
show_version(to_file=self.outf)
2667
class cmd_rocks(Command):
2668
"""Statement of optimism."""
2674
print "It sure does!"
2677
class cmd_find_merge_base(Command):
2678
"""Find and print a base revision for merging two branches."""
2679
# TODO: Options to specify revisions on either side, as if
2680
# merging only part of the history.
2681
takes_args = ['branch', 'other']
2685
def run(self, branch, other):
2686
from bzrlib.revision import ensure_null
2688
branch1 = Branch.open_containing(branch)[0]
2689
branch2 = Branch.open_containing(other)[0]
2694
last1 = ensure_null(branch1.last_revision())
2695
last2 = ensure_null(branch2.last_revision())
2697
graph = branch1.repository.get_graph(branch2.repository)
2698
base_rev_id = graph.find_unique_lca(last1, last2)
2700
print 'merge base is revision %s' % base_rev_id
2707
class cmd_merge(Command):
2708
"""Perform a three-way merge.
2710
The source of the merge can be specified either in the form of a branch,
2711
or in the form of a path to a file containing a merge directive generated
2712
with bzr send. If neither is specified, the default is the upstream branch
2713
or the branch most recently merged using --remember.
2715
When merging a branch, by default the tip will be merged. To pick a different
2716
revision, pass --revision. If you specify two values, the first will be used as
2717
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2718
available revisions, like this is commonly referred to as "cherrypicking".
2720
Revision numbers are always relative to the branch being merged.
2722
By default, bzr will try to merge in all new work from the other
2723
branch, automatically determining an appropriate base. If this
2724
fails, you may need to give an explicit base.
2726
Merge will do its best to combine the changes in two branches, but there
2727
are some kinds of problems only a human can fix. When it encounters those,
2728
it will mark a conflict. A conflict means that you need to fix something,
2729
before you should commit.
2731
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2733
If there is no default branch set, the first merge will set it. After
2734
that, you can omit the branch to use the default. To change the
2735
default, use --remember. The value will only be saved if the remote
2736
location can be accessed.
2738
The results of the merge are placed into the destination working
2739
directory, where they can be reviewed (with bzr diff), tested, and then
2740
committed to record the result of the merge.
2742
merge refuses to run if there are any uncommitted changes, unless
2746
To merge the latest revision from bzr.dev::
2748
bzr merge ../bzr.dev
2750
To merge changes up to and including revision 82 from bzr.dev::
2752
bzr merge -r 82 ../bzr.dev
2754
To merge the changes introduced by 82, without previous changes::
2756
bzr merge -r 81..82 ../bzr.dev
2758
To apply a merge directive contained in in /tmp/merge:
2760
bzr merge /tmp/merge
2763
encoding_type = 'exact'
2764
_see_also = ['update', 'remerge', 'status-flags']
2765
takes_args = ['location?']
2770
help='Merge even if the destination tree has uncommitted changes.'),
2774
Option('show-base', help="Show base revision text in "
2776
Option('uncommitted', help='Apply uncommitted changes'
2777
' from a working copy, instead of branch changes.'),
2778
Option('pull', help='If the destination is already'
2779
' completely merged into the source, pull from the'
2780
' source rather than merging. When this happens,'
2781
' you do not need to commit the result.'),
2783
help='Branch to merge into, '
2784
'rather than the one containing the working directory.',
2788
Option('preview', help='Instead of merging, show a diff of the merge.')
2791
def run(self, location=None, revision=None, force=False,
2792
merge_type=None, show_base=False, reprocess=False, remember=False,
2793
uncommitted=False, pull=False,
2797
if merge_type is None:
2798
merge_type = _mod_merge.Merge3Merger
2800
if directory is None: directory = u'.'
2801
possible_transports = []
2803
allow_pending = True
2804
verified = 'inapplicable'
2805
tree = WorkingTree.open_containing(directory)[0]
2806
change_reporter = delta._ChangeReporter(
2807
unversioned_filter=tree.is_ignored)
2810
pb = ui.ui_factory.nested_progress_bar()
2811
cleanups.append(pb.finished)
2813
cleanups.append(tree.unlock)
2814
if location is not None:
2816
mergeable = bundle.read_mergeable_from_url(location,
2817
possible_transports=possible_transports)
2818
except errors.NotABundle:
2822
raise errors.BzrCommandError('Cannot use --uncommitted'
2823
' with bundles or merge directives.')
2825
if revision is not None:
2826
raise errors.BzrCommandError(
2827
'Cannot use -r with merge directives or bundles')
2828
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2831
if merger is None and uncommitted:
2832
if revision is not None and len(revision) > 0:
2833
raise errors.BzrCommandError('Cannot use --uncommitted and'
2834
' --revision at the same time.')
2835
location = self._select_branch_location(tree, location)[0]
2836
other_tree, other_path = WorkingTree.open_containing(location)
2837
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2839
allow_pending = False
2840
if other_path != '':
2841
merger.interesting_files = [other_path]
2844
merger, allow_pending = self._get_merger_from_branch(tree,
2845
location, revision, remember, possible_transports, pb)
2847
merger.merge_type = merge_type
2848
merger.reprocess = reprocess
2849
merger.show_base = show_base
2850
self.sanity_check_merger(merger)
2851
if (merger.base_rev_id == merger.other_rev_id and
2852
merger.other_rev_id is not None):
2853
note('Nothing to do.')
2856
if merger.interesting_files is not None:
2857
raise errors.BzrCommandError('Cannot pull individual files')
2858
if (merger.base_rev_id == tree.last_revision()):
2859
result = tree.pull(merger.other_branch, False,
2860
merger.other_rev_id)
2861
result.report(self.outf)
2863
merger.check_basis(not force)
2865
return self._do_preview(merger)
2867
return self._do_merge(merger, change_reporter, allow_pending,
2870
for cleanup in reversed(cleanups):
2873
def _do_preview(self, merger):
2874
from bzrlib.diff import show_diff_trees
2875
tree_merger = merger.make_merger()
2876
tt = tree_merger.make_preview_transform()
2878
result_tree = tt.get_preview_tree()
2879
show_diff_trees(merger.this_tree, result_tree, self.outf,
2880
old_label='', new_label='')
2884
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2885
merger.change_reporter = change_reporter
2886
conflict_count = merger.do_merge()
2888
merger.set_pending()
2889
if verified == 'failed':
2890
warning('Preview patch does not match changes')
2891
if conflict_count != 0:
2896
def sanity_check_merger(self, merger):
2897
if (merger.show_base and
2898
not merger.merge_type is _mod_merge.Merge3Merger):
2899
raise errors.BzrCommandError("Show-base is not supported for this"
2900
" merge type. %s" % merger.merge_type)
2901
if merger.reprocess and not merger.merge_type.supports_reprocess:
2902
raise errors.BzrCommandError("Conflict reduction is not supported"
2903
" for merge type %s." %
2905
if merger.reprocess and merger.show_base:
2906
raise errors.BzrCommandError("Cannot do conflict reduction and"
2909
def _get_merger_from_branch(self, tree, location, revision, remember,
2910
possible_transports, pb):
2911
"""Produce a merger from a location, assuming it refers to a branch."""
2912
from bzrlib.tag import _merge_tags_if_possible
2913
# find the branch locations
2914
other_loc, user_location = self._select_branch_location(tree, location,
2916
if revision is not None and len(revision) == 2:
2917
base_loc, _unused = self._select_branch_location(tree,
2918
location, revision, 0)
2920
base_loc = other_loc
2922
other_branch, other_path = Branch.open_containing(other_loc,
2923
possible_transports)
2924
if base_loc == other_loc:
2925
base_branch = other_branch
2927
base_branch, base_path = Branch.open_containing(base_loc,
2928
possible_transports)
2929
# Find the revision ids
2930
if revision is None or len(revision) < 1 or revision[-1] is None:
2931
other_revision_id = _mod_revision.ensure_null(
2932
other_branch.last_revision())
2934
other_revision_id = revision[-1].as_revision_id(other_branch)
2935
if (revision is not None and len(revision) == 2
2936
and revision[0] is not None):
2937
base_revision_id = revision[0].as_revision_id(base_branch)
2939
base_revision_id = None
2940
# Remember where we merge from
2941
if ((remember or tree.branch.get_submit_branch() is None) and
2942
user_location is not None):
2943
tree.branch.set_submit_branch(other_branch.base)
2944
_merge_tags_if_possible(other_branch, tree.branch)
2945
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2946
other_revision_id, base_revision_id, other_branch, base_branch)
2947
if other_path != '':
2948
allow_pending = False
2949
merger.interesting_files = [other_path]
2951
allow_pending = True
2952
return merger, allow_pending
2954
def _select_branch_location(self, tree, user_location, revision=None,
2956
"""Select a branch location, according to possible inputs.
2958
If provided, branches from ``revision`` are preferred. (Both
2959
``revision`` and ``index`` must be supplied.)
2961
Otherwise, the ``location`` parameter is used. If it is None, then the
2962
``submit`` or ``parent`` location is used, and a note is printed.
2964
:param tree: The working tree to select a branch for merging into
2965
:param location: The location entered by the user
2966
:param revision: The revision parameter to the command
2967
:param index: The index to use for the revision parameter. Negative
2968
indices are permitted.
2969
:return: (selected_location, user_location). The default location
2970
will be the user-entered location.
2972
if (revision is not None and index is not None
2973
and revision[index] is not None):
2974
branch = revision[index].get_branch()
2975
if branch is not None:
2976
return branch, branch
2977
if user_location is None:
2978
location = self._get_remembered(tree, 'Merging from')
2980
location = user_location
2981
return location, user_location
2983
def _get_remembered(self, tree, verb_string):
2984
"""Use tree.branch's parent if none was supplied.
2986
Report if the remembered location was used.
2988
stored_location = tree.branch.get_submit_branch()
2989
if stored_location is None:
2990
stored_location = tree.branch.get_parent()
2991
mutter("%s", stored_location)
2992
if stored_location is None:
2993
raise errors.BzrCommandError("No location specified or remembered")
2994
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
2995
note(u"%s remembered location %s", verb_string, display_url)
2996
return stored_location
2999
class cmd_remerge(Command):
3002
Use this if you want to try a different merge technique while resolving
3003
conflicts. Some merge techniques are better than others, and remerge
3004
lets you try different ones on different files.
3006
The options for remerge have the same meaning and defaults as the ones for
3007
merge. The difference is that remerge can (only) be run when there is a
3008
pending merge, and it lets you specify particular files.
3011
Re-do the merge of all conflicted files, and show the base text in
3012
conflict regions, in addition to the usual THIS and OTHER texts::
3014
bzr remerge --show-base
3016
Re-do the merge of "foobar", using the weave merge algorithm, with
3017
additional processing to reduce the size of conflict regions::
3019
bzr remerge --merge-type weave --reprocess foobar
3021
takes_args = ['file*']
3026
help="Show base revision text in conflicts."),
3029
def run(self, file_list=None, merge_type=None, show_base=False,
3031
if merge_type is None:
3032
merge_type = _mod_merge.Merge3Merger
3033
tree, file_list = tree_files(file_list)
3036
parents = tree.get_parent_ids()
3037
if len(parents) != 2:
3038
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3039
" merges. Not cherrypicking or"
3041
repository = tree.branch.repository
3042
interesting_ids = None
3044
conflicts = tree.conflicts()
3045
if file_list is not None:
3046
interesting_ids = set()
3047
for filename in file_list:
3048
file_id = tree.path2id(filename)
3050
raise errors.NotVersionedError(filename)
3051
interesting_ids.add(file_id)
3052
if tree.kind(file_id) != "directory":
3055
for name, ie in tree.inventory.iter_entries(file_id):
3056
interesting_ids.add(ie.file_id)
3057
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3059
# Remerge only supports resolving contents conflicts
3060
allowed_conflicts = ('text conflict', 'contents conflict')
3061
restore_files = [c.path for c in conflicts
3062
if c.typestring in allowed_conflicts]
3063
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3064
tree.set_conflicts(ConflictList(new_conflicts))
3065
if file_list is not None:
3066
restore_files = file_list
3067
for filename in restore_files:
3069
restore(tree.abspath(filename))
3070
except errors.NotConflicted:
3072
# Disable pending merges, because the file texts we are remerging
3073
# have not had those merges performed. If we use the wrong parents
3074
# list, we imply that the working tree text has seen and rejected
3075
# all the changes from the other tree, when in fact those changes
3076
# have not yet been seen.
3077
pb = ui.ui_factory.nested_progress_bar()
3078
tree.set_parent_ids(parents[:1])
3080
merger = _mod_merge.Merger.from_revision_ids(pb,
3082
merger.interesting_ids = interesting_ids
3083
merger.merge_type = merge_type
3084
merger.show_base = show_base
3085
merger.reprocess = reprocess
3086
conflicts = merger.do_merge()
3088
tree.set_parent_ids(parents)
3098
class cmd_revert(Command):
3099
"""Revert files to a previous revision.
3101
Giving a list of files will revert only those files. Otherwise, all files
3102
will be reverted. If the revision is not specified with '--revision', the
3103
last committed revision is used.
3105
To remove only some changes, without reverting to a prior version, use
3106
merge instead. For example, "merge . --revision -2..-3" will remove the
3107
changes introduced by -2, without affecting the changes introduced by -1.
3108
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3110
By default, any files that have been manually changed will be backed up
3111
first. (Files changed only by merge are not backed up.) Backup files have
3112
'.~#~' appended to their name, where # is a number.
3114
When you provide files, you can use their current pathname or the pathname
3115
from the target revision. So you can use revert to "undelete" a file by
3116
name. If you name a directory, all the contents of that directory will be
3119
Any files that have been newly added since that revision will be deleted,
3120
with a backup kept if appropriate. Directories containing unknown files
3121
will not be deleted.
3123
The working tree contains a list of pending merged revisions, which will
3124
be included as parents in the next commit. Normally, revert clears that
3125
list as well as reverting the files. If any files are specified, revert
3126
leaves the pending merge list alone and reverts only the files. Use "bzr
3127
revert ." in the tree root to revert all files but keep the merge record,
3128
and "bzr revert --forget-merges" to clear the pending merge list without
3129
reverting any files.
3132
_see_also = ['cat', 'export']
3135
Option('no-backup', "Do not save backups of reverted files."),
3136
Option('forget-merges',
3137
'Remove pending merge marker, without changing any files.'),
3139
takes_args = ['file*']
3141
def run(self, revision=None, no_backup=False, file_list=None,
3142
forget_merges=None):
3143
tree, file_list = tree_files(file_list)
3145
tree.set_parent_ids(tree.get_parent_ids()[:1])
3147
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3150
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3151
if revision is None:
3152
rev_id = tree.last_revision()
3153
elif len(revision) != 1:
3154
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3156
rev_id = revision[0].as_revision_id(tree.branch)
3157
pb = ui.ui_factory.nested_progress_bar()
3159
tree.revert(file_list,
3160
tree.branch.repository.revision_tree(rev_id),
3161
not no_backup, pb, report_changes=True)
3166
class cmd_assert_fail(Command):
3167
"""Test reporting of assertion failures"""
3168
# intended just for use in testing
3173
raise AssertionError("always fails")
3176
class cmd_help(Command):
3177
"""Show help on a command or other topic.
3180
_see_also = ['topics']
3182
Option('long', 'Show help on all commands.'),
3184
takes_args = ['topic?']
3185
aliases = ['?', '--help', '-?', '-h']
3188
def run(self, topic=None, long=False):
3190
if topic is None and long:
3192
bzrlib.help.help(topic)
3195
class cmd_shell_complete(Command):
3196
"""Show appropriate completions for context.
3198
For a list of all available commands, say 'bzr shell-complete'.
3200
takes_args = ['context?']
3205
def run(self, context=None):
3206
import shellcomplete
3207
shellcomplete.shellcomplete(context)
3210
class cmd_missing(Command):
3211
"""Show unmerged/unpulled revisions between two branches.
3213
OTHER_BRANCH may be local or remote.
3216
_see_also = ['merge', 'pull']
3217
takes_args = ['other_branch?']
3219
Option('reverse', 'Reverse the order of revisions.'),
3221
'Display changes in the local branch only.'),
3222
Option('this' , 'Same as --mine-only.'),
3223
Option('theirs-only',
3224
'Display changes in the remote branch only.'),
3225
Option('other', 'Same as --theirs-only.'),
3230
encoding_type = 'replace'
3233
def run(self, other_branch=None, reverse=False, mine_only=False,
3234
theirs_only=False, log_format=None, long=False, short=False, line=False,
3235
show_ids=False, verbose=False, this=False, other=False):
3236
from bzrlib.missing import find_unmerged, iter_log_revisions
3242
# TODO: We should probably check that we don't have mine-only and
3243
# theirs-only set, but it gets complicated because we also have
3244
# this and other which could be used.
3251
local_branch = Branch.open_containing(u".")[0]
3252
parent = local_branch.get_parent()
3253
if other_branch is None:
3254
other_branch = parent
3255
if other_branch is None:
3256
raise errors.BzrCommandError("No peer location known"
3258
display_url = urlutils.unescape_for_display(parent,
3260
self.outf.write("Using last location: " + display_url + "\n")
3262
remote_branch = Branch.open(other_branch)
3263
if remote_branch.base == local_branch.base:
3264
remote_branch = local_branch
3265
local_branch.lock_read()
3267
remote_branch.lock_read()
3269
local_extra, remote_extra = find_unmerged(
3270
local_branch, remote_branch, restrict)
3272
if log_format is None:
3273
registry = log.log_formatter_registry
3274
log_format = registry.get_default(local_branch)
3275
lf = log_format(to_file=self.outf,
3277
show_timezone='original')
3278
if reverse is False:
3279
if local_extra is not None:
3280
local_extra.reverse()
3281
if remote_extra is not None:
3282
remote_extra.reverse()
3285
if local_extra and not theirs_only:
3286
self.outf.write("You have %d extra revision(s):\n" %
3288
for revision in iter_log_revisions(local_extra,
3289
local_branch.repository,
3291
lf.log_revision(revision)
3292
printed_local = True
3295
printed_local = False
3297
if remote_extra and not mine_only:
3298
if printed_local is True:
3299
self.outf.write("\n\n\n")
3300
self.outf.write("You are missing %d revision(s):\n" %
3302
for revision in iter_log_revisions(remote_extra,
3303
remote_branch.repository,
3305
lf.log_revision(revision)
3308
if mine_only and not local_extra:
3309
# We checked local, and found nothing extra
3310
self.outf.write('This branch is up to date.\n')
3311
elif theirs_only and not remote_extra:
3312
# We checked remote, and found nothing extra
3313
self.outf.write('Other branch is up to date.\n')
3314
elif not (mine_only or theirs_only or local_extra or
3316
# We checked both branches, and neither one had extra
3318
self.outf.write("Branches are up to date.\n")
3320
remote_branch.unlock()
3322
local_branch.unlock()
3323
if not status_code and parent is None and other_branch is not None:
3324
local_branch.lock_write()
3326
# handle race conditions - a parent might be set while we run.
3327
if local_branch.get_parent() is None:
3328
local_branch.set_parent(remote_branch.base)
3330
local_branch.unlock()
3334
class cmd_pack(Command):
3335
"""Compress the data within a repository."""
3337
_see_also = ['repositories']
3338
takes_args = ['branch_or_repo?']
3340
def run(self, branch_or_repo='.'):
3341
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3343
branch = dir.open_branch()
3344
repository = branch.repository
3345
except errors.NotBranchError:
3346
repository = dir.open_repository()
3350
class cmd_plugins(Command):
3351
"""List the installed plugins.
3353
This command displays the list of installed plugins including
3354
version of plugin and a short description of each.
3356
--verbose shows the path where each plugin is located.
3358
A plugin is an external component for Bazaar that extends the
3359
revision control system, by adding or replacing code in Bazaar.
3360
Plugins can do a variety of things, including overriding commands,
3361
adding new commands, providing additional network transports and
3362
customizing log output.
3364
See the Bazaar web site, http://bazaar-vcs.org, for further
3365
information on plugins including where to find them and how to
3366
install them. Instructions are also provided there on how to
3367
write new plugins using the Python programming language.
3369
takes_options = ['verbose']
3372
def run(self, verbose=False):
3373
import bzrlib.plugin
3374
from inspect import getdoc
3376
for name, plugin in bzrlib.plugin.plugins().items():
3377
version = plugin.__version__
3378
if version == 'unknown':
3380
name_ver = '%s %s' % (name, version)
3381
d = getdoc(plugin.module)
3383
doc = d.split('\n')[0]
3385
doc = '(no description)'
3386
result.append((name_ver, doc, plugin.path()))
3387
for name_ver, doc, path in sorted(result):
3395
class cmd_testament(Command):
3396
"""Show testament (signing-form) of a revision."""
3399
Option('long', help='Produce long-format testament.'),
3401
help='Produce a strict-format testament.')]
3402
takes_args = ['branch?']
3404
def run(self, branch=u'.', revision=None, long=False, strict=False):
3405
from bzrlib.testament import Testament, StrictTestament
3407
testament_class = StrictTestament
3409
testament_class = Testament
3411
b = Branch.open_containing(branch)[0]
3413
b = Branch.open(branch)
3416
if revision is None:
3417
rev_id = b.last_revision()
3419
rev_id = revision[0].as_revision_id(b)
3420
t = testament_class.from_revision(b.repository, rev_id)
3422
sys.stdout.writelines(t.as_text_lines())
3424
sys.stdout.write(t.as_short_text())
3429
class cmd_annotate(Command):
3430
"""Show the origin of each line in a file.
3432
This prints out the given file with an annotation on the left side
3433
indicating which revision, author and date introduced the change.
3435
If the origin is the same for a run of consecutive lines, it is
3436
shown only at the top, unless the --all option is given.
3438
# TODO: annotate directories; showing when each file was last changed
3439
# TODO: if the working copy is modified, show annotations on that
3440
# with new uncommitted lines marked
3441
aliases = ['ann', 'blame', 'praise']
3442
takes_args = ['filename']
3443
takes_options = [Option('all', help='Show annotations on all lines.'),
3444
Option('long', help='Show commit date in annotations.'),
3448
encoding_type = 'exact'
3451
def run(self, filename, all=False, long=False, revision=None,
3453
from bzrlib.annotate import annotate_file
3454
wt, branch, relpath = \
3455
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3461
if revision is None:
3462
revision_id = branch.last_revision()
3463
elif len(revision) != 1:
3464
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3466
revision_id = revision[0].as_revision_id(branch)
3467
tree = branch.repository.revision_tree(revision_id)
3469
file_id = wt.path2id(relpath)
3471
file_id = tree.path2id(relpath)
3473
raise errors.NotVersionedError(filename)
3474
file_version = tree.inventory[file_id].revision
3475
annotate_file(branch, file_version, file_id, long, all, self.outf,
3484
class cmd_re_sign(Command):
3485
"""Create a digital signature for an existing revision."""
3486
# TODO be able to replace existing ones.
3488
hidden = True # is this right ?
3489
takes_args = ['revision_id*']
3490
takes_options = ['revision']
3492
def run(self, revision_id_list=None, revision=None):
3493
if revision_id_list is not None and revision is not None:
3494
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3495
if revision_id_list is None and revision is None:
3496
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3497
b = WorkingTree.open_containing(u'.')[0].branch
3500
return self._run(b, revision_id_list, revision)
3504
def _run(self, b, revision_id_list, revision):
3505
import bzrlib.gpg as gpg
3506
gpg_strategy = gpg.GPGStrategy(b.get_config())
3507
if revision_id_list is not None:
3508
b.repository.start_write_group()
3510
for revision_id in revision_id_list:
3511
b.repository.sign_revision(revision_id, gpg_strategy)
3513
b.repository.abort_write_group()
3516
b.repository.commit_write_group()
3517
elif revision is not None:
3518
if len(revision) == 1:
3519
revno, rev_id = revision[0].in_history(b)
3520
b.repository.start_write_group()
3522
b.repository.sign_revision(rev_id, gpg_strategy)
3524
b.repository.abort_write_group()
3527
b.repository.commit_write_group()
3528
elif len(revision) == 2:
3529
# are they both on rh- if so we can walk between them
3530
# might be nice to have a range helper for arbitrary
3531
# revision paths. hmm.
3532
from_revno, from_revid = revision[0].in_history(b)
3533
to_revno, to_revid = revision[1].in_history(b)
3534
if to_revid is None:
3535
to_revno = b.revno()
3536
if from_revno is None or to_revno is None:
3537
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3538
b.repository.start_write_group()
3540
for revno in range(from_revno, to_revno + 1):
3541
b.repository.sign_revision(b.get_rev_id(revno),
3544
b.repository.abort_write_group()
3547
b.repository.commit_write_group()
3549
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3552
class cmd_bind(Command):
3553
"""Convert the current branch into a checkout of the supplied branch.
3555
Once converted into a checkout, commits must succeed on the master branch
3556
before they will be applied to the local branch.
3559
_see_also = ['checkouts', 'unbind']
3560
takes_args = ['location?']
3563
def run(self, location=None):
3564
b, relpath = Branch.open_containing(u'.')
3565
if location is None:
3567
location = b.get_old_bound_location()
3568
except errors.UpgradeRequired:
3569
raise errors.BzrCommandError('No location supplied. '
3570
'This format does not remember old locations.')
3572
if location is None:
3573
raise errors.BzrCommandError('No location supplied and no '
3574
'previous location known')
3575
b_other = Branch.open(location)
3578
except errors.DivergedBranches:
3579
raise errors.BzrCommandError('These branches have diverged.'
3580
' Try merging, and then bind again.')
3583
class cmd_unbind(Command):
3584
"""Convert the current checkout into a regular branch.
3586
After unbinding, the local branch is considered independent and subsequent
3587
commits will be local only.
3590
_see_also = ['checkouts', 'bind']
3595
b, relpath = Branch.open_containing(u'.')
3597
raise errors.BzrCommandError('Local branch is not bound')
3600
class cmd_uncommit(Command):
3601
"""Remove the last committed revision.
3603
--verbose will print out what is being removed.
3604
--dry-run will go through all the motions, but not actually
3607
If --revision is specified, uncommit revisions to leave the branch at the
3608
specified revision. For example, "bzr uncommit -r 15" will leave the
3609
branch at revision 15.
3611
Uncommit leaves the working tree ready for a new commit. The only change
3612
it may make is to restore any pending merges that were present before
3616
# TODO: jam 20060108 Add an option to allow uncommit to remove
3617
# unreferenced information in 'branch-as-repository' branches.
3618
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3619
# information in shared branches as well.
3620
_see_also = ['commit']
3621
takes_options = ['verbose', 'revision',
3622
Option('dry-run', help='Don\'t actually make changes.'),
3623
Option('force', help='Say yes to all questions.'),
3625
help="Only remove the commits from the local branch"
3626
" when in a checkout."
3629
takes_args = ['location?']
3631
encoding_type = 'replace'
3633
def run(self, location=None,
3634
dry_run=False, verbose=False,
3635
revision=None, force=False, local=False):
3636
if location is None:
3638
control, relpath = bzrdir.BzrDir.open_containing(location)
3640
tree = control.open_workingtree()
3642
except (errors.NoWorkingTree, errors.NotLocalUrl):
3644
b = control.open_branch()
3646
if tree is not None:
3651
return self._run(b, tree, dry_run, verbose, revision, force,
3654
if tree is not None:
3659
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3660
from bzrlib.log import log_formatter, show_log
3661
from bzrlib.uncommit import uncommit
3663
last_revno, last_rev_id = b.last_revision_info()
3666
if revision is None:
3668
rev_id = last_rev_id
3670
# 'bzr uncommit -r 10' actually means uncommit
3671
# so that the final tree is at revno 10.
3672
# but bzrlib.uncommit.uncommit() actually uncommits
3673
# the revisions that are supplied.
3674
# So we need to offset it by one
3675
revno = revision[0].in_history(b).revno + 1
3676
if revno <= last_revno:
3677
rev_id = b.get_rev_id(revno)
3679
if rev_id is None or _mod_revision.is_null(rev_id):
3680
self.outf.write('No revisions to uncommit.\n')
3683
lf = log_formatter('short',
3685
show_timezone='original')
3690
direction='forward',
3691
start_revision=revno,
3692
end_revision=last_revno)
3695
print 'Dry-run, pretending to remove the above revisions.'
3697
val = raw_input('Press <enter> to continue')
3699
print 'The above revision(s) will be removed.'
3701
val = raw_input('Are you sure [y/N]? ')
3702
if val.lower() not in ('y', 'yes'):
3706
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3707
revno=revno, local=local)
3710
class cmd_break_lock(Command):
3711
"""Break a dead lock on a repository, branch or working directory.
3713
CAUTION: Locks should only be broken when you are sure that the process
3714
holding the lock has been stopped.
3716
You can get information on what locks are open via the 'bzr info' command.
3721
takes_args = ['location?']
3723
def run(self, location=None, show=False):
3724
if location is None:
3726
control, relpath = bzrdir.BzrDir.open_containing(location)
3728
control.break_lock()
3729
except NotImplementedError:
3733
class cmd_wait_until_signalled(Command):
3734
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3736
This just prints a line to signal when it is ready, then blocks on stdin.
3742
sys.stdout.write("running\n")
3744
sys.stdin.readline()
3747
class cmd_serve(Command):
3748
"""Run the bzr server."""
3750
aliases = ['server']
3754
help='Serve on stdin/out for use from inetd or sshd.'),
3756
help='Listen for connections on nominated port of the form '
3757
'[hostname:]portnumber. Passing 0 as the port number will '
3758
'result in a dynamically allocated port. The default port is '
3762
help='Serve contents of this directory.',
3764
Option('allow-writes',
3765
help='By default the server is a readonly server. Supplying '
3766
'--allow-writes enables write access to the contents of '
3767
'the served directory and below.'
3771
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3772
from bzrlib import lockdir
3773
from bzrlib.smart import medium, server
3774
from bzrlib.transport import get_transport
3775
from bzrlib.transport.chroot import ChrootServer
3776
if directory is None:
3777
directory = os.getcwd()
3778
url = urlutils.local_path_to_url(directory)
3779
if not allow_writes:
3780
url = 'readonly+' + url
3781
chroot_server = ChrootServer(get_transport(url))
3782
chroot_server.setUp()
3783
t = get_transport(chroot_server.get_url())
3785
smart_server = medium.SmartServerPipeStreamMedium(
3786
sys.stdin, sys.stdout, t)
3788
host = medium.BZR_DEFAULT_INTERFACE
3790
port = medium.BZR_DEFAULT_PORT
3793
host, port = port.split(':')
3795
smart_server = server.SmartTCPServer(t, host=host, port=port)
3796
print 'listening on port: ', smart_server.port
3798
# for the duration of this server, no UI output is permitted.
3799
# note that this may cause problems with blackbox tests. This should
3800
# be changed with care though, as we dont want to use bandwidth sending
3801
# progress over stderr to smart server clients!
3802
old_factory = ui.ui_factory
3803
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3805
ui.ui_factory = ui.SilentUIFactory()
3806
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3807
smart_server.serve()
3809
ui.ui_factory = old_factory
3810
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3813
class cmd_join(Command):
3814
"""Combine a subtree into its containing tree.
3816
This command is for experimental use only. It requires the target tree
3817
to be in dirstate-with-subtree format, which cannot be converted into
3820
The TREE argument should be an independent tree, inside another tree, but
3821
not part of it. (Such trees can be produced by "bzr split", but also by
3822
running "bzr branch" with the target inside a tree.)
3824
The result is a combined tree, with the subtree no longer an independant
3825
part. This is marked as a merge of the subtree into the containing tree,
3826
and all history is preserved.
3828
If --reference is specified, the subtree retains its independence. It can
3829
be branched by itself, and can be part of multiple projects at the same
3830
time. But operations performed in the containing tree, such as commit
3831
and merge, will recurse into the subtree.
3834
_see_also = ['split']
3835
takes_args = ['tree']
3837
Option('reference', help='Join by reference.'),
3841
def run(self, tree, reference=False):
3842
sub_tree = WorkingTree.open(tree)
3843
parent_dir = osutils.dirname(sub_tree.basedir)
3844
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3845
repo = containing_tree.branch.repository
3846
if not repo.supports_rich_root():
3847
raise errors.BzrCommandError(
3848
"Can't join trees because %s doesn't support rich root data.\n"
3849
"You can use bzr upgrade on the repository."
3853
containing_tree.add_reference(sub_tree)
3854
except errors.BadReferenceTarget, e:
3855
# XXX: Would be better to just raise a nicely printable
3856
# exception from the real origin. Also below. mbp 20070306
3857
raise errors.BzrCommandError("Cannot join %s. %s" %
3861
containing_tree.subsume(sub_tree)
3862
except errors.BadSubsumeSource, e:
3863
raise errors.BzrCommandError("Cannot join %s. %s" %
3867
class cmd_split(Command):
3868
"""Split a subdirectory of a tree into a separate tree.
3870
This command will produce a target tree in a format that supports
3871
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3872
converted into earlier formats like 'dirstate-tags'.
3874
The TREE argument should be a subdirectory of a working tree. That
3875
subdirectory will be converted into an independent tree, with its own
3876
branch. Commits in the top-level tree will not apply to the new subtree.
3879
# join is not un-hidden yet
3880
#_see_also = ['join']
3881
takes_args = ['tree']
3883
def run(self, tree):
3884
containing_tree, subdir = WorkingTree.open_containing(tree)
3885
sub_id = containing_tree.path2id(subdir)
3887
raise errors.NotVersionedError(subdir)
3889
containing_tree.extract(sub_id)
3890
except errors.RootNotRich:
3891
raise errors.UpgradeRequired(containing_tree.branch.base)
3894
class cmd_merge_directive(Command):
3895
"""Generate a merge directive for auto-merge tools.
3897
A directive requests a merge to be performed, and also provides all the
3898
information necessary to do so. This means it must either include a
3899
revision bundle, or the location of a branch containing the desired
3902
A submit branch (the location to merge into) must be supplied the first
3903
time the command is issued. After it has been supplied once, it will
3904
be remembered as the default.
3906
A public branch is optional if a revision bundle is supplied, but required
3907
if --diff or --plain is specified. It will be remembered as the default
3908
after the first use.
3911
takes_args = ['submit_branch?', 'public_branch?']
3915
_see_also = ['send']
3918
RegistryOption.from_kwargs('patch-type',
3919
'The type of patch to include in the directive.',
3921
value_switches=True,
3923
bundle='Bazaar revision bundle (default).',
3924
diff='Normal unified diff.',
3925
plain='No patch, just directive.'),
3926
Option('sign', help='GPG-sign the directive.'), 'revision',
3927
Option('mail-to', type=str,
3928
help='Instead of printing the directive, email to this address.'),
3929
Option('message', type=str, short_name='m',
3930
help='Message to use when committing this merge.')
3933
encoding_type = 'exact'
3935
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3936
sign=False, revision=None, mail_to=None, message=None):
3937
from bzrlib.revision import ensure_null, NULL_REVISION
3938
include_patch, include_bundle = {
3939
'plain': (False, False),
3940
'diff': (True, False),
3941
'bundle': (True, True),
3943
branch = Branch.open('.')
3944
stored_submit_branch = branch.get_submit_branch()
3945
if submit_branch is None:
3946
submit_branch = stored_submit_branch
3948
if stored_submit_branch is None:
3949
branch.set_submit_branch(submit_branch)
3950
if submit_branch is None:
3951
submit_branch = branch.get_parent()
3952
if submit_branch is None:
3953
raise errors.BzrCommandError('No submit branch specified or known')
3955
stored_public_branch = branch.get_public_branch()
3956
if public_branch is None:
3957
public_branch = stored_public_branch
3958
elif stored_public_branch is None:
3959
branch.set_public_branch(public_branch)
3960
if not include_bundle and public_branch is None:
3961
raise errors.BzrCommandError('No public branch specified or'
3963
base_revision_id = None
3964
if revision is not None:
3965
if len(revision) > 2:
3966
raise errors.BzrCommandError('bzr merge-directive takes '
3967
'at most two one revision identifiers')
3968
revision_id = revision[-1].as_revision_id(branch)
3969
if len(revision) == 2:
3970
base_revision_id = revision[0].as_revision_id(branch)
3972
revision_id = branch.last_revision()
3973
revision_id = ensure_null(revision_id)
3974
if revision_id == NULL_REVISION:
3975
raise errors.BzrCommandError('No revisions to bundle.')
3976
directive = merge_directive.MergeDirective2.from_objects(
3977
branch.repository, revision_id, time.time(),
3978
osutils.local_time_offset(), submit_branch,
3979
public_branch=public_branch, include_patch=include_patch,
3980
include_bundle=include_bundle, message=message,
3981
base_revision_id=base_revision_id)
3984
self.outf.write(directive.to_signed(branch))
3986
self.outf.writelines(directive.to_lines())
3988
message = directive.to_email(mail_to, branch, sign)
3989
s = SMTPConnection(branch.get_config())
3990
s.send_email(message)
3993
class cmd_send(Command):
3994
"""Mail or create a merge-directive for submiting changes.
3996
A merge directive provides many things needed for requesting merges:
3998
* A machine-readable description of the merge to perform
4000
* An optional patch that is a preview of the changes requested
4002
* An optional bundle of revision data, so that the changes can be applied
4003
directly from the merge directive, without retrieving data from a
4006
If --no-bundle is specified, then public_branch is needed (and must be
4007
up-to-date), so that the receiver can perform the merge using the
4008
public_branch. The public_branch is always included if known, so that
4009
people can check it later.
4011
The submit branch defaults to the parent, but can be overridden. Both
4012
submit branch and public branch will be remembered if supplied.
4014
If a public_branch is known for the submit_branch, that public submit
4015
branch is used in the merge instructions. This means that a local mirror
4016
can be used as your actual submit branch, once you have set public_branch
4019
Mail is sent using your preferred mail program. This should be transparent
4020
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4021
If the preferred client can't be found (or used), your editor will be used.
4023
To use a specific mail program, set the mail_client configuration option.
4024
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4025
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4026
generic options are "default", "editor", "emacsclient", "mapi", and
4029
If mail is being sent, a to address is required. This can be supplied
4030
either on the commandline, by setting the submit_to configuration
4031
option in the branch itself or the child_submit_to configuration option
4032
in the submit branch.
4034
Two formats are currently supported: "4" uses revision bundle format 4 and
4035
merge directive format 2. It is significantly faster and smaller than
4036
older formats. It is compatible with Bazaar 0.19 and later. It is the
4037
default. "0.9" uses revision bundle format 0.9 and merge directive
4038
format 1. It is compatible with Bazaar 0.12 - 0.18.
4040
Merge directives are applied using the merge command or the pull command.
4043
encoding_type = 'exact'
4045
_see_also = ['merge', 'pull']
4047
takes_args = ['submit_branch?', 'public_branch?']
4051
help='Do not include a bundle in the merge directive.'),
4052
Option('no-patch', help='Do not include a preview patch in the merge'
4055
help='Remember submit and public branch.'),
4057
help='Branch to generate the submission from, '
4058
'rather than the one containing the working directory.',
4061
Option('output', short_name='o',
4062
help='Write merge directive to this file; '
4063
'use - for stdout.',
4065
Option('mail-to', help='Mail the request to this address.',
4069
RegistryOption.from_kwargs('format',
4070
'Use the specified output format.',
4071
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4072
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4075
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4076
no_patch=False, revision=None, remember=False, output=None,
4077
format='4', mail_to=None, message=None, **kwargs):
4078
return self._run(submit_branch, revision, public_branch, remember,
4079
format, no_bundle, no_patch, output,
4080
kwargs.get('from', '.'), mail_to, message)
4082
def _run(self, submit_branch, revision, public_branch, remember, format,
4083
no_bundle, no_patch, output, from_, mail_to, message):
4084
from bzrlib.revision import NULL_REVISION
4085
branch = Branch.open_containing(from_)[0]
4087
outfile = StringIO()
4091
outfile = open(output, 'wb')
4092
# we may need to write data into branch's repository to calculate
4097
config = branch.get_config()
4099
mail_to = config.get_user_option('submit_to')
4100
mail_client = config.get_mail_client()
4101
if remember and submit_branch is None:
4102
raise errors.BzrCommandError(
4103
'--remember requires a branch to be specified.')
4104
stored_submit_branch = branch.get_submit_branch()
4105
remembered_submit_branch = False
4106
if submit_branch is None:
4107
submit_branch = stored_submit_branch
4108
remembered_submit_branch = True
4110
if stored_submit_branch is None or remember:
4111
branch.set_submit_branch(submit_branch)
4112
if submit_branch is None:
4113
submit_branch = branch.get_parent()
4114
remembered_submit_branch = True
4115
if submit_branch is None:
4116
raise errors.BzrCommandError('No submit branch known or'
4118
if remembered_submit_branch:
4119
note('Using saved location: %s', submit_branch)
4122
submit_config = Branch.open(submit_branch).get_config()
4123
mail_to = submit_config.get_user_option("child_submit_to")
4125
stored_public_branch = branch.get_public_branch()
4126
if public_branch is None:
4127
public_branch = stored_public_branch
4128
elif stored_public_branch is None or remember:
4129
branch.set_public_branch(public_branch)
4130
if no_bundle and public_branch is None:
4131
raise errors.BzrCommandError('No public branch specified or'
4133
base_revision_id = None
4135
if revision is not None:
4136
if len(revision) > 2:
4137
raise errors.BzrCommandError('bzr send takes '
4138
'at most two one revision identifiers')
4139
revision_id = revision[-1].as_revision_id(branch)
4140
if len(revision) == 2:
4141
base_revision_id = revision[0].as_revision_id(branch)
4142
if revision_id is None:
4143
revision_id = branch.last_revision()
4144
if revision_id == NULL_REVISION:
4145
raise errors.BzrCommandError('No revisions to submit.')
4147
directive = merge_directive.MergeDirective2.from_objects(
4148
branch.repository, revision_id, time.time(),
4149
osutils.local_time_offset(), submit_branch,
4150
public_branch=public_branch, include_patch=not no_patch,
4151
include_bundle=not no_bundle, message=message,
4152
base_revision_id=base_revision_id)
4153
elif format == '0.9':
4156
patch_type = 'bundle'
4158
raise errors.BzrCommandError('Format 0.9 does not'
4159
' permit bundle with no patch')
4165
directive = merge_directive.MergeDirective.from_objects(
4166
branch.repository, revision_id, time.time(),
4167
osutils.local_time_offset(), submit_branch,
4168
public_branch=public_branch, patch_type=patch_type,
4171
outfile.writelines(directive.to_lines())
4173
subject = '[MERGE] '
4174
if message is not None:
4177
revision = branch.repository.get_revision(revision_id)
4178
subject += revision.get_summary()
4179
basename = directive.get_disk_name(branch)
4180
mail_client.compose_merge_request(mail_to, subject,
4181
outfile.getvalue(), basename)
4188
class cmd_bundle_revisions(cmd_send):
4190
"""Create a merge-directive for submiting changes.
4192
A merge directive provides many things needed for requesting merges:
4194
* A machine-readable description of the merge to perform
4196
* An optional patch that is a preview of the changes requested
4198
* An optional bundle of revision data, so that the changes can be applied
4199
directly from the merge directive, without retrieving data from a
4202
If --no-bundle is specified, then public_branch is needed (and must be
4203
up-to-date), so that the receiver can perform the merge using the
4204
public_branch. The public_branch is always included if known, so that
4205
people can check it later.
4207
The submit branch defaults to the parent, but can be overridden. Both
4208
submit branch and public branch will be remembered if supplied.
4210
If a public_branch is known for the submit_branch, that public submit
4211
branch is used in the merge instructions. This means that a local mirror
4212
can be used as your actual submit branch, once you have set public_branch
4215
Two formats are currently supported: "4" uses revision bundle format 4 and
4216
merge directive format 2. It is significantly faster and smaller than
4217
older formats. It is compatible with Bazaar 0.19 and later. It is the
4218
default. "0.9" uses revision bundle format 0.9 and merge directive
4219
format 1. It is compatible with Bazaar 0.12 - 0.18.
4224
help='Do not include a bundle in the merge directive.'),
4225
Option('no-patch', help='Do not include a preview patch in the merge'
4228
help='Remember submit and public branch.'),
4230
help='Branch to generate the submission from, '
4231
'rather than the one containing the working directory.',
4234
Option('output', short_name='o', help='Write directive to this file.',
4237
RegistryOption.from_kwargs('format',
4238
'Use the specified output format.',
4239
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4240
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4242
aliases = ['bundle']
4244
_see_also = ['send', 'merge']
4248
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4249
no_patch=False, revision=None, remember=False, output=None,
4250
format='4', **kwargs):
4253
return self._run(submit_branch, revision, public_branch, remember,
4254
format, no_bundle, no_patch, output,
4255
kwargs.get('from', '.'), None, None)
4258
class cmd_tag(Command):
4259
"""Create, remove or modify a tag naming a revision.
4261
Tags give human-meaningful names to revisions. Commands that take a -r
4262
(--revision) option can be given -rtag:X, where X is any previously
4265
Tags are stored in the branch. Tags are copied from one branch to another
4266
along when you branch, push, pull or merge.
4268
It is an error to give a tag name that already exists unless you pass
4269
--force, in which case the tag is moved to point to the new revision.
4272
_see_also = ['commit', 'tags']
4273
takes_args = ['tag_name']
4276
help='Delete this tag rather than placing it.',
4279
help='Branch in which to place the tag.',
4284
help='Replace existing tags.',
4289
def run(self, tag_name,
4295
branch, relpath = Branch.open_containing(directory)
4299
branch.tags.delete_tag(tag_name)
4300
self.outf.write('Deleted tag %s.\n' % tag_name)
4303
if len(revision) != 1:
4304
raise errors.BzrCommandError(
4305
"Tags can only be placed on a single revision, "
4307
revision_id = revision[0].as_revision_id(branch)
4309
revision_id = branch.last_revision()
4310
if (not force) and branch.tags.has_tag(tag_name):
4311
raise errors.TagAlreadyExists(tag_name)
4312
branch.tags.set_tag(tag_name, revision_id)
4313
self.outf.write('Created tag %s.\n' % tag_name)
4318
class cmd_tags(Command):
4321
This command shows a table of tag names and the revisions they reference.
4327
help='Branch whose tags should be displayed.',
4331
RegistryOption.from_kwargs('sort',
4332
'Sort tags by different criteria.', title='Sorting',
4333
alpha='Sort tags lexicographically (default).',
4334
time='Sort tags chronologically.',
4345
branch, relpath = Branch.open_containing(directory)
4346
tags = branch.tags.get_tag_dict().items()
4349
elif sort == 'time':
4351
for tag, revid in tags:
4353
revobj = branch.repository.get_revision(revid)
4354
except errors.NoSuchRevision:
4355
timestamp = sys.maxint # place them at the end
4357
timestamp = revobj.timestamp
4358
timestamps[revid] = timestamp
4359
tags.sort(key=lambda x: timestamps[x[1]])
4361
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4362
revno_map = branch.get_revision_id_to_revno_map()
4363
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4364
for tag, revid in tags ]
4365
for tag, revspec in tags:
4366
self.outf.write('%-20s %s\n' % (tag, revspec))
4369
class cmd_reconfigure(Command):
4370
"""Reconfigure the type of a bzr directory.
4372
A target configuration must be specified.
4374
For checkouts, the bind-to location will be auto-detected if not specified.
4375
The order of preference is
4376
1. For a lightweight checkout, the current bound location.
4377
2. For branches that used to be checkouts, the previously-bound location.
4378
3. The push location.
4379
4. The parent location.
4380
If none of these is available, --bind-to must be specified.
4383
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4384
takes_args = ['location?']
4385
takes_options = [RegistryOption.from_kwargs('target_type',
4386
title='Target type',
4387
help='The type to reconfigure the directory to.',
4388
value_switches=True, enum_switch=False,
4389
branch='Reconfigure to be an unbound branch '
4390
'with no working tree.',
4391
tree='Reconfigure to be an unbound branch '
4392
'with a working tree.',
4393
checkout='Reconfigure to be a bound branch '
4394
'with a working tree.',
4395
lightweight_checkout='Reconfigure to be a lightweight'
4396
' checkout (with no local history).',
4397
standalone='Reconfigure to be a standalone branch '
4398
'(i.e. stop using shared repository).',
4399
use_shared='Reconfigure to use a shared repository.'),
4400
Option('bind-to', help='Branch to bind checkout to.',
4403
help='Perform reconfiguration even if local changes'
4407
def run(self, location=None, target_type=None, bind_to=None, force=False):
4408
directory = bzrdir.BzrDir.open(location)
4409
if target_type is None:
4410
raise errors.BzrCommandError('No target configuration specified')
4411
elif target_type == 'branch':
4412
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4413
elif target_type == 'tree':
4414
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4415
elif target_type == 'checkout':
4416
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4418
elif target_type == 'lightweight-checkout':
4419
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4421
elif target_type == 'use-shared':
4422
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4423
elif target_type == 'standalone':
4424
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4425
reconfiguration.apply(force)
4428
class cmd_switch(Command):
4429
"""Set the branch of a checkout and update.
4431
For lightweight checkouts, this changes the branch being referenced.
4432
For heavyweight checkouts, this checks that there are no local commits
4433
versus the current bound branch, then it makes the local branch a mirror
4434
of the new location and binds to it.
4436
In both cases, the working tree is updated and uncommitted changes
4437
are merged. The user can commit or revert these as they desire.
4439
Pending merges need to be committed or reverted before using switch.
4441
The path to the branch to switch to can be specified relative to the parent
4442
directory of the current branch. For example, if you are currently in a
4443
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4447
takes_args = ['to_location']
4448
takes_options = [Option('force',
4449
help='Switch even if local commits will be lost.')
4452
def run(self, to_location, force=False):
4453
from bzrlib import switch
4455
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4457
to_branch = Branch.open(to_location)
4458
except errors.NotBranchError:
4459
to_branch = Branch.open(
4460
control_dir.open_branch().base + '../' + to_location)
4461
switch.switch(control_dir, to_branch, force)
4462
note('Switched to branch: %s',
4463
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4466
class cmd_hooks(Command):
4467
"""Show a branch's currently registered hooks.
4471
takes_args = ['path?']
4473
def run(self, path=None):
4476
branch_hooks = Branch.open(path).hooks
4477
for hook_type in branch_hooks:
4478
hooks = branch_hooks[hook_type]
4479
self.outf.write("%s:\n" % (hook_type,))
4482
self.outf.write(" %s\n" %
4483
(branch_hooks.get_hook_name(hook),))
4485
self.outf.write(" <no hooks installed>\n")
4488
def _create_prefix(cur_transport):
4489
needed = [cur_transport]
4490
# Recurse upwards until we can create a directory successfully
4492
new_transport = cur_transport.clone('..')
4493
if new_transport.base == cur_transport.base:
4494
raise errors.BzrCommandError(
4495
"Failed to create path prefix for %s."
4496
% cur_transport.base)
4498
new_transport.mkdir('.')
4499
except errors.NoSuchFile:
4500
needed.append(new_transport)
4501
cur_transport = new_transport
4504
# Now we only need to create child directories
4506
cur_transport = needed.pop()
4507
cur_transport.ensure_base()
4510
# these get imported and then picked up by the scan for cmd_*
4511
# TODO: Some more consistent way to split command definitions across files;
4512
# we do need to load at least some information about them to know of
4513
# aliases. ideally we would avoid loading the implementation until the
4514
# details were needed.
4515
from bzrlib.cmd_version_info import cmd_version_info
4516
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4517
from bzrlib.bundle.commands import (
4520
from bzrlib.sign_my_commits import cmd_sign_my_commits
4521
from bzrlib.weave_commands import cmd_versionedfile_list, \
4522
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
