1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
20
from StringIO import StringIO
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
43
revision as _mod_revision,
50
from bzrlib.branch import Branch
51
from bzrlib.conflicts import ConflictList
52
from bzrlib.revisionspec import RevisionSpec
53
from bzrlib.smtp_connection import SMTPConnection
54
from bzrlib.workingtree import WorkingTree
57
from bzrlib.commands import Command, display_command
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
62
def tree_files(file_list, default_branch=u'.'):
64
return internal_tree_files(file_list, default_branch)
65
except errors.FileInWrongBranch, e:
66
raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
(e.path, file_list[0]))
70
# XXX: Bad function name; should possibly also be a class method of
71
# WorkingTree rather than a function.
72
def internal_tree_files(file_list, default_branch=u'.'):
73
"""Convert command-line paths to a WorkingTree and relative paths.
75
This is typically used for command-line processors that take one or
76
more filenames, and infer the workingtree that contains them.
78
The filenames given are not required to exist.
80
:param file_list: Filenames to convert.
82
:param default_branch: Fallback tree path to use if file_list is empty or
85
:return: workingtree, [relative_paths]
87
if file_list is None or len(file_list) == 0:
88
return WorkingTree.open_containing(default_branch)[0], file_list
89
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
91
for filename in file_list:
93
new_list.append(tree.relpath(osutils.dereference_path(filename)))
94
except errors.PathNotChild:
95
raise errors.FileInWrongBranch(tree.branch, filename)
99
# TODO: Make sure no commands unconditionally use the working directory as a
100
# branch. If a filename argument is used, the first of them should be used to
101
# specify the branch. (Perhaps this can be factored out into some kind of
102
# Argument class, representing a file in a branch, where the first occurrence
105
class cmd_status(Command):
106
"""Display status summary.
108
This reports on versioned and unknown files, reporting them
109
grouped by state. Possible states are:
112
Versioned in the working copy but not in the previous revision.
115
Versioned in the previous revision but removed or deleted
119
Path of this file changed from the previous revision;
120
the text may also have changed. This includes files whose
121
parent directory was renamed.
124
Text has changed since the previous revision.
127
File kind has been changed (e.g. from file to directory).
130
Not versioned and not matching an ignore pattern.
132
To see ignored files use 'bzr ignored'. For details on the
133
changes to file texts, use 'bzr diff'.
135
Note that --short or -S gives status flags for each item, similar
136
to Subversion's status command. To get output similar to svn -q,
139
If no arguments are specified, the status of the entire working
140
directory is shown. Otherwise, only the status of the specified
141
files or directories is reported. If a directory is given, status
142
is reported for everything inside that directory.
144
If a revision argument is given, the status is calculated against
145
that revision, or between two revisions if two are provided.
148
# TODO: --no-recurse, --recurse options
150
takes_args = ['file*']
151
takes_options = ['show-ids', 'revision', 'change',
152
Option('short', help='Use short status indicators.',
154
Option('versioned', help='Only show versioned files.',
156
Option('no-pending', help='Don\'t show pending merges.',
159
aliases = ['st', 'stat']
161
encoding_type = 'replace'
162
_see_also = ['diff', 'revert', 'status-flags']
165
def run(self, show_ids=False, file_list=None, revision=None, short=False,
166
versioned=False, no_pending=False):
167
from bzrlib.status import show_tree_status
169
if revision and len(revision) > 2:
170
raise errors.BzrCommandError('bzr status --revision takes exactly'
171
' one or two revision specifiers')
173
tree, file_list = tree_files(file_list)
175
show_tree_status(tree, show_ids=show_ids,
176
specific_files=file_list, revision=revision,
177
to_file=self.outf, short=short, versioned=versioned,
178
show_pending=not no_pending)
181
class cmd_cat_revision(Command):
182
"""Write out metadata for a revision.
184
The revision to print can either be specified by a specific
185
revision identifier, or you can use --revision.
189
takes_args = ['revision_id?']
190
takes_options = ['revision']
191
# cat-revision is more for frontends so should be exact
195
def run(self, revision_id=None, revision=None):
196
if revision_id is not None and revision is not None:
197
raise errors.BzrCommandError('You can only supply one of'
198
' revision_id or --revision')
199
if revision_id is None and revision is None:
200
raise errors.BzrCommandError('You must supply either'
201
' --revision or a revision_id')
202
b = WorkingTree.open_containing(u'.')[0].branch
204
# TODO: jam 20060112 should cat-revision always output utf-8?
205
if revision_id is not None:
206
revision_id = osutils.safe_revision_id(revision_id, warn=False)
207
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
208
elif revision is not None:
211
raise errors.BzrCommandError('You cannot specify a NULL'
213
rev_id = rev.as_revision_id(b)
214
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
217
class cmd_remove_tree(Command):
218
"""Remove the working tree from a given branch/checkout.
220
Since a lightweight checkout is little more than a working tree
221
this will refuse to run against one.
223
To re-create the working tree, use "bzr checkout".
225
_see_also = ['checkout', 'working-trees']
227
takes_args = ['location?']
229
def run(self, location='.'):
230
d = bzrdir.BzrDir.open(location)
233
working = d.open_workingtree()
234
except errors.NoWorkingTree:
235
raise errors.BzrCommandError("No working tree to remove")
236
except errors.NotLocalUrl:
237
raise errors.BzrCommandError("You cannot remove the working tree of a "
240
working_path = working.bzrdir.root_transport.base
241
branch_path = working.branch.bzrdir.root_transport.base
242
if working_path != branch_path:
243
raise errors.BzrCommandError("You cannot remove the working tree from "
244
"a lightweight checkout")
246
d.destroy_workingtree()
249
class cmd_revno(Command):
250
"""Show current revision number.
252
This is equal to the number of revisions on this branch.
256
takes_args = ['location?']
259
def run(self, location=u'.'):
260
self.outf.write(str(Branch.open_containing(location)[0].revno()))
261
self.outf.write('\n')
264
class cmd_revision_info(Command):
265
"""Show revision number and revision id for a given revision identifier.
268
takes_args = ['revision_info*']
269
takes_options = ['revision']
272
def run(self, revision=None, revision_info_list=[]):
275
if revision is not None:
276
revs.extend(revision)
277
if revision_info_list is not None:
278
for rev in revision_info_list:
279
revs.append(RevisionSpec.from_string(rev))
281
b = Branch.open_containing(u'.')[0]
284
revs.append(RevisionSpec.from_string('-1'))
287
revision_id = rev.as_revision_id(b)
289
revno = '%4d' % (b.revision_id_to_revno(revision_id))
290
except errors.NoSuchRevision:
291
dotted_map = b.get_revision_id_to_revno_map()
292
revno = '.'.join(str(i) for i in dotted_map[revision_id])
293
print '%s %s' % (revno, revision_id)
296
class cmd_add(Command):
297
"""Add specified files or directories.
299
In non-recursive mode, all the named items are added, regardless
300
of whether they were previously ignored. A warning is given if
301
any of the named files are already versioned.
303
In recursive mode (the default), files are treated the same way
304
but the behaviour for directories is different. Directories that
305
are already versioned do not give a warning. All directories,
306
whether already versioned or not, are searched for files or
307
subdirectories that are neither versioned or ignored, and these
308
are added. This search proceeds recursively into versioned
309
directories. If no names are given '.' is assumed.
311
Therefore simply saying 'bzr add' will version all files that
312
are currently unknown.
314
Adding a file whose parent directory is not versioned will
315
implicitly add the parent, and so on up to the root. This means
316
you should never need to explicitly add a directory, they'll just
317
get added when you add a file in the directory.
319
--dry-run will show which files would be added, but not actually
322
--file-ids-from will try to use the file ids from the supplied path.
323
It looks up ids trying to find a matching parent directory with the
324
same filename, and then by pure path. This option is rarely needed
325
but can be useful when adding the same logical file into two
326
branches that will be merged later (without showing the two different
327
adds as a conflict). It is also useful when merging another project
328
into a subdirectory of this one.
330
takes_args = ['file*']
333
help="Don't recursively add the contents of directories."),
335
help="Show what would be done, but don't actually do anything."),
337
Option('file-ids-from',
339
help='Lookup file ids from this tree.'),
341
encoding_type = 'replace'
342
_see_also = ['remove']
344
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
349
if file_ids_from is not None:
351
base_tree, base_path = WorkingTree.open_containing(
353
except errors.NoWorkingTree:
354
base_branch, base_path = Branch.open_containing(
356
base_tree = base_branch.basis_tree()
358
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
359
to_file=self.outf, should_print=(not is_quiet()))
361
action = bzrlib.add.AddAction(to_file=self.outf,
362
should_print=(not is_quiet()))
365
base_tree.lock_read()
367
file_list = self._maybe_expand_globs(file_list)
369
tree = WorkingTree.open_containing(file_list[0])[0]
371
tree = WorkingTree.open_containing(u'.')[0]
372
added, ignored = tree.smart_add(file_list, not
373
no_recurse, action=action, save=not dry_run)
375
if base_tree is not None:
379
for glob in sorted(ignored.keys()):
380
for path in ignored[glob]:
381
self.outf.write("ignored %s matching \"%s\"\n"
385
for glob, paths in ignored.items():
386
match_len += len(paths)
387
self.outf.write("ignored %d file(s).\n" % match_len)
388
self.outf.write("If you wish to add some of these files,"
389
" please add them by name.\n")
392
class cmd_mkdir(Command):
393
"""Create a new versioned directory.
395
This is equivalent to creating the directory and then adding it.
398
takes_args = ['dir+']
399
encoding_type = 'replace'
401
def run(self, dir_list):
404
wt, dd = WorkingTree.open_containing(d)
406
self.outf.write('added %s\n' % d)
409
class cmd_relpath(Command):
410
"""Show path of a file relative to root"""
412
takes_args = ['filename']
416
def run(self, filename):
417
# TODO: jam 20050106 Can relpath return a munged path if
418
# sys.stdout encoding cannot represent it?
419
tree, relpath = WorkingTree.open_containing(filename)
420
self.outf.write(relpath)
421
self.outf.write('\n')
424
class cmd_inventory(Command):
425
"""Show inventory of the current working copy or a revision.
427
It is possible to limit the output to a particular entry
428
type using the --kind option. For example: --kind file.
430
It is also possible to restrict the list of files to a specific
431
set. For example: bzr inventory --show-ids this/file
440
help='List entries of a particular kind: file, directory, symlink.',
443
takes_args = ['file*']
446
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
447
if kind and kind not in ['file', 'directory', 'symlink']:
448
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
450
work_tree, file_list = tree_files(file_list)
451
work_tree.lock_read()
453
if revision is not None:
454
if len(revision) > 1:
455
raise errors.BzrCommandError(
456
'bzr inventory --revision takes exactly one revision'
458
revision_id = revision[0].as_revision_id(work_tree.branch)
459
tree = work_tree.branch.repository.revision_tree(revision_id)
461
extra_trees = [work_tree]
467
if file_list is not None:
468
file_ids = tree.paths2ids(file_list, trees=extra_trees,
469
require_versioned=True)
470
# find_ids_across_trees may include some paths that don't
472
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
473
for file_id in file_ids if file_id in tree)
475
entries = tree.inventory.entries()
478
if tree is not work_tree:
481
for path, entry in entries:
482
if kind and kind != entry.kind:
485
self.outf.write('%-50s %s\n' % (path, entry.file_id))
487
self.outf.write(path)
488
self.outf.write('\n')
491
class cmd_mv(Command):
492
"""Move or rename a file.
495
bzr mv OLDNAME NEWNAME
497
bzr mv SOURCE... DESTINATION
499
If the last argument is a versioned directory, all the other names
500
are moved into it. Otherwise, there must be exactly two arguments
501
and the file is changed to a new name.
503
If OLDNAME does not exist on the filesystem but is versioned and
504
NEWNAME does exist on the filesystem but is not versioned, mv
505
assumes that the file has been manually moved and only updates
506
its internal inventory to reflect that change.
507
The same is valid when moving many SOURCE files to a DESTINATION.
509
Files cannot be moved between branches.
512
takes_args = ['names*']
513
takes_options = [Option("after", help="Move only the bzr identifier"
514
" of the file, because the file has already been moved."),
516
aliases = ['move', 'rename']
517
encoding_type = 'replace'
519
def run(self, names_list, after=False):
520
if names_list is None:
523
if len(names_list) < 2:
524
raise errors.BzrCommandError("missing file argument")
525
tree, rel_names = tree_files(names_list)
528
self._run(tree, names_list, rel_names, after)
532
def _run(self, tree, names_list, rel_names, after):
533
into_existing = osutils.isdir(names_list[-1])
534
if into_existing and len(names_list) == 2:
536
# a. case-insensitive filesystem and change case of dir
537
# b. move directory after the fact (if the source used to be
538
# a directory, but now doesn't exist in the working tree
539
# and the target is an existing directory, just rename it)
540
if (not tree.case_sensitive
541
and rel_names[0].lower() == rel_names[1].lower()):
542
into_existing = False
545
from_id = tree.path2id(rel_names[0])
546
if (not osutils.lexists(names_list[0]) and
547
from_id and inv.get_file_kind(from_id) == "directory"):
548
into_existing = False
551
# move into existing directory
552
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
553
self.outf.write("%s => %s\n" % pair)
555
if len(names_list) != 2:
556
raise errors.BzrCommandError('to mv multiple files the'
557
' destination must be a versioned'
559
tree.rename_one(rel_names[0], rel_names[1], after=after)
560
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
563
class cmd_pull(Command):
564
"""Turn this branch into a mirror of another branch.
566
This command only works on branches that have not diverged. Branches are
567
considered diverged if the destination branch's most recent commit is one
568
that has not been merged (directly or indirectly) into the parent.
570
If branches have diverged, you can use 'bzr merge' to integrate the changes
571
from one into the other. Once one branch has merged, the other should
572
be able to pull it again.
574
If you want to forget your local changes and just update your branch to
575
match the remote one, use pull --overwrite.
577
If there is no default location set, the first pull will set it. After
578
that, you can omit the location to use the default. To change the
579
default, use --remember. The value will only be saved if the remote
580
location can be accessed.
582
Note: The location can be specified either in the form of a branch,
583
or in the form of a path to a file containing a merge directive generated
587
_see_also = ['push', 'update', 'status-flags']
588
takes_options = ['remember', 'overwrite', 'revision',
589
custom_help('verbose',
590
help='Show logs of pulled revisions.'),
592
help='Branch to pull into, '
593
'rather than the one containing the working directory.',
598
takes_args = ['location?']
599
encoding_type = 'replace'
601
def run(self, location=None, remember=False, overwrite=False,
602
revision=None, verbose=False,
604
# FIXME: too much stuff is in the command class
607
if directory is None:
610
tree_to = WorkingTree.open_containing(directory)[0]
611
branch_to = tree_to.branch
612
except errors.NoWorkingTree:
614
branch_to = Branch.open_containing(directory)[0]
616
possible_transports = []
617
if location is not None:
619
mergeable = bundle.read_mergeable_from_url(location,
620
possible_transports=possible_transports)
621
except errors.NotABundle:
624
stored_loc = branch_to.get_parent()
626
if stored_loc is None:
627
raise errors.BzrCommandError("No pull location known or"
630
display_url = urlutils.unescape_for_display(stored_loc,
633
self.outf.write("Using saved location: %s\n" % display_url)
634
location = stored_loc
636
if mergeable is not None:
637
if revision is not None:
638
raise errors.BzrCommandError(
639
'Cannot use -r with merge directives or bundles')
640
mergeable.install_revisions(branch_to.repository)
641
base_revision_id, revision_id, verified = \
642
mergeable.get_merge_request(branch_to.repository)
643
branch_from = branch_to
645
branch_from = Branch.open(location,
646
possible_transports=possible_transports)
648
if branch_to.get_parent() is None or remember:
649
branch_to.set_parent(branch_from.base)
651
if revision is not None:
652
if len(revision) == 1:
653
revision_id = revision[0].as_revision_id(branch_from)
655
raise errors.BzrCommandError(
656
'bzr pull --revision takes one value.')
658
branch_to.lock_write()
660
if tree_to is not None:
661
change_reporter = delta._ChangeReporter(
662
unversioned_filter=tree_to.is_ignored)
663
result = tree_to.pull(branch_from, overwrite, revision_id,
665
possible_transports=possible_transports)
667
result = branch_to.pull(branch_from, overwrite, revision_id)
669
result.report(self.outf)
670
if verbose and result.old_revid != result.new_revid:
672
branch_to.repository.iter_reverse_revision_history(
675
new_rh = branch_to.revision_history()
676
log.show_changed_revisions(branch_to, old_rh, new_rh,
682
class cmd_push(Command):
683
"""Update a mirror of this branch.
685
The target branch will not have its working tree populated because this
686
is both expensive, and is not supported on remote file systems.
688
Some smart servers or protocols *may* put the working tree in place in
691
This command only works on branches that have not diverged. Branches are
692
considered diverged if the destination branch's most recent commit is one
693
that has not been merged (directly or indirectly) by the source branch.
695
If branches have diverged, you can use 'bzr push --overwrite' to replace
696
the other branch completely, discarding its unmerged changes.
698
If you want to ensure you have the different changes in the other branch,
699
do a merge (see bzr help merge) from the other branch, and commit that.
700
After that you will be able to do a push without '--overwrite'.
702
If there is no default push location set, the first push will set it.
703
After that, you can omit the location to use the default. To change the
704
default, use --remember. The value will only be saved if the remote
705
location can be accessed.
708
_see_also = ['pull', 'update', 'working-trees']
709
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
710
Option('create-prefix',
711
help='Create the path leading up to the branch '
712
'if it does not already exist.'),
714
help='Branch to push from, '
715
'rather than the one containing the working directory.',
719
Option('use-existing-dir',
720
help='By default push will fail if the target'
721
' directory exists, but does not already'
722
' have a control directory. This flag will'
723
' allow push to proceed.'),
725
takes_args = ['location?']
726
encoding_type = 'replace'
728
def run(self, location=None, remember=False, overwrite=False,
729
create_prefix=False, verbose=False, revision=None,
730
use_existing_dir=False,
732
# FIXME: Way too big! Put this into a function called from the
734
if directory is None:
736
br_from = Branch.open_containing(directory)[0]
737
stored_loc = br_from.get_push_location()
739
if stored_loc is None:
740
raise errors.BzrCommandError("No push location known or specified.")
742
display_url = urlutils.unescape_for_display(stored_loc,
744
self.outf.write("Using saved location: %s\n" % display_url)
745
location = stored_loc
747
to_transport = transport.get_transport(location)
749
br_to = repository_to = dir_to = None
751
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
752
except errors.NotBranchError:
753
pass # Didn't find anything
755
# If we can open a branch, use its direct repository, otherwise see
756
# if there is a repository without a branch.
758
br_to = dir_to.open_branch()
759
except errors.NotBranchError:
760
# Didn't find a branch, can we find a repository?
762
repository_to = dir_to.find_repository()
763
except errors.NoRepositoryPresent:
766
# Found a branch, so we must have found a repository
767
repository_to = br_to.repository
769
if revision is not None:
770
if len(revision) == 1:
771
revision_id = revision[0].in_history(br_from).rev_id
773
raise errors.BzrCommandError(
774
'bzr push --revision takes one value.')
776
revision_id = br_from.last_revision()
782
# The destination doesn't exist; create it.
783
# XXX: Refactor the create_prefix/no_create_prefix code into a
784
# common helper function
786
def make_directory(transport):
790
def redirected(redirected_transport, e, redirection_notice):
791
return transport.get_transport(e.get_target_url())
794
to_transport = transport.do_catching_redirections(
795
make_directory, to_transport, redirected)
796
except errors.FileExists:
797
if not use_existing_dir:
798
raise errors.BzrCommandError("Target directory %s"
799
" already exists, but does not have a valid .bzr"
800
" directory. Supply --use-existing-dir to push"
801
" there anyway." % location)
802
except errors.NoSuchFile:
803
if not create_prefix:
804
raise errors.BzrCommandError("Parent directory of %s"
806
"\nYou may supply --create-prefix to create all"
807
" leading parent directories."
809
_create_prefix(to_transport)
810
except errors.TooManyRedirections:
811
raise errors.BzrCommandError("Too many redirections trying "
812
"to make %s." % location)
814
# Now the target directory exists, but doesn't have a .bzr
815
# directory. So we need to create it, along with any work to create
816
# all of the dependent branches, etc.
817
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
818
revision_id=revision_id)
819
br_to = dir_to.open_branch()
820
# TODO: Some more useful message about what was copied
821
note('Created new branch.')
822
# We successfully created the target, remember it
823
if br_from.get_push_location() is None or remember:
824
br_from.set_push_location(br_to.base)
825
elif repository_to is None:
826
# we have a bzrdir but no branch or repository
827
# XXX: Figure out what to do other than complain.
828
raise errors.BzrCommandError("At %s you have a valid .bzr control"
829
" directory, but not a branch or repository. This is an"
830
" unsupported configuration. Please move the target directory"
831
" out of the way and try again."
834
# We have a repository but no branch, copy the revisions, and then
836
repository_to.fetch(br_from.repository, revision_id=revision_id)
837
br_to = br_from.clone(dir_to, revision_id=revision_id)
838
note('Created new branch.')
839
if br_from.get_push_location() is None or remember:
840
br_from.set_push_location(br_to.base)
841
else: # We have a valid to branch
842
# We were able to connect to the remote location, so remember it
843
# we don't need to successfully push because of possible divergence.
844
if br_from.get_push_location() is None or remember:
845
br_from.set_push_location(br_to.base)
847
old_rh = br_to.revision_history()
850
tree_to = dir_to.open_workingtree()
851
except errors.NotLocalUrl:
852
warning("This transport does not update the working "
853
"tree of: %s. See 'bzr help working-trees' for "
854
"more information." % br_to.base)
855
push_result = br_from.push(br_to, overwrite,
856
stop_revision=revision_id)
857
except errors.NoWorkingTree:
858
push_result = br_from.push(br_to, overwrite,
859
stop_revision=revision_id)
863
push_result = br_from.push(tree_to.branch, overwrite,
864
stop_revision=revision_id)
868
except errors.DivergedBranches:
869
raise errors.BzrCommandError('These branches have diverged.'
870
' Try using "merge" and then "push".')
871
if push_result is not None:
872
push_result.report(self.outf)
874
new_rh = br_to.revision_history()
877
from bzrlib.log import show_changed_revisions
878
show_changed_revisions(br_to, old_rh, new_rh,
881
# we probably did a clone rather than a push, so a message was
886
class cmd_branch(Command):
887
"""Create a new copy of a branch.
889
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
890
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
891
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
892
is derived from the FROM_LOCATION by stripping a leading scheme or drive
893
identifier, if any. For example, "branch lp:foo-bar" will attempt to
896
To retrieve the branch as of a particular revision, supply the --revision
897
parameter, as in "branch foo/bar -r 5".
900
_see_also = ['checkout']
901
takes_args = ['from_location', 'to_location?']
902
takes_options = ['revision', Option('hardlink',
903
help='Hard-link working tree files where possible.')]
904
aliases = ['get', 'clone']
906
def run(self, from_location, to_location=None, revision=None,
908
from bzrlib.tag import _merge_tags_if_possible
911
elif len(revision) > 1:
912
raise errors.BzrCommandError(
913
'bzr branch --revision takes exactly 1 revision value')
915
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
919
if len(revision) == 1 and revision[0] is not None:
920
revision_id = revision[0].as_revision_id(br_from)
922
# FIXME - wt.last_revision, fallback to branch, fall back to
923
# None or perhaps NULL_REVISION to mean copy nothing
925
revision_id = br_from.last_revision()
926
if to_location is None:
927
to_location = urlutils.derive_to_location(from_location)
928
to_transport = transport.get_transport(to_location)
930
to_transport.mkdir('.')
931
except errors.FileExists:
932
raise errors.BzrCommandError('Target directory "%s" already'
933
' exists.' % to_location)
934
except errors.NoSuchFile:
935
raise errors.BzrCommandError('Parent of "%s" does not exist.'
938
# preserve whatever source format we have.
939
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
940
possible_transports=[to_transport],
941
accelerator_tree=accelerator_tree,
943
branch = dir.open_branch()
944
except errors.NoSuchRevision:
945
to_transport.delete_tree('.')
946
msg = "The branch %s has no revision %s." % (from_location, revision[0])
947
raise errors.BzrCommandError(msg)
948
_merge_tags_if_possible(br_from, branch)
949
note('Branched %d revision(s).' % branch.revno())
954
class cmd_checkout(Command):
955
"""Create a new checkout of an existing branch.
957
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
958
the branch found in '.'. This is useful if you have removed the working tree
959
or if it was never created - i.e. if you pushed the branch to its current
962
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
963
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
964
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
965
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
966
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
969
To retrieve the branch as of a particular revision, supply the --revision
970
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
971
out of date [so you cannot commit] but it may be useful (i.e. to examine old
975
_see_also = ['checkouts', 'branch']
976
takes_args = ['branch_location?', 'to_location?']
977
takes_options = ['revision',
978
Option('lightweight',
979
help="Perform a lightweight checkout. Lightweight "
980
"checkouts depend on access to the branch for "
981
"every operation. Normal checkouts can perform "
982
"common operations like diff and status without "
983
"such access, and also support local commits."
985
Option('files-from', type=str,
986
help="Get file contents from this tree."),
988
help='Hard-link working tree files where possible.'
993
def run(self, branch_location=None, to_location=None, revision=None,
994
lightweight=False, files_from=None, hardlink=False):
997
elif len(revision) > 1:
998
raise errors.BzrCommandError(
999
'bzr checkout --revision takes exactly 1 revision value')
1000
if branch_location is None:
1001
branch_location = osutils.getcwd()
1002
to_location = branch_location
1003
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1005
if files_from is not None:
1006
accelerator_tree = WorkingTree.open(files_from)
1007
if len(revision) == 1 and revision[0] is not None:
1008
revision_id = revision[0].as_revision_id(source)
1011
if to_location is None:
1012
to_location = urlutils.derive_to_location(branch_location)
1013
# if the source and to_location are the same,
1014
# and there is no working tree,
1015
# then reconstitute a branch
1016
if (osutils.abspath(to_location) ==
1017
osutils.abspath(branch_location)):
1019
source.bzrdir.open_workingtree()
1020
except errors.NoWorkingTree:
1021
source.bzrdir.create_workingtree(revision_id)
1023
source.create_checkout(to_location, revision_id, lightweight,
1024
accelerator_tree, hardlink)
1027
class cmd_renames(Command):
1028
"""Show list of renamed files.
1030
# TODO: Option to show renames between two historical versions.
1032
# TODO: Only show renames under dir, rather than in the whole branch.
1033
_see_also = ['status']
1034
takes_args = ['dir?']
1037
def run(self, dir=u'.'):
1038
tree = WorkingTree.open_containing(dir)[0]
1041
new_inv = tree.inventory
1042
old_tree = tree.basis_tree()
1043
old_tree.lock_read()
1045
old_inv = old_tree.inventory
1046
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1048
for old_name, new_name in renames:
1049
self.outf.write("%s => %s\n" % (old_name, new_name))
1056
class cmd_update(Command):
1057
"""Update a tree to have the latest code committed to its branch.
1059
This will perform a merge into the working tree, and may generate
1060
conflicts. If you have any local changes, you will still
1061
need to commit them after the update for the update to be complete.
1063
If you want to discard your local changes, you can just do a
1064
'bzr revert' instead of 'bzr commit' after the update.
1067
_see_also = ['pull', 'working-trees', 'status-flags']
1068
takes_args = ['dir?']
1071
def run(self, dir='.'):
1072
tree = WorkingTree.open_containing(dir)[0]
1073
possible_transports = []
1074
master = tree.branch.get_master_branch(
1075
possible_transports=possible_transports)
1076
if master is not None:
1079
tree.lock_tree_write()
1081
existing_pending_merges = tree.get_parent_ids()[1:]
1082
last_rev = _mod_revision.ensure_null(tree.last_revision())
1083
if last_rev == _mod_revision.ensure_null(
1084
tree.branch.last_revision()):
1085
# may be up to date, check master too.
1086
if master is None or last_rev == _mod_revision.ensure_null(
1087
master.last_revision()):
1088
revno = tree.branch.revision_id_to_revno(last_rev)
1089
note("Tree is up to date at revision %d." % (revno,))
1091
conflicts = tree.update(
1092
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1093
possible_transports=possible_transports)
1094
revno = tree.branch.revision_id_to_revno(
1095
_mod_revision.ensure_null(tree.last_revision()))
1096
note('Updated to revision %d.' % (revno,))
1097
if tree.get_parent_ids()[1:] != existing_pending_merges:
1098
note('Your local commits will now show as pending merges with '
1099
"'bzr status', and can be committed with 'bzr commit'.")
1108
class cmd_info(Command):
1109
"""Show information about a working tree, branch or repository.
1111
This command will show all known locations and formats associated to the
1112
tree, branch or repository. Statistical information is included with
1115
Branches and working trees will also report any missing revisions.
1117
_see_also = ['revno', 'working-trees', 'repositories']
1118
takes_args = ['location?']
1119
takes_options = ['verbose']
1120
encoding_type = 'replace'
1123
def run(self, location=None, verbose=False):
1128
from bzrlib.info import show_bzrdir_info
1129
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1130
verbose=noise_level, outfile=self.outf)
1133
class cmd_remove(Command):
1134
"""Remove files or directories.
1136
This makes bzr stop tracking changes to the specified files and
1137
delete them if they can easily be recovered using revert.
1139
You can specify one or more files, and/or --new. If you specify --new,
1140
only 'added' files will be removed. If you specify both, then new files
1141
in the specified directories will be removed. If the directories are
1142
also new, they will also be removed.
1144
takes_args = ['file*']
1145
takes_options = ['verbose',
1146
Option('new', help='Remove newly-added files.'),
1147
RegistryOption.from_kwargs('file-deletion-strategy',
1148
'The file deletion mode to be used.',
1149
title='Deletion Strategy', value_switches=True, enum_switch=False,
1150
safe='Only delete files if they can be'
1151
' safely recovered (default).',
1152
keep="Don't delete any files.",
1153
force='Delete all the specified files, even if they can not be '
1154
'recovered and even if they are non-empty directories.')]
1156
encoding_type = 'replace'
1158
def run(self, file_list, verbose=False, new=False,
1159
file_deletion_strategy='safe'):
1160
tree, file_list = tree_files(file_list)
1162
if file_list is not None:
1163
file_list = [f for f in file_list]
1165
raise errors.BzrCommandError('Specify one or more files to'
1166
' remove, or use --new.')
1169
added = tree.changes_from(tree.basis_tree(),
1170
specific_files=file_list).added
1171
file_list = sorted([f[0] for f in added], reverse=True)
1172
if len(file_list) == 0:
1173
raise errors.BzrCommandError('No matching files.')
1174
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1175
keep_files=file_deletion_strategy=='keep',
1176
force=file_deletion_strategy=='force')
1179
class cmd_file_id(Command):
1180
"""Print file_id of a particular file or directory.
1182
The file_id is assigned when the file is first added and remains the
1183
same through all revisions where the file exists, even when it is
1188
_see_also = ['inventory', 'ls']
1189
takes_args = ['filename']
1192
def run(self, filename):
1193
tree, relpath = WorkingTree.open_containing(filename)
1194
i = tree.path2id(relpath)
1196
raise errors.NotVersionedError(filename)
1198
self.outf.write(i + '\n')
1201
class cmd_file_path(Command):
1202
"""Print path of file_ids to a file or directory.
1204
This prints one line for each directory down to the target,
1205
starting at the branch root.
1209
takes_args = ['filename']
1212
def run(self, filename):
1213
tree, relpath = WorkingTree.open_containing(filename)
1214
fid = tree.path2id(relpath)
1216
raise errors.NotVersionedError(filename)
1217
segments = osutils.splitpath(relpath)
1218
for pos in range(1, len(segments) + 1):
1219
path = osutils.joinpath(segments[:pos])
1220
self.outf.write("%s\n" % tree.path2id(path))
1223
class cmd_reconcile(Command):
1224
"""Reconcile bzr metadata in a branch.
1226
This can correct data mismatches that may have been caused by
1227
previous ghost operations or bzr upgrades. You should only
1228
need to run this command if 'bzr check' or a bzr developer
1229
advises you to run it.
1231
If a second branch is provided, cross-branch reconciliation is
1232
also attempted, which will check that data like the tree root
1233
id which was not present in very early bzr versions is represented
1234
correctly in both branches.
1236
At the same time it is run it may recompress data resulting in
1237
a potential saving in disk space or performance gain.
1239
The branch *MUST* be on a listable system such as local disk or sftp.
1242
_see_also = ['check']
1243
takes_args = ['branch?']
1245
def run(self, branch="."):
1246
from bzrlib.reconcile import reconcile
1247
dir = bzrdir.BzrDir.open(branch)
1251
class cmd_revision_history(Command):
1252
"""Display the list of revision ids on a branch."""
1255
takes_args = ['location?']
1260
def run(self, location="."):
1261
branch = Branch.open_containing(location)[0]
1262
for revid in branch.revision_history():
1263
self.outf.write(revid)
1264
self.outf.write('\n')
1267
class cmd_ancestry(Command):
1268
"""List all revisions merged into this branch."""
1270
_see_also = ['log', 'revision-history']
1271
takes_args = ['location?']
1276
def run(self, location="."):
1278
wt = WorkingTree.open_containing(location)[0]
1279
except errors.NoWorkingTree:
1280
b = Branch.open(location)
1281
last_revision = b.last_revision()
1284
last_revision = wt.last_revision()
1286
revision_ids = b.repository.get_ancestry(last_revision)
1288
for revision_id in revision_ids:
1289
self.outf.write(revision_id + '\n')
1292
class cmd_init(Command):
1293
"""Make a directory into a versioned branch.
1295
Use this to create an empty branch, or before importing an
1298
If there is a repository in a parent directory of the location, then
1299
the history of the branch will be stored in the repository. Otherwise
1300
init creates a standalone branch which carries its own history
1301
in the .bzr directory.
1303
If there is already a branch at the location but it has no working tree,
1304
the tree can be populated with 'bzr checkout'.
1306
Recipe for importing a tree of files::
1312
bzr commit -m "imported project"
1315
_see_also = ['init-repository', 'branch', 'checkout']
1316
takes_args = ['location?']
1318
Option('create-prefix',
1319
help='Create the path leading up to the branch '
1320
'if it does not already exist.'),
1321
RegistryOption('format',
1322
help='Specify a format for this branch. '
1323
'See "help formats".',
1324
registry=bzrdir.format_registry,
1325
converter=bzrdir.format_registry.make_bzrdir,
1326
value_switches=True,
1327
title="Branch Format",
1329
Option('append-revisions-only',
1330
help='Never change revnos or the existing log.'
1331
' Append revisions to it only.')
1333
def run(self, location=None, format=None, append_revisions_only=False,
1334
create_prefix=False):
1336
format = bzrdir.format_registry.make_bzrdir('default')
1337
if location is None:
1340
to_transport = transport.get_transport(location)
1342
# The path has to exist to initialize a
1343
# branch inside of it.
1344
# Just using os.mkdir, since I don't
1345
# believe that we want to create a bunch of
1346
# locations if the user supplies an extended path
1348
to_transport.ensure_base()
1349
except errors.NoSuchFile:
1350
if not create_prefix:
1351
raise errors.BzrCommandError("Parent directory of %s"
1353
"\nYou may supply --create-prefix to create all"
1354
" leading parent directories."
1356
_create_prefix(to_transport)
1359
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1360
except errors.NotBranchError:
1361
# really a NotBzrDir error...
1362
create_branch = bzrdir.BzrDir.create_branch_convenience
1363
branch = create_branch(to_transport.base, format=format,
1364
possible_transports=[to_transport])
1366
from bzrlib.transport.local import LocalTransport
1367
if existing_bzrdir.has_branch():
1368
if (isinstance(to_transport, LocalTransport)
1369
and not existing_bzrdir.has_workingtree()):
1370
raise errors.BranchExistsWithoutWorkingTree(location)
1371
raise errors.AlreadyBranchError(location)
1373
branch = existing_bzrdir.create_branch()
1374
existing_bzrdir.create_workingtree()
1375
if append_revisions_only:
1377
branch.set_append_revisions_only(True)
1378
except errors.UpgradeRequired:
1379
raise errors.BzrCommandError('This branch format cannot be set'
1380
' to append-revisions-only. Try --experimental-branch6')
1383
class cmd_init_repository(Command):
1384
"""Create a shared repository to hold branches.
1386
New branches created under the repository directory will store their
1387
revisions in the repository, not in the branch directory.
1389
If the --no-trees option is used then the branches in the repository
1390
will not have working trees by default.
1393
Create a shared repositories holding just branches::
1395
bzr init-repo --no-trees repo
1398
Make a lightweight checkout elsewhere::
1400
bzr checkout --lightweight repo/trunk trunk-checkout
1405
_see_also = ['init', 'branch', 'checkout', 'repositories']
1406
takes_args = ["location"]
1407
takes_options = [RegistryOption('format',
1408
help='Specify a format for this repository. See'
1409
' "bzr help formats" for details.',
1410
registry=bzrdir.format_registry,
1411
converter=bzrdir.format_registry.make_bzrdir,
1412
value_switches=True, title='Repository format'),
1414
help='Branches in the repository will default to'
1415
' not having a working tree.'),
1417
aliases = ["init-repo"]
1419
def run(self, location, format=None, no_trees=False):
1421
format = bzrdir.format_registry.make_bzrdir('default')
1423
if location is None:
1426
to_transport = transport.get_transport(location)
1427
to_transport.ensure_base()
1429
newdir = format.initialize_on_transport(to_transport)
1430
repo = newdir.create_repository(shared=True)
1431
repo.set_make_working_trees(not no_trees)
1434
class cmd_diff(Command):
1435
"""Show differences in the working tree, between revisions or branches.
1437
If no arguments are given, all changes for the current tree are listed.
1438
If files are given, only the changes in those files are listed.
1439
Remote and multiple branches can be compared by using the --old and
1440
--new options. If not provided, the default for both is derived from
1441
the first argument, if any, or the current tree if no arguments are
1444
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1445
produces patches suitable for "patch -p1".
1449
2 - unrepresentable changes
1454
Shows the difference in the working tree versus the last commit::
1458
Difference between the working tree and revision 1::
1462
Difference between revision 2 and revision 1::
1466
Difference between revision 2 and revision 1 for branch xxx::
1470
Show just the differences for file NEWS::
1474
Show the differences in working tree xxx for file NEWS::
1478
Show the differences from branch xxx to this working tree:
1482
Show the differences between two branches for file NEWS::
1484
bzr diff --old xxx --new yyy NEWS
1486
Same as 'bzr diff' but prefix paths with old/ and new/::
1488
bzr diff --prefix old/:new/
1490
_see_also = ['status']
1491
takes_args = ['file*']
1493
Option('diff-options', type=str,
1494
help='Pass these options to the external diff program.'),
1495
Option('prefix', type=str,
1497
help='Set prefixes added to old and new filenames, as '
1498
'two values separated by a colon. (eg "old/:new/").'),
1500
help='Branch/tree to compare from.',
1504
help='Branch/tree to compare to.',
1510
help='Use this command to compare files.',
1514
aliases = ['di', 'dif']
1515
encoding_type = 'exact'
1518
def run(self, revision=None, file_list=None, diff_options=None,
1519
prefix=None, old=None, new=None, using=None):
1520
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1522
if (prefix is None) or (prefix == '0'):
1530
old_label, new_label = prefix.split(":")
1532
raise errors.BzrCommandError(
1533
'--prefix expects two values separated by a colon'
1534
' (eg "old/:new/")')
1536
if revision and len(revision) > 2:
1537
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1538
' one or two revision specifiers')
1540
old_tree, new_tree, specific_files, extra_trees = \
1541
_get_trees_to_diff(file_list, revision, old, new)
1542
return show_diff_trees(old_tree, new_tree, sys.stdout,
1543
specific_files=specific_files,
1544
external_diff_options=diff_options,
1545
old_label=old_label, new_label=new_label,
1546
extra_trees=extra_trees, using=using)
1549
class cmd_deleted(Command):
1550
"""List files deleted in the working tree.
1552
# TODO: Show files deleted since a previous revision, or
1553
# between two revisions.
1554
# TODO: Much more efficient way to do this: read in new
1555
# directories with readdir, rather than stating each one. Same
1556
# level of effort but possibly much less IO. (Or possibly not,
1557
# if the directories are very large...)
1558
_see_also = ['status', 'ls']
1559
takes_options = ['show-ids']
1562
def run(self, show_ids=False):
1563
tree = WorkingTree.open_containing(u'.')[0]
1566
old = tree.basis_tree()
1569
for path, ie in old.inventory.iter_entries():
1570
if not tree.has_id(ie.file_id):
1571
self.outf.write(path)
1573
self.outf.write(' ')
1574
self.outf.write(ie.file_id)
1575
self.outf.write('\n')
1582
class cmd_modified(Command):
1583
"""List files modified in working tree.
1587
_see_also = ['status', 'ls']
1590
help='Write an ascii NUL (\\0) separator '
1591
'between files rather than a newline.')
1595
def run(self, null=False):
1596
tree = WorkingTree.open_containing(u'.')[0]
1597
td = tree.changes_from(tree.basis_tree())
1598
for path, id, kind, text_modified, meta_modified in td.modified:
1600
self.outf.write(path + '\0')
1602
self.outf.write(osutils.quotefn(path) + '\n')
1605
class cmd_added(Command):
1606
"""List files added in working tree.
1610
_see_also = ['status', 'ls']
1613
help='Write an ascii NUL (\\0) separator '
1614
'between files rather than a newline.')
1618
def run(self, null=False):
1619
wt = WorkingTree.open_containing(u'.')[0]
1622
basis = wt.basis_tree()
1625
basis_inv = basis.inventory
1628
if file_id in basis_inv:
1630
if inv.is_root(file_id) and len(basis_inv) == 0:
1632
path = inv.id2path(file_id)
1633
if not os.access(osutils.abspath(path), os.F_OK):
1636
self.outf.write(path + '\0')
1638
self.outf.write(osutils.quotefn(path) + '\n')
1645
class cmd_root(Command):
1646
"""Show the tree root directory.
1648
The root is the nearest enclosing directory with a .bzr control
1651
takes_args = ['filename?']
1653
def run(self, filename=None):
1654
"""Print the branch root."""
1655
tree = WorkingTree.open_containing(filename)[0]
1656
self.outf.write(tree.basedir + '\n')
1659
def _parse_limit(limitstring):
1661
return int(limitstring)
1663
msg = "The limit argument must be an integer."
1664
raise errors.BzrCommandError(msg)
1667
class cmd_log(Command):
1668
"""Show log of a branch, file, or directory.
1670
By default show the log of the branch containing the working directory.
1672
To request a range of logs, you can use the command -r begin..end
1673
-r revision requests a specific revision, -r ..end or -r begin.. are
1677
Log the current branch::
1685
Log the last 10 revisions of a branch::
1687
bzr log -r -10.. http://server/branch
1690
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1692
takes_args = ['location?']
1695
help='Show from oldest to newest.'),
1698
help='Display timezone as local, original, or utc.'),
1699
custom_help('verbose',
1700
help='Show files changed in each revision.'),
1706
help='Show revisions whose message matches this '
1707
'regular expression.',
1711
help='Limit the output to the first N revisions.',
1715
encoding_type = 'replace'
1718
def run(self, location=None, timezone='original',
1726
from bzrlib.log import show_log
1727
direction = (forward and 'forward') or 'reverse'
1732
# find the file id to log:
1734
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1738
tree = b.basis_tree()
1739
file_id = tree.path2id(fp)
1741
raise errors.BzrCommandError(
1742
"Path does not have any revision history: %s" %
1746
# FIXME ? log the current subdir only RBC 20060203
1747
if revision is not None \
1748
and len(revision) > 0 and revision[0].get_branch():
1749
location = revision[0].get_branch()
1752
dir, relpath = bzrdir.BzrDir.open_containing(location)
1753
b = dir.open_branch()
1757
if revision is None:
1760
elif len(revision) == 1:
1761
rev1 = rev2 = revision[0].in_history(b)
1762
elif len(revision) == 2:
1763
if revision[1].get_branch() != revision[0].get_branch():
1764
# b is taken from revision[0].get_branch(), and
1765
# show_log will use its revision_history. Having
1766
# different branches will lead to weird behaviors.
1767
raise errors.BzrCommandError(
1768
"Log doesn't accept two revisions in different"
1770
rev1 = revision[0].in_history(b)
1771
rev2 = revision[1].in_history(b)
1773
raise errors.BzrCommandError(
1774
'bzr log --revision takes one or two values.')
1776
if log_format is None:
1777
log_format = log.log_formatter_registry.get_default(b)
1779
lf = log_format(show_ids=show_ids, to_file=self.outf,
1780
show_timezone=timezone)
1786
direction=direction,
1787
start_revision=rev1,
1795
def get_log_format(long=False, short=False, line=False, default='long'):
1796
log_format = default
1800
log_format = 'short'
1806
class cmd_touching_revisions(Command):
1807
"""Return revision-ids which affected a particular file.
1809
A more user-friendly interface is "bzr log FILE".
1813
takes_args = ["filename"]
1816
def run(self, filename):
1817
tree, relpath = WorkingTree.open_containing(filename)
1819
file_id = tree.path2id(relpath)
1820
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1821
self.outf.write("%6d %s\n" % (revno, what))
1824
class cmd_ls(Command):
1825
"""List files in a tree.
1828
_see_also = ['status', 'cat']
1829
takes_args = ['path?']
1830
# TODO: Take a revision or remote path and list that tree instead.
1834
Option('non-recursive',
1835
help='Don\'t recurse into subdirectories.'),
1837
help='Print paths relative to the root of the branch.'),
1838
Option('unknown', help='Print unknown files.'),
1839
Option('versioned', help='Print versioned files.',
1841
Option('ignored', help='Print ignored files.'),
1843
help='Write an ascii NUL (\\0) separator '
1844
'between files rather than a newline.'),
1846
help='List entries of a particular kind: file, directory, symlink.',
1851
def run(self, revision=None, verbose=False,
1852
non_recursive=False, from_root=False,
1853
unknown=False, versioned=False, ignored=False,
1854
null=False, kind=None, show_ids=False, path=None):
1856
if kind and kind not in ('file', 'directory', 'symlink'):
1857
raise errors.BzrCommandError('invalid kind specified')
1859
if verbose and null:
1860
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1861
all = not (unknown or versioned or ignored)
1863
selection = {'I':ignored, '?':unknown, 'V':versioned}
1870
raise errors.BzrCommandError('cannot specify both --from-root'
1874
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1880
if revision is not None:
1881
tree = branch.repository.revision_tree(
1882
revision[0].as_revision_id(branch))
1884
tree = branch.basis_tree()
1888
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1889
if fp.startswith(relpath):
1890
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1891
if non_recursive and '/' in fp:
1893
if not all and not selection[fc]:
1895
if kind is not None and fkind != kind:
1898
kindch = entry.kind_character()
1899
outstring = '%-8s %s%s' % (fc, fp, kindch)
1900
if show_ids and fid is not None:
1901
outstring = "%-50s %s" % (outstring, fid)
1902
self.outf.write(outstring + '\n')
1904
self.outf.write(fp + '\0')
1907
self.outf.write(fid)
1908
self.outf.write('\0')
1916
self.outf.write('%-50s %s\n' % (fp, my_id))
1918
self.outf.write(fp + '\n')
1923
class cmd_unknowns(Command):
1924
"""List unknown files.
1932
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1933
self.outf.write(osutils.quotefn(f) + '\n')
1936
class cmd_ignore(Command):
1937
"""Ignore specified files or patterns.
1939
See ``bzr help patterns`` for details on the syntax of patterns.
1941
To remove patterns from the ignore list, edit the .bzrignore file.
1942
After adding, editing or deleting that file either indirectly by
1943
using this command or directly by using an editor, be sure to commit
1946
Note: ignore patterns containing shell wildcards must be quoted from
1950
Ignore the top level Makefile::
1952
bzr ignore ./Makefile
1954
Ignore class files in all directories::
1956
bzr ignore "*.class"
1958
Ignore .o files under the lib directory::
1960
bzr ignore "lib/**/*.o"
1962
Ignore .o files under the lib directory::
1964
bzr ignore "RE:lib/.*\.o"
1966
Ignore everything but the "debian" toplevel directory::
1968
bzr ignore "RE:(?!debian/).*"
1971
_see_also = ['status', 'ignored', 'patterns']
1972
takes_args = ['name_pattern*']
1974
Option('old-default-rules',
1975
help='Write out the ignore rules bzr < 0.9 always used.')
1978
def run(self, name_pattern_list=None, old_default_rules=None):
1979
from bzrlib.atomicfile import AtomicFile
1980
if old_default_rules is not None:
1981
# dump the rules and exit
1982
for pattern in ignores.OLD_DEFAULTS:
1985
if not name_pattern_list:
1986
raise errors.BzrCommandError("ignore requires at least one "
1987
"NAME_PATTERN or --old-default-rules")
1988
name_pattern_list = [globbing.normalize_pattern(p)
1989
for p in name_pattern_list]
1990
for name_pattern in name_pattern_list:
1991
if (name_pattern[0] == '/' or
1992
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1993
raise errors.BzrCommandError(
1994
"NAME_PATTERN should not be an absolute path")
1995
tree, relpath = WorkingTree.open_containing(u'.')
1996
ifn = tree.abspath('.bzrignore')
1997
if os.path.exists(ifn):
2000
igns = f.read().decode('utf-8')
2006
# TODO: If the file already uses crlf-style termination, maybe
2007
# we should use that for the newly added lines?
2009
if igns and igns[-1] != '\n':
2011
for name_pattern in name_pattern_list:
2012
igns += name_pattern + '\n'
2014
f = AtomicFile(ifn, 'wb')
2016
f.write(igns.encode('utf-8'))
2021
if not tree.path2id('.bzrignore'):
2022
tree.add(['.bzrignore'])
2024
ignored = globbing.Globster(name_pattern_list)
2027
for entry in tree.list_files():
2031
if ignored.match(filename):
2032
matches.append(filename.encode('utf-8'))
2034
if len(matches) > 0:
2035
print "Warning: the following files are version controlled and" \
2036
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2038
class cmd_ignored(Command):
2039
"""List ignored files and the patterns that matched them.
2042
encoding_type = 'replace'
2043
_see_also = ['ignore']
2047
tree = WorkingTree.open_containing(u'.')[0]
2050
for path, file_class, kind, file_id, entry in tree.list_files():
2051
if file_class != 'I':
2053
## XXX: Slightly inefficient since this was already calculated
2054
pat = tree.is_ignored(path)
2055
self.outf.write('%-50s %s\n' % (path, pat))
2060
class cmd_lookup_revision(Command):
2061
"""Lookup the revision-id from a revision-number
2064
bzr lookup-revision 33
2067
takes_args = ['revno']
2070
def run(self, revno):
2074
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2076
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2079
class cmd_export(Command):
2080
"""Export current or past revision to a destination directory or archive.
2082
If no revision is specified this exports the last committed revision.
2084
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2085
given, try to find the format with the extension. If no extension
2086
is found exports to a directory (equivalent to --format=dir).
2088
If root is supplied, it will be used as the root directory inside
2089
container formats (tar, zip, etc). If it is not supplied it will default
2090
to the exported filename. The root option has no effect for 'dir' format.
2092
If branch is omitted then the branch containing the current working
2093
directory will be used.
2095
Note: Export of tree with non-ASCII filenames to zip is not supported.
2097
================= =========================
2098
Supported formats Autodetected by extension
2099
================= =========================
2102
tbz2 .tar.bz2, .tbz2
2105
================= =========================
2107
takes_args = ['dest', 'branch?']
2110
help="Type of file to export to.",
2115
help="Name of the root directory inside the exported file."),
2117
def run(self, dest, branch=None, revision=None, format=None, root=None):
2118
from bzrlib.export import export
2121
tree = WorkingTree.open_containing(u'.')[0]
2124
b = Branch.open(branch)
2126
if revision is None:
2127
# should be tree.last_revision FIXME
2128
rev_id = b.last_revision()
2130
if len(revision) != 1:
2131
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2132
rev_id = revision[0].as_revision_id(b)
2133
t = b.repository.revision_tree(rev_id)
2135
export(t, dest, format, root)
2136
except errors.NoSuchExportFormat, e:
2137
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2140
class cmd_cat(Command):
2141
"""Write the contents of a file as of a given revision to standard output.
2143
If no revision is nominated, the last revision is used.
2145
Note: Take care to redirect standard output when using this command on a
2151
Option('name-from-revision', help='The path name in the old tree.'),
2154
takes_args = ['filename']
2155
encoding_type = 'exact'
2158
def run(self, filename, revision=None, name_from_revision=False):
2159
if revision is not None and len(revision) != 1:
2160
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2161
" one revision specifier")
2162
tree, branch, relpath = \
2163
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2166
return self._run(tree, branch, relpath, filename, revision,
2171
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2173
tree = b.basis_tree()
2174
if revision is None:
2175
revision_id = b.last_revision()
2177
revision_id = revision[0].as_revision_id(b)
2179
cur_file_id = tree.path2id(relpath)
2180
rev_tree = b.repository.revision_tree(revision_id)
2181
old_file_id = rev_tree.path2id(relpath)
2183
if name_from_revision:
2184
if old_file_id is None:
2185
raise errors.BzrCommandError("%r is not present in revision %s"
2186
% (filename, revision_id))
2188
content = rev_tree.get_file_text(old_file_id)
2189
elif cur_file_id is not None:
2190
content = rev_tree.get_file_text(cur_file_id)
2191
elif old_file_id is not None:
2192
content = rev_tree.get_file_text(old_file_id)
2194
raise errors.BzrCommandError("%r is not present in revision %s" %
2195
(filename, revision_id))
2196
self.outf.write(content)
2199
class cmd_local_time_offset(Command):
2200
"""Show the offset in seconds from GMT to local time."""
2204
print osutils.local_time_offset()
2208
class cmd_commit(Command):
2209
"""Commit changes into a new revision.
2211
If no arguments are given, the entire tree is committed.
2213
If selected files are specified, only changes to those files are
2214
committed. If a directory is specified then the directory and everything
2215
within it is committed.
2217
If author of the change is not the same person as the committer, you can
2218
specify the author's name using the --author option. The name should be
2219
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2221
A selected-file commit may fail in some cases where the committed
2222
tree would be invalid. Consider::
2227
bzr commit foo -m "committing foo"
2228
bzr mv foo/bar foo/baz
2231
bzr commit foo/bar -m "committing bar but not baz"
2233
In the example above, the last commit will fail by design. This gives
2234
the user the opportunity to decide whether they want to commit the
2235
rename at the same time, separately first, or not at all. (As a general
2236
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2238
Note: A selected-file commit after a merge is not yet supported.
2240
# TODO: Run hooks on tree to-be-committed, and after commit.
2242
# TODO: Strict commit that fails if there are deleted files.
2243
# (what does "deleted files" mean ??)
2245
# TODO: Give better message for -s, --summary, used by tla people
2247
# XXX: verbose currently does nothing
2249
_see_also = ['bugs', 'uncommit']
2250
takes_args = ['selected*']
2252
Option('message', type=unicode,
2254
help="Description of the new revision."),
2257
help='Commit even if nothing has changed.'),
2258
Option('file', type=str,
2261
help='Take commit message from this file.'),
2263
help="Refuse to commit if there are unknown "
2264
"files in the working tree."),
2265
ListOption('fixes', type=str,
2266
help="Mark a bug as being fixed by this revision."),
2267
Option('author', type=unicode,
2268
help="Set the author's name, if it's different "
2269
"from the committer."),
2271
help="Perform a local commit in a bound "
2272
"branch. Local commits are not pushed to "
2273
"the master branch until a normal commit "
2277
help='When no message is supplied, show the diff along'
2278
' with the status summary in the message editor.'),
2280
aliases = ['ci', 'checkin']
2282
def _get_bug_fix_properties(self, fixes, branch):
2284
# Configure the properties for bug fixing attributes.
2285
for fixed_bug in fixes:
2286
tokens = fixed_bug.split(':')
2287
if len(tokens) != 2:
2288
raise errors.BzrCommandError(
2289
"Invalid bug %s. Must be in the form of 'tag:id'. "
2290
"Commit refused." % fixed_bug)
2291
tag, bug_id = tokens
2293
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2294
except errors.UnknownBugTrackerAbbreviation:
2295
raise errors.BzrCommandError(
2296
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2297
except errors.MalformedBugIdentifier:
2298
raise errors.BzrCommandError(
2299
"Invalid bug identifier for %s. Commit refused."
2301
properties.append('%s fixed' % bug_url)
2302
return '\n'.join(properties)
2304
def run(self, message=None, file=None, verbose=False, selected_list=None,
2305
unchanged=False, strict=False, local=False, fixes=None,
2306
author=None, show_diff=False):
2307
from bzrlib.errors import (
2312
from bzrlib.msgeditor import (
2313
edit_commit_message_encoded,
2314
make_commit_message_template_encoded
2317
# TODO: Need a blackbox test for invoking the external editor; may be
2318
# slightly problematic to run this cross-platform.
2320
# TODO: do more checks that the commit will succeed before
2321
# spending the user's valuable time typing a commit message.
2325
tree, selected_list = tree_files(selected_list)
2326
if selected_list == ['']:
2327
# workaround - commit of root of tree should be exactly the same
2328
# as just default commit in that tree, and succeed even though
2329
# selected-file merge commit is not done yet
2334
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2336
properties['bugs'] = bug_property
2338
if local and not tree.branch.get_bound_location():
2339
raise errors.LocalRequiresBoundBranch()
2341
def get_message(commit_obj):
2342
"""Callback to get commit message"""
2343
my_message = message
2344
if my_message is None and not file:
2345
t = make_commit_message_template_encoded(tree,
2346
selected_list, diff=show_diff,
2347
output_encoding=bzrlib.user_encoding)
2348
my_message = edit_commit_message_encoded(t)
2349
if my_message is None:
2350
raise errors.BzrCommandError("please specify a commit"
2351
" message with either --message or --file")
2352
elif my_message and file:
2353
raise errors.BzrCommandError(
2354
"please specify either --message or --file")
2356
my_message = codecs.open(file, 'rt',
2357
bzrlib.user_encoding).read()
2358
if my_message == "":
2359
raise errors.BzrCommandError("empty commit message specified")
2363
tree.commit(message_callback=get_message,
2364
specific_files=selected_list,
2365
allow_pointless=unchanged, strict=strict, local=local,
2366
reporter=None, verbose=verbose, revprops=properties,
2368
except PointlessCommit:
2369
# FIXME: This should really happen before the file is read in;
2370
# perhaps prepare the commit; get the message; then actually commit
2371
raise errors.BzrCommandError("no changes to commit."
2372
" use --unchanged to commit anyhow")
2373
except ConflictsInTree:
2374
raise errors.BzrCommandError('Conflicts detected in working '
2375
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2377
except StrictCommitFailed:
2378
raise errors.BzrCommandError("Commit refused because there are"
2379
" unknown files in the working tree.")
2380
except errors.BoundBranchOutOfDate, e:
2381
raise errors.BzrCommandError(str(e) + "\n"
2382
'To commit to master branch, run update and then commit.\n'
2383
'You can also pass --local to commit to continue working '
2387
class cmd_check(Command):
2388
"""Validate consistency of branch history.
2390
This command checks various invariants about the branch storage to
2391
detect data corruption or bzr bugs.
2395
revisions: This is just the number of revisions checked. It doesn't
2397
versionedfiles: This is just the number of versionedfiles checked. It
2398
doesn't indicate a problem.
2399
unreferenced ancestors: Texts that are ancestors of other texts, but
2400
are not properly referenced by the revision ancestry. This is a
2401
subtle problem that Bazaar can work around.
2402
unique file texts: This is the total number of unique file contents
2403
seen in the checked revisions. It does not indicate a problem.
2404
repeated file texts: This is the total number of repeated texts seen
2405
in the checked revisions. Texts can be repeated when their file
2406
entries are modified, but the file contents are not. It does not
2410
_see_also = ['reconcile']
2411
takes_args = ['branch?']
2412
takes_options = ['verbose']
2414
def run(self, branch=None, verbose=False):
2415
from bzrlib.check import check
2417
branch_obj = Branch.open_containing('.')[0]
2419
branch_obj = Branch.open(branch)
2420
check(branch_obj, verbose)
2421
# bit hacky, check the tree parent is accurate
2424
tree = WorkingTree.open_containing('.')[0]
2426
tree = WorkingTree.open(branch)
2427
except (errors.NoWorkingTree, errors.NotLocalUrl):
2430
# This is a primitive 'check' for tree state. Currently this is not
2431
# integrated into the main check logic as yet.
2434
tree_basis = tree.basis_tree()
2435
tree_basis.lock_read()
2437
repo_basis = tree.branch.repository.revision_tree(
2438
tree.last_revision())
2439
if len(list(repo_basis.iter_changes(tree_basis))):
2440
raise errors.BzrCheckError(
2441
"Mismatched basis inventory content.")
2449
class cmd_upgrade(Command):
2450
"""Upgrade branch storage to current format.
2452
The check command or bzr developers may sometimes advise you to run
2453
this command. When the default format has changed you may also be warned
2454
during other operations to upgrade.
2457
_see_also = ['check']
2458
takes_args = ['url?']
2460
RegistryOption('format',
2461
help='Upgrade to a specific format. See "bzr help'
2462
' formats" for details.',
2463
registry=bzrdir.format_registry,
2464
converter=bzrdir.format_registry.make_bzrdir,
2465
value_switches=True, title='Branch format'),
2468
def run(self, url='.', format=None):
2469
from bzrlib.upgrade import upgrade
2471
format = bzrdir.format_registry.make_bzrdir('default')
2472
upgrade(url, format)
2475
class cmd_whoami(Command):
2476
"""Show or set bzr user id.
2479
Show the email of the current user::
2483
Set the current user::
2485
bzr whoami "Frank Chu <fchu@example.com>"
2487
takes_options = [ Option('email',
2488
help='Display email address only.'),
2490
help='Set identity for the current branch instead of '
2493
takes_args = ['name?']
2494
encoding_type = 'replace'
2497
def run(self, email=False, branch=False, name=None):
2499
# use branch if we're inside one; otherwise global config
2501
c = Branch.open_containing('.')[0].get_config()
2502
except errors.NotBranchError:
2503
c = config.GlobalConfig()
2505
self.outf.write(c.user_email() + '\n')
2507
self.outf.write(c.username() + '\n')
2510
# display a warning if an email address isn't included in the given name.
2512
config.extract_email_address(name)
2513
except errors.NoEmailInUsername, e:
2514
warning('"%s" does not seem to contain an email address. '
2515
'This is allowed, but not recommended.', name)
2517
# use global config unless --branch given
2519
c = Branch.open_containing('.')[0].get_config()
2521
c = config.GlobalConfig()
2522
c.set_user_option('email', name)
2525
class cmd_nick(Command):
2526
"""Print or set the branch nickname.
2528
If unset, the tree root directory name is used as the nickname
2529
To print the current nickname, execute with no argument.
2532
_see_also = ['info']
2533
takes_args = ['nickname?']
2534
def run(self, nickname=None):
2535
branch = Branch.open_containing(u'.')[0]
2536
if nickname is None:
2537
self.printme(branch)
2539
branch.nick = nickname
2542
def printme(self, branch):
2546
class cmd_alias(Command):
2547
"""Set/unset and display aliases.
2550
Show the current aliases::
2554
Show the alias specified for 'll'::
2558
Set an alias for 'll'::
2560
bzr alias ll="log --line -r-10..-1"
2562
To remove an alias for 'll'::
2564
bzr alias --remove ll
2567
takes_args = ['name?']
2569
Option('remove', help='Remove the alias.'),
2572
def run(self, name=None, remove=False):
2574
self.remove_alias(name)
2576
self.print_aliases()
2578
equal_pos = name.find('=')
2580
self.print_alias(name)
2582
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2584
def remove_alias(self, alias_name):
2585
if alias_name is None:
2586
raise errors.BzrCommandError(
2587
'bzr alias --remove expects an alias to remove.')
2588
# If alias is not found, print something like:
2589
# unalias: foo: not found
2590
c = config.GlobalConfig()
2591
c.unset_alias(alias_name)
2594
def print_aliases(self):
2595
"""Print out the defined aliases in a similar format to bash."""
2596
aliases = config.GlobalConfig().get_aliases()
2597
for key, value in sorted(aliases.iteritems()):
2598
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2601
def print_alias(self, alias_name):
2602
from bzrlib.commands import get_alias
2603
alias = get_alias(alias_name)
2605
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2608
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2610
def set_alias(self, alias_name, alias_command):
2611
"""Save the alias in the global config."""
2612
c = config.GlobalConfig()
2613
c.set_alias(alias_name, alias_command)
2616
class cmd_selftest(Command):
2617
"""Run internal test suite.
2619
If arguments are given, they are regular expressions that say which tests
2620
should run. Tests matching any expression are run, and other tests are
2623
Alternatively if --first is given, matching tests are run first and then
2624
all other tests are run. This is useful if you have been working in a
2625
particular area, but want to make sure nothing else was broken.
2627
If --exclude is given, tests that match that regular expression are
2628
excluded, regardless of whether they match --first or not.
2630
To help catch accidential dependencies between tests, the --randomize
2631
option is useful. In most cases, the argument used is the word 'now'.
2632
Note that the seed used for the random number generator is displayed
2633
when this option is used. The seed can be explicitly passed as the
2634
argument to this option if required. This enables reproduction of the
2635
actual ordering used if and when an order sensitive problem is encountered.
2637
If --list-only is given, the tests that would be run are listed. This is
2638
useful when combined with --first, --exclude and/or --randomize to
2639
understand their impact. The test harness reports "Listed nn tests in ..."
2640
instead of "Ran nn tests in ..." when list mode is enabled.
2642
If the global option '--no-plugins' is given, plugins are not loaded
2643
before running the selftests. This has two effects: features provided or
2644
modified by plugins will not be tested, and tests provided by plugins will
2647
Tests that need working space on disk use a common temporary directory,
2648
typically inside $TMPDIR or /tmp.
2651
Run only tests relating to 'ignore'::
2655
Disable plugins and list tests as they're run::
2657
bzr --no-plugins selftest -v
2659
# NB: this is used from the class without creating an instance, which is
2660
# why it does not have a self parameter.
2661
def get_transport_type(typestring):
2662
"""Parse and return a transport specifier."""
2663
if typestring == "sftp":
2664
from bzrlib.transport.sftp import SFTPAbsoluteServer
2665
return SFTPAbsoluteServer
2666
if typestring == "memory":
2667
from bzrlib.transport.memory import MemoryServer
2669
if typestring == "fakenfs":
2670
from bzrlib.transport.fakenfs import FakeNFSServer
2671
return FakeNFSServer
2672
msg = "No known transport type %s. Supported types are: sftp\n" %\
2674
raise errors.BzrCommandError(msg)
2677
takes_args = ['testspecs*']
2678
takes_options = ['verbose',
2680
help='Stop when one test fails.',
2684
help='Use a different transport by default '
2685
'throughout the test suite.',
2686
type=get_transport_type),
2688
help='Run the benchmarks rather than selftests.'),
2689
Option('lsprof-timed',
2690
help='Generate lsprof output for benchmarked'
2691
' sections of code.'),
2692
Option('cache-dir', type=str,
2693
help='Cache intermediate benchmark output in this '
2696
help='Run all tests, but run specified tests first.',
2700
help='List the tests instead of running them.'),
2701
Option('randomize', type=str, argname="SEED",
2702
help='Randomize the order of tests using the given'
2703
' seed or "now" for the current time.'),
2704
Option('exclude', type=str, argname="PATTERN",
2706
help='Exclude tests that match this regular'
2708
Option('strict', help='Fail on missing dependencies or '
2710
Option('load-list', type=str, argname='TESTLISTFILE',
2711
help='Load a test id list from a text file.'),
2712
ListOption('debugflag', type=str, short_name='E',
2713
help='Turn on a selftest debug flag.'),
2714
Option('starting-with', type=str, argname='TESTID',
2716
help='Load only the tests starting with TESTID.'),
2718
encoding_type = 'replace'
2720
def run(self, testspecs_list=None, verbose=False, one=False,
2721
transport=None, benchmark=None,
2722
lsprof_timed=None, cache_dir=None,
2723
first=False, list_only=False,
2724
randomize=None, exclude=None, strict=False,
2725
load_list=None, debugflag=None, starting_with=None):
2727
from bzrlib.tests import selftest
2728
import bzrlib.benchmarks as benchmarks
2729
from bzrlib.benchmarks import tree_creator
2731
# Make deprecation warnings visible, unless -Werror is set
2732
symbol_versioning.activate_deprecation_warnings(override=False)
2734
if cache_dir is not None:
2735
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2737
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2738
print ' %s (%s python%s)' % (
2740
bzrlib.version_string,
2741
bzrlib._format_version_tuple(sys.version_info),
2744
if testspecs_list is not None:
2745
pattern = '|'.join(testspecs_list)
2749
test_suite_factory = benchmarks.test_suite
2750
# Unless user explicitly asks for quiet, be verbose in benchmarks
2751
verbose = not is_quiet()
2752
# TODO: should possibly lock the history file...
2753
benchfile = open(".perf_history", "at", buffering=1)
2755
test_suite_factory = None
2758
result = selftest(verbose=verbose,
2760
stop_on_failure=one,
2761
transport=transport,
2762
test_suite_factory=test_suite_factory,
2763
lsprof_timed=lsprof_timed,
2764
bench_history=benchfile,
2765
matching_tests_first=first,
2766
list_only=list_only,
2767
random_seed=randomize,
2768
exclude_pattern=exclude,
2770
load_list=load_list,
2771
debug_flags=debugflag,
2772
starting_with=starting_with,
2775
if benchfile is not None:
2778
note('tests passed')
2780
note('tests failed')
2781
return int(not result)
2784
class cmd_version(Command):
2785
"""Show version of bzr."""
2787
encoding_type = 'replace'
2789
Option("short", help="Print just the version number."),
2793
def run(self, short=False):
2794
from bzrlib.version import show_version
2796
self.outf.write(bzrlib.version_string + '\n')
2798
show_version(to_file=self.outf)
2801
class cmd_rocks(Command):
2802
"""Statement of optimism."""
2808
print "It sure does!"
2811
class cmd_find_merge_base(Command):
2812
"""Find and print a base revision for merging two branches."""
2813
# TODO: Options to specify revisions on either side, as if
2814
# merging only part of the history.
2815
takes_args = ['branch', 'other']
2819
def run(self, branch, other):
2820
from bzrlib.revision import ensure_null
2822
branch1 = Branch.open_containing(branch)[0]
2823
branch2 = Branch.open_containing(other)[0]
2828
last1 = ensure_null(branch1.last_revision())
2829
last2 = ensure_null(branch2.last_revision())
2831
graph = branch1.repository.get_graph(branch2.repository)
2832
base_rev_id = graph.find_unique_lca(last1, last2)
2834
print 'merge base is revision %s' % base_rev_id
2841
class cmd_merge(Command):
2842
"""Perform a three-way merge.
2844
The source of the merge can be specified either in the form of a branch,
2845
or in the form of a path to a file containing a merge directive generated
2846
with bzr send. If neither is specified, the default is the upstream branch
2847
or the branch most recently merged using --remember.
2849
When merging a branch, by default the tip will be merged. To pick a different
2850
revision, pass --revision. If you specify two values, the first will be used as
2851
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2852
available revisions, like this is commonly referred to as "cherrypicking".
2854
Revision numbers are always relative to the branch being merged.
2856
By default, bzr will try to merge in all new work from the other
2857
branch, automatically determining an appropriate base. If this
2858
fails, you may need to give an explicit base.
2860
Merge will do its best to combine the changes in two branches, but there
2861
are some kinds of problems only a human can fix. When it encounters those,
2862
it will mark a conflict. A conflict means that you need to fix something,
2863
before you should commit.
2865
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2867
If there is no default branch set, the first merge will set it. After
2868
that, you can omit the branch to use the default. To change the
2869
default, use --remember. The value will only be saved if the remote
2870
location can be accessed.
2872
The results of the merge are placed into the destination working
2873
directory, where they can be reviewed (with bzr diff), tested, and then
2874
committed to record the result of the merge.
2876
merge refuses to run if there are any uncommitted changes, unless
2880
To merge the latest revision from bzr.dev::
2882
bzr merge ../bzr.dev
2884
To merge changes up to and including revision 82 from bzr.dev::
2886
bzr merge -r 82 ../bzr.dev
2888
To merge the changes introduced by 82, without previous changes::
2890
bzr merge -r 81..82 ../bzr.dev
2892
To apply a merge directive contained in in /tmp/merge:
2894
bzr merge /tmp/merge
2897
encoding_type = 'exact'
2898
_see_also = ['update', 'remerge', 'status-flags']
2899
takes_args = ['location?']
2904
help='Merge even if the destination tree has uncommitted changes.'),
2908
Option('show-base', help="Show base revision text in "
2910
Option('uncommitted', help='Apply uncommitted changes'
2911
' from a working copy, instead of branch changes.'),
2912
Option('pull', help='If the destination is already'
2913
' completely merged into the source, pull from the'
2914
' source rather than merging. When this happens,'
2915
' you do not need to commit the result.'),
2917
help='Branch to merge into, '
2918
'rather than the one containing the working directory.',
2922
Option('preview', help='Instead of merging, show a diff of the merge.')
2925
def run(self, location=None, revision=None, force=False,
2926
merge_type=None, show_base=False, reprocess=False, remember=False,
2927
uncommitted=False, pull=False,
2931
if merge_type is None:
2932
merge_type = _mod_merge.Merge3Merger
2934
if directory is None: directory = u'.'
2935
possible_transports = []
2937
allow_pending = True
2938
verified = 'inapplicable'
2939
tree = WorkingTree.open_containing(directory)[0]
2940
change_reporter = delta._ChangeReporter(
2941
unversioned_filter=tree.is_ignored)
2944
pb = ui.ui_factory.nested_progress_bar()
2945
cleanups.append(pb.finished)
2947
cleanups.append(tree.unlock)
2948
if location is not None:
2950
mergeable = bundle.read_mergeable_from_url(location,
2951
possible_transports=possible_transports)
2952
except errors.NotABundle:
2956
raise errors.BzrCommandError('Cannot use --uncommitted'
2957
' with bundles or merge directives.')
2959
if revision is not None:
2960
raise errors.BzrCommandError(
2961
'Cannot use -r with merge directives or bundles')
2962
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2965
if merger is None and uncommitted:
2966
if revision is not None and len(revision) > 0:
2967
raise errors.BzrCommandError('Cannot use --uncommitted and'
2968
' --revision at the same time.')
2969
location = self._select_branch_location(tree, location)[0]
2970
other_tree, other_path = WorkingTree.open_containing(location)
2971
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2973
allow_pending = False
2974
if other_path != '':
2975
merger.interesting_files = [other_path]
2978
merger, allow_pending = self._get_merger_from_branch(tree,
2979
location, revision, remember, possible_transports, pb)
2981
merger.merge_type = merge_type
2982
merger.reprocess = reprocess
2983
merger.show_base = show_base
2984
self.sanity_check_merger(merger)
2985
if (merger.base_rev_id == merger.other_rev_id and
2986
merger.other_rev_id is not None):
2987
note('Nothing to do.')
2990
if merger.interesting_files is not None:
2991
raise errors.BzrCommandError('Cannot pull individual files')
2992
if (merger.base_rev_id == tree.last_revision()):
2993
result = tree.pull(merger.other_branch, False,
2994
merger.other_rev_id)
2995
result.report(self.outf)
2997
merger.check_basis(not force)
2999
return self._do_preview(merger)
3001
return self._do_merge(merger, change_reporter, allow_pending,
3004
for cleanup in reversed(cleanups):
3007
def _do_preview(self, merger):
3008
from bzrlib.diff import show_diff_trees
3009
tree_merger = merger.make_merger()
3010
tt = tree_merger.make_preview_transform()
3012
result_tree = tt.get_preview_tree()
3013
show_diff_trees(merger.this_tree, result_tree, self.outf,
3014
old_label='', new_label='')
3018
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3019
merger.change_reporter = change_reporter
3020
conflict_count = merger.do_merge()
3022
merger.set_pending()
3023
if verified == 'failed':
3024
warning('Preview patch does not match changes')
3025
if conflict_count != 0:
3030
def sanity_check_merger(self, merger):
3031
if (merger.show_base and
3032
not merger.merge_type is _mod_merge.Merge3Merger):
3033
raise errors.BzrCommandError("Show-base is not supported for this"
3034
" merge type. %s" % merger.merge_type)
3035
if merger.reprocess and not merger.merge_type.supports_reprocess:
3036
raise errors.BzrCommandError("Conflict reduction is not supported"
3037
" for merge type %s." %
3039
if merger.reprocess and merger.show_base:
3040
raise errors.BzrCommandError("Cannot do conflict reduction and"
3043
def _get_merger_from_branch(self, tree, location, revision, remember,
3044
possible_transports, pb):
3045
"""Produce a merger from a location, assuming it refers to a branch."""
3046
from bzrlib.tag import _merge_tags_if_possible
3047
# find the branch locations
3048
other_loc, user_location = self._select_branch_location(tree, location,
3050
if revision is not None and len(revision) == 2:
3051
base_loc, _unused = self._select_branch_location(tree,
3052
location, revision, 0)
3054
base_loc = other_loc
3056
other_branch, other_path = Branch.open_containing(other_loc,
3057
possible_transports)
3058
if base_loc == other_loc:
3059
base_branch = other_branch
3061
base_branch, base_path = Branch.open_containing(base_loc,
3062
possible_transports)
3063
# Find the revision ids
3064
if revision is None or len(revision) < 1 or revision[-1] is None:
3065
other_revision_id = _mod_revision.ensure_null(
3066
other_branch.last_revision())
3068
other_revision_id = revision[-1].as_revision_id(other_branch)
3069
if (revision is not None and len(revision) == 2
3070
and revision[0] is not None):
3071
base_revision_id = revision[0].as_revision_id(base_branch)
3073
base_revision_id = None
3074
# Remember where we merge from
3075
if ((remember or tree.branch.get_submit_branch() is None) and
3076
user_location is not None):
3077
tree.branch.set_submit_branch(other_branch.base)
3078
_merge_tags_if_possible(other_branch, tree.branch)
3079
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3080
other_revision_id, base_revision_id, other_branch, base_branch)
3081
if other_path != '':
3082
allow_pending = False
3083
merger.interesting_files = [other_path]
3085
allow_pending = True
3086
return merger, allow_pending
3088
def _select_branch_location(self, tree, user_location, revision=None,
3090
"""Select a branch location, according to possible inputs.
3092
If provided, branches from ``revision`` are preferred. (Both
3093
``revision`` and ``index`` must be supplied.)
3095
Otherwise, the ``location`` parameter is used. If it is None, then the
3096
``submit`` or ``parent`` location is used, and a note is printed.
3098
:param tree: The working tree to select a branch for merging into
3099
:param location: The location entered by the user
3100
:param revision: The revision parameter to the command
3101
:param index: The index to use for the revision parameter. Negative
3102
indices are permitted.
3103
:return: (selected_location, user_location). The default location
3104
will be the user-entered location.
3106
if (revision is not None and index is not None
3107
and revision[index] is not None):
3108
branch = revision[index].get_branch()
3109
if branch is not None:
3110
return branch, branch
3111
if user_location is None:
3112
location = self._get_remembered(tree, 'Merging from')
3114
location = user_location
3115
return location, user_location
3117
def _get_remembered(self, tree, verb_string):
3118
"""Use tree.branch's parent if none was supplied.
3120
Report if the remembered location was used.
3122
stored_location = tree.branch.get_submit_branch()
3123
if stored_location is None:
3124
stored_location = tree.branch.get_parent()
3125
mutter("%s", stored_location)
3126
if stored_location is None:
3127
raise errors.BzrCommandError("No location specified or remembered")
3128
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3129
note(u"%s remembered location %s", verb_string, display_url)
3130
return stored_location
3133
class cmd_remerge(Command):
3136
Use this if you want to try a different merge technique while resolving
3137
conflicts. Some merge techniques are better than others, and remerge
3138
lets you try different ones on different files.
3140
The options for remerge have the same meaning and defaults as the ones for
3141
merge. The difference is that remerge can (only) be run when there is a
3142
pending merge, and it lets you specify particular files.
3145
Re-do the merge of all conflicted files, and show the base text in
3146
conflict regions, in addition to the usual THIS and OTHER texts::
3148
bzr remerge --show-base
3150
Re-do the merge of "foobar", using the weave merge algorithm, with
3151
additional processing to reduce the size of conflict regions::
3153
bzr remerge --merge-type weave --reprocess foobar
3155
takes_args = ['file*']
3160
help="Show base revision text in conflicts."),
3163
def run(self, file_list=None, merge_type=None, show_base=False,
3165
if merge_type is None:
3166
merge_type = _mod_merge.Merge3Merger
3167
tree, file_list = tree_files(file_list)
3170
parents = tree.get_parent_ids()
3171
if len(parents) != 2:
3172
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3173
" merges. Not cherrypicking or"
3175
repository = tree.branch.repository
3176
interesting_ids = None
3178
conflicts = tree.conflicts()
3179
if file_list is not None:
3180
interesting_ids = set()
3181
for filename in file_list:
3182
file_id = tree.path2id(filename)
3184
raise errors.NotVersionedError(filename)
3185
interesting_ids.add(file_id)
3186
if tree.kind(file_id) != "directory":
3189
for name, ie in tree.inventory.iter_entries(file_id):
3190
interesting_ids.add(ie.file_id)
3191
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3193
# Remerge only supports resolving contents conflicts
3194
allowed_conflicts = ('text conflict', 'contents conflict')
3195
restore_files = [c.path for c in conflicts
3196
if c.typestring in allowed_conflicts]
3197
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3198
tree.set_conflicts(ConflictList(new_conflicts))
3199
if file_list is not None:
3200
restore_files = file_list
3201
for filename in restore_files:
3203
restore(tree.abspath(filename))
3204
except errors.NotConflicted:
3206
# Disable pending merges, because the file texts we are remerging
3207
# have not had those merges performed. If we use the wrong parents
3208
# list, we imply that the working tree text has seen and rejected
3209
# all the changes from the other tree, when in fact those changes
3210
# have not yet been seen.
3211
pb = ui.ui_factory.nested_progress_bar()
3212
tree.set_parent_ids(parents[:1])
3214
merger = _mod_merge.Merger.from_revision_ids(pb,
3216
merger.interesting_ids = interesting_ids
3217
merger.merge_type = merge_type
3218
merger.show_base = show_base
3219
merger.reprocess = reprocess
3220
conflicts = merger.do_merge()
3222
tree.set_parent_ids(parents)
3232
class cmd_revert(Command):
3233
"""Revert files to a previous revision.
3235
Giving a list of files will revert only those files. Otherwise, all files
3236
will be reverted. If the revision is not specified with '--revision', the
3237
last committed revision is used.
3239
To remove only some changes, without reverting to a prior version, use
3240
merge instead. For example, "merge . --revision -2..-3" will remove the
3241
changes introduced by -2, without affecting the changes introduced by -1.
3242
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3244
By default, any files that have been manually changed will be backed up
3245
first. (Files changed only by merge are not backed up.) Backup files have
3246
'.~#~' appended to their name, where # is a number.
3248
When you provide files, you can use their current pathname or the pathname
3249
from the target revision. So you can use revert to "undelete" a file by
3250
name. If you name a directory, all the contents of that directory will be
3253
Any files that have been newly added since that revision will be deleted,
3254
with a backup kept if appropriate. Directories containing unknown files
3255
will not be deleted.
3257
The working tree contains a list of pending merged revisions, which will
3258
be included as parents in the next commit. Normally, revert clears that
3259
list as well as reverting the files. If any files are specified, revert
3260
leaves the pending merge list alone and reverts only the files. Use "bzr
3261
revert ." in the tree root to revert all files but keep the merge record,
3262
and "bzr revert --forget-merges" to clear the pending merge list without
3263
reverting any files.
3266
_see_also = ['cat', 'export']
3269
Option('no-backup', "Do not save backups of reverted files."),
3270
Option('forget-merges',
3271
'Remove pending merge marker, without changing any files.'),
3273
takes_args = ['file*']
3275
def run(self, revision=None, no_backup=False, file_list=None,
3276
forget_merges=None):
3277
tree, file_list = tree_files(file_list)
3279
tree.set_parent_ids(tree.get_parent_ids()[:1])
3281
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3284
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3285
if revision is None:
3286
rev_id = tree.last_revision()
3287
elif len(revision) != 1:
3288
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3290
rev_id = revision[0].as_revision_id(tree.branch)
3291
pb = ui.ui_factory.nested_progress_bar()
3293
tree.revert(file_list,
3294
tree.branch.repository.revision_tree(rev_id),
3295
not no_backup, pb, report_changes=True)
3300
class cmd_assert_fail(Command):
3301
"""Test reporting of assertion failures"""
3302
# intended just for use in testing
3307
raise AssertionError("always fails")
3310
class cmd_help(Command):
3311
"""Show help on a command or other topic.
3314
_see_also = ['topics']
3316
Option('long', 'Show help on all commands.'),
3318
takes_args = ['topic?']
3319
aliases = ['?', '--help', '-?', '-h']
3322
def run(self, topic=None, long=False):
3324
if topic is None and long:
3326
bzrlib.help.help(topic)
3329
class cmd_shell_complete(Command):
3330
"""Show appropriate completions for context.
3332
For a list of all available commands, say 'bzr shell-complete'.
3334
takes_args = ['context?']
3339
def run(self, context=None):
3340
import shellcomplete
3341
shellcomplete.shellcomplete(context)
3344
class cmd_missing(Command):
3345
"""Show unmerged/unpulled revisions between two branches.
3347
OTHER_BRANCH may be local or remote.
3350
_see_also = ['merge', 'pull']
3351
takes_args = ['other_branch?']
3353
Option('reverse', 'Reverse the order of revisions.'),
3355
'Display changes in the local branch only.'),
3356
Option('this' , 'Same as --mine-only.'),
3357
Option('theirs-only',
3358
'Display changes in the remote branch only.'),
3359
Option('other', 'Same as --theirs-only.'),
3364
encoding_type = 'replace'
3367
def run(self, other_branch=None, reverse=False, mine_only=False,
3368
theirs_only=False, log_format=None, long=False, short=False, line=False,
3369
show_ids=False, verbose=False, this=False, other=False):
3370
from bzrlib.missing import find_unmerged, iter_log_revisions
3376
# TODO: We should probably check that we don't have mine-only and
3377
# theirs-only set, but it gets complicated because we also have
3378
# this and other which could be used.
3385
local_branch = Branch.open_containing(u".")[0]
3386
parent = local_branch.get_parent()
3387
if other_branch is None:
3388
other_branch = parent
3389
if other_branch is None:
3390
raise errors.BzrCommandError("No peer location known"
3392
display_url = urlutils.unescape_for_display(parent,
3394
self.outf.write("Using last location: " + display_url + "\n")
3396
remote_branch = Branch.open(other_branch)
3397
if remote_branch.base == local_branch.base:
3398
remote_branch = local_branch
3399
local_branch.lock_read()
3401
remote_branch.lock_read()
3403
local_extra, remote_extra = find_unmerged(
3404
local_branch, remote_branch, restrict)
3406
if log_format is None:
3407
registry = log.log_formatter_registry
3408
log_format = registry.get_default(local_branch)
3409
lf = log_format(to_file=self.outf,
3411
show_timezone='original')
3412
if reverse is False:
3413
if local_extra is not None:
3414
local_extra.reverse()
3415
if remote_extra is not None:
3416
remote_extra.reverse()
3419
if local_extra and not theirs_only:
3420
self.outf.write("You have %d extra revision(s):\n" %
3422
for revision in iter_log_revisions(local_extra,
3423
local_branch.repository,
3425
lf.log_revision(revision)
3426
printed_local = True
3429
printed_local = False
3431
if remote_extra and not mine_only:
3432
if printed_local is True:
3433
self.outf.write("\n\n\n")
3434
self.outf.write("You are missing %d revision(s):\n" %
3436
for revision in iter_log_revisions(remote_extra,
3437
remote_branch.repository,
3439
lf.log_revision(revision)
3442
if mine_only and not local_extra:
3443
# We checked local, and found nothing extra
3444
self.outf.write('This branch is up to date.\n')
3445
elif theirs_only and not remote_extra:
3446
# We checked remote, and found nothing extra
3447
self.outf.write('Other branch is up to date.\n')
3448
elif not (mine_only or theirs_only or local_extra or
3450
# We checked both branches, and neither one had extra
3452
self.outf.write("Branches are up to date.\n")
3454
remote_branch.unlock()
3456
local_branch.unlock()
3457
if not status_code and parent is None and other_branch is not None:
3458
local_branch.lock_write()
3460
# handle race conditions - a parent might be set while we run.
3461
if local_branch.get_parent() is None:
3462
local_branch.set_parent(remote_branch.base)
3464
local_branch.unlock()
3468
class cmd_pack(Command):
3469
"""Compress the data within a repository."""
3471
_see_also = ['repositories']
3472
takes_args = ['branch_or_repo?']
3474
def run(self, branch_or_repo='.'):
3475
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3477
branch = dir.open_branch()
3478
repository = branch.repository
3479
except errors.NotBranchError:
3480
repository = dir.open_repository()
3484
class cmd_plugins(Command):
3485
"""List the installed plugins.
3487
This command displays the list of installed plugins including
3488
version of plugin and a short description of each.
3490
--verbose shows the path where each plugin is located.
3492
A plugin is an external component for Bazaar that extends the
3493
revision control system, by adding or replacing code in Bazaar.
3494
Plugins can do a variety of things, including overriding commands,
3495
adding new commands, providing additional network transports and
3496
customizing log output.
3498
See the Bazaar web site, http://bazaar-vcs.org, for further
3499
information on plugins including where to find them and how to
3500
install them. Instructions are also provided there on how to
3501
write new plugins using the Python programming language.
3503
takes_options = ['verbose']
3506
def run(self, verbose=False):
3507
import bzrlib.plugin
3508
from inspect import getdoc
3510
for name, plugin in bzrlib.plugin.plugins().items():
3511
version = plugin.__version__
3512
if version == 'unknown':
3514
name_ver = '%s %s' % (name, version)
3515
d = getdoc(plugin.module)
3517
doc = d.split('\n')[0]
3519
doc = '(no description)'
3520
result.append((name_ver, doc, plugin.path()))
3521
for name_ver, doc, path in sorted(result):
3529
class cmd_testament(Command):
3530
"""Show testament (signing-form) of a revision."""
3533
Option('long', help='Produce long-format testament.'),
3535
help='Produce a strict-format testament.')]
3536
takes_args = ['branch?']
3538
def run(self, branch=u'.', revision=None, long=False, strict=False):
3539
from bzrlib.testament import Testament, StrictTestament
3541
testament_class = StrictTestament
3543
testament_class = Testament
3544
b = WorkingTree.open_containing(branch)[0].branch
3547
if revision is None:
3548
rev_id = b.last_revision()
3550
rev_id = revision[0].as_revision_id(b)
3551
t = testament_class.from_revision(b.repository, rev_id)
3553
sys.stdout.writelines(t.as_text_lines())
3555
sys.stdout.write(t.as_short_text())
3560
class cmd_annotate(Command):
3561
"""Show the origin of each line in a file.
3563
This prints out the given file with an annotation on the left side
3564
indicating which revision, author and date introduced the change.
3566
If the origin is the same for a run of consecutive lines, it is
3567
shown only at the top, unless the --all option is given.
3569
# TODO: annotate directories; showing when each file was last changed
3570
# TODO: if the working copy is modified, show annotations on that
3571
# with new uncommitted lines marked
3572
aliases = ['ann', 'blame', 'praise']
3573
takes_args = ['filename']
3574
takes_options = [Option('all', help='Show annotations on all lines.'),
3575
Option('long', help='Show commit date in annotations.'),
3579
encoding_type = 'exact'
3582
def run(self, filename, all=False, long=False, revision=None,
3584
from bzrlib.annotate import annotate_file
3585
wt, branch, relpath = \
3586
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3592
if revision is None:
3593
revision_id = branch.last_revision()
3594
elif len(revision) != 1:
3595
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3597
revision_id = revision[0].as_revision_id(branch)
3598
tree = branch.repository.revision_tree(revision_id)
3600
file_id = wt.path2id(relpath)
3602
file_id = tree.path2id(relpath)
3604
raise errors.NotVersionedError(filename)
3605
file_version = tree.inventory[file_id].revision
3606
annotate_file(branch, file_version, file_id, long, all, self.outf,
3615
class cmd_re_sign(Command):
3616
"""Create a digital signature for an existing revision."""
3617
# TODO be able to replace existing ones.
3619
hidden = True # is this right ?
3620
takes_args = ['revision_id*']
3621
takes_options = ['revision']
3623
def run(self, revision_id_list=None, revision=None):
3624
if revision_id_list is not None and revision is not None:
3625
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3626
if revision_id_list is None and revision is None:
3627
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3628
b = WorkingTree.open_containing(u'.')[0].branch
3631
return self._run(b, revision_id_list, revision)
3635
def _run(self, b, revision_id_list, revision):
3636
import bzrlib.gpg as gpg
3637
gpg_strategy = gpg.GPGStrategy(b.get_config())
3638
if revision_id_list is not None:
3639
b.repository.start_write_group()
3641
for revision_id in revision_id_list:
3642
b.repository.sign_revision(revision_id, gpg_strategy)
3644
b.repository.abort_write_group()
3647
b.repository.commit_write_group()
3648
elif revision is not None:
3649
if len(revision) == 1:
3650
revno, rev_id = revision[0].in_history(b)
3651
b.repository.start_write_group()
3653
b.repository.sign_revision(rev_id, gpg_strategy)
3655
b.repository.abort_write_group()
3658
b.repository.commit_write_group()
3659
elif len(revision) == 2:
3660
# are they both on rh- if so we can walk between them
3661
# might be nice to have a range helper for arbitrary
3662
# revision paths. hmm.
3663
from_revno, from_revid = revision[0].in_history(b)
3664
to_revno, to_revid = revision[1].in_history(b)
3665
if to_revid is None:
3666
to_revno = b.revno()
3667
if from_revno is None or to_revno is None:
3668
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3669
b.repository.start_write_group()
3671
for revno in range(from_revno, to_revno + 1):
3672
b.repository.sign_revision(b.get_rev_id(revno),
3675
b.repository.abort_write_group()
3678
b.repository.commit_write_group()
3680
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3683
class cmd_bind(Command):
3684
"""Convert the current branch into a checkout of the supplied branch.
3686
Once converted into a checkout, commits must succeed on the master branch
3687
before they will be applied to the local branch.
3690
_see_also = ['checkouts', 'unbind']
3691
takes_args = ['location?']
3694
def run(self, location=None):
3695
b, relpath = Branch.open_containing(u'.')
3696
if location is None:
3698
location = b.get_old_bound_location()
3699
except errors.UpgradeRequired:
3700
raise errors.BzrCommandError('No location supplied. '
3701
'This format does not remember old locations.')
3703
if location is None:
3704
raise errors.BzrCommandError('No location supplied and no '
3705
'previous location known')
3706
b_other = Branch.open(location)
3709
except errors.DivergedBranches:
3710
raise errors.BzrCommandError('These branches have diverged.'
3711
' Try merging, and then bind again.')
3714
class cmd_unbind(Command):
3715
"""Convert the current checkout into a regular branch.
3717
After unbinding, the local branch is considered independent and subsequent
3718
commits will be local only.
3721
_see_also = ['checkouts', 'bind']
3726
b, relpath = Branch.open_containing(u'.')
3728
raise errors.BzrCommandError('Local branch is not bound')
3731
class cmd_uncommit(Command):
3732
"""Remove the last committed revision.
3734
--verbose will print out what is being removed.
3735
--dry-run will go through all the motions, but not actually
3738
If --revision is specified, uncommit revisions to leave the branch at the
3739
specified revision. For example, "bzr uncommit -r 15" will leave the
3740
branch at revision 15.
3742
Uncommit leaves the working tree ready for a new commit. The only change
3743
it may make is to restore any pending merges that were present before
3747
# TODO: jam 20060108 Add an option to allow uncommit to remove
3748
# unreferenced information in 'branch-as-repository' branches.
3749
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3750
# information in shared branches as well.
3751
_see_also = ['commit']
3752
takes_options = ['verbose', 'revision',
3753
Option('dry-run', help='Don\'t actually make changes.'),
3754
Option('force', help='Say yes to all questions.'),
3756
help="Only remove the commits from the local branch"
3757
" when in a checkout."
3760
takes_args = ['location?']
3762
encoding_type = 'replace'
3764
def run(self, location=None,
3765
dry_run=False, verbose=False,
3766
revision=None, force=False, local=False):
3767
if location is None:
3769
control, relpath = bzrdir.BzrDir.open_containing(location)
3771
tree = control.open_workingtree()
3773
except (errors.NoWorkingTree, errors.NotLocalUrl):
3775
b = control.open_branch()
3777
if tree is not None:
3782
return self._run(b, tree, dry_run, verbose, revision, force,
3785
if tree is not None:
3790
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3791
from bzrlib.log import log_formatter, show_log
3792
from bzrlib.uncommit import uncommit
3794
last_revno, last_rev_id = b.last_revision_info()
3797
if revision is None:
3799
rev_id = last_rev_id
3801
# 'bzr uncommit -r 10' actually means uncommit
3802
# so that the final tree is at revno 10.
3803
# but bzrlib.uncommit.uncommit() actually uncommits
3804
# the revisions that are supplied.
3805
# So we need to offset it by one
3806
revno = revision[0].in_history(b).revno + 1
3807
if revno <= last_revno:
3808
rev_id = b.get_rev_id(revno)
3810
if rev_id is None or _mod_revision.is_null(rev_id):
3811
self.outf.write('No revisions to uncommit.\n')
3814
lf = log_formatter('short',
3816
show_timezone='original')
3821
direction='forward',
3822
start_revision=revno,
3823
end_revision=last_revno)
3826
print 'Dry-run, pretending to remove the above revisions.'
3828
val = raw_input('Press <enter> to continue')
3830
print 'The above revision(s) will be removed.'
3832
val = raw_input('Are you sure [y/N]? ')
3833
if val.lower() not in ('y', 'yes'):
3837
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3838
revno=revno, local=local)
3841
class cmd_break_lock(Command):
3842
"""Break a dead lock on a repository, branch or working directory.
3844
CAUTION: Locks should only be broken when you are sure that the process
3845
holding the lock has been stopped.
3847
You can get information on what locks are open via the 'bzr info' command.
3852
takes_args = ['location?']
3854
def run(self, location=None, show=False):
3855
if location is None:
3857
control, relpath = bzrdir.BzrDir.open_containing(location)
3859
control.break_lock()
3860
except NotImplementedError:
3864
class cmd_wait_until_signalled(Command):
3865
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3867
This just prints a line to signal when it is ready, then blocks on stdin.
3873
sys.stdout.write("running\n")
3875
sys.stdin.readline()
3878
class cmd_serve(Command):
3879
"""Run the bzr server."""
3881
aliases = ['server']
3885
help='Serve on stdin/out for use from inetd or sshd.'),
3887
help='Listen for connections on nominated port of the form '
3888
'[hostname:]portnumber. Passing 0 as the port number will '
3889
'result in a dynamically allocated port. The default port is '
3893
help='Serve contents of this directory.',
3895
Option('allow-writes',
3896
help='By default the server is a readonly server. Supplying '
3897
'--allow-writes enables write access to the contents of '
3898
'the served directory and below.'
3902
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3903
from bzrlib import lockdir
3904
from bzrlib.smart import medium, server
3905
from bzrlib.transport import get_transport
3906
from bzrlib.transport.chroot import ChrootServer
3907
if directory is None:
3908
directory = os.getcwd()
3909
url = urlutils.local_path_to_url(directory)
3910
if not allow_writes:
3911
url = 'readonly+' + url
3912
chroot_server = ChrootServer(get_transport(url))
3913
chroot_server.setUp()
3914
t = get_transport(chroot_server.get_url())
3916
smart_server = medium.SmartServerPipeStreamMedium(
3917
sys.stdin, sys.stdout, t)
3919
host = medium.BZR_DEFAULT_INTERFACE
3921
port = medium.BZR_DEFAULT_PORT
3924
host, port = port.split(':')
3926
smart_server = server.SmartTCPServer(t, host=host, port=port)
3927
print 'listening on port: ', smart_server.port
3929
# for the duration of this server, no UI output is permitted.
3930
# note that this may cause problems with blackbox tests. This should
3931
# be changed with care though, as we dont want to use bandwidth sending
3932
# progress over stderr to smart server clients!
3933
old_factory = ui.ui_factory
3934
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3936
ui.ui_factory = ui.SilentUIFactory()
3937
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3938
smart_server.serve()
3940
ui.ui_factory = old_factory
3941
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3944
class cmd_join(Command):
3945
"""Combine a subtree into its containing tree.
3947
This command is for experimental use only. It requires the target tree
3948
to be in dirstate-with-subtree format, which cannot be converted into
3951
The TREE argument should be an independent tree, inside another tree, but
3952
not part of it. (Such trees can be produced by "bzr split", but also by
3953
running "bzr branch" with the target inside a tree.)
3955
The result is a combined tree, with the subtree no longer an independant
3956
part. This is marked as a merge of the subtree into the containing tree,
3957
and all history is preserved.
3959
If --reference is specified, the subtree retains its independence. It can
3960
be branched by itself, and can be part of multiple projects at the same
3961
time. But operations performed in the containing tree, such as commit
3962
and merge, will recurse into the subtree.
3965
_see_also = ['split']
3966
takes_args = ['tree']
3968
Option('reference', help='Join by reference.'),
3972
def run(self, tree, reference=False):
3973
sub_tree = WorkingTree.open(tree)
3974
parent_dir = osutils.dirname(sub_tree.basedir)
3975
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3976
repo = containing_tree.branch.repository
3977
if not repo.supports_rich_root():
3978
raise errors.BzrCommandError(
3979
"Can't join trees because %s doesn't support rich root data.\n"
3980
"You can use bzr upgrade on the repository."
3984
containing_tree.add_reference(sub_tree)
3985
except errors.BadReferenceTarget, e:
3986
# XXX: Would be better to just raise a nicely printable
3987
# exception from the real origin. Also below. mbp 20070306
3988
raise errors.BzrCommandError("Cannot join %s. %s" %
3992
containing_tree.subsume(sub_tree)
3993
except errors.BadSubsumeSource, e:
3994
raise errors.BzrCommandError("Cannot join %s. %s" %
3998
class cmd_split(Command):
3999
"""Split a subdirectory of a tree into a separate tree.
4001
This command will produce a target tree in a format that supports
4002
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4003
converted into earlier formats like 'dirstate-tags'.
4005
The TREE argument should be a subdirectory of a working tree. That
4006
subdirectory will be converted into an independent tree, with its own
4007
branch. Commits in the top-level tree will not apply to the new subtree.
4010
# join is not un-hidden yet
4011
#_see_also = ['join']
4012
takes_args = ['tree']
4014
def run(self, tree):
4015
containing_tree, subdir = WorkingTree.open_containing(tree)
4016
sub_id = containing_tree.path2id(subdir)
4018
raise errors.NotVersionedError(subdir)
4020
containing_tree.extract(sub_id)
4021
except errors.RootNotRich:
4022
raise errors.UpgradeRequired(containing_tree.branch.base)
4025
class cmd_merge_directive(Command):
4026
"""Generate a merge directive for auto-merge tools.
4028
A directive requests a merge to be performed, and also provides all the
4029
information necessary to do so. This means it must either include a
4030
revision bundle, or the location of a branch containing the desired
4033
A submit branch (the location to merge into) must be supplied the first
4034
time the command is issued. After it has been supplied once, it will
4035
be remembered as the default.
4037
A public branch is optional if a revision bundle is supplied, but required
4038
if --diff or --plain is specified. It will be remembered as the default
4039
after the first use.
4042
takes_args = ['submit_branch?', 'public_branch?']
4046
_see_also = ['send']
4049
RegistryOption.from_kwargs('patch-type',
4050
'The type of patch to include in the directive.',
4052
value_switches=True,
4054
bundle='Bazaar revision bundle (default).',
4055
diff='Normal unified diff.',
4056
plain='No patch, just directive.'),
4057
Option('sign', help='GPG-sign the directive.'), 'revision',
4058
Option('mail-to', type=str,
4059
help='Instead of printing the directive, email to this address.'),
4060
Option('message', type=str, short_name='m',
4061
help='Message to use when committing this merge.')
4064
encoding_type = 'exact'
4066
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4067
sign=False, revision=None, mail_to=None, message=None):
4068
from bzrlib.revision import ensure_null, NULL_REVISION
4069
include_patch, include_bundle = {
4070
'plain': (False, False),
4071
'diff': (True, False),
4072
'bundle': (True, True),
4074
branch = Branch.open('.')
4075
stored_submit_branch = branch.get_submit_branch()
4076
if submit_branch is None:
4077
submit_branch = stored_submit_branch
4079
if stored_submit_branch is None:
4080
branch.set_submit_branch(submit_branch)
4081
if submit_branch is None:
4082
submit_branch = branch.get_parent()
4083
if submit_branch is None:
4084
raise errors.BzrCommandError('No submit branch specified or known')
4086
stored_public_branch = branch.get_public_branch()
4087
if public_branch is None:
4088
public_branch = stored_public_branch
4089
elif stored_public_branch is None:
4090
branch.set_public_branch(public_branch)
4091
if not include_bundle and public_branch is None:
4092
raise errors.BzrCommandError('No public branch specified or'
4094
base_revision_id = None
4095
if revision is not None:
4096
if len(revision) > 2:
4097
raise errors.BzrCommandError('bzr merge-directive takes '
4098
'at most two one revision identifiers')
4099
revision_id = revision[-1].as_revision_id(branch)
4100
if len(revision) == 2:
4101
base_revision_id = revision[0].as_revision_id(branch)
4103
revision_id = branch.last_revision()
4104
revision_id = ensure_null(revision_id)
4105
if revision_id == NULL_REVISION:
4106
raise errors.BzrCommandError('No revisions to bundle.')
4107
directive = merge_directive.MergeDirective2.from_objects(
4108
branch.repository, revision_id, time.time(),
4109
osutils.local_time_offset(), submit_branch,
4110
public_branch=public_branch, include_patch=include_patch,
4111
include_bundle=include_bundle, message=message,
4112
base_revision_id=base_revision_id)
4115
self.outf.write(directive.to_signed(branch))
4117
self.outf.writelines(directive.to_lines())
4119
message = directive.to_email(mail_to, branch, sign)
4120
s = SMTPConnection(branch.get_config())
4121
s.send_email(message)
4124
class cmd_send(Command):
4125
"""Mail or create a merge-directive for submiting changes.
4127
A merge directive provides many things needed for requesting merges:
4129
* A machine-readable description of the merge to perform
4131
* An optional patch that is a preview of the changes requested
4133
* An optional bundle of revision data, so that the changes can be applied
4134
directly from the merge directive, without retrieving data from a
4137
If --no-bundle is specified, then public_branch is needed (and must be
4138
up-to-date), so that the receiver can perform the merge using the
4139
public_branch. The public_branch is always included if known, so that
4140
people can check it later.
4142
The submit branch defaults to the parent, but can be overridden. Both
4143
submit branch and public branch will be remembered if supplied.
4145
If a public_branch is known for the submit_branch, that public submit
4146
branch is used in the merge instructions. This means that a local mirror
4147
can be used as your actual submit branch, once you have set public_branch
4150
Mail is sent using your preferred mail program. This should be transparent
4151
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4152
If the preferred client can't be found (or used), your editor will be used.
4154
To use a specific mail program, set the mail_client configuration option.
4155
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4156
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4157
generic options are "default", "editor", "mapi", and "xdg-email".
4159
If mail is being sent, a to address is required. This can be supplied
4160
either on the commandline, by setting the submit_to configuration
4161
option in the branch itself or the child_submit_to configuration option
4162
in the submit branch.
4164
Two formats are currently supported: "4" uses revision bundle format 4 and
4165
merge directive format 2. It is significantly faster and smaller than
4166
older formats. It is compatible with Bazaar 0.19 and later. It is the
4167
default. "0.9" uses revision bundle format 0.9 and merge directive
4168
format 1. It is compatible with Bazaar 0.12 - 0.18.
4170
Merge directives are applied using the merge command or the pull command.
4173
encoding_type = 'exact'
4175
_see_also = ['merge', 'pull']
4177
takes_args = ['submit_branch?', 'public_branch?']
4181
help='Do not include a bundle in the merge directive.'),
4182
Option('no-patch', help='Do not include a preview patch in the merge'
4185
help='Remember submit and public branch.'),
4187
help='Branch to generate the submission from, '
4188
'rather than the one containing the working directory.',
4191
Option('output', short_name='o',
4192
help='Write merge directive to this file; '
4193
'use - for stdout.',
4195
Option('mail-to', help='Mail the request to this address.',
4199
RegistryOption.from_kwargs('format',
4200
'Use the specified output format.',
4201
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4202
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4205
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4206
no_patch=False, revision=None, remember=False, output=None,
4207
format='4', mail_to=None, message=None, **kwargs):
4208
return self._run(submit_branch, revision, public_branch, remember,
4209
format, no_bundle, no_patch, output,
4210
kwargs.get('from', '.'), mail_to, message)
4212
def _run(self, submit_branch, revision, public_branch, remember, format,
4213
no_bundle, no_patch, output, from_, mail_to, message):
4214
from bzrlib.revision import NULL_REVISION
4215
branch = Branch.open_containing(from_)[0]
4217
outfile = StringIO()
4221
outfile = open(output, 'wb')
4222
# we may need to write data into branch's repository to calculate
4227
config = branch.get_config()
4229
mail_to = config.get_user_option('submit_to')
4230
mail_client = config.get_mail_client()
4231
if remember and submit_branch is None:
4232
raise errors.BzrCommandError(
4233
'--remember requires a branch to be specified.')
4234
stored_submit_branch = branch.get_submit_branch()
4235
remembered_submit_branch = False
4236
if submit_branch is None:
4237
submit_branch = stored_submit_branch
4238
remembered_submit_branch = True
4240
if stored_submit_branch is None or remember:
4241
branch.set_submit_branch(submit_branch)
4242
if submit_branch is None:
4243
submit_branch = branch.get_parent()
4244
remembered_submit_branch = True
4245
if submit_branch is None:
4246
raise errors.BzrCommandError('No submit branch known or'
4248
if remembered_submit_branch:
4249
note('Using saved location: %s', submit_branch)
4252
submit_config = Branch.open(submit_branch).get_config()
4253
mail_to = submit_config.get_user_option("child_submit_to")
4255
stored_public_branch = branch.get_public_branch()
4256
if public_branch is None:
4257
public_branch = stored_public_branch
4258
elif stored_public_branch is None or remember:
4259
branch.set_public_branch(public_branch)
4260
if no_bundle and public_branch is None:
4261
raise errors.BzrCommandError('No public branch specified or'
4263
base_revision_id = None
4265
if revision is not None:
4266
if len(revision) > 2:
4267
raise errors.BzrCommandError('bzr send takes '
4268
'at most two one revision identifiers')
4269
revision_id = revision[-1].as_revision_id(branch)
4270
if len(revision) == 2:
4271
base_revision_id = revision[0].as_revision_id(branch)
4272
if revision_id is None:
4273
revision_id = branch.last_revision()
4274
if revision_id == NULL_REVISION:
4275
raise errors.BzrCommandError('No revisions to submit.')
4277
directive = merge_directive.MergeDirective2.from_objects(
4278
branch.repository, revision_id, time.time(),
4279
osutils.local_time_offset(), submit_branch,
4280
public_branch=public_branch, include_patch=not no_patch,
4281
include_bundle=not no_bundle, message=message,
4282
base_revision_id=base_revision_id)
4283
elif format == '0.9':
4286
patch_type = 'bundle'
4288
raise errors.BzrCommandError('Format 0.9 does not'
4289
' permit bundle with no patch')
4295
directive = merge_directive.MergeDirective.from_objects(
4296
branch.repository, revision_id, time.time(),
4297
osutils.local_time_offset(), submit_branch,
4298
public_branch=public_branch, patch_type=patch_type,
4301
outfile.writelines(directive.to_lines())
4303
subject = '[MERGE] '
4304
if message is not None:
4307
revision = branch.repository.get_revision(revision_id)
4308
subject += revision.get_summary()
4309
basename = directive.get_disk_name(branch)
4310
mail_client.compose_merge_request(mail_to, subject,
4311
outfile.getvalue(), basename)
4318
class cmd_bundle_revisions(cmd_send):
4320
"""Create a merge-directive for submiting changes.
4322
A merge directive provides many things needed for requesting merges:
4324
* A machine-readable description of the merge to perform
4326
* An optional patch that is a preview of the changes requested
4328
* An optional bundle of revision data, so that the changes can be applied
4329
directly from the merge directive, without retrieving data from a
4332
If --no-bundle is specified, then public_branch is needed (and must be
4333
up-to-date), so that the receiver can perform the merge using the
4334
public_branch. The public_branch is always included if known, so that
4335
people can check it later.
4337
The submit branch defaults to the parent, but can be overridden. Both
4338
submit branch and public branch will be remembered if supplied.
4340
If a public_branch is known for the submit_branch, that public submit
4341
branch is used in the merge instructions. This means that a local mirror
4342
can be used as your actual submit branch, once you have set public_branch
4345
Two formats are currently supported: "4" uses revision bundle format 4 and
4346
merge directive format 2. It is significantly faster and smaller than
4347
older formats. It is compatible with Bazaar 0.19 and later. It is the
4348
default. "0.9" uses revision bundle format 0.9 and merge directive
4349
format 1. It is compatible with Bazaar 0.12 - 0.18.
4354
help='Do not include a bundle in the merge directive.'),
4355
Option('no-patch', help='Do not include a preview patch in the merge'
4358
help='Remember submit and public branch.'),
4360
help='Branch to generate the submission from, '
4361
'rather than the one containing the working directory.',
4364
Option('output', short_name='o', help='Write directive to this file.',
4367
RegistryOption.from_kwargs('format',
4368
'Use the specified output format.',
4369
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4370
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4372
aliases = ['bundle']
4374
_see_also = ['send', 'merge']
4378
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4379
no_patch=False, revision=None, remember=False, output=None,
4380
format='4', **kwargs):
4383
return self._run(submit_branch, revision, public_branch, remember,
4384
format, no_bundle, no_patch, output,
4385
kwargs.get('from', '.'), None, None)
4388
class cmd_tag(Command):
4389
"""Create, remove or modify a tag naming a revision.
4391
Tags give human-meaningful names to revisions. Commands that take a -r
4392
(--revision) option can be given -rtag:X, where X is any previously
4395
Tags are stored in the branch. Tags are copied from one branch to another
4396
along when you branch, push, pull or merge.
4398
It is an error to give a tag name that already exists unless you pass
4399
--force, in which case the tag is moved to point to the new revision.
4402
_see_also = ['commit', 'tags']
4403
takes_args = ['tag_name']
4406
help='Delete this tag rather than placing it.',
4409
help='Branch in which to place the tag.',
4414
help='Replace existing tags.',
4419
def run(self, tag_name,
4425
branch, relpath = Branch.open_containing(directory)
4429
branch.tags.delete_tag(tag_name)
4430
self.outf.write('Deleted tag %s.\n' % tag_name)
4433
if len(revision) != 1:
4434
raise errors.BzrCommandError(
4435
"Tags can only be placed on a single revision, "
4437
revision_id = revision[0].as_revision_id(branch)
4439
revision_id = branch.last_revision()
4440
if (not force) and branch.tags.has_tag(tag_name):
4441
raise errors.TagAlreadyExists(tag_name)
4442
branch.tags.set_tag(tag_name, revision_id)
4443
self.outf.write('Created tag %s.\n' % tag_name)
4448
class cmd_tags(Command):
4451
This command shows a table of tag names and the revisions they reference.
4457
help='Branch whose tags should be displayed.',
4461
RegistryOption.from_kwargs('sort',
4462
'Sort tags by different criteria.', title='Sorting',
4463
alpha='Sort tags lexicographically (default).',
4464
time='Sort tags chronologically.',
4475
branch, relpath = Branch.open_containing(directory)
4476
tags = branch.tags.get_tag_dict().items()
4479
elif sort == 'time':
4481
for tag, revid in tags:
4483
revobj = branch.repository.get_revision(revid)
4484
except errors.NoSuchRevision:
4485
timestamp = sys.maxint # place them at the end
4487
timestamp = revobj.timestamp
4488
timestamps[revid] = timestamp
4489
tags.sort(key=lambda x: timestamps[x[1]])
4491
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4492
revno_map = branch.get_revision_id_to_revno_map()
4493
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4494
for tag, revid in tags ]
4495
for tag, revspec in tags:
4496
self.outf.write('%-20s %s\n' % (tag, revspec))
4499
class cmd_reconfigure(Command):
4500
"""Reconfigure the type of a bzr directory.
4502
A target configuration must be specified.
4504
For checkouts, the bind-to location will be auto-detected if not specified.
4505
The order of preference is
4506
1. For a lightweight checkout, the current bound location.
4507
2. For branches that used to be checkouts, the previously-bound location.
4508
3. The push location.
4509
4. The parent location.
4510
If none of these is available, --bind-to must be specified.
4513
takes_args = ['location?']
4514
takes_options = [RegistryOption.from_kwargs('target_type',
4515
title='Target type',
4516
help='The type to reconfigure the directory to.',
4517
value_switches=True, enum_switch=False,
4518
branch='Reconfigure to a branch.',
4519
tree='Reconfigure to a tree.',
4520
checkout='Reconfigure to a checkout.',
4521
lightweight_checkout='Reconfigure to a lightweight'
4523
standalone='Reconfigure to be standalone.',
4524
use_shared='Reconfigure to use a shared repository.'),
4525
Option('bind-to', help='Branch to bind checkout to.',
4528
help='Perform reconfiguration even if local changes'
4532
def run(self, location=None, target_type=None, bind_to=None, force=False):
4533
directory = bzrdir.BzrDir.open(location)
4534
if target_type is None:
4535
raise errors.BzrCommandError('No target configuration specified')
4536
elif target_type == 'branch':
4537
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4538
elif target_type == 'tree':
4539
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4540
elif target_type == 'checkout':
4541
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4543
elif target_type == 'lightweight-checkout':
4544
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4546
elif target_type == 'use-shared':
4547
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4548
elif target_type == 'standalone':
4549
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4550
reconfiguration.apply(force)
4553
class cmd_switch(Command):
4554
"""Set the branch of a checkout and update.
4556
For lightweight checkouts, this changes the branch being referenced.
4557
For heavyweight checkouts, this checks that there are no local commits
4558
versus the current bound branch, then it makes the local branch a mirror
4559
of the new location and binds to it.
4561
In both cases, the working tree is updated and uncommitted changes
4562
are merged. The user can commit or revert these as they desire.
4564
Pending merges need to be committed or reverted before using switch.
4566
The path to the branch to switch to can be specified relative to the parent
4567
directory of the current branch. For example, if you are currently in a
4568
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4572
takes_args = ['to_location']
4573
takes_options = [Option('force',
4574
help='Switch even if local commits will be lost.')
4577
def run(self, to_location, force=False):
4578
from bzrlib import switch
4580
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4582
to_branch = Branch.open(to_location)
4583
except errors.NotBranchError:
4584
to_branch = Branch.open(
4585
control_dir.open_branch().base + '../' + to_location)
4586
switch.switch(control_dir, to_branch, force)
4587
note('Switched to branch: %s',
4588
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4591
class cmd_hooks(Command):
4592
"""Show a branch's currently registered hooks.
4596
takes_args = ['path?']
4598
def run(self, path=None):
4601
branch_hooks = Branch.open(path).hooks
4602
for hook_type in branch_hooks:
4603
hooks = branch_hooks[hook_type]
4604
self.outf.write("%s:\n" % (hook_type,))
4607
self.outf.write(" %s\n" %
4608
(branch_hooks.get_hook_name(hook),))
4610
self.outf.write(" <no hooks installed>\n")
4613
def _create_prefix(cur_transport):
4614
needed = [cur_transport]
4615
# Recurse upwards until we can create a directory successfully
4617
new_transport = cur_transport.clone('..')
4618
if new_transport.base == cur_transport.base:
4619
raise errors.BzrCommandError(
4620
"Failed to create path prefix for %s."
4621
% cur_transport.base)
4623
new_transport.mkdir('.')
4624
except errors.NoSuchFile:
4625
needed.append(new_transport)
4626
cur_transport = new_transport
4629
# Now we only need to create child directories
4631
cur_transport = needed.pop()
4632
cur_transport.ensure_base()
4635
# these get imported and then picked up by the scan for cmd_*
4636
# TODO: Some more consistent way to split command definitions across files;
4637
# we do need to load at least some information about them to know of
4638
# aliases. ideally we would avoid loading the implementation until the
4639
# details were needed.
4640
from bzrlib.cmd_version_info import cmd_version_info
4641
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4642
from bzrlib.bundle.commands import (
4645
from bzrlib.sign_my_commits import cmd_sign_my_commits
4646
from bzrlib.weave_commands import cmd_versionedfile_list, \
4647
cmd_weave_plan_merge, cmd_weave_merge_text