1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
47
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
68
def tree_files(file_list, default_branch=u'.'):
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
84
The filenames given are not required to exist.
86
:param file_list: Filenames to convert.
88
:param default_branch: Fallback tree path to use if file_list is empty or
91
:return: workingtree, [relative_paths]
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
97
for filename in file_list:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
113
return bzrdir.format_registry.make_bzrdir(typestring)
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
125
class cmd_status(Command):
126
"""Display status summary.
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
132
Versioned in the working copy but not in the previous revision.
135
Versioned in the previous revision but removed or deleted
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
144
Text has changed since the previous revision.
147
File kind has been changed (e.g. from file to directory).
150
Not versioned and not matching an ignore pattern.
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
155
--short gives a status flags for each item, similar to the SVN's status
158
If no arguments are specified, the status of the entire working
159
directory is shown. Otherwise, only the status of the specified
160
files or directories is reported. If a directory is given, status
161
is reported for everything inside that directory.
163
If a revision argument is given, the status is calculated against
164
that revision, or between two revisions if two are provided.
167
# TODO: --no-recurse, --recurse options
169
takes_args = ['file*']
170
takes_options = ['show-ids', 'revision',
171
Option('short', help='Give short SVN-style status lines.'),
172
Option('versioned', help='Only show versioned files.')]
173
aliases = ['st', 'stat']
175
encoding_type = 'replace'
176
_see_also = ['diff', 'revert', 'status-flags']
179
def run(self, show_ids=False, file_list=None, revision=None, short=False,
181
from bzrlib.status import show_tree_status
183
tree, file_list = tree_files(file_list)
185
show_tree_status(tree, show_ids=show_ids,
186
specific_files=file_list, revision=revision,
187
to_file=self.outf, short=short, versioned=versioned)
190
class cmd_cat_revision(Command):
191
"""Write out metadata for a revision.
193
The revision to print can either be specified by a specific
194
revision identifier, or you can use --revision.
198
takes_args = ['revision_id?']
199
takes_options = ['revision']
200
# cat-revision is more for frontends so should be exact
204
def run(self, revision_id=None, revision=None):
206
revision_id = osutils.safe_revision_id(revision_id, warn=False)
207
if revision_id is not None and revision is not None:
208
raise errors.BzrCommandError('You can only supply one of'
209
' revision_id or --revision')
210
if revision_id is None and revision is None:
211
raise errors.BzrCommandError('You must supply either'
212
' --revision or a revision_id')
213
b = WorkingTree.open_containing(u'.')[0].branch
215
# TODO: jam 20060112 should cat-revision always output utf-8?
216
if revision_id is not None:
217
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
218
elif revision is not None:
221
raise errors.BzrCommandError('You cannot specify a NULL'
223
revno, rev_id = rev.in_history(b)
224
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
227
class cmd_remove_tree(Command):
228
"""Remove the working tree from a given branch/checkout.
230
Since a lightweight checkout is little more than a working tree
231
this will refuse to run against one.
233
To re-create the working tree, use "bzr checkout".
235
_see_also = ['checkout', 'working-trees']
237
takes_args = ['location?']
239
def run(self, location='.'):
240
d = bzrdir.BzrDir.open(location)
243
working = d.open_workingtree()
244
except errors.NoWorkingTree:
245
raise errors.BzrCommandError("No working tree to remove")
246
except errors.NotLocalUrl:
247
raise errors.BzrCommandError("You cannot remove the working tree of a "
250
working_path = working.bzrdir.root_transport.base
251
branch_path = working.branch.bzrdir.root_transport.base
252
if working_path != branch_path:
253
raise errors.BzrCommandError("You cannot remove the working tree from "
254
"a lightweight checkout")
256
d.destroy_workingtree()
259
class cmd_revno(Command):
260
"""Show current revision number.
262
This is equal to the number of revisions on this branch.
266
takes_args = ['location?']
269
def run(self, location=u'.'):
270
self.outf.write(str(Branch.open_containing(location)[0].revno()))
271
self.outf.write('\n')
274
class cmd_revision_info(Command):
275
"""Show revision number and revision id for a given revision identifier.
278
takes_args = ['revision_info*']
279
takes_options = ['revision']
282
def run(self, revision=None, revision_info_list=[]):
285
if revision is not None:
286
revs.extend(revision)
287
if revision_info_list is not None:
288
for rev in revision_info_list:
289
revs.append(RevisionSpec.from_string(rev))
291
b = Branch.open_containing(u'.')[0]
294
revs.append(RevisionSpec.from_string('-1'))
297
revinfo = rev.in_history(b)
298
if revinfo.revno is None:
299
dotted_map = b.get_revision_id_to_revno_map()
300
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
301
print '%s %s' % (revno, revinfo.rev_id)
303
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
306
class cmd_add(Command):
307
"""Add specified files or directories.
309
In non-recursive mode, all the named items are added, regardless
310
of whether they were previously ignored. A warning is given if
311
any of the named files are already versioned.
313
In recursive mode (the default), files are treated the same way
314
but the behaviour for directories is different. Directories that
315
are already versioned do not give a warning. All directories,
316
whether already versioned or not, are searched for files or
317
subdirectories that are neither versioned or ignored, and these
318
are added. This search proceeds recursively into versioned
319
directories. If no names are given '.' is assumed.
321
Therefore simply saying 'bzr add' will version all files that
322
are currently unknown.
324
Adding a file whose parent directory is not versioned will
325
implicitly add the parent, and so on up to the root. This means
326
you should never need to explicitly add a directory, they'll just
327
get added when you add a file in the directory.
329
--dry-run will show which files would be added, but not actually
332
--file-ids-from will try to use the file ids from the supplied path.
333
It looks up ids trying to find a matching parent directory with the
334
same filename, and then by pure path. This option is rarely needed
335
but can be useful when adding the same logical file into two
336
branches that will be merged later (without showing the two different
337
adds as a conflict). It is also useful when merging another project
338
into a subdirectory of this one.
340
takes_args = ['file*']
343
help="Don't recursively add the contents of directories."),
345
help="Show what would be done, but don't actually do anything."),
347
Option('file-ids-from',
349
help='Lookup file ids from this tree.'),
351
encoding_type = 'replace'
352
_see_also = ['remove']
354
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
359
if file_ids_from is not None:
361
base_tree, base_path = WorkingTree.open_containing(
363
except errors.NoWorkingTree:
364
base_branch, base_path = Branch.open_containing(
366
base_tree = base_branch.basis_tree()
368
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
369
to_file=self.outf, should_print=(not is_quiet()))
371
action = bzrlib.add.AddAction(to_file=self.outf,
372
should_print=(not is_quiet()))
375
base_tree.lock_read()
377
file_list = self._maybe_expand_globs(file_list)
379
tree = WorkingTree.open_containing(file_list[0])[0]
381
tree = WorkingTree.open_containing(u'.')[0]
382
added, ignored = tree.smart_add(file_list, not
383
no_recurse, action=action, save=not dry_run)
385
if base_tree is not None:
389
for glob in sorted(ignored.keys()):
390
for path in ignored[glob]:
391
self.outf.write("ignored %s matching \"%s\"\n"
395
for glob, paths in ignored.items():
396
match_len += len(paths)
397
self.outf.write("ignored %d file(s).\n" % match_len)
398
self.outf.write("If you wish to add some of these files,"
399
" please add them by name.\n")
402
class cmd_mkdir(Command):
403
"""Create a new versioned directory.
405
This is equivalent to creating the directory and then adding it.
408
takes_args = ['dir+']
409
encoding_type = 'replace'
411
def run(self, dir_list):
414
wt, dd = WorkingTree.open_containing(d)
416
self.outf.write('added %s\n' % d)
419
class cmd_relpath(Command):
420
"""Show path of a file relative to root"""
422
takes_args = ['filename']
426
def run(self, filename):
427
# TODO: jam 20050106 Can relpath return a munged path if
428
# sys.stdout encoding cannot represent it?
429
tree, relpath = WorkingTree.open_containing(filename)
430
self.outf.write(relpath)
431
self.outf.write('\n')
434
class cmd_inventory(Command):
435
"""Show inventory of the current working copy or a revision.
437
It is possible to limit the output to a particular entry
438
type using the --kind option. For example: --kind file.
440
It is also possible to restrict the list of files to a specific
441
set. For example: bzr inventory --show-ids this/file
450
help='List entries of a particular kind: file, directory, symlink.',
453
takes_args = ['file*']
456
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
457
if kind and kind not in ['file', 'directory', 'symlink']:
458
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
460
work_tree, file_list = tree_files(file_list)
461
work_tree.lock_read()
463
if revision is not None:
464
if len(revision) > 1:
465
raise errors.BzrCommandError(
466
'bzr inventory --revision takes exactly one revision'
468
revision_id = revision[0].in_history(work_tree.branch).rev_id
469
tree = work_tree.branch.repository.revision_tree(revision_id)
471
extra_trees = [work_tree]
477
if file_list is not None:
478
file_ids = tree.paths2ids(file_list, trees=extra_trees,
479
require_versioned=True)
480
# find_ids_across_trees may include some paths that don't
482
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
483
for file_id in file_ids if file_id in tree)
485
entries = tree.inventory.entries()
488
if tree is not work_tree:
491
for path, entry in entries:
492
if kind and kind != entry.kind:
495
self.outf.write('%-50s %s\n' % (path, entry.file_id))
497
self.outf.write(path)
498
self.outf.write('\n')
501
class cmd_mv(Command):
502
"""Move or rename a file.
505
bzr mv OLDNAME NEWNAME
507
bzr mv SOURCE... DESTINATION
509
If the last argument is a versioned directory, all the other names
510
are moved into it. Otherwise, there must be exactly two arguments
511
and the file is changed to a new name.
513
If OLDNAME does not exist on the filesystem but is versioned and
514
NEWNAME does exist on the filesystem but is not versioned, mv
515
assumes that the file has been manually moved and only updates
516
its internal inventory to reflect that change.
517
The same is valid when moving many SOURCE files to a DESTINATION.
519
Files cannot be moved between branches.
522
takes_args = ['names*']
523
takes_options = [Option("after", help="Move only the bzr identifier"
524
" of the file, because the file has already been moved."),
526
aliases = ['move', 'rename']
527
encoding_type = 'replace'
529
def run(self, names_list, after=False):
530
if names_list is None:
533
if len(names_list) < 2:
534
raise errors.BzrCommandError("missing file argument")
535
tree, rel_names = tree_files(names_list)
537
if os.path.isdir(names_list[-1]):
538
# move into existing directory
539
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
540
self.outf.write("%s => %s\n" % pair)
542
if len(names_list) != 2:
543
raise errors.BzrCommandError('to mv multiple files the'
544
' destination must be a versioned'
546
tree.rename_one(rel_names[0], rel_names[1], after=after)
547
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
550
class cmd_pull(Command):
551
"""Turn this branch into a mirror of another branch.
553
This command only works on branches that have not diverged. Branches are
554
considered diverged if the destination branch's most recent commit is one
555
that has not been merged (directly or indirectly) into the parent.
557
If branches have diverged, you can use 'bzr merge' to integrate the changes
558
from one into the other. Once one branch has merged, the other should
559
be able to pull it again.
561
If you want to forget your local changes and just update your branch to
562
match the remote one, use pull --overwrite.
564
If there is no default location set, the first pull will set it. After
565
that, you can omit the location to use the default. To change the
566
default, use --remember. The value will only be saved if the remote
567
location can be accessed.
570
_see_also = ['push', 'update', 'status-flags']
571
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
573
help='Branch to pull into, '
574
'rather than the one containing the working directory.',
579
takes_args = ['location?']
580
encoding_type = 'replace'
582
def run(self, location=None, remember=False, overwrite=False,
583
revision=None, verbose=False,
585
# FIXME: too much stuff is in the command class
588
if directory is None:
591
tree_to = WorkingTree.open_containing(directory)[0]
592
branch_to = tree_to.branch
593
except errors.NoWorkingTree:
595
branch_to = Branch.open_containing(directory)[0]
597
if location is not None:
598
mergeable, location_transport = _get_mergeable_helper(location)
600
stored_loc = branch_to.get_parent()
602
if stored_loc is None:
603
raise errors.BzrCommandError("No pull location known or"
606
display_url = urlutils.unescape_for_display(stored_loc,
608
self.outf.write("Using saved location: %s\n" % display_url)
609
location = stored_loc
610
location_transport = transport.get_transport(location)
612
if mergeable is not None:
613
if revision is not None:
614
raise errors.BzrCommandError(
615
'Cannot use -r with merge directives or bundles')
616
mergeable.install_revisions(branch_to.repository)
617
base_revision_id, revision_id, verified = \
618
mergeable.get_merge_request(branch_to.repository)
619
branch_from = branch_to
621
branch_from = Branch.open_from_transport(location_transport)
623
if branch_to.get_parent() is None or remember:
624
branch_to.set_parent(branch_from.base)
626
if revision is not None:
627
if len(revision) == 1:
628
revision_id = revision[0].in_history(branch_from).rev_id
630
raise errors.BzrCommandError(
631
'bzr pull --revision takes one value.')
634
old_rh = branch_to.revision_history()
635
if tree_to is not None:
636
result = tree_to.pull(branch_from, overwrite, revision_id,
637
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
639
result = branch_to.pull(branch_from, overwrite, revision_id)
641
result.report(self.outf)
643
from bzrlib.log import show_changed_revisions
644
new_rh = branch_to.revision_history()
645
show_changed_revisions(branch_to, old_rh, new_rh,
649
class cmd_push(Command):
650
"""Update a mirror of this branch.
652
The target branch will not have its working tree populated because this
653
is both expensive, and is not supported on remote file systems.
655
Some smart servers or protocols *may* put the working tree in place in
658
This command only works on branches that have not diverged. Branches are
659
considered diverged if the destination branch's most recent commit is one
660
that has not been merged (directly or indirectly) by the source branch.
662
If branches have diverged, you can use 'bzr push --overwrite' to replace
663
the other branch completely, discarding its unmerged changes.
665
If you want to ensure you have the different changes in the other branch,
666
do a merge (see bzr help merge) from the other branch, and commit that.
667
After that you will be able to do a push without '--overwrite'.
669
If there is no default push location set, the first push will set it.
670
After that, you can omit the location to use the default. To change the
671
default, use --remember. The value will only be saved if the remote
672
location can be accessed.
675
_see_also = ['pull', 'update', 'working-trees']
676
takes_options = ['remember', 'overwrite', 'verbose',
677
Option('create-prefix',
678
help='Create the path leading up to the branch '
679
'if it does not already exist.'),
681
help='Branch to push from, '
682
'rather than the one containing the working directory.',
686
Option('use-existing-dir',
687
help='By default push will fail if the target'
688
' directory exists, but does not already'
689
' have a control directory. This flag will'
690
' allow push to proceed.'),
692
takes_args = ['location?']
693
encoding_type = 'replace'
695
def run(self, location=None, remember=False, overwrite=False,
696
create_prefix=False, verbose=False,
697
use_existing_dir=False,
699
# FIXME: Way too big! Put this into a function called from the
701
if directory is None:
703
br_from = Branch.open_containing(directory)[0]
704
stored_loc = br_from.get_push_location()
706
if stored_loc is None:
707
raise errors.BzrCommandError("No push location known or specified.")
709
display_url = urlutils.unescape_for_display(stored_loc,
711
self.outf.write("Using saved location: %s\n" % display_url)
712
location = stored_loc
714
to_transport = transport.get_transport(location)
716
br_to = repository_to = dir_to = None
718
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
719
except errors.NotBranchError:
720
pass # Didn't find anything
722
# If we can open a branch, use its direct repository, otherwise see
723
# if there is a repository without a branch.
725
br_to = dir_to.open_branch()
726
except errors.NotBranchError:
727
# Didn't find a branch, can we find a repository?
729
repository_to = dir_to.find_repository()
730
except errors.NoRepositoryPresent:
733
# Found a branch, so we must have found a repository
734
repository_to = br_to.repository
739
# The destination doesn't exist; create it.
740
# XXX: Refactor the create_prefix/no_create_prefix code into a
741
# common helper function
743
to_transport.mkdir('.')
744
except errors.FileExists:
745
if not use_existing_dir:
746
raise errors.BzrCommandError("Target directory %s"
747
" already exists, but does not have a valid .bzr"
748
" directory. Supply --use-existing-dir to push"
749
" there anyway." % location)
750
except errors.NoSuchFile:
751
if not create_prefix:
752
raise errors.BzrCommandError("Parent directory of %s"
754
"\nYou may supply --create-prefix to create all"
755
" leading parent directories."
757
_create_prefix(to_transport)
759
# Now the target directory exists, but doesn't have a .bzr
760
# directory. So we need to create it, along with any work to create
761
# all of the dependent branches, etc.
762
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
763
revision_id=br_from.last_revision())
764
br_to = dir_to.open_branch()
765
# TODO: Some more useful message about what was copied
766
note('Created new branch.')
767
# We successfully created the target, remember it
768
if br_from.get_push_location() is None or remember:
769
br_from.set_push_location(br_to.base)
770
elif repository_to is None:
771
# we have a bzrdir but no branch or repository
772
# XXX: Figure out what to do other than complain.
773
raise errors.BzrCommandError("At %s you have a valid .bzr control"
774
" directory, but not a branch or repository. This is an"
775
" unsupported configuration. Please move the target directory"
776
" out of the way and try again."
779
# We have a repository but no branch, copy the revisions, and then
781
last_revision_id = br_from.last_revision()
782
repository_to.fetch(br_from.repository,
783
revision_id=last_revision_id)
784
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
785
note('Created new branch.')
786
if br_from.get_push_location() is None or remember:
787
br_from.set_push_location(br_to.base)
788
else: # We have a valid to branch
789
# We were able to connect to the remote location, so remember it
790
# we don't need to successfully push because of possible divergence.
791
if br_from.get_push_location() is None or remember:
792
br_from.set_push_location(br_to.base)
794
old_rh = br_to.revision_history()
797
tree_to = dir_to.open_workingtree()
798
except errors.NotLocalUrl:
799
warning("This transport does not update the working "
800
"tree of: %s. See 'bzr help working-trees' for "
801
"more information." % br_to.base)
802
push_result = br_from.push(br_to, overwrite)
803
except errors.NoWorkingTree:
804
push_result = br_from.push(br_to, overwrite)
808
push_result = br_from.push(tree_to.branch, overwrite)
812
except errors.DivergedBranches:
813
raise errors.BzrCommandError('These branches have diverged.'
814
' Try using "merge" and then "push".')
815
if push_result is not None:
816
push_result.report(self.outf)
818
new_rh = br_to.revision_history()
821
from bzrlib.log import show_changed_revisions
822
show_changed_revisions(br_to, old_rh, new_rh,
825
# we probably did a clone rather than a push, so a message was
830
class cmd_branch(Command):
831
"""Create a new copy of a branch.
833
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
834
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
835
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
836
is derived from the FROM_LOCATION by stripping a leading scheme or drive
837
identifier, if any. For example, "branch lp:foo-bar" will attempt to
840
To retrieve the branch as of a particular revision, supply the --revision
841
parameter, as in "branch foo/bar -r 5".
844
_see_also = ['checkout']
845
takes_args = ['from_location', 'to_location?']
846
takes_options = ['revision']
847
aliases = ['get', 'clone']
849
def run(self, from_location, to_location=None, revision=None):
850
from bzrlib.tag import _merge_tags_if_possible
853
elif len(revision) > 1:
854
raise errors.BzrCommandError(
855
'bzr branch --revision takes exactly 1 revision value')
857
br_from = Branch.open(from_location)
860
if len(revision) == 1 and revision[0] is not None:
861
revision_id = revision[0].in_history(br_from)[1]
863
# FIXME - wt.last_revision, fallback to branch, fall back to
864
# None or perhaps NULL_REVISION to mean copy nothing
866
revision_id = br_from.last_revision()
867
if to_location is None:
868
to_location = urlutils.derive_to_location(from_location)
871
name = os.path.basename(to_location) + '\n'
873
to_transport = transport.get_transport(to_location)
875
to_transport.mkdir('.')
876
except errors.FileExists:
877
raise errors.BzrCommandError('Target directory "%s" already'
878
' exists.' % to_location)
879
except errors.NoSuchFile:
880
raise errors.BzrCommandError('Parent of "%s" does not exist.'
883
# preserve whatever source format we have.
884
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
885
possible_transports=[to_transport])
886
branch = dir.open_branch()
887
except errors.NoSuchRevision:
888
to_transport.delete_tree('.')
889
msg = "The branch %s has no revision %s." % (from_location, revision[0])
890
raise errors.BzrCommandError(msg)
892
branch.control_files.put_utf8('branch-name', name)
893
_merge_tags_if_possible(br_from, branch)
894
note('Branched %d revision(s).' % branch.revno())
899
class cmd_checkout(Command):
900
"""Create a new checkout of an existing branch.
902
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
903
the branch found in '.'. This is useful if you have removed the working tree
904
or if it was never created - i.e. if you pushed the branch to its current
907
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
908
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
909
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
910
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
911
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
914
To retrieve the branch as of a particular revision, supply the --revision
915
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
916
out of date [so you cannot commit] but it may be useful (i.e. to examine old
920
_see_also = ['checkouts', 'branch']
921
takes_args = ['branch_location?', 'to_location?']
922
takes_options = ['revision',
923
Option('lightweight',
924
help="Perform a lightweight checkout. Lightweight "
925
"checkouts depend on access to the branch for "
926
"every operation. Normal checkouts can perform "
927
"common operations like diff and status without "
928
"such access, and also support local commits."
933
def run(self, branch_location=None, to_location=None, revision=None,
937
elif len(revision) > 1:
938
raise errors.BzrCommandError(
939
'bzr checkout --revision takes exactly 1 revision value')
940
if branch_location is None:
941
branch_location = osutils.getcwd()
942
to_location = branch_location
943
source = Branch.open(branch_location)
944
if len(revision) == 1 and revision[0] is not None:
945
revision_id = _mod_revision.ensure_null(
946
revision[0].in_history(source)[1])
949
if to_location is None:
950
to_location = urlutils.derive_to_location(branch_location)
951
# if the source and to_location are the same,
952
# and there is no working tree,
953
# then reconstitute a branch
954
if (osutils.abspath(to_location) ==
955
osutils.abspath(branch_location)):
957
source.bzrdir.open_workingtree()
958
except errors.NoWorkingTree:
959
source.bzrdir.create_workingtree(revision_id)
962
os.mkdir(to_location)
964
if e.errno == errno.EEXIST:
965
raise errors.BzrCommandError('Target directory "%s" already'
966
' exists.' % to_location)
967
if e.errno == errno.ENOENT:
968
raise errors.BzrCommandError('Parent of "%s" does not exist.'
972
source.create_checkout(to_location, revision_id, lightweight)
975
class cmd_renames(Command):
976
"""Show list of renamed files.
978
# TODO: Option to show renames between two historical versions.
980
# TODO: Only show renames under dir, rather than in the whole branch.
981
_see_also = ['status']
982
takes_args = ['dir?']
985
def run(self, dir=u'.'):
986
tree = WorkingTree.open_containing(dir)[0]
989
new_inv = tree.inventory
990
old_tree = tree.basis_tree()
993
old_inv = old_tree.inventory
994
renames = list(_mod_tree.find_renames(old_inv, new_inv))
996
for old_name, new_name in renames:
997
self.outf.write("%s => %s\n" % (old_name, new_name))
1004
class cmd_update(Command):
1005
"""Update a tree to have the latest code committed to its branch.
1007
This will perform a merge into the working tree, and may generate
1008
conflicts. If you have any local changes, you will still
1009
need to commit them after the update for the update to be complete.
1011
If you want to discard your local changes, you can just do a
1012
'bzr revert' instead of 'bzr commit' after the update.
1015
_see_also = ['pull', 'working-trees', 'status-flags']
1016
takes_args = ['dir?']
1019
def run(self, dir='.'):
1020
tree = WorkingTree.open_containing(dir)[0]
1021
master = tree.branch.get_master_branch()
1022
if master is not None:
1025
tree.lock_tree_write()
1027
existing_pending_merges = tree.get_parent_ids()[1:]
1028
last_rev = _mod_revision.ensure_null(tree.last_revision())
1029
if last_rev == _mod_revision.ensure_null(
1030
tree.branch.last_revision()):
1031
# may be up to date, check master too.
1032
if master is None or last_rev == _mod_revision.ensure_null(
1033
master.last_revision()):
1034
revno = tree.branch.revision_id_to_revno(last_rev)
1035
note("Tree is up to date at revision %d." % (revno,))
1037
conflicts = tree.update(delta._ChangeReporter(
1038
unversioned_filter=tree.is_ignored))
1039
revno = tree.branch.revision_id_to_revno(
1040
_mod_revision.ensure_null(tree.last_revision()))
1041
note('Updated to revision %d.' % (revno,))
1042
if tree.get_parent_ids()[1:] != existing_pending_merges:
1043
note('Your local commits will now show as pending merges with '
1044
"'bzr status', and can be committed with 'bzr commit'.")
1053
class cmd_info(Command):
1054
"""Show information about a working tree, branch or repository.
1056
This command will show all known locations and formats associated to the
1057
tree, branch or repository. Statistical information is included with
1060
Branches and working trees will also report any missing revisions.
1062
_see_also = ['revno', 'working-trees', 'repositories']
1063
takes_args = ['location?']
1064
takes_options = ['verbose']
1067
def run(self, location=None, verbose=0):
1068
from bzrlib.info import show_bzrdir_info
1069
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1073
class cmd_remove(Command):
1074
"""Remove files or directories.
1076
This makes bzr stop tracking changes to the specified files and
1077
delete them if they can easily be recovered using revert.
1079
You can specify one or more files, and/or --new. If you specify --new,
1080
only 'added' files will be removed. If you specify both, then new files
1081
in the specified directories will be removed. If the directories are
1082
also new, they will also be removed.
1084
takes_args = ['file*']
1085
takes_options = ['verbose',
1086
Option('new', help='Remove newly-added files.'),
1087
RegistryOption.from_kwargs('file-deletion-strategy',
1088
'The file deletion mode to be used',
1089
title='Deletion Strategy', value_switches=True, enum_switch=False,
1090
safe='Only delete files if they can be'
1091
' safely recovered (default).',
1092
keep="Don't delete any files.",
1093
force='Delete all the specified files, even if they can not be '
1094
'recovered and even if they are non-empty directories.')]
1096
encoding_type = 'replace'
1098
def run(self, file_list, verbose=False, new=False,
1099
file_deletion_strategy='safe'):
1100
tree, file_list = tree_files(file_list)
1102
if file_list is not None:
1103
file_list = [f for f in file_list if f != '']
1105
raise errors.BzrCommandError('Specify one or more files to'
1106
' remove, or use --new.')
1109
added = tree.changes_from(tree.basis_tree(),
1110
specific_files=file_list).added
1111
file_list = sorted([f[0] for f in added], reverse=True)
1112
if len(file_list) == 0:
1113
raise errors.BzrCommandError('No matching files.')
1114
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1115
keep_files=file_deletion_strategy=='keep',
1116
force=file_deletion_strategy=='force')
1119
class cmd_file_id(Command):
1120
"""Print file_id of a particular file or directory.
1122
The file_id is assigned when the file is first added and remains the
1123
same through all revisions where the file exists, even when it is
1128
_see_also = ['inventory', 'ls']
1129
takes_args = ['filename']
1132
def run(self, filename):
1133
tree, relpath = WorkingTree.open_containing(filename)
1134
i = tree.path2id(relpath)
1136
raise errors.NotVersionedError(filename)
1138
self.outf.write(i + '\n')
1141
class cmd_file_path(Command):
1142
"""Print path of file_ids to a file or directory.
1144
This prints one line for each directory down to the target,
1145
starting at the branch root.
1149
takes_args = ['filename']
1152
def run(self, filename):
1153
tree, relpath = WorkingTree.open_containing(filename)
1154
fid = tree.path2id(relpath)
1156
raise errors.NotVersionedError(filename)
1157
segments = osutils.splitpath(relpath)
1158
for pos in range(1, len(segments) + 1):
1159
path = osutils.joinpath(segments[:pos])
1160
self.outf.write("%s\n" % tree.path2id(path))
1163
class cmd_reconcile(Command):
1164
"""Reconcile bzr metadata in a branch.
1166
This can correct data mismatches that may have been caused by
1167
previous ghost operations or bzr upgrades. You should only
1168
need to run this command if 'bzr check' or a bzr developer
1169
advises you to run it.
1171
If a second branch is provided, cross-branch reconciliation is
1172
also attempted, which will check that data like the tree root
1173
id which was not present in very early bzr versions is represented
1174
correctly in both branches.
1176
At the same time it is run it may recompress data resulting in
1177
a potential saving in disk space or performance gain.
1179
The branch *MUST* be on a listable system such as local disk or sftp.
1182
_see_also = ['check']
1183
takes_args = ['branch?']
1185
def run(self, branch="."):
1186
from bzrlib.reconcile import reconcile
1187
dir = bzrdir.BzrDir.open(branch)
1191
class cmd_revision_history(Command):
1192
"""Display the list of revision ids on a branch."""
1195
takes_args = ['location?']
1200
def run(self, location="."):
1201
branch = Branch.open_containing(location)[0]
1202
for revid in branch.revision_history():
1203
self.outf.write(revid)
1204
self.outf.write('\n')
1207
class cmd_ancestry(Command):
1208
"""List all revisions merged into this branch."""
1210
_see_also = ['log', 'revision-history']
1211
takes_args = ['location?']
1216
def run(self, location="."):
1218
wt = WorkingTree.open_containing(location)[0]
1219
except errors.NoWorkingTree:
1220
b = Branch.open(location)
1221
last_revision = b.last_revision()
1224
last_revision = wt.last_revision()
1226
revision_ids = b.repository.get_ancestry(last_revision)
1227
assert revision_ids[0] is None
1229
for revision_id in revision_ids:
1230
self.outf.write(revision_id + '\n')
1233
class cmd_init(Command):
1234
"""Make a directory into a versioned branch.
1236
Use this to create an empty branch, or before importing an
1239
If there is a repository in a parent directory of the location, then
1240
the history of the branch will be stored in the repository. Otherwise
1241
init creates a standalone branch which carries its own history
1242
in the .bzr directory.
1244
If there is already a branch at the location but it has no working tree,
1245
the tree can be populated with 'bzr checkout'.
1247
Recipe for importing a tree of files::
1253
bzr commit -m 'imported project'
1256
_see_also = ['init-repo', 'branch', 'checkout']
1257
takes_args = ['location?']
1259
Option('create-prefix',
1260
help='Create the path leading up to the branch '
1261
'if it does not already exist.'),
1262
RegistryOption('format',
1263
help='Specify a format for this branch. '
1264
'See "help formats".',
1265
registry=bzrdir.format_registry,
1266
converter=bzrdir.format_registry.make_bzrdir,
1267
value_switches=True,
1268
title="Branch Format",
1270
Option('append-revisions-only',
1271
help='Never change revnos or the existing log.'
1272
' Append revisions to it only.')
1274
def run(self, location=None, format=None, append_revisions_only=False,
1275
create_prefix=False):
1277
format = bzrdir.format_registry.make_bzrdir('default')
1278
if location is None:
1281
to_transport = transport.get_transport(location)
1283
# The path has to exist to initialize a
1284
# branch inside of it.
1285
# Just using os.mkdir, since I don't
1286
# believe that we want to create a bunch of
1287
# locations if the user supplies an extended path
1289
to_transport.ensure_base()
1290
except errors.NoSuchFile:
1291
if not create_prefix:
1292
raise errors.BzrCommandError("Parent directory of %s"
1294
"\nYou may supply --create-prefix to create all"
1295
" leading parent directories."
1297
_create_prefix(to_transport)
1300
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1301
except errors.NotBranchError:
1302
# really a NotBzrDir error...
1303
create_branch = bzrdir.BzrDir.create_branch_convenience
1304
branch = create_branch(to_transport.base, format=format,
1305
possible_transports=[to_transport])
1307
from bzrlib.transport.local import LocalTransport
1308
if existing_bzrdir.has_branch():
1309
if (isinstance(to_transport, LocalTransport)
1310
and not existing_bzrdir.has_workingtree()):
1311
raise errors.BranchExistsWithoutWorkingTree(location)
1312
raise errors.AlreadyBranchError(location)
1314
branch = existing_bzrdir.create_branch()
1315
existing_bzrdir.create_workingtree()
1316
if append_revisions_only:
1318
branch.set_append_revisions_only(True)
1319
except errors.UpgradeRequired:
1320
raise errors.BzrCommandError('This branch format cannot be set'
1321
' to append-revisions-only. Try --experimental-branch6')
1324
class cmd_init_repository(Command):
1325
"""Create a shared repository to hold branches.
1327
New branches created under the repository directory will store their
1328
revisions in the repository, not in the branch directory.
1330
If the --no-trees option is used then the branches in the repository
1331
will not have working trees by default.
1334
Create a shared repositories holding just branches::
1336
bzr init-repo --no-trees repo
1339
Make a lightweight checkout elsewhere::
1341
bzr checkout --lightweight repo/trunk trunk-checkout
1346
_see_also = ['init', 'branch', 'checkout', 'repositories']
1347
takes_args = ["location"]
1348
takes_options = [RegistryOption('format',
1349
help='Specify a format for this repository. See'
1350
' "bzr help formats" for details.',
1351
registry=bzrdir.format_registry,
1352
converter=bzrdir.format_registry.make_bzrdir,
1353
value_switches=True, title='Repository format'),
1355
help='Branches in the repository will default to'
1356
' not having a working tree.'),
1358
aliases = ["init-repo"]
1360
def run(self, location, format=None, no_trees=False):
1362
format = bzrdir.format_registry.make_bzrdir('default')
1364
if location is None:
1367
to_transport = transport.get_transport(location)
1368
to_transport.ensure_base()
1370
newdir = format.initialize_on_transport(to_transport)
1371
repo = newdir.create_repository(shared=True)
1372
repo.set_make_working_trees(not no_trees)
1375
class cmd_diff(Command):
1376
"""Show differences in the working tree or between revisions.
1378
If files are listed, only the changes in those files are listed.
1379
Otherwise, all changes for the tree are listed.
1381
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1382
produces patches suitable for "patch -p1".
1385
Shows the difference in the working tree versus the last commit::
1389
Difference between the working tree and revision 1::
1393
Difference between revision 2 and revision 1::
1397
Same as 'bzr diff' but prefix paths with old/ and new/::
1399
bzr diff --prefix old/:new/
1401
Show the differences between the two working trees::
1403
bzr diff bzr.mine bzr.dev
1405
Show just the differences for 'foo.c'::
1409
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1410
# or a graphical diff.
1412
# TODO: Python difflib is not exactly the same as unidiff; should
1413
# either fix it up or prefer to use an external diff.
1415
# TODO: Selected-file diff is inefficient and doesn't show you
1418
# TODO: This probably handles non-Unix newlines poorly.
1420
_see_also = ['status']
1421
takes_args = ['file*']
1423
Option('diff-options', type=str,
1424
help='Pass these options to the external diff program.'),
1425
Option('prefix', type=str,
1427
help='Set prefixes to added to old and new filenames, as '
1428
'two values separated by a colon. (eg "old/:new/").'),
1431
aliases = ['di', 'dif']
1432
encoding_type = 'exact'
1435
def run(self, revision=None, file_list=None, diff_options=None,
1437
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1439
if (prefix is None) or (prefix == '0'):
1447
old_label, new_label = prefix.split(":")
1449
raise errors.BzrCommandError(
1450
'--prefix expects two values separated by a colon'
1451
' (eg "old/:new/")')
1453
if revision and len(revision) > 2:
1454
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1455
' one or two revision specifiers')
1458
tree1, file_list = internal_tree_files(file_list)
1462
except errors.FileInWrongBranch:
1463
if len(file_list) != 2:
1464
raise errors.BzrCommandError("Files are in different branches")
1466
tree1, file1 = WorkingTree.open_containing(file_list[0])
1467
tree2, file2 = WorkingTree.open_containing(file_list[1])
1468
if file1 != "" or file2 != "":
1469
# FIXME diff those two files. rbc 20051123
1470
raise errors.BzrCommandError("Files are in different branches")
1472
except errors.NotBranchError:
1473
if (revision is not None and len(revision) == 2
1474
and not revision[0].needs_branch()
1475
and not revision[1].needs_branch()):
1476
# If both revision specs include a branch, we can
1477
# diff them without needing a local working tree
1478
tree1, tree2 = None, None
1482
if tree2 is not None:
1483
if revision is not None:
1484
# FIXME: but there should be a clean way to diff between
1485
# non-default versions of two trees, it's not hard to do
1487
raise errors.BzrCommandError(
1488
"Sorry, diffing arbitrary revisions across branches "
1489
"is not implemented yet")
1490
return show_diff_trees(tree1, tree2, sys.stdout,
1491
specific_files=file_list,
1492
external_diff_options=diff_options,
1493
old_label=old_label, new_label=new_label)
1495
return diff_cmd_helper(tree1, file_list, diff_options,
1496
revision_specs=revision,
1497
old_label=old_label, new_label=new_label)
1500
class cmd_deleted(Command):
1501
"""List files deleted in the working tree.
1503
# TODO: Show files deleted since a previous revision, or
1504
# between two revisions.
1505
# TODO: Much more efficient way to do this: read in new
1506
# directories with readdir, rather than stating each one. Same
1507
# level of effort but possibly much less IO. (Or possibly not,
1508
# if the directories are very large...)
1509
_see_also = ['status', 'ls']
1510
takes_options = ['show-ids']
1513
def run(self, show_ids=False):
1514
tree = WorkingTree.open_containing(u'.')[0]
1517
old = tree.basis_tree()
1520
for path, ie in old.inventory.iter_entries():
1521
if not tree.has_id(ie.file_id):
1522
self.outf.write(path)
1524
self.outf.write(' ')
1525
self.outf.write(ie.file_id)
1526
self.outf.write('\n')
1533
class cmd_modified(Command):
1534
"""List files modified in working tree.
1538
_see_also = ['status', 'ls']
1542
tree = WorkingTree.open_containing(u'.')[0]
1543
td = tree.changes_from(tree.basis_tree())
1544
for path, id, kind, text_modified, meta_modified in td.modified:
1545
self.outf.write(path + '\n')
1548
class cmd_added(Command):
1549
"""List files added in working tree.
1553
_see_also = ['status', 'ls']
1557
wt = WorkingTree.open_containing(u'.')[0]
1560
basis = wt.basis_tree()
1563
basis_inv = basis.inventory
1566
if file_id in basis_inv:
1568
if inv.is_root(file_id) and len(basis_inv) == 0:
1570
path = inv.id2path(file_id)
1571
if not os.access(osutils.abspath(path), os.F_OK):
1573
self.outf.write(path + '\n')
1580
class cmd_root(Command):
1581
"""Show the tree root directory.
1583
The root is the nearest enclosing directory with a .bzr control
1586
takes_args = ['filename?']
1588
def run(self, filename=None):
1589
"""Print the branch root."""
1590
tree = WorkingTree.open_containing(filename)[0]
1591
self.outf.write(tree.basedir + '\n')
1594
def _parse_limit(limitstring):
1596
return int(limitstring)
1598
msg = "The limit argument must be an integer."
1599
raise errors.BzrCommandError(msg)
1602
class cmd_log(Command):
1603
"""Show log of a branch, file, or directory.
1605
By default show the log of the branch containing the working directory.
1607
To request a range of logs, you can use the command -r begin..end
1608
-r revision requests a specific revision, -r ..end or -r begin.. are
1612
Log the current branch::
1620
Log the last 10 revisions of a branch::
1622
bzr log -r -10.. http://server/branch
1625
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1627
takes_args = ['location?']
1630
help='Show from oldest to newest.'),
1633
help='Display timezone as local, original, or utc.'),
1636
help='Show files changed in each revision.'),
1642
help='Show revisions whose message matches this '
1643
'regular expression.',
1646
help='Limit the output to the first N revisions.',
1650
encoding_type = 'replace'
1653
def run(self, location=None, timezone='original',
1661
from bzrlib.log import show_log
1662
assert message is None or isinstance(message, basestring), \
1663
"invalid message argument %r" % message
1664
direction = (forward and 'forward') or 'reverse'
1669
# find the file id to log:
1671
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1675
tree = b.basis_tree()
1676
file_id = tree.path2id(fp)
1678
raise errors.BzrCommandError(
1679
"Path does not have any revision history: %s" %
1683
# FIXME ? log the current subdir only RBC 20060203
1684
if revision is not None \
1685
and len(revision) > 0 and revision[0].get_branch():
1686
location = revision[0].get_branch()
1689
dir, relpath = bzrdir.BzrDir.open_containing(location)
1690
b = dir.open_branch()
1694
if revision is None:
1697
elif len(revision) == 1:
1698
rev1 = rev2 = revision[0].in_history(b)
1699
elif len(revision) == 2:
1700
if revision[1].get_branch() != revision[0].get_branch():
1701
# b is taken from revision[0].get_branch(), and
1702
# show_log will use its revision_history. Having
1703
# different branches will lead to weird behaviors.
1704
raise errors.BzrCommandError(
1705
"Log doesn't accept two revisions in different"
1707
rev1 = revision[0].in_history(b)
1708
rev2 = revision[1].in_history(b)
1710
raise errors.BzrCommandError(
1711
'bzr log --revision takes one or two values.')
1713
if log_format is None:
1714
log_format = log.log_formatter_registry.get_default(b)
1716
lf = log_format(show_ids=show_ids, to_file=self.outf,
1717
show_timezone=timezone)
1723
direction=direction,
1724
start_revision=rev1,
1732
def get_log_format(long=False, short=False, line=False, default='long'):
1733
log_format = default
1737
log_format = 'short'
1743
class cmd_touching_revisions(Command):
1744
"""Return revision-ids which affected a particular file.
1746
A more user-friendly interface is "bzr log FILE".
1750
takes_args = ["filename"]
1753
def run(self, filename):
1754
tree, relpath = WorkingTree.open_containing(filename)
1756
file_id = tree.path2id(relpath)
1757
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1758
self.outf.write("%6d %s\n" % (revno, what))
1761
class cmd_ls(Command):
1762
"""List files in a tree.
1765
_see_also = ['status', 'cat']
1766
takes_args = ['path?']
1767
# TODO: Take a revision or remote path and list that tree instead.
1771
Option('non-recursive',
1772
help='Don\'t recurse into subdirectories.'),
1774
help='Print paths relative to the root of the branch.'),
1775
Option('unknown', help='Print unknown files.'),
1776
Option('versioned', help='Print versioned files.'),
1777
Option('ignored', help='Print ignored files.'),
1779
help='Write an ascii NUL (\\0) separator '
1780
'between files rather than a newline.'),
1782
help='List entries of a particular kind: file, directory, symlink.',
1787
def run(self, revision=None, verbose=False,
1788
non_recursive=False, from_root=False,
1789
unknown=False, versioned=False, ignored=False,
1790
null=False, kind=None, show_ids=False, path=None):
1792
if kind and kind not in ('file', 'directory', 'symlink'):
1793
raise errors.BzrCommandError('invalid kind specified')
1795
if verbose and null:
1796
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1797
all = not (unknown or versioned or ignored)
1799
selection = {'I':ignored, '?':unknown, 'V':versioned}
1806
raise errors.BzrCommandError('cannot specify both --from-root'
1810
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1816
if revision is not None:
1817
tree = branch.repository.revision_tree(
1818
revision[0].in_history(branch).rev_id)
1820
tree = branch.basis_tree()
1824
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1825
if fp.startswith(relpath):
1826
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1827
if non_recursive and '/' in fp:
1829
if not all and not selection[fc]:
1831
if kind is not None and fkind != kind:
1834
kindch = entry.kind_character()
1835
outstring = '%-8s %s%s' % (fc, fp, kindch)
1836
if show_ids and fid is not None:
1837
outstring = "%-50s %s" % (outstring, fid)
1838
self.outf.write(outstring + '\n')
1840
self.outf.write(fp + '\0')
1843
self.outf.write(fid)
1844
self.outf.write('\0')
1852
self.outf.write('%-50s %s\n' % (fp, my_id))
1854
self.outf.write(fp + '\n')
1859
class cmd_unknowns(Command):
1860
"""List unknown files.
1868
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1869
self.outf.write(osutils.quotefn(f) + '\n')
1872
class cmd_ignore(Command):
1873
"""Ignore specified files or patterns.
1875
To remove patterns from the ignore list, edit the .bzrignore file.
1877
Trailing slashes on patterns are ignored.
1878
If the pattern contains a slash or is a regular expression, it is compared
1879
to the whole path from the branch root. Otherwise, it is compared to only
1880
the last component of the path. To match a file only in the root
1881
directory, prepend './'.
1883
Ignore patterns specifying absolute paths are not allowed.
1885
Ignore patterns may include globbing wildcards such as::
1887
? - Matches any single character except '/'
1888
* - Matches 0 or more characters except '/'
1889
/**/ - Matches 0 or more directories in a path
1890
[a-z] - Matches a single character from within a group of characters
1892
Ignore patterns may also be Python regular expressions.
1893
Regular expression ignore patterns are identified by a 'RE:' prefix
1894
followed by the regular expression. Regular expression ignore patterns
1895
may not include named or numbered groups.
1897
Note: ignore patterns containing shell wildcards must be quoted from
1901
Ignore the top level Makefile::
1903
bzr ignore ./Makefile
1905
Ignore class files in all directories::
1907
bzr ignore '*.class'
1909
Ignore .o files under the lib directory::
1911
bzr ignore 'lib/**/*.o'
1913
Ignore .o files under the lib directory::
1915
bzr ignore 'RE:lib/.*\.o'
1918
_see_also = ['status', 'ignored']
1919
takes_args = ['name_pattern*']
1921
Option('old-default-rules',
1922
help='Write out the ignore rules bzr < 0.9 always used.')
1925
def run(self, name_pattern_list=None, old_default_rules=None):
1926
from bzrlib.atomicfile import AtomicFile
1927
if old_default_rules is not None:
1928
# dump the rules and exit
1929
for pattern in ignores.OLD_DEFAULTS:
1932
if not name_pattern_list:
1933
raise errors.BzrCommandError("ignore requires at least one "
1934
"NAME_PATTERN or --old-default-rules")
1935
name_pattern_list = [globbing.normalize_pattern(p)
1936
for p in name_pattern_list]
1937
for name_pattern in name_pattern_list:
1938
if (name_pattern[0] == '/' or
1939
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1940
raise errors.BzrCommandError(
1941
"NAME_PATTERN should not be an absolute path")
1942
tree, relpath = WorkingTree.open_containing(u'.')
1943
ifn = tree.abspath('.bzrignore')
1944
if os.path.exists(ifn):
1947
igns = f.read().decode('utf-8')
1953
# TODO: If the file already uses crlf-style termination, maybe
1954
# we should use that for the newly added lines?
1956
if igns and igns[-1] != '\n':
1958
for name_pattern in name_pattern_list:
1959
igns += name_pattern + '\n'
1961
f = AtomicFile(ifn, 'wb')
1963
f.write(igns.encode('utf-8'))
1968
if not tree.path2id('.bzrignore'):
1969
tree.add(['.bzrignore'])
1972
class cmd_ignored(Command):
1973
"""List ignored files and the patterns that matched them.
1976
_see_also = ['ignore']
1979
tree = WorkingTree.open_containing(u'.')[0]
1982
for path, file_class, kind, file_id, entry in tree.list_files():
1983
if file_class != 'I':
1985
## XXX: Slightly inefficient since this was already calculated
1986
pat = tree.is_ignored(path)
1987
print '%-50s %s' % (path, pat)
1992
class cmd_lookup_revision(Command):
1993
"""Lookup the revision-id from a revision-number
1996
bzr lookup-revision 33
1999
takes_args = ['revno']
2002
def run(self, revno):
2006
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2008
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2011
class cmd_export(Command):
2012
"""Export current or past revision to a destination directory or archive.
2014
If no revision is specified this exports the last committed revision.
2016
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2017
given, try to find the format with the extension. If no extension
2018
is found exports to a directory (equivalent to --format=dir).
2020
If root is supplied, it will be used as the root directory inside
2021
container formats (tar, zip, etc). If it is not supplied it will default
2022
to the exported filename. The root option has no effect for 'dir' format.
2024
If branch is omitted then the branch containing the current working
2025
directory will be used.
2027
Note: Export of tree with non-ASCII filenames to zip is not supported.
2029
================= =========================
2030
Supported formats Autodetected by extension
2031
================= =========================
2034
tbz2 .tar.bz2, .tbz2
2037
================= =========================
2039
takes_args = ['dest', 'branch?']
2042
help="Type of file to export to.",
2047
help="Name of the root directory inside the exported file."),
2049
def run(self, dest, branch=None, revision=None, format=None, root=None):
2050
from bzrlib.export import export
2053
tree = WorkingTree.open_containing(u'.')[0]
2056
b = Branch.open(branch)
2058
if revision is None:
2059
# should be tree.last_revision FIXME
2060
rev_id = b.last_revision()
2062
if len(revision) != 1:
2063
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2064
rev_id = revision[0].in_history(b).rev_id
2065
t = b.repository.revision_tree(rev_id)
2067
export(t, dest, format, root)
2068
except errors.NoSuchExportFormat, e:
2069
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2072
class cmd_cat(Command):
2073
"""Write the contents of a file as of a given revision to standard output.
2075
If no revision is nominated, the last revision is used.
2077
Note: Take care to redirect standard output when using this command on a
2083
Option('name-from-revision', help='The path name in the old tree.'),
2086
takes_args = ['filename']
2087
encoding_type = 'exact'
2090
def run(self, filename, revision=None, name_from_revision=False):
2091
if revision is not None and len(revision) != 1:
2092
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2097
tree, b, relpath = \
2098
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2099
except errors.NotBranchError:
2102
if revision is not None and revision[0].get_branch() is not None:
2103
b = Branch.open(revision[0].get_branch())
2105
tree = b.basis_tree()
2106
if revision is None:
2107
revision_id = b.last_revision()
2109
revision_id = revision[0].in_history(b).rev_id
2111
cur_file_id = tree.path2id(relpath)
2112
rev_tree = b.repository.revision_tree(revision_id)
2113
old_file_id = rev_tree.path2id(relpath)
2115
if name_from_revision:
2116
if old_file_id is None:
2117
raise errors.BzrCommandError("%r is not present in revision %s"
2118
% (filename, revision_id))
2120
rev_tree.print_file(old_file_id)
2121
elif cur_file_id is not None:
2122
rev_tree.print_file(cur_file_id)
2123
elif old_file_id is not None:
2124
rev_tree.print_file(old_file_id)
2126
raise errors.BzrCommandError("%r is not present in revision %s" %
2127
(filename, revision_id))
2130
class cmd_local_time_offset(Command):
2131
"""Show the offset in seconds from GMT to local time."""
2135
print osutils.local_time_offset()
2139
class cmd_commit(Command):
2140
"""Commit changes into a new revision.
2142
If no arguments are given, the entire tree is committed.
2144
If selected files are specified, only changes to those files are
2145
committed. If a directory is specified then the directory and everything
2146
within it is committed.
2148
A selected-file commit may fail in some cases where the committed
2149
tree would be invalid. Consider::
2154
bzr commit foo -m "committing foo"
2155
bzr mv foo/bar foo/baz
2158
bzr commit foo/bar -m "committing bar but not baz"
2160
In the example above, the last commit will fail by design. This gives
2161
the user the opportunity to decide whether they want to commit the
2162
rename at the same time, separately first, or not at all. (As a general
2163
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2165
Note: A selected-file commit after a merge is not yet supported.
2167
# TODO: Run hooks on tree to-be-committed, and after commit.
2169
# TODO: Strict commit that fails if there are deleted files.
2170
# (what does "deleted files" mean ??)
2172
# TODO: Give better message for -s, --summary, used by tla people
2174
# XXX: verbose currently does nothing
2176
_see_also = ['bugs', 'uncommit']
2177
takes_args = ['selected*']
2179
Option('message', type=unicode,
2181
help="Description of the new revision."),
2184
help='Commit even if nothing has changed.'),
2185
Option('file', type=str,
2188
help='Take commit message from this file.'),
2190
help="Refuse to commit if there are unknown "
2191
"files in the working tree."),
2192
ListOption('fixes', type=str,
2193
help="Mark a bug as being fixed by this revision."),
2195
help="Perform a local commit in a bound "
2196
"branch. Local commits are not pushed to "
2197
"the master branch until a normal commit "
2201
aliases = ['ci', 'checkin']
2203
def _get_bug_fix_properties(self, fixes, branch):
2205
# Configure the properties for bug fixing attributes.
2206
for fixed_bug in fixes:
2207
tokens = fixed_bug.split(':')
2208
if len(tokens) != 2:
2209
raise errors.BzrCommandError(
2210
"Invalid bug %s. Must be in the form of 'tag:id'. "
2211
"Commit refused." % fixed_bug)
2212
tag, bug_id = tokens
2214
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2215
except errors.UnknownBugTrackerAbbreviation:
2216
raise errors.BzrCommandError(
2217
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2218
except errors.MalformedBugIdentifier:
2219
raise errors.BzrCommandError(
2220
"Invalid bug identifier for %s. Commit refused."
2222
properties.append('%s fixed' % bug_url)
2223
return '\n'.join(properties)
2225
def run(self, message=None, file=None, verbose=True, selected_list=None,
2226
unchanged=False, strict=False, local=False, fixes=None):
2227
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2228
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2230
from bzrlib.msgeditor import edit_commit_message, \
2231
make_commit_message_template
2233
# TODO: Need a blackbox test for invoking the external editor; may be
2234
# slightly problematic to run this cross-platform.
2236
# TODO: do more checks that the commit will succeed before
2237
# spending the user's valuable time typing a commit message.
2241
tree, selected_list = tree_files(selected_list)
2242
if selected_list == ['']:
2243
# workaround - commit of root of tree should be exactly the same
2244
# as just default commit in that tree, and succeed even though
2245
# selected-file merge commit is not done yet
2248
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2250
properties['bugs'] = bug_property
2252
if local and not tree.branch.get_bound_location():
2253
raise errors.LocalRequiresBoundBranch()
2255
def get_message(commit_obj):
2256
"""Callback to get commit message"""
2257
my_message = message
2258
if my_message is None and not file:
2259
template = make_commit_message_template(tree, selected_list)
2260
my_message = edit_commit_message(template)
2261
if my_message is None:
2262
raise errors.BzrCommandError("please specify a commit"
2263
" message with either --message or --file")
2264
elif my_message and file:
2265
raise errors.BzrCommandError(
2266
"please specify either --message or --file")
2268
my_message = codecs.open(file, 'rt',
2269
bzrlib.user_encoding).read()
2270
if my_message == "":
2271
raise errors.BzrCommandError("empty commit message specified")
2275
reporter = ReportCommitToLog()
2277
reporter = NullCommitReporter()
2280
tree.commit(message_callback=get_message,
2281
specific_files=selected_list,
2282
allow_pointless=unchanged, strict=strict, local=local,
2283
reporter=reporter, revprops=properties)
2284
except PointlessCommit:
2285
# FIXME: This should really happen before the file is read in;
2286
# perhaps prepare the commit; get the message; then actually commit
2287
raise errors.BzrCommandError("no changes to commit."
2288
" use --unchanged to commit anyhow")
2289
except ConflictsInTree:
2290
raise errors.BzrCommandError('Conflicts detected in working '
2291
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2293
except StrictCommitFailed:
2294
raise errors.BzrCommandError("Commit refused because there are"
2295
" unknown files in the working tree.")
2296
except errors.BoundBranchOutOfDate, e:
2297
raise errors.BzrCommandError(str(e) + "\n"
2298
'To commit to master branch, run update and then commit.\n'
2299
'You can also pass --local to commit to continue working '
2303
class cmd_check(Command):
2304
"""Validate consistency of branch history.
2306
This command checks various invariants about the branch storage to
2307
detect data corruption or bzr bugs.
2310
_see_also = ['reconcile']
2311
takes_args = ['branch?']
2312
takes_options = ['verbose']
2314
def run(self, branch=None, verbose=False):
2315
from bzrlib.check import check
2317
tree = WorkingTree.open_containing()[0]
2318
branch = tree.branch
2320
branch = Branch.open(branch)
2321
check(branch, verbose)
2324
class cmd_upgrade(Command):
2325
"""Upgrade branch storage to current format.
2327
The check command or bzr developers may sometimes advise you to run
2328
this command. When the default format has changed you may also be warned
2329
during other operations to upgrade.
2332
_see_also = ['check']
2333
takes_args = ['url?']
2335
RegistryOption('format',
2336
help='Upgrade to a specific format. See "bzr help'
2337
' formats" for details.',
2338
registry=bzrdir.format_registry,
2339
converter=bzrdir.format_registry.make_bzrdir,
2340
value_switches=True, title='Branch format'),
2343
def run(self, url='.', format=None):
2344
from bzrlib.upgrade import upgrade
2346
format = bzrdir.format_registry.make_bzrdir('default')
2347
upgrade(url, format)
2350
class cmd_whoami(Command):
2351
"""Show or set bzr user id.
2354
Show the email of the current user::
2358
Set the current user::
2360
bzr whoami 'Frank Chu <fchu@example.com>'
2362
takes_options = [ Option('email',
2363
help='Display email address only.'),
2365
help='Set identity for the current branch instead of '
2368
takes_args = ['name?']
2369
encoding_type = 'replace'
2372
def run(self, email=False, branch=False, name=None):
2374
# use branch if we're inside one; otherwise global config
2376
c = Branch.open_containing('.')[0].get_config()
2377
except errors.NotBranchError:
2378
c = config.GlobalConfig()
2380
self.outf.write(c.user_email() + '\n')
2382
self.outf.write(c.username() + '\n')
2385
# display a warning if an email address isn't included in the given name.
2387
config.extract_email_address(name)
2388
except errors.NoEmailInUsername, e:
2389
warning('"%s" does not seem to contain an email address. '
2390
'This is allowed, but not recommended.', name)
2392
# use global config unless --branch given
2394
c = Branch.open_containing('.')[0].get_config()
2396
c = config.GlobalConfig()
2397
c.set_user_option('email', name)
2400
class cmd_nick(Command):
2401
"""Print or set the branch nickname.
2403
If unset, the tree root directory name is used as the nickname
2404
To print the current nickname, execute with no argument.
2407
_see_also = ['info']
2408
takes_args = ['nickname?']
2409
def run(self, nickname=None):
2410
branch = Branch.open_containing(u'.')[0]
2411
if nickname is None:
2412
self.printme(branch)
2414
branch.nick = nickname
2417
def printme(self, branch):
2421
class cmd_selftest(Command):
2422
"""Run internal test suite.
2424
If arguments are given, they are regular expressions that say which tests
2425
should run. Tests matching any expression are run, and other tests are
2428
Alternatively if --first is given, matching tests are run first and then
2429
all other tests are run. This is useful if you have been working in a
2430
particular area, but want to make sure nothing else was broken.
2432
If --exclude is given, tests that match that regular expression are
2433
excluded, regardless of whether they match --first or not.
2435
To help catch accidential dependencies between tests, the --randomize
2436
option is useful. In most cases, the argument used is the word 'now'.
2437
Note that the seed used for the random number generator is displayed
2438
when this option is used. The seed can be explicitly passed as the
2439
argument to this option if required. This enables reproduction of the
2440
actual ordering used if and when an order sensitive problem is encountered.
2442
If --list-only is given, the tests that would be run are listed. This is
2443
useful when combined with --first, --exclude and/or --randomize to
2444
understand their impact. The test harness reports "Listed nn tests in ..."
2445
instead of "Ran nn tests in ..." when list mode is enabled.
2447
If the global option '--no-plugins' is given, plugins are not loaded
2448
before running the selftests. This has two effects: features provided or
2449
modified by plugins will not be tested, and tests provided by plugins will
2452
Tests that need working space on disk use a common temporary directory,
2453
typically inside $TMPDIR or /tmp.
2456
Run only tests relating to 'ignore'::
2460
Disable plugins and list tests as they're run::
2462
bzr --no-plugins selftest -v
2464
# NB: this is used from the class without creating an instance, which is
2465
# why it does not have a self parameter.
2466
def get_transport_type(typestring):
2467
"""Parse and return a transport specifier."""
2468
if typestring == "sftp":
2469
from bzrlib.transport.sftp import SFTPAbsoluteServer
2470
return SFTPAbsoluteServer
2471
if typestring == "memory":
2472
from bzrlib.transport.memory import MemoryServer
2474
if typestring == "fakenfs":
2475
from bzrlib.transport.fakenfs import FakeNFSServer
2476
return FakeNFSServer
2477
msg = "No known transport type %s. Supported types are: sftp\n" %\
2479
raise errors.BzrCommandError(msg)
2482
takes_args = ['testspecs*']
2483
takes_options = ['verbose',
2485
help='Stop when one test fails.',
2489
help='Use a different transport by default '
2490
'throughout the test suite.',
2491
type=get_transport_type),
2493
help='Run the benchmarks rather than selftests.'),
2494
Option('lsprof-timed',
2495
help='Generate lsprof output for benchmarked'
2496
' sections of code.'),
2497
Option('cache-dir', type=str,
2498
help='Cache intermediate benchmark output in this '
2501
help='Run all tests, but run specified tests first.',
2505
help='List the tests instead of running them.'),
2506
Option('randomize', type=str, argname="SEED",
2507
help='Randomize the order of tests using the given'
2508
' seed or "now" for the current time.'),
2509
Option('exclude', type=str, argname="PATTERN",
2511
help='Exclude tests that match this regular'
2514
encoding_type = 'replace'
2516
def run(self, testspecs_list=None, verbose=None, one=False,
2517
transport=None, benchmark=None,
2518
lsprof_timed=None, cache_dir=None,
2519
first=False, list_only=False,
2520
randomize=None, exclude=None):
2522
from bzrlib.tests import selftest
2523
import bzrlib.benchmarks as benchmarks
2524
from bzrlib.benchmarks import tree_creator
2525
from bzrlib.version import show_version
2527
if cache_dir is not None:
2528
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2530
show_version(show_config=False, show_copyright=False)
2532
if testspecs_list is not None:
2533
pattern = '|'.join(testspecs_list)
2537
test_suite_factory = benchmarks.test_suite
2540
# TODO: should possibly lock the history file...
2541
benchfile = open(".perf_history", "at", buffering=1)
2543
test_suite_factory = None
2548
result = selftest(verbose=verbose,
2550
stop_on_failure=one,
2551
transport=transport,
2552
test_suite_factory=test_suite_factory,
2553
lsprof_timed=lsprof_timed,
2554
bench_history=benchfile,
2555
matching_tests_first=first,
2556
list_only=list_only,
2557
random_seed=randomize,
2558
exclude_pattern=exclude
2561
if benchfile is not None:
2564
info('tests passed')
2566
info('tests failed')
2567
return int(not result)
2570
class cmd_version(Command):
2571
"""Show version of bzr."""
2575
from bzrlib.version import show_version
2579
class cmd_rocks(Command):
2580
"""Statement of optimism."""
2586
print "It sure does!"
2589
class cmd_find_merge_base(Command):
2590
"""Find and print a base revision for merging two branches."""
2591
# TODO: Options to specify revisions on either side, as if
2592
# merging only part of the history.
2593
takes_args = ['branch', 'other']
2597
def run(self, branch, other):
2598
from bzrlib.revision import ensure_null, MultipleRevisionSources
2600
branch1 = Branch.open_containing(branch)[0]
2601
branch2 = Branch.open_containing(other)[0]
2603
last1 = ensure_null(branch1.last_revision())
2604
last2 = ensure_null(branch2.last_revision())
2606
graph = branch1.repository.get_graph(branch2.repository)
2607
base_rev_id = graph.find_unique_lca(last1, last2)
2609
print 'merge base is revision %s' % base_rev_id
2612
class cmd_merge(Command):
2613
"""Perform a three-way merge.
2615
The branch is the branch you will merge from. By default, it will merge
2616
the latest revision. If you specify a revision, that revision will be
2617
merged. If you specify two revisions, the first will be used as a BASE,
2618
and the second one as OTHER. Revision numbers are always relative to the
2621
By default, bzr will try to merge in all new work from the other
2622
branch, automatically determining an appropriate base. If this
2623
fails, you may need to give an explicit base.
2625
Merge will do its best to combine the changes in two branches, but there
2626
are some kinds of problems only a human can fix. When it encounters those,
2627
it will mark a conflict. A conflict means that you need to fix something,
2628
before you should commit.
2630
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2632
If there is no default branch set, the first merge will set it. After
2633
that, you can omit the branch to use the default. To change the
2634
default, use --remember. The value will only be saved if the remote
2635
location can be accessed.
2637
The results of the merge are placed into the destination working
2638
directory, where they can be reviewed (with bzr diff), tested, and then
2639
committed to record the result of the merge.
2641
merge refuses to run if there are any uncommitted changes, unless
2645
To merge the latest revision from bzr.dev::
2647
bzr merge ../bzr.dev
2649
To merge changes up to and including revision 82 from bzr.dev::
2651
bzr merge -r 82 ../bzr.dev
2653
To merge the changes introduced by 82, without previous changes::
2655
bzr merge -r 81..82 ../bzr.dev
2658
_see_also = ['update', 'remerge', 'status-flags']
2659
takes_args = ['branch?']
2663
help='Merge even if the destination tree has uncommitted changes.'),
2667
Option('show-base', help="Show base revision text in "
2669
Option('uncommitted', help='Apply uncommitted changes'
2670
' from a working copy, instead of branch changes.'),
2671
Option('pull', help='If the destination is already'
2672
' completely merged into the source, pull from the'
2673
' source rather than merging. When this happens,'
2674
' you do not need to commit the result.'),
2676
help='Branch to merge into, '
2677
'rather than the one containing the working directory.',
2683
def run(self, branch=None, revision=None, force=False, merge_type=None,
2684
show_base=False, reprocess=False, remember=False,
2685
uncommitted=False, pull=False,
2688
from bzrlib.tag import _merge_tags_if_possible
2689
# This is actually a branch (or merge-directive) *location*.
2693
if merge_type is None:
2694
merge_type = _mod_merge.Merge3Merger
2696
if directory is None: directory = u'.'
2697
possible_transports = []
2699
allow_pending = True
2700
verified = 'inapplicable'
2701
tree = WorkingTree.open_containing(directory)[0]
2702
change_reporter = delta._ChangeReporter(
2703
unversioned_filter=tree.is_ignored)
2706
pb = ui.ui_factory.nested_progress_bar()
2707
cleanups.append(pb.finished)
2709
cleanups.append(tree.unlock)
2710
if location is not None:
2711
mergeable, other_transport = _get_mergeable_helper(location)
2714
raise errors.BzrCommandError('Cannot use --uncommitted'
2715
' with bundles or merge directives.')
2717
if revision is not None:
2718
raise errors.BzrCommandError(
2719
'Cannot use -r with merge directives or bundles')
2720
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2722
possible_transports.append(other_transport)
2724
if merger is None and uncommitted:
2725
if revision is not None and len(revision) > 0:
2726
raise errors.BzrCommandError('Cannot use --uncommitted and'
2727
' --revision at the same time.')
2728
location = self._select_branch_location(tree, location)[0]
2729
other_tree, other_path = WorkingTree.open_containing(location)
2730
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2732
allow_pending = False
2735
merger, allow_pending = self._get_merger_from_branch(tree,
2736
location, revision, remember, possible_transports, pb)
2738
merger.merge_type = merge_type
2739
merger.reprocess = reprocess
2740
merger.show_base = show_base
2741
merger.change_reporter = change_reporter
2742
self.sanity_check_merger(merger)
2743
if (merger.base_rev_id == merger.other_rev_id and
2744
merger.other_rev_id != None):
2745
note('Nothing to do.')
2748
if merger.interesting_files is not None:
2749
raise BzrCommandError('Cannot pull individual files')
2750
if (merger.base_rev_id == tree.last_revision()):
2751
result = tree.pull(merger.other_branch, False,
2752
merger.other_rev_id)
2753
result.report(self.outf)
2755
merger.check_basis(not force)
2756
conflict_count = merger.do_merge()
2758
merger.set_pending()
2759
if verified == 'failed':
2760
warning('Preview patch does not match changes')
2761
if conflict_count != 0:
2766
for cleanup in reversed(cleanups):
2769
def sanity_check_merger(self, merger):
2770
if (merger.show_base and
2771
not merger.merge_type is _mod_merge.Merge3Merger):
2772
raise errors.BzrCommandError("Show-base is not supported for this"
2773
" merge type. %s" % merge_type)
2774
if merger.reprocess and not merger.merge_type.supports_reprocess:
2775
raise errors.BzrCommandError("Conflict reduction is not supported"
2776
" for merge type %s." % merge_type)
2777
if merger.reprocess and merger.show_base:
2778
raise errors.BzrCommandError("Cannot do conflict reduction and"
2781
def _get_merger_from_branch(self, tree, location, revision, remember,
2782
possible_transports, pb):
2783
"""Produce a merger from a location, assuming it refers to a branch."""
2784
from bzrlib.tag import _merge_tags_if_possible
2785
assert revision is None or len(revision) < 3
2786
# find the branch locations
2787
other_loc, location = self._select_branch_location(tree, location,
2789
if revision is not None and len(revision) == 2:
2790
base_loc, location = self._select_branch_location(tree, location,
2793
base_loc = other_loc
2795
other_branch, other_path = Branch.open_containing(other_loc,
2796
possible_transports)
2797
if base_loc == other_loc:
2798
base_branch = other_branch
2800
base_branch, base_path = Branch.open_containing(base_loc,
2801
possible_transports)
2802
# Find the revision ids
2803
if revision is None or len(revision) < 1 or revision[-1] is None:
2804
other_revision_id = _mod_revision.ensure_null(
2805
other_branch.last_revision())
2807
other_revision_id = \
2808
_mod_revision.ensure_null(
2809
revision[-1].in_history(other_branch).rev_id)
2810
if (revision is not None and len(revision) == 2
2811
and revision[0] is not None):
2812
base_revision_id = \
2813
_mod_revision.ensure_null(
2814
revision[0].in_history(base_branch).rev_id)
2816
base_revision_id = None
2817
# Remember where we merge from
2818
if ((tree.branch.get_parent() is None or remember) and
2819
other_branch is not None):
2820
tree.branch.set_parent(other_branch.base)
2821
_merge_tags_if_possible(other_branch, tree.branch)
2822
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2823
other_revision_id, base_revision_id, other_branch, base_branch)
2824
if other_path != '':
2825
allow_pending = False
2826
merger.interesting_files = [other_path]
2828
allow_pending = True
2829
return merger, allow_pending
2831
def _select_branch_location(self, tree, location, revision=None,
2833
"""Select a branch location, according to possible inputs.
2835
If provided, branches from ``revision`` are preferred. (Both
2836
``revision`` and ``index`` must be supplied.)
2838
Otherwise, the ``location`` parameter is used. If it is None, then the
2839
``parent`` location is used, and a note is printed.
2841
:param tree: The working tree to select a branch for merging into
2842
:param location: The location entered by the user
2843
:param revision: The revision parameter to the command
2844
:param index: The index to use for the revision parameter. Negative
2845
indices are permitted.
2846
:return: (selected_location, default_location). The default location
2847
will be the user-entered location, if any, or else the remembered
2850
if (revision is not None and index is not None
2851
and revision[index] is not None):
2852
branch = revision[index].get_branch()
2853
if branch is not None:
2854
return branch, location
2855
location = self._get_remembered_parent(tree, location, 'Merging from')
2856
return location, location
2858
# TODO: move up to common parent; this isn't merge-specific anymore.
2859
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2860
"""Use tree.branch's parent if none was supplied.
2862
Report if the remembered location was used.
2864
if supplied_location is not None:
2865
return supplied_location
2866
stored_location = tree.branch.get_parent()
2867
mutter("%s", stored_location)
2868
if stored_location is None:
2869
raise errors.BzrCommandError("No location specified or remembered")
2870
display_url = urlutils.unescape_for_display(stored_location,
2872
self.outf.write("%s remembered location %s\n" % (verb_string,
2874
return stored_location
2877
class cmd_remerge(Command):
2880
Use this if you want to try a different merge technique while resolving
2881
conflicts. Some merge techniques are better than others, and remerge
2882
lets you try different ones on different files.
2884
The options for remerge have the same meaning and defaults as the ones for
2885
merge. The difference is that remerge can (only) be run when there is a
2886
pending merge, and it lets you specify particular files.
2889
Re-do the merge of all conflicted files, and show the base text in
2890
conflict regions, in addition to the usual THIS and OTHER texts::
2892
bzr remerge --show-base
2894
Re-do the merge of "foobar", using the weave merge algorithm, with
2895
additional processing to reduce the size of conflict regions::
2897
bzr remerge --merge-type weave --reprocess foobar
2899
takes_args = ['file*']
2904
help="Show base revision text in conflicts."),
2907
def run(self, file_list=None, merge_type=None, show_base=False,
2909
if merge_type is None:
2910
merge_type = _mod_merge.Merge3Merger
2911
tree, file_list = tree_files(file_list)
2914
parents = tree.get_parent_ids()
2915
if len(parents) != 2:
2916
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2917
" merges. Not cherrypicking or"
2919
repository = tree.branch.repository
2920
graph = repository.get_graph()
2921
base_revision = graph.find_unique_lca(parents[0], parents[1])
2922
base_tree = repository.revision_tree(base_revision)
2923
other_tree = repository.revision_tree(parents[1])
2924
interesting_ids = None
2926
conflicts = tree.conflicts()
2927
if file_list is not None:
2928
interesting_ids = set()
2929
for filename in file_list:
2930
file_id = tree.path2id(filename)
2932
raise errors.NotVersionedError(filename)
2933
interesting_ids.add(file_id)
2934
if tree.kind(file_id) != "directory":
2937
for name, ie in tree.inventory.iter_entries(file_id):
2938
interesting_ids.add(ie.file_id)
2939
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2941
# Remerge only supports resolving contents conflicts
2942
allowed_conflicts = ('text conflict', 'contents conflict')
2943
restore_files = [c.path for c in conflicts
2944
if c.typestring in allowed_conflicts]
2945
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2946
tree.set_conflicts(ConflictList(new_conflicts))
2947
if file_list is not None:
2948
restore_files = file_list
2949
for filename in restore_files:
2951
restore(tree.abspath(filename))
2952
except errors.NotConflicted:
2954
# Disable pending merges, because the file texts we are remerging
2955
# have not had those merges performed. If we use the wrong parents
2956
# list, we imply that the working tree text has seen and rejected
2957
# all the changes from the other tree, when in fact those changes
2958
# have not yet been seen.
2959
tree.set_parent_ids(parents[:1])
2961
conflicts = _mod_merge.merge_inner(
2962
tree.branch, other_tree, base_tree,
2964
interesting_ids=interesting_ids,
2965
other_rev_id=parents[1],
2966
merge_type=merge_type,
2967
show_base=show_base,
2968
reprocess=reprocess)
2970
tree.set_parent_ids(parents)
2979
class cmd_revert(Command):
2980
"""Revert files to a previous revision.
2982
Giving a list of files will revert only those files. Otherwise, all files
2983
will be reverted. If the revision is not specified with '--revision', the
2984
last committed revision is used.
2986
To remove only some changes, without reverting to a prior version, use
2987
merge instead. For example, "merge . --r-2..-3" will remove the changes
2988
introduced by -2, without affecting the changes introduced by -1. Or
2989
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2991
By default, any files that have been manually changed will be backed up
2992
first. (Files changed only by merge are not backed up.) Backup files have
2993
'.~#~' appended to their name, where # is a number.
2995
When you provide files, you can use their current pathname or the pathname
2996
from the target revision. So you can use revert to "undelete" a file by
2997
name. If you name a directory, all the contents of that directory will be
3001
_see_also = ['cat', 'export']
3004
Option('no-backup', "Do not save backups of reverted files."),
3006
takes_args = ['file*']
3008
def run(self, revision=None, no_backup=False, file_list=None):
3009
if file_list is not None:
3010
if len(file_list) == 0:
3011
raise errors.BzrCommandError("No files specified")
3015
tree, file_list = tree_files(file_list)
3016
if revision is None:
3017
# FIXME should be tree.last_revision
3018
rev_id = tree.last_revision()
3019
elif len(revision) != 1:
3020
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3022
rev_id = revision[0].in_history(tree.branch).rev_id
3023
pb = ui.ui_factory.nested_progress_bar()
3025
tree.revert(file_list,
3026
tree.branch.repository.revision_tree(rev_id),
3027
not no_backup, pb, report_changes=True)
3032
class cmd_assert_fail(Command):
3033
"""Test reporting of assertion failures"""
3034
# intended just for use in testing
3039
raise AssertionError("always fails")
3042
class cmd_help(Command):
3043
"""Show help on a command or other topic.
3046
_see_also = ['topics']
3048
Option('long', 'Show help on all commands.'),
3050
takes_args = ['topic?']
3051
aliases = ['?', '--help', '-?', '-h']
3054
def run(self, topic=None, long=False):
3056
if topic is None and long:
3058
bzrlib.help.help(topic)
3061
class cmd_shell_complete(Command):
3062
"""Show appropriate completions for context.
3064
For a list of all available commands, say 'bzr shell-complete'.
3066
takes_args = ['context?']
3071
def run(self, context=None):
3072
import shellcomplete
3073
shellcomplete.shellcomplete(context)
3076
class cmd_fetch(Command):
3077
"""Copy in history from another branch but don't merge it.
3079
This is an internal method used for pull and merge.
3082
takes_args = ['from_branch', 'to_branch']
3083
def run(self, from_branch, to_branch):
3084
from bzrlib.fetch import Fetcher
3085
from_b = Branch.open(from_branch)
3086
to_b = Branch.open(to_branch)
3087
Fetcher(to_b, from_b)
3090
class cmd_missing(Command):
3091
"""Show unmerged/unpulled revisions between two branches.
3093
OTHER_BRANCH may be local or remote.
3096
_see_also = ['merge', 'pull']
3097
takes_args = ['other_branch?']
3099
Option('reverse', 'Reverse the order of revisions.'),
3101
'Display changes in the local branch only.'),
3102
Option('this' , 'Same as --mine-only.'),
3103
Option('theirs-only',
3104
'Display changes in the remote branch only.'),
3105
Option('other', 'Same as --theirs-only.'),
3110
encoding_type = 'replace'
3113
def run(self, other_branch=None, reverse=False, mine_only=False,
3114
theirs_only=False, log_format=None, long=False, short=False, line=False,
3115
show_ids=False, verbose=False, this=False, other=False):
3116
from bzrlib.missing import find_unmerged, iter_log_revisions
3117
from bzrlib.log import log_formatter
3124
local_branch = Branch.open_containing(u".")[0]
3125
parent = local_branch.get_parent()
3126
if other_branch is None:
3127
other_branch = parent
3128
if other_branch is None:
3129
raise errors.BzrCommandError("No peer location known"
3131
display_url = urlutils.unescape_for_display(parent,
3133
self.outf.write("Using last location: " + display_url + "\n")
3135
remote_branch = Branch.open(other_branch)
3136
if remote_branch.base == local_branch.base:
3137
remote_branch = local_branch
3138
local_branch.lock_read()
3140
remote_branch.lock_read()
3142
local_extra, remote_extra = find_unmerged(local_branch,
3144
if log_format is None:
3145
registry = log.log_formatter_registry
3146
log_format = registry.get_default(local_branch)
3147
lf = log_format(to_file=self.outf,
3149
show_timezone='original')
3150
if reverse is False:
3151
local_extra.reverse()
3152
remote_extra.reverse()
3153
if local_extra and not theirs_only:
3154
self.outf.write("You have %d extra revision(s):\n" %
3156
for revision in iter_log_revisions(local_extra,
3157
local_branch.repository,
3159
lf.log_revision(revision)
3160
printed_local = True
3162
printed_local = False
3163
if remote_extra and not mine_only:
3164
if printed_local is True:
3165
self.outf.write("\n\n\n")
3166
self.outf.write("You are missing %d revision(s):\n" %
3168
for revision in iter_log_revisions(remote_extra,
3169
remote_branch.repository,
3171
lf.log_revision(revision)
3172
if not remote_extra and not local_extra:
3174
self.outf.write("Branches are up to date.\n")
3178
remote_branch.unlock()
3180
local_branch.unlock()
3181
if not status_code and parent is None and other_branch is not None:
3182
local_branch.lock_write()
3184
# handle race conditions - a parent might be set while we run.
3185
if local_branch.get_parent() is None:
3186
local_branch.set_parent(remote_branch.base)
3188
local_branch.unlock()
3192
class cmd_pack(Command):
3193
"""Compress the data within a repository."""
3195
_see_also = ['repositories']
3196
takes_args = ['branch_or_repo?']
3198
def run(self, branch_or_repo='.'):
3199
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3201
branch = dir.open_branch()
3202
repository = branch.repository
3203
except errors.NotBranchError:
3204
repository = dir.open_repository()
3208
class cmd_plugins(Command):
3209
"""List the installed plugins.
3211
This command displays the list of installed plugins including the
3212
path where each one is located and a short description of each.
3214
A plugin is an external component for Bazaar that extends the
3215
revision control system, by adding or replacing code in Bazaar.
3216
Plugins can do a variety of things, including overriding commands,
3217
adding new commands, providing additional network transports and
3218
customizing log output.
3220
See the Bazaar web site, http://bazaar-vcs.org, for further
3221
information on plugins including where to find them and how to
3222
install them. Instructions are also provided there on how to
3223
write new plugins using the Python programming language.
3228
import bzrlib.plugin
3229
from inspect import getdoc
3230
for name, plugin in bzrlib.plugin.all_plugins().items():
3231
if getattr(plugin, '__path__', None) is not None:
3232
print plugin.__path__[0]
3233
elif getattr(plugin, '__file__', None) is not None:
3234
print plugin.__file__
3240
print '\t', d.split('\n')[0]
3243
class cmd_testament(Command):
3244
"""Show testament (signing-form) of a revision."""
3247
Option('long', help='Produce long-format testament.'),
3249
help='Produce a strict-format testament.')]
3250
takes_args = ['branch?']
3252
def run(self, branch=u'.', revision=None, long=False, strict=False):
3253
from bzrlib.testament import Testament, StrictTestament
3255
testament_class = StrictTestament
3257
testament_class = Testament
3258
b = WorkingTree.open_containing(branch)[0].branch
3261
if revision is None:
3262
rev_id = b.last_revision()
3264
rev_id = revision[0].in_history(b).rev_id
3265
t = testament_class.from_revision(b.repository, rev_id)
3267
sys.stdout.writelines(t.as_text_lines())
3269
sys.stdout.write(t.as_short_text())
3274
class cmd_annotate(Command):
3275
"""Show the origin of each line in a file.
3277
This prints out the given file with an annotation on the left side
3278
indicating which revision, author and date introduced the change.
3280
If the origin is the same for a run of consecutive lines, it is
3281
shown only at the top, unless the --all option is given.
3283
# TODO: annotate directories; showing when each file was last changed
3284
# TODO: if the working copy is modified, show annotations on that
3285
# with new uncommitted lines marked
3286
aliases = ['ann', 'blame', 'praise']
3287
takes_args = ['filename']
3288
takes_options = [Option('all', help='Show annotations on all lines.'),
3289
Option('long', help='Show commit date in annotations.'),
3293
encoding_type = 'exact'
3296
def run(self, filename, all=False, long=False, revision=None,
3298
from bzrlib.annotate import annotate_file
3299
tree, relpath = WorkingTree.open_containing(filename)
3300
branch = tree.branch
3303
if revision is None:
3304
revision_id = branch.last_revision()
3305
elif len(revision) != 1:
3306
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3308
revision_id = revision[0].in_history(branch).rev_id
3309
file_id = tree.path2id(relpath)
3311
raise errors.NotVersionedError(filename)
3312
tree = branch.repository.revision_tree(revision_id)
3313
file_version = tree.inventory[file_id].revision
3314
annotate_file(branch, file_version, file_id, long, all, self.outf,
3320
class cmd_re_sign(Command):
3321
"""Create a digital signature for an existing revision."""
3322
# TODO be able to replace existing ones.
3324
hidden = True # is this right ?
3325
takes_args = ['revision_id*']
3326
takes_options = ['revision']
3328
def run(self, revision_id_list=None, revision=None):
3329
import bzrlib.gpg as gpg
3330
if revision_id_list is not None and revision is not None:
3331
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3332
if revision_id_list is None and revision is None:
3333
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3334
b = WorkingTree.open_containing(u'.')[0].branch
3335
gpg_strategy = gpg.GPGStrategy(b.get_config())
3336
if revision_id_list is not None:
3337
for revision_id in revision_id_list:
3338
b.repository.sign_revision(revision_id, gpg_strategy)
3339
elif revision is not None:
3340
if len(revision) == 1:
3341
revno, rev_id = revision[0].in_history(b)
3342
b.repository.sign_revision(rev_id, gpg_strategy)
3343
elif len(revision) == 2:
3344
# are they both on rh- if so we can walk between them
3345
# might be nice to have a range helper for arbitrary
3346
# revision paths. hmm.
3347
from_revno, from_revid = revision[0].in_history(b)
3348
to_revno, to_revid = revision[1].in_history(b)
3349
if to_revid is None:
3350
to_revno = b.revno()
3351
if from_revno is None or to_revno is None:
3352
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3353
for revno in range(from_revno, to_revno + 1):
3354
b.repository.sign_revision(b.get_rev_id(revno),
3357
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3360
class cmd_bind(Command):
3361
"""Convert the current branch into a checkout of the supplied branch.
3363
Once converted into a checkout, commits must succeed on the master branch
3364
before they will be applied to the local branch.
3367
_see_also = ['checkouts', 'unbind']
3368
takes_args = ['location?']
3371
def run(self, location=None):
3372
b, relpath = Branch.open_containing(u'.')
3373
if location is None:
3375
location = b.get_old_bound_location()
3376
except errors.UpgradeRequired:
3377
raise errors.BzrCommandError('No location supplied. '
3378
'This format does not remember old locations.')
3380
if location is None:
3381
raise errors.BzrCommandError('No location supplied and no '
3382
'previous location known')
3383
b_other = Branch.open(location)
3386
except errors.DivergedBranches:
3387
raise errors.BzrCommandError('These branches have diverged.'
3388
' Try merging, and then bind again.')
3391
class cmd_unbind(Command):
3392
"""Convert the current checkout into a regular branch.
3394
After unbinding, the local branch is considered independent and subsequent
3395
commits will be local only.
3398
_see_also = ['checkouts', 'bind']
3403
b, relpath = Branch.open_containing(u'.')
3405
raise errors.BzrCommandError('Local branch is not bound')
3408
class cmd_uncommit(Command):
3409
"""Remove the last committed revision.
3411
--verbose will print out what is being removed.
3412
--dry-run will go through all the motions, but not actually
3415
In the future, uncommit will create a revision bundle, which can then
3419
# TODO: jam 20060108 Add an option to allow uncommit to remove
3420
# unreferenced information in 'branch-as-repository' branches.
3421
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3422
# information in shared branches as well.
3423
_see_also = ['commit']
3424
takes_options = ['verbose', 'revision',
3425
Option('dry-run', help='Don\'t actually make changes.'),
3426
Option('force', help='Say yes to all questions.')]
3427
takes_args = ['location?']
3430
def run(self, location=None,
3431
dry_run=False, verbose=False,
3432
revision=None, force=False):
3433
from bzrlib.log import log_formatter, show_log
3435
from bzrlib.uncommit import uncommit
3437
if location is None:
3439
control, relpath = bzrdir.BzrDir.open_containing(location)
3441
tree = control.open_workingtree()
3443
except (errors.NoWorkingTree, errors.NotLocalUrl):
3445
b = control.open_branch()
3448
if revision is None:
3451
# 'bzr uncommit -r 10' actually means uncommit
3452
# so that the final tree is at revno 10.
3453
# but bzrlib.uncommit.uncommit() actually uncommits
3454
# the revisions that are supplied.
3455
# So we need to offset it by one
3456
revno = revision[0].in_history(b).revno+1
3458
if revno <= b.revno():
3459
rev_id = b.get_rev_id(revno)
3461
self.outf.write('No revisions to uncommit.\n')
3464
lf = log_formatter('short',
3466
show_timezone='original')
3471
direction='forward',
3472
start_revision=revno,
3473
end_revision=b.revno())
3476
print 'Dry-run, pretending to remove the above revisions.'
3478
val = raw_input('Press <enter> to continue')
3480
print 'The above revision(s) will be removed.'
3482
val = raw_input('Are you sure [y/N]? ')
3483
if val.lower() not in ('y', 'yes'):
3487
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3491
class cmd_break_lock(Command):
3492
"""Break a dead lock on a repository, branch or working directory.
3494
CAUTION: Locks should only be broken when you are sure that the process
3495
holding the lock has been stopped.
3497
You can get information on what locks are open via the 'bzr info' command.
3502
takes_args = ['location?']
3504
def run(self, location=None, show=False):
3505
if location is None:
3507
control, relpath = bzrdir.BzrDir.open_containing(location)
3509
control.break_lock()
3510
except NotImplementedError:
3514
class cmd_wait_until_signalled(Command):
3515
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3517
This just prints a line to signal when it is ready, then blocks on stdin.
3523
sys.stdout.write("running\n")
3525
sys.stdin.readline()
3528
class cmd_serve(Command):
3529
"""Run the bzr server."""
3531
aliases = ['server']
3535
help='Serve on stdin/out for use from inetd or sshd.'),
3537
help='Listen for connections on nominated port of the form '
3538
'[hostname:]portnumber. Passing 0 as the port number will '
3539
'result in a dynamically allocated port. The default port is '
3543
help='Serve contents of this directory.',
3545
Option('allow-writes',
3546
help='By default the server is a readonly server. Supplying '
3547
'--allow-writes enables write access to the contents of '
3548
'the served directory and below.'
3552
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3553
from bzrlib.smart import medium, server
3554
from bzrlib.transport import get_transport
3555
from bzrlib.transport.chroot import ChrootServer
3556
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3557
if directory is None:
3558
directory = os.getcwd()
3559
url = urlutils.local_path_to_url(directory)
3560
if not allow_writes:
3561
url = 'readonly+' + url
3562
chroot_server = ChrootServer(get_transport(url))
3563
chroot_server.setUp()
3564
t = get_transport(chroot_server.get_url())
3566
smart_server = medium.SmartServerPipeStreamMedium(
3567
sys.stdin, sys.stdout, t)
3569
host = BZR_DEFAULT_INTERFACE
3571
port = BZR_DEFAULT_PORT
3574
host, port = port.split(':')
3576
smart_server = server.SmartTCPServer(t, host=host, port=port)
3577
print 'listening on port: ', smart_server.port
3579
# for the duration of this server, no UI output is permitted.
3580
# note that this may cause problems with blackbox tests. This should
3581
# be changed with care though, as we dont want to use bandwidth sending
3582
# progress over stderr to smart server clients!
3583
old_factory = ui.ui_factory
3585
ui.ui_factory = ui.SilentUIFactory()
3586
smart_server.serve()
3588
ui.ui_factory = old_factory
3591
class cmd_join(Command):
3592
"""Combine a subtree into its containing tree.
3594
This command is for experimental use only. It requires the target tree
3595
to be in dirstate-with-subtree format, which cannot be converted into
3598
The TREE argument should be an independent tree, inside another tree, but
3599
not part of it. (Such trees can be produced by "bzr split", but also by
3600
running "bzr branch" with the target inside a tree.)
3602
The result is a combined tree, with the subtree no longer an independant
3603
part. This is marked as a merge of the subtree into the containing tree,
3604
and all history is preserved.
3606
If --reference is specified, the subtree retains its independence. It can
3607
be branched by itself, and can be part of multiple projects at the same
3608
time. But operations performed in the containing tree, such as commit
3609
and merge, will recurse into the subtree.
3612
_see_also = ['split']
3613
takes_args = ['tree']
3615
Option('reference', help='Join by reference.'),
3619
def run(self, tree, reference=False):
3620
sub_tree = WorkingTree.open(tree)
3621
parent_dir = osutils.dirname(sub_tree.basedir)
3622
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3623
repo = containing_tree.branch.repository
3624
if not repo.supports_rich_root():
3625
raise errors.BzrCommandError(
3626
"Can't join trees because %s doesn't support rich root data.\n"
3627
"You can use bzr upgrade on the repository."
3631
containing_tree.add_reference(sub_tree)
3632
except errors.BadReferenceTarget, e:
3633
# XXX: Would be better to just raise a nicely printable
3634
# exception from the real origin. Also below. mbp 20070306
3635
raise errors.BzrCommandError("Cannot join %s. %s" %
3639
containing_tree.subsume(sub_tree)
3640
except errors.BadSubsumeSource, e:
3641
raise errors.BzrCommandError("Cannot join %s. %s" %
3645
class cmd_split(Command):
3646
"""Split a tree into two trees.
3648
This command is for experimental use only. It requires the target tree
3649
to be in dirstate-with-subtree format, which cannot be converted into
3652
The TREE argument should be a subdirectory of a working tree. That
3653
subdirectory will be converted into an independent tree, with its own
3654
branch. Commits in the top-level tree will not apply to the new subtree.
3655
If you want that behavior, do "bzr join --reference TREE".
3658
_see_also = ['join']
3659
takes_args = ['tree']
3663
def run(self, tree):
3664
containing_tree, subdir = WorkingTree.open_containing(tree)
3665
sub_id = containing_tree.path2id(subdir)
3667
raise errors.NotVersionedError(subdir)
3669
containing_tree.extract(sub_id)
3670
except errors.RootNotRich:
3671
raise errors.UpgradeRequired(containing_tree.branch.base)
3675
class cmd_merge_directive(Command):
3676
"""Generate a merge directive for auto-merge tools.
3678
A directive requests a merge to be performed, and also provides all the
3679
information necessary to do so. This means it must either include a
3680
revision bundle, or the location of a branch containing the desired
3683
A submit branch (the location to merge into) must be supplied the first
3684
time the command is issued. After it has been supplied once, it will
3685
be remembered as the default.
3687
A public branch is optional if a revision bundle is supplied, but required
3688
if --diff or --plain is specified. It will be remembered as the default
3689
after the first use.
3692
takes_args = ['submit_branch?', 'public_branch?']
3696
_see_also = ['submit']
3699
RegistryOption.from_kwargs('patch-type',
3700
'The type of patch to include in the directive',
3702
value_switches=True,
3704
bundle='Bazaar revision bundle (default).',
3705
diff='Normal unified diff.',
3706
plain='No patch, just directive.'),
3707
Option('sign', help='GPG-sign the directive.'), 'revision',
3708
Option('mail-to', type=str,
3709
help='Instead of printing the directive, email to this address.'),
3710
Option('message', type=str, short_name='m',
3711
help='Message to use when committing this merge.')
3714
encoding_type = 'exact'
3716
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3717
sign=False, revision=None, mail_to=None, message=None):
3718
from bzrlib.revision import ensure_null, NULL_REVISION
3719
include_patch, include_bundle = {
3720
'plain': (False, False),
3721
'diff': (True, False),
3722
'bundle': (True, True),
3724
branch = Branch.open('.')
3725
stored_submit_branch = branch.get_submit_branch()
3726
if submit_branch is None:
3727
submit_branch = stored_submit_branch
3729
if stored_submit_branch is None:
3730
branch.set_submit_branch(submit_branch)
3731
if submit_branch is None:
3732
submit_branch = branch.get_parent()
3733
if submit_branch is None:
3734
raise errors.BzrCommandError('No submit branch specified or known')
3736
stored_public_branch = branch.get_public_branch()
3737
if public_branch is None:
3738
public_branch = stored_public_branch
3739
elif stored_public_branch is None:
3740
branch.set_public_branch(public_branch)
3741
if not include_bundle and public_branch is None:
3742
raise errors.BzrCommandError('No public branch specified or'
3744
base_revision_id = None
3745
if revision is not None:
3746
if len(revision) > 2:
3747
raise errors.BzrCommandError('bzr merge-directive takes '
3748
'at most two one revision identifiers')
3749
revision_id = revision[-1].in_history(branch).rev_id
3750
if len(revision) == 2:
3751
base_revision_id = revision[0].in_history(branch).rev_id
3752
base_revision_id = ensure_null(base_revision_id)
3754
revision_id = branch.last_revision()
3755
revision_id = ensure_null(revision_id)
3756
if revision_id == NULL_REVISION:
3757
raise errors.BzrCommandError('No revisions to bundle.')
3758
directive = merge_directive.MergeDirective2.from_objects(
3759
branch.repository, revision_id, time.time(),
3760
osutils.local_time_offset(), submit_branch,
3761
public_branch=public_branch, include_patch=include_patch,
3762
include_bundle=include_bundle, message=message,
3763
base_revision_id=base_revision_id)
3766
self.outf.write(directive.to_signed(branch))
3768
self.outf.writelines(directive.to_lines())
3770
message = directive.to_email(mail_to, branch, sign)
3771
s = SMTPConnection(branch.get_config())
3772
s.send_email(message)
3775
class cmd_send(Command):
3776
"""Create a merge-directive for submiting changes.
3778
A merge directive provides many things needed for requesting merges:
3780
* A machine-readable description of the merge to perform
3782
* An optional patch that is a preview of the changes requested
3784
* An optional bundle of revision data, so that the changes can be applied
3785
directly from the merge directive, without retrieving data from a
3788
If --no-bundle is specified, then public_branch is needed (and must be
3789
up-to-date), so that the receiver can perform the merge using the
3790
public_branch. The public_branch is always included if known, so that
3791
people can check it later.
3793
The submit branch defaults to the parent, but can be overridden. Both
3794
submit branch and public branch will be remembered if supplied.
3796
If a public_branch is known for the submit_branch, that public submit
3797
branch is used in the merge instructions. This means that a local mirror
3798
can be used as your actual submit branch, once you have set public_branch
3802
encoding_type = 'exact'
3804
aliases = ['bundle', 'bundle-revisions']
3806
_see_also = ['merge']
3808
takes_args = ['submit_branch?', 'public_branch?']
3812
help='Do not include a bundle in the merge directive.'),
3813
Option('no-patch', help='Do not include a preview patch in the merge'
3816
help='Remember submit and public branch.'),
3818
help='Branch to generate the submission from, '
3819
'rather than the one containing the working directory.',
3822
Option('output', short_name='o', help='Write directive to this file.',
3827
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3828
no_patch=False, revision=None, remember=False, output=None,
3830
from bzrlib.revision import ensure_null, NULL_REVISION
3832
raise errors.BzrCommandError('File must be specified with'
3837
outfile = open(output, 'wb')
3839
from_ = kwargs.get('from', '.')
3840
branch = Branch.open_containing(from_)[0]
3841
if remember and submit_branch is None:
3842
raise errors.BzrCommandError(
3843
'--remember requires a branch to be specified.')
3844
stored_submit_branch = branch.get_submit_branch()
3845
remembered_submit_branch = False
3846
if submit_branch is None:
3847
submit_branch = stored_submit_branch
3848
remembered_submit_branch = True
3850
if stored_submit_branch is None or remember:
3851
branch.set_submit_branch(submit_branch)
3852
if submit_branch is None:
3853
submit_branch = branch.get_parent()
3854
remembered_submit_branch = True
3855
if submit_branch is None:
3856
raise errors.BzrCommandError('No submit branch known or'
3858
if remembered_submit_branch:
3859
note('Using saved location: %s', submit_branch)
3861
stored_public_branch = branch.get_public_branch()
3862
if public_branch is None:
3863
public_branch = stored_public_branch
3864
elif stored_public_branch is None or remember:
3865
branch.set_public_branch(public_branch)
3866
if no_bundle and public_branch is None:
3867
raise errors.BzrCommandError('No public branch specified or'
3869
base_revision_id = None
3870
if revision is not None:
3871
if len(revision) > 2:
3872
raise errors.BzrCommandError('bzr send takes '
3873
'at most two one revision identifiers')
3874
revision_id = revision[-1].in_history(branch).rev_id
3875
if len(revision) == 2:
3876
base_revision_id = revision[0].in_history(branch).rev_id
3877
base_revision_id = ensure_null(base_revision_id)
3879
revision_id = branch.last_revision()
3880
revision_id = ensure_null(revision_id)
3881
if revision_id == NULL_REVISION:
3882
raise errors.BzrCommandError('No revisions to submit.')
3883
directive = merge_directive.MergeDirective2.from_objects(
3884
branch.repository, revision_id, time.time(),
3885
osutils.local_time_offset(), submit_branch,
3886
public_branch=public_branch, include_patch=not no_patch,
3887
include_bundle=not no_bundle, message=None,
3888
base_revision_id=base_revision_id)
3889
outfile.writelines(directive.to_lines())
3895
class cmd_tag(Command):
3896
"""Create, remove or modify a tag naming a revision.
3898
Tags give human-meaningful names to revisions. Commands that take a -r
3899
(--revision) option can be given -rtag:X, where X is any previously
3902
Tags are stored in the branch. Tags are copied from one branch to another
3903
along when you branch, push, pull or merge.
3905
It is an error to give a tag name that already exists unless you pass
3906
--force, in which case the tag is moved to point to the new revision.
3909
_see_also = ['commit', 'tags']
3910
takes_args = ['tag_name']
3913
help='Delete this tag rather than placing it.',
3916
help='Branch in which to place the tag.',
3921
help='Replace existing tags.',
3926
def run(self, tag_name,
3932
branch, relpath = Branch.open_containing(directory)
3936
branch.tags.delete_tag(tag_name)
3937
self.outf.write('Deleted tag %s.\n' % tag_name)
3940
if len(revision) != 1:
3941
raise errors.BzrCommandError(
3942
"Tags can only be placed on a single revision, "
3944
revision_id = revision[0].in_history(branch).rev_id
3946
revision_id = branch.last_revision()
3947
if (not force) and branch.tags.has_tag(tag_name):
3948
raise errors.TagAlreadyExists(tag_name)
3949
branch.tags.set_tag(tag_name, revision_id)
3950
self.outf.write('Created tag %s.\n' % tag_name)
3955
class cmd_tags(Command):
3958
This tag shows a table of tag names and the revisions they reference.
3964
help='Branch whose tags should be displayed.',
3974
branch, relpath = Branch.open_containing(directory)
3975
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3976
self.outf.write('%-20s %s\n' % (tag_name, target))
3979
def _create_prefix(cur_transport):
3980
needed = [cur_transport]
3981
# Recurse upwards until we can create a directory successfully
3983
new_transport = cur_transport.clone('..')
3984
if new_transport.base == cur_transport.base:
3985
raise errors.BzrCommandError(
3986
"Failed to create path prefix for %s."
3987
% cur_transport.base)
3989
new_transport.mkdir('.')
3990
except errors.NoSuchFile:
3991
needed.append(new_transport)
3992
cur_transport = new_transport
3995
# Now we only need to create child directories
3997
cur_transport = needed.pop()
3998
cur_transport.ensure_base()
4001
def _get_mergeable_helper(location):
4002
"""Get a merge directive or bundle if 'location' points to one.
4004
Try try to identify a bundle and returns its mergeable form. If it's not,
4005
we return the tried transport anyway so that it can reused to access the
4008
:param location: can point to a bundle or a branch.
4010
:return: mergeable, transport
4013
url = urlutils.normalize_url(location)
4014
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4015
location_transport = transport.get_transport(url)
4018
# There may be redirections but we ignore the intermediate
4019
# and final transports used
4020
read = bundle.read_mergeable_from_transport
4021
mergeable, t = read(location_transport, filename)
4022
except errors.NotABundle:
4023
# Continue on considering this url a Branch but adjust the
4024
# location_transport
4025
location_transport = location_transport.clone(filename)
4026
return mergeable, location_transport
4029
# these get imported and then picked up by the scan for cmd_*
4030
# TODO: Some more consistent way to split command definitions across files;
4031
# we do need to load at least some information about them to know of
4032
# aliases. ideally we would avoid loading the implementation until the
4033
# details were needed.
4034
from bzrlib.cmd_version_info import cmd_version_info
4035
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4036
from bzrlib.bundle.commands import (
4039
from bzrlib.sign_my_commits import cmd_sign_my_commits
4040
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4041
cmd_weave_plan_merge, cmd_weave_merge_text