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']
1591
tree = WorkingTree.open_containing(u'.')[0]
1592
td = tree.changes_from(tree.basis_tree())
1593
for path, id, kind, text_modified, meta_modified in td.modified:
1594
self.outf.write(path + '\n')
1597
class cmd_added(Command):
1598
"""List files added in working tree.
1602
_see_also = ['status', 'ls']
1606
wt = WorkingTree.open_containing(u'.')[0]
1609
basis = wt.basis_tree()
1612
basis_inv = basis.inventory
1615
if file_id in basis_inv:
1617
if inv.is_root(file_id) and len(basis_inv) == 0:
1619
path = inv.id2path(file_id)
1620
if not os.access(osutils.abspath(path), os.F_OK):
1622
self.outf.write(path + '\n')
1629
class cmd_root(Command):
1630
"""Show the tree root directory.
1632
The root is the nearest enclosing directory with a .bzr control
1635
takes_args = ['filename?']
1637
def run(self, filename=None):
1638
"""Print the branch root."""
1639
tree = WorkingTree.open_containing(filename)[0]
1640
self.outf.write(tree.basedir + '\n')
1643
def _parse_limit(limitstring):
1645
return int(limitstring)
1647
msg = "The limit argument must be an integer."
1648
raise errors.BzrCommandError(msg)
1651
class cmd_log(Command):
1652
"""Show log of a branch, file, or directory.
1654
By default show the log of the branch containing the working directory.
1656
To request a range of logs, you can use the command -r begin..end
1657
-r revision requests a specific revision, -r ..end or -r begin.. are
1661
Log the current branch::
1669
Log the last 10 revisions of a branch::
1671
bzr log -r -10.. http://server/branch
1674
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1676
takes_args = ['location?']
1679
help='Show from oldest to newest.'),
1682
help='Display timezone as local, original, or utc.'),
1683
custom_help('verbose',
1684
help='Show files changed in each revision.'),
1690
help='Show revisions whose message matches this '
1691
'regular expression.',
1695
help='Limit the output to the first N revisions.',
1699
encoding_type = 'replace'
1702
def run(self, location=None, timezone='original',
1710
from bzrlib.log import show_log
1711
direction = (forward and 'forward') or 'reverse'
1716
# find the file id to log:
1718
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1722
tree = b.basis_tree()
1723
file_id = tree.path2id(fp)
1725
raise errors.BzrCommandError(
1726
"Path does not have any revision history: %s" %
1730
# FIXME ? log the current subdir only RBC 20060203
1731
if revision is not None \
1732
and len(revision) > 0 and revision[0].get_branch():
1733
location = revision[0].get_branch()
1736
dir, relpath = bzrdir.BzrDir.open_containing(location)
1737
b = dir.open_branch()
1741
if revision is None:
1744
elif len(revision) == 1:
1745
rev1 = rev2 = revision[0].in_history(b)
1746
elif len(revision) == 2:
1747
if revision[1].get_branch() != revision[0].get_branch():
1748
# b is taken from revision[0].get_branch(), and
1749
# show_log will use its revision_history. Having
1750
# different branches will lead to weird behaviors.
1751
raise errors.BzrCommandError(
1752
"Log doesn't accept two revisions in different"
1754
rev1 = revision[0].in_history(b)
1755
rev2 = revision[1].in_history(b)
1757
raise errors.BzrCommandError(
1758
'bzr log --revision takes one or two values.')
1760
if log_format is None:
1761
log_format = log.log_formatter_registry.get_default(b)
1763
lf = log_format(show_ids=show_ids, to_file=self.outf,
1764
show_timezone=timezone)
1770
direction=direction,
1771
start_revision=rev1,
1779
def get_log_format(long=False, short=False, line=False, default='long'):
1780
log_format = default
1784
log_format = 'short'
1790
class cmd_touching_revisions(Command):
1791
"""Return revision-ids which affected a particular file.
1793
A more user-friendly interface is "bzr log FILE".
1797
takes_args = ["filename"]
1800
def run(self, filename):
1801
tree, relpath = WorkingTree.open_containing(filename)
1803
file_id = tree.path2id(relpath)
1804
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1805
self.outf.write("%6d %s\n" % (revno, what))
1808
class cmd_ls(Command):
1809
"""List files in a tree.
1812
_see_also = ['status', 'cat']
1813
takes_args = ['path?']
1814
# TODO: Take a revision or remote path and list that tree instead.
1818
Option('non-recursive',
1819
help='Don\'t recurse into subdirectories.'),
1821
help='Print paths relative to the root of the branch.'),
1822
Option('unknown', help='Print unknown files.'),
1823
Option('versioned', help='Print versioned files.',
1825
Option('ignored', help='Print ignored files.'),
1827
help='Write an ascii NUL (\\0) separator '
1828
'between files rather than a newline.'),
1830
help='List entries of a particular kind: file, directory, symlink.',
1835
def run(self, revision=None, verbose=False,
1836
non_recursive=False, from_root=False,
1837
unknown=False, versioned=False, ignored=False,
1838
null=False, kind=None, show_ids=False, path=None):
1840
if kind and kind not in ('file', 'directory', 'symlink'):
1841
raise errors.BzrCommandError('invalid kind specified')
1843
if verbose and null:
1844
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1845
all = not (unknown or versioned or ignored)
1847
selection = {'I':ignored, '?':unknown, 'V':versioned}
1854
raise errors.BzrCommandError('cannot specify both --from-root'
1858
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1864
if revision is not None:
1865
tree = branch.repository.revision_tree(
1866
revision[0].as_revision_id(branch))
1868
tree = branch.basis_tree()
1872
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1873
if fp.startswith(relpath):
1874
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1875
if non_recursive and '/' in fp:
1877
if not all and not selection[fc]:
1879
if kind is not None and fkind != kind:
1882
kindch = entry.kind_character()
1883
outstring = '%-8s %s%s' % (fc, fp, kindch)
1884
if show_ids and fid is not None:
1885
outstring = "%-50s %s" % (outstring, fid)
1886
self.outf.write(outstring + '\n')
1888
self.outf.write(fp + '\0')
1891
self.outf.write(fid)
1892
self.outf.write('\0')
1900
self.outf.write('%-50s %s\n' % (fp, my_id))
1902
self.outf.write(fp + '\n')
1907
class cmd_unknowns(Command):
1908
"""List unknown files.
1916
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1917
self.outf.write(osutils.quotefn(f) + '\n')
1920
class cmd_ignore(Command):
1921
"""Ignore specified files or patterns.
1923
To remove patterns from the ignore list, edit the .bzrignore file.
1925
Trailing slashes on patterns are ignored.
1926
If the pattern contains a slash or is a regular expression, it is compared
1927
to the whole path from the branch root. Otherwise, it is compared to only
1928
the last component of the path. To match a file only in the root
1929
directory, prepend './'.
1931
Ignore patterns specifying absolute paths are not allowed.
1933
Ignore patterns may include globbing wildcards such as::
1935
? - Matches any single character except '/'
1936
* - Matches 0 or more characters except '/'
1937
/**/ - Matches 0 or more directories in a path
1938
[a-z] - Matches a single character from within a group of characters
1940
Ignore patterns may also be Python regular expressions.
1941
Regular expression ignore patterns are identified by a 'RE:' prefix
1942
followed by the regular expression. Regular expression ignore patterns
1943
may not include named or numbered groups.
1945
Note: ignore patterns containing shell wildcards must be quoted from
1949
Ignore the top level Makefile::
1951
bzr ignore ./Makefile
1953
Ignore class files in all directories::
1955
bzr ignore "*.class"
1957
Ignore .o files under the lib directory::
1959
bzr ignore "lib/**/*.o"
1961
Ignore .o files under the lib directory::
1963
bzr ignore "RE:lib/.*\.o"
1965
Ignore everything but the "debian" toplevel directory::
1967
bzr ignore "RE:(?!debian/).*"
1970
_see_also = ['status', 'ignored']
1971
takes_args = ['name_pattern*']
1973
Option('old-default-rules',
1974
help='Write out the ignore rules bzr < 0.9 always used.')
1977
def run(self, name_pattern_list=None, old_default_rules=None):
1978
from bzrlib.atomicfile import AtomicFile
1979
if old_default_rules is not None:
1980
# dump the rules and exit
1981
for pattern in ignores.OLD_DEFAULTS:
1984
if not name_pattern_list:
1985
raise errors.BzrCommandError("ignore requires at least one "
1986
"NAME_PATTERN or --old-default-rules")
1987
name_pattern_list = [globbing.normalize_pattern(p)
1988
for p in name_pattern_list]
1989
for name_pattern in name_pattern_list:
1990
if (name_pattern[0] == '/' or
1991
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1992
raise errors.BzrCommandError(
1993
"NAME_PATTERN should not be an absolute path")
1994
tree, relpath = WorkingTree.open_containing(u'.')
1995
ifn = tree.abspath('.bzrignore')
1996
if os.path.exists(ifn):
1999
igns = f.read().decode('utf-8')
2005
# TODO: If the file already uses crlf-style termination, maybe
2006
# we should use that for the newly added lines?
2008
if igns and igns[-1] != '\n':
2010
for name_pattern in name_pattern_list:
2011
igns += name_pattern + '\n'
2013
f = AtomicFile(ifn, 'wb')
2015
f.write(igns.encode('utf-8'))
2020
if not tree.path2id('.bzrignore'):
2021
tree.add(['.bzrignore'])
2023
ignored = globbing.Globster(name_pattern_list)
2026
for entry in tree.list_files():
2030
if ignored.match(filename):
2031
matches.append(filename.encode('utf-8'))
2033
if len(matches) > 0:
2034
print "Warning: the following files are version controlled and" \
2035
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2037
class cmd_ignored(Command):
2038
"""List ignored files and the patterns that matched them.
2041
encoding_type = 'replace'
2042
_see_also = ['ignore']
2046
tree = WorkingTree.open_containing(u'.')[0]
2049
for path, file_class, kind, file_id, entry in tree.list_files():
2050
if file_class != 'I':
2052
## XXX: Slightly inefficient since this was already calculated
2053
pat = tree.is_ignored(path)
2054
self.outf.write('%-50s %s\n' % (path, pat))
2059
class cmd_lookup_revision(Command):
2060
"""Lookup the revision-id from a revision-number
2063
bzr lookup-revision 33
2066
takes_args = ['revno']
2069
def run(self, revno):
2073
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2075
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2078
class cmd_export(Command):
2079
"""Export current or past revision to a destination directory or archive.
2081
If no revision is specified this exports the last committed revision.
2083
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2084
given, try to find the format with the extension. If no extension
2085
is found exports to a directory (equivalent to --format=dir).
2087
If root is supplied, it will be used as the root directory inside
2088
container formats (tar, zip, etc). If it is not supplied it will default
2089
to the exported filename. The root option has no effect for 'dir' format.
2091
If branch is omitted then the branch containing the current working
2092
directory will be used.
2094
Note: Export of tree with non-ASCII filenames to zip is not supported.
2096
================= =========================
2097
Supported formats Autodetected by extension
2098
================= =========================
2101
tbz2 .tar.bz2, .tbz2
2104
================= =========================
2106
takes_args = ['dest', 'branch?']
2109
help="Type of file to export to.",
2114
help="Name of the root directory inside the exported file."),
2116
def run(self, dest, branch=None, revision=None, format=None, root=None):
2117
from bzrlib.export import export
2120
tree = WorkingTree.open_containing(u'.')[0]
2123
b = Branch.open(branch)
2125
if revision is None:
2126
# should be tree.last_revision FIXME
2127
rev_id = b.last_revision()
2129
if len(revision) != 1:
2130
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2131
rev_id = revision[0].as_revision_id(b)
2132
t = b.repository.revision_tree(rev_id)
2134
export(t, dest, format, root)
2135
except errors.NoSuchExportFormat, e:
2136
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2139
class cmd_cat(Command):
2140
"""Write the contents of a file as of a given revision to standard output.
2142
If no revision is nominated, the last revision is used.
2144
Note: Take care to redirect standard output when using this command on a
2150
Option('name-from-revision', help='The path name in the old tree.'),
2153
takes_args = ['filename']
2154
encoding_type = 'exact'
2157
def run(self, filename, revision=None, name_from_revision=False):
2158
if revision is not None and len(revision) != 1:
2159
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2160
" one revision specifier")
2161
tree, branch, relpath = \
2162
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2165
return self._run(tree, branch, relpath, filename, revision,
2170
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2172
tree = b.basis_tree()
2173
if revision is None:
2174
revision_id = b.last_revision()
2176
revision_id = revision[0].as_revision_id(b)
2178
cur_file_id = tree.path2id(relpath)
2179
rev_tree = b.repository.revision_tree(revision_id)
2180
old_file_id = rev_tree.path2id(relpath)
2182
if name_from_revision:
2183
if old_file_id is None:
2184
raise errors.BzrCommandError("%r is not present in revision %s"
2185
% (filename, revision_id))
2187
rev_tree.print_file(old_file_id)
2188
elif cur_file_id is not None:
2189
rev_tree.print_file(cur_file_id)
2190
elif old_file_id is not None:
2191
rev_tree.print_file(old_file_id)
2193
raise errors.BzrCommandError("%r is not present in revision %s" %
2194
(filename, revision_id))
2197
class cmd_local_time_offset(Command):
2198
"""Show the offset in seconds from GMT to local time."""
2202
print osutils.local_time_offset()
2206
class cmd_commit(Command):
2207
"""Commit changes into a new revision.
2209
If no arguments are given, the entire tree is committed.
2211
If selected files are specified, only changes to those files are
2212
committed. If a directory is specified then the directory and everything
2213
within it is committed.
2215
If author of the change is not the same person as the committer, you can
2216
specify the author's name using the --author option. The name should be
2217
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2219
A selected-file commit may fail in some cases where the committed
2220
tree would be invalid. Consider::
2225
bzr commit foo -m "committing foo"
2226
bzr mv foo/bar foo/baz
2229
bzr commit foo/bar -m "committing bar but not baz"
2231
In the example above, the last commit will fail by design. This gives
2232
the user the opportunity to decide whether they want to commit the
2233
rename at the same time, separately first, or not at all. (As a general
2234
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2236
Note: A selected-file commit after a merge is not yet supported.
2238
# TODO: Run hooks on tree to-be-committed, and after commit.
2240
# TODO: Strict commit that fails if there are deleted files.
2241
# (what does "deleted files" mean ??)
2243
# TODO: Give better message for -s, --summary, used by tla people
2245
# XXX: verbose currently does nothing
2247
_see_also = ['bugs', 'uncommit']
2248
takes_args = ['selected*']
2250
Option('message', type=unicode,
2252
help="Description of the new revision."),
2255
help='Commit even if nothing has changed.'),
2256
Option('file', type=str,
2259
help='Take commit message from this file.'),
2261
help="Refuse to commit if there are unknown "
2262
"files in the working tree."),
2263
ListOption('fixes', type=str,
2264
help="Mark a bug as being fixed by this revision."),
2265
Option('author', type=unicode,
2266
help="Set the author's name, if it's different "
2267
"from the committer."),
2269
help="Perform a local commit in a bound "
2270
"branch. Local commits are not pushed to "
2271
"the master branch until a normal commit "
2275
help='When no message is supplied, show the diff along'
2276
' with the status summary in the message editor.'),
2278
aliases = ['ci', 'checkin']
2280
def _get_bug_fix_properties(self, fixes, branch):
2282
# Configure the properties for bug fixing attributes.
2283
for fixed_bug in fixes:
2284
tokens = fixed_bug.split(':')
2285
if len(tokens) != 2:
2286
raise errors.BzrCommandError(
2287
"Invalid bug %s. Must be in the form of 'tag:id'. "
2288
"Commit refused." % fixed_bug)
2289
tag, bug_id = tokens
2291
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2292
except errors.UnknownBugTrackerAbbreviation:
2293
raise errors.BzrCommandError(
2294
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2295
except errors.MalformedBugIdentifier:
2296
raise errors.BzrCommandError(
2297
"Invalid bug identifier for %s. Commit refused."
2299
properties.append('%s fixed' % bug_url)
2300
return '\n'.join(properties)
2302
def run(self, message=None, file=None, verbose=False, selected_list=None,
2303
unchanged=False, strict=False, local=False, fixes=None,
2304
author=None, show_diff=False):
2305
from bzrlib.errors import (
2310
from bzrlib.msgeditor import (
2311
edit_commit_message_encoded,
2312
make_commit_message_template_encoded
2315
# TODO: Need a blackbox test for invoking the external editor; may be
2316
# slightly problematic to run this cross-platform.
2318
# TODO: do more checks that the commit will succeed before
2319
# spending the user's valuable time typing a commit message.
2323
tree, selected_list = tree_files(selected_list)
2324
if selected_list == ['']:
2325
# workaround - commit of root of tree should be exactly the same
2326
# as just default commit in that tree, and succeed even though
2327
# selected-file merge commit is not done yet
2332
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2334
properties['bugs'] = bug_property
2336
if local and not tree.branch.get_bound_location():
2337
raise errors.LocalRequiresBoundBranch()
2339
def get_message(commit_obj):
2340
"""Callback to get commit message"""
2341
my_message = message
2342
if my_message is None and not file:
2343
t = make_commit_message_template_encoded(tree,
2344
selected_list, diff=show_diff,
2345
output_encoding=bzrlib.user_encoding)
2346
my_message = edit_commit_message_encoded(t)
2347
if my_message is None:
2348
raise errors.BzrCommandError("please specify a commit"
2349
" message with either --message or --file")
2350
elif my_message and file:
2351
raise errors.BzrCommandError(
2352
"please specify either --message or --file")
2354
my_message = codecs.open(file, 'rt',
2355
bzrlib.user_encoding).read()
2356
if my_message == "":
2357
raise errors.BzrCommandError("empty commit message specified")
2361
tree.commit(message_callback=get_message,
2362
specific_files=selected_list,
2363
allow_pointless=unchanged, strict=strict, local=local,
2364
reporter=None, verbose=verbose, revprops=properties,
2366
except PointlessCommit:
2367
# FIXME: This should really happen before the file is read in;
2368
# perhaps prepare the commit; get the message; then actually commit
2369
raise errors.BzrCommandError("no changes to commit."
2370
" use --unchanged to commit anyhow")
2371
except ConflictsInTree:
2372
raise errors.BzrCommandError('Conflicts detected in working '
2373
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2375
except StrictCommitFailed:
2376
raise errors.BzrCommandError("Commit refused because there are"
2377
" unknown files in the working tree.")
2378
except errors.BoundBranchOutOfDate, e:
2379
raise errors.BzrCommandError(str(e) + "\n"
2380
'To commit to master branch, run update and then commit.\n'
2381
'You can also pass --local to commit to continue working '
2385
class cmd_check(Command):
2386
"""Validate consistency of branch history.
2388
This command checks various invariants about the branch storage to
2389
detect data corruption or bzr bugs.
2393
revisions: This is just the number of revisions checked. It doesn't
2395
versionedfiles: This is just the number of versionedfiles checked. It
2396
doesn't indicate a problem.
2397
unreferenced ancestors: Texts that are ancestors of other texts, but
2398
are not properly referenced by the revision ancestry. This is a
2399
subtle problem that Bazaar can work around.
2400
unique file texts: This is the total number of unique file contents
2401
seen in the checked revisions. It does not indicate a problem.
2402
repeated file texts: This is the total number of repeated texts seen
2403
in the checked revisions. Texts can be repeated when their file
2404
entries are modified, but the file contents are not. It does not
2408
_see_also = ['reconcile']
2409
takes_args = ['branch?']
2410
takes_options = ['verbose']
2412
def run(self, branch=None, verbose=False):
2413
from bzrlib.check import check
2415
branch_obj = Branch.open_containing('.')[0]
2417
branch_obj = Branch.open(branch)
2418
check(branch_obj, verbose)
2419
# bit hacky, check the tree parent is accurate
2422
tree = WorkingTree.open_containing('.')[0]
2424
tree = WorkingTree.open(branch)
2425
except (errors.NoWorkingTree, errors.NotLocalUrl):
2428
# This is a primitive 'check' for tree state. Currently this is not
2429
# integrated into the main check logic as yet.
2432
tree_basis = tree.basis_tree()
2433
tree_basis.lock_read()
2435
repo_basis = tree.branch.repository.revision_tree(
2436
tree.last_revision())
2437
if len(list(repo_basis.iter_changes(tree_basis))):
2438
raise errors.BzrCheckError(
2439
"Mismatched basis inventory content.")
2447
class cmd_upgrade(Command):
2448
"""Upgrade branch storage to current format.
2450
The check command or bzr developers may sometimes advise you to run
2451
this command. When the default format has changed you may also be warned
2452
during other operations to upgrade.
2455
_see_also = ['check']
2456
takes_args = ['url?']
2458
RegistryOption('format',
2459
help='Upgrade to a specific format. See "bzr help'
2460
' formats" for details.',
2461
registry=bzrdir.format_registry,
2462
converter=bzrdir.format_registry.make_bzrdir,
2463
value_switches=True, title='Branch format'),
2466
def run(self, url='.', format=None):
2467
from bzrlib.upgrade import upgrade
2469
format = bzrdir.format_registry.make_bzrdir('default')
2470
upgrade(url, format)
2473
class cmd_whoami(Command):
2474
"""Show or set bzr user id.
2477
Show the email of the current user::
2481
Set the current user::
2483
bzr whoami "Frank Chu <fchu@example.com>"
2485
takes_options = [ Option('email',
2486
help='Display email address only.'),
2488
help='Set identity for the current branch instead of '
2491
takes_args = ['name?']
2492
encoding_type = 'replace'
2495
def run(self, email=False, branch=False, name=None):
2497
# use branch if we're inside one; otherwise global config
2499
c = Branch.open_containing('.')[0].get_config()
2500
except errors.NotBranchError:
2501
c = config.GlobalConfig()
2503
self.outf.write(c.user_email() + '\n')
2505
self.outf.write(c.username() + '\n')
2508
# display a warning if an email address isn't included in the given name.
2510
config.extract_email_address(name)
2511
except errors.NoEmailInUsername, e:
2512
warning('"%s" does not seem to contain an email address. '
2513
'This is allowed, but not recommended.', name)
2515
# use global config unless --branch given
2517
c = Branch.open_containing('.')[0].get_config()
2519
c = config.GlobalConfig()
2520
c.set_user_option('email', name)
2523
class cmd_nick(Command):
2524
"""Print or set the branch nickname.
2526
If unset, the tree root directory name is used as the nickname
2527
To print the current nickname, execute with no argument.
2530
_see_also = ['info']
2531
takes_args = ['nickname?']
2532
def run(self, nickname=None):
2533
branch = Branch.open_containing(u'.')[0]
2534
if nickname is None:
2535
self.printme(branch)
2537
branch.nick = nickname
2540
def printme(self, branch):
2544
class cmd_selftest(Command):
2545
"""Run internal test suite.
2547
If arguments are given, they are regular expressions that say which tests
2548
should run. Tests matching any expression are run, and other tests are
2551
Alternatively if --first is given, matching tests are run first and then
2552
all other tests are run. This is useful if you have been working in a
2553
particular area, but want to make sure nothing else was broken.
2555
If --exclude is given, tests that match that regular expression are
2556
excluded, regardless of whether they match --first or not.
2558
To help catch accidential dependencies between tests, the --randomize
2559
option is useful. In most cases, the argument used is the word 'now'.
2560
Note that the seed used for the random number generator is displayed
2561
when this option is used. The seed can be explicitly passed as the
2562
argument to this option if required. This enables reproduction of the
2563
actual ordering used if and when an order sensitive problem is encountered.
2565
If --list-only is given, the tests that would be run are listed. This is
2566
useful when combined with --first, --exclude and/or --randomize to
2567
understand their impact. The test harness reports "Listed nn tests in ..."
2568
instead of "Ran nn tests in ..." when list mode is enabled.
2570
If the global option '--no-plugins' is given, plugins are not loaded
2571
before running the selftests. This has two effects: features provided or
2572
modified by plugins will not be tested, and tests provided by plugins will
2575
Tests that need working space on disk use a common temporary directory,
2576
typically inside $TMPDIR or /tmp.
2579
Run only tests relating to 'ignore'::
2583
Disable plugins and list tests as they're run::
2585
bzr --no-plugins selftest -v
2587
# NB: this is used from the class without creating an instance, which is
2588
# why it does not have a self parameter.
2589
def get_transport_type(typestring):
2590
"""Parse and return a transport specifier."""
2591
if typestring == "sftp":
2592
from bzrlib.transport.sftp import SFTPAbsoluteServer
2593
return SFTPAbsoluteServer
2594
if typestring == "memory":
2595
from bzrlib.transport.memory import MemoryServer
2597
if typestring == "fakenfs":
2598
from bzrlib.transport.fakenfs import FakeNFSServer
2599
return FakeNFSServer
2600
msg = "No known transport type %s. Supported types are: sftp\n" %\
2602
raise errors.BzrCommandError(msg)
2605
takes_args = ['testspecs*']
2606
takes_options = ['verbose',
2608
help='Stop when one test fails.',
2612
help='Use a different transport by default '
2613
'throughout the test suite.',
2614
type=get_transport_type),
2616
help='Run the benchmarks rather than selftests.'),
2617
Option('lsprof-timed',
2618
help='Generate lsprof output for benchmarked'
2619
' sections of code.'),
2620
Option('cache-dir', type=str,
2621
help='Cache intermediate benchmark output in this '
2624
help='Run all tests, but run specified tests first.',
2628
help='List the tests instead of running them.'),
2629
Option('randomize', type=str, argname="SEED",
2630
help='Randomize the order of tests using the given'
2631
' seed or "now" for the current time.'),
2632
Option('exclude', type=str, argname="PATTERN",
2634
help='Exclude tests that match this regular'
2636
Option('strict', help='Fail on missing dependencies or '
2638
Option('load-list', type=str, argname='TESTLISTFILE',
2639
help='Load a test id list from a text file.'),
2640
ListOption('debugflag', type=str, short_name='E',
2641
help='Turn on a selftest debug flag.'),
2642
Option('starting-with', type=str, argname='TESTID',
2644
help='Load only the tests starting with TESTID.'),
2646
encoding_type = 'replace'
2648
def run(self, testspecs_list=None, verbose=False, one=False,
2649
transport=None, benchmark=None,
2650
lsprof_timed=None, cache_dir=None,
2651
first=False, list_only=False,
2652
randomize=None, exclude=None, strict=False,
2653
load_list=None, debugflag=None, starting_with=None):
2655
from bzrlib.tests import selftest
2656
import bzrlib.benchmarks as benchmarks
2657
from bzrlib.benchmarks import tree_creator
2659
# Make deprecation warnings visible, unless -Werror is set
2660
symbol_versioning.activate_deprecation_warnings(override=False)
2662
if cache_dir is not None:
2663
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2665
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2666
print ' %s (%s python%s)' % (
2668
bzrlib.version_string,
2669
bzrlib._format_version_tuple(sys.version_info),
2672
if testspecs_list is not None:
2673
pattern = '|'.join(testspecs_list)
2677
test_suite_factory = benchmarks.test_suite
2678
# Unless user explicitly asks for quiet, be verbose in benchmarks
2679
verbose = not is_quiet()
2680
# TODO: should possibly lock the history file...
2681
benchfile = open(".perf_history", "at", buffering=1)
2683
test_suite_factory = None
2686
result = selftest(verbose=verbose,
2688
stop_on_failure=one,
2689
transport=transport,
2690
test_suite_factory=test_suite_factory,
2691
lsprof_timed=lsprof_timed,
2692
bench_history=benchfile,
2693
matching_tests_first=first,
2694
list_only=list_only,
2695
random_seed=randomize,
2696
exclude_pattern=exclude,
2698
load_list=load_list,
2699
debug_flags=debugflag,
2700
starting_with=starting_with,
2703
if benchfile is not None:
2706
note('tests passed')
2708
note('tests failed')
2709
return int(not result)
2712
class cmd_version(Command):
2713
"""Show version of bzr."""
2715
encoding_type = 'replace'
2717
Option("short", help="Print just the version number."),
2721
def run(self, short=False):
2722
from bzrlib.version import show_version
2724
self.outf.write(bzrlib.version_string + '\n')
2726
show_version(to_file=self.outf)
2729
class cmd_rocks(Command):
2730
"""Statement of optimism."""
2736
print "It sure does!"
2739
class cmd_find_merge_base(Command):
2740
"""Find and print a base revision for merging two branches."""
2741
# TODO: Options to specify revisions on either side, as if
2742
# merging only part of the history.
2743
takes_args = ['branch', 'other']
2747
def run(self, branch, other):
2748
from bzrlib.revision import ensure_null
2750
branch1 = Branch.open_containing(branch)[0]
2751
branch2 = Branch.open_containing(other)[0]
2756
last1 = ensure_null(branch1.last_revision())
2757
last2 = ensure_null(branch2.last_revision())
2759
graph = branch1.repository.get_graph(branch2.repository)
2760
base_rev_id = graph.find_unique_lca(last1, last2)
2762
print 'merge base is revision %s' % base_rev_id
2769
class cmd_merge(Command):
2770
"""Perform a three-way merge.
2772
The source of the merge can be specified either in the form of a branch,
2773
or in the form of a path to a file containing a merge directive generated
2774
with bzr send. If neither is specified, the default is the upstream branch
2775
or the branch most recently merged using --remember.
2777
When merging a branch, by default the tip will be merged. To pick a different
2778
revision, pass --revision. If you specify two values, the first will be used as
2779
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2780
available revisions, like this is commonly referred to as "cherrypicking".
2782
Revision numbers are always relative to the branch being merged.
2784
By default, bzr will try to merge in all new work from the other
2785
branch, automatically determining an appropriate base. If this
2786
fails, you may need to give an explicit base.
2788
Merge will do its best to combine the changes in two branches, but there
2789
are some kinds of problems only a human can fix. When it encounters those,
2790
it will mark a conflict. A conflict means that you need to fix something,
2791
before you should commit.
2793
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2795
If there is no default branch set, the first merge will set it. After
2796
that, you can omit the branch to use the default. To change the
2797
default, use --remember. The value will only be saved if the remote
2798
location can be accessed.
2800
The results of the merge are placed into the destination working
2801
directory, where they can be reviewed (with bzr diff), tested, and then
2802
committed to record the result of the merge.
2804
merge refuses to run if there are any uncommitted changes, unless
2808
To merge the latest revision from bzr.dev::
2810
bzr merge ../bzr.dev
2812
To merge changes up to and including revision 82 from bzr.dev::
2814
bzr merge -r 82 ../bzr.dev
2816
To merge the changes introduced by 82, without previous changes::
2818
bzr merge -r 81..82 ../bzr.dev
2820
To apply a merge directive contained in in /tmp/merge:
2822
bzr merge /tmp/merge
2825
encoding_type = 'exact'
2826
_see_also = ['update', 'remerge', 'status-flags']
2827
takes_args = ['location?']
2832
help='Merge even if the destination tree has uncommitted changes.'),
2836
Option('show-base', help="Show base revision text in "
2838
Option('uncommitted', help='Apply uncommitted changes'
2839
' from a working copy, instead of branch changes.'),
2840
Option('pull', help='If the destination is already'
2841
' completely merged into the source, pull from the'
2842
' source rather than merging. When this happens,'
2843
' you do not need to commit the result.'),
2845
help='Branch to merge into, '
2846
'rather than the one containing the working directory.',
2850
Option('preview', help='Instead of merging, show a diff of the merge.')
2853
def run(self, location=None, revision=None, force=False,
2854
merge_type=None, show_base=False, reprocess=False, remember=False,
2855
uncommitted=False, pull=False,
2859
if merge_type is None:
2860
merge_type = _mod_merge.Merge3Merger
2862
if directory is None: directory = u'.'
2863
possible_transports = []
2865
allow_pending = True
2866
verified = 'inapplicable'
2867
tree = WorkingTree.open_containing(directory)[0]
2868
change_reporter = delta._ChangeReporter(
2869
unversioned_filter=tree.is_ignored)
2872
pb = ui.ui_factory.nested_progress_bar()
2873
cleanups.append(pb.finished)
2875
cleanups.append(tree.unlock)
2876
if location is not None:
2878
mergeable = bundle.read_mergeable_from_url(location,
2879
possible_transports=possible_transports)
2880
except errors.NotABundle:
2884
raise errors.BzrCommandError('Cannot use --uncommitted'
2885
' with bundles or merge directives.')
2887
if revision is not None:
2888
raise errors.BzrCommandError(
2889
'Cannot use -r with merge directives or bundles')
2890
merger, verified = _mod_merge.Merger.from_mergeable(tree,
2893
if merger is None and uncommitted:
2894
if revision is not None and len(revision) > 0:
2895
raise errors.BzrCommandError('Cannot use --uncommitted and'
2896
' --revision at the same time.')
2897
location = self._select_branch_location(tree, location)[0]
2898
other_tree, other_path = WorkingTree.open_containing(location)
2899
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2901
allow_pending = False
2902
if other_path != '':
2903
merger.interesting_files = [other_path]
2906
merger, allow_pending = self._get_merger_from_branch(tree,
2907
location, revision, remember, possible_transports, pb)
2909
merger.merge_type = merge_type
2910
merger.reprocess = reprocess
2911
merger.show_base = show_base
2912
self.sanity_check_merger(merger)
2913
if (merger.base_rev_id == merger.other_rev_id and
2914
merger.other_rev_id is not None):
2915
note('Nothing to do.')
2918
if merger.interesting_files is not None:
2919
raise errors.BzrCommandError('Cannot pull individual files')
2920
if (merger.base_rev_id == tree.last_revision()):
2921
result = tree.pull(merger.other_branch, False,
2922
merger.other_rev_id)
2923
result.report(self.outf)
2925
merger.check_basis(not force)
2927
return self._do_preview(merger)
2929
return self._do_merge(merger, change_reporter, allow_pending,
2932
for cleanup in reversed(cleanups):
2935
def _do_preview(self, merger):
2936
from bzrlib.diff import show_diff_trees
2937
tree_merger = merger.make_merger()
2938
tt = tree_merger.make_preview_transform()
2940
result_tree = tt.get_preview_tree()
2941
show_diff_trees(merger.this_tree, result_tree, self.outf,
2942
old_label='', new_label='')
2946
def _do_merge(self, merger, change_reporter, allow_pending, verified):
2947
merger.change_reporter = change_reporter
2948
conflict_count = merger.do_merge()
2950
merger.set_pending()
2951
if verified == 'failed':
2952
warning('Preview patch does not match changes')
2953
if conflict_count != 0:
2958
def sanity_check_merger(self, merger):
2959
if (merger.show_base and
2960
not merger.merge_type is _mod_merge.Merge3Merger):
2961
raise errors.BzrCommandError("Show-base is not supported for this"
2962
" merge type. %s" % merger.merge_type)
2963
if merger.reprocess and not merger.merge_type.supports_reprocess:
2964
raise errors.BzrCommandError("Conflict reduction is not supported"
2965
" for merge type %s." %
2967
if merger.reprocess and merger.show_base:
2968
raise errors.BzrCommandError("Cannot do conflict reduction and"
2971
def _get_merger_from_branch(self, tree, location, revision, remember,
2972
possible_transports, pb):
2973
"""Produce a merger from a location, assuming it refers to a branch."""
2974
from bzrlib.tag import _merge_tags_if_possible
2975
# find the branch locations
2976
other_loc, user_location = self._select_branch_location(tree, location,
2978
if revision is not None and len(revision) == 2:
2979
base_loc, _unused = self._select_branch_location(tree,
2980
location, revision, 0)
2982
base_loc = other_loc
2984
other_branch, other_path = Branch.open_containing(other_loc,
2985
possible_transports)
2986
if base_loc == other_loc:
2987
base_branch = other_branch
2989
base_branch, base_path = Branch.open_containing(base_loc,
2990
possible_transports)
2991
# Find the revision ids
2992
if revision is None or len(revision) < 1 or revision[-1] is None:
2993
other_revision_id = _mod_revision.ensure_null(
2994
other_branch.last_revision())
2996
other_revision_id = revision[-1].as_revision_id(other_branch)
2997
if (revision is not None and len(revision) == 2
2998
and revision[0] is not None):
2999
base_revision_id = revision[0].as_revision_id(base_branch)
3001
base_revision_id = None
3002
# Remember where we merge from
3003
if ((remember or tree.branch.get_submit_branch() is None) and
3004
user_location is not None):
3005
tree.branch.set_submit_branch(other_branch.base)
3006
_merge_tags_if_possible(other_branch, tree.branch)
3007
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3008
other_revision_id, base_revision_id, other_branch, base_branch)
3009
if other_path != '':
3010
allow_pending = False
3011
merger.interesting_files = [other_path]
3013
allow_pending = True
3014
return merger, allow_pending
3016
def _select_branch_location(self, tree, user_location, revision=None,
3018
"""Select a branch location, according to possible inputs.
3020
If provided, branches from ``revision`` are preferred. (Both
3021
``revision`` and ``index`` must be supplied.)
3023
Otherwise, the ``location`` parameter is used. If it is None, then the
3024
``submit`` or ``parent`` location is used, and a note is printed.
3026
:param tree: The working tree to select a branch for merging into
3027
:param location: The location entered by the user
3028
:param revision: The revision parameter to the command
3029
:param index: The index to use for the revision parameter. Negative
3030
indices are permitted.
3031
:return: (selected_location, user_location). The default location
3032
will be the user-entered location.
3034
if (revision is not None and index is not None
3035
and revision[index] is not None):
3036
branch = revision[index].get_branch()
3037
if branch is not None:
3038
return branch, branch
3039
if user_location is None:
3040
location = self._get_remembered(tree, 'Merging from')
3042
location = user_location
3043
return location, user_location
3045
def _get_remembered(self, tree, verb_string):
3046
"""Use tree.branch's parent if none was supplied.
3048
Report if the remembered location was used.
3050
stored_location = tree.branch.get_submit_branch()
3051
if stored_location is None:
3052
stored_location = tree.branch.get_parent()
3053
mutter("%s", stored_location)
3054
if stored_location is None:
3055
raise errors.BzrCommandError("No location specified or remembered")
3056
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3057
note(u"%s remembered location %s", verb_string, display_url)
3058
return stored_location
3061
class cmd_remerge(Command):
3064
Use this if you want to try a different merge technique while resolving
3065
conflicts. Some merge techniques are better than others, and remerge
3066
lets you try different ones on different files.
3068
The options for remerge have the same meaning and defaults as the ones for
3069
merge. The difference is that remerge can (only) be run when there is a
3070
pending merge, and it lets you specify particular files.
3073
Re-do the merge of all conflicted files, and show the base text in
3074
conflict regions, in addition to the usual THIS and OTHER texts::
3076
bzr remerge --show-base
3078
Re-do the merge of "foobar", using the weave merge algorithm, with
3079
additional processing to reduce the size of conflict regions::
3081
bzr remerge --merge-type weave --reprocess foobar
3083
takes_args = ['file*']
3088
help="Show base revision text in conflicts."),
3091
def run(self, file_list=None, merge_type=None, show_base=False,
3093
if merge_type is None:
3094
merge_type = _mod_merge.Merge3Merger
3095
tree, file_list = tree_files(file_list)
3098
parents = tree.get_parent_ids()
3099
if len(parents) != 2:
3100
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3101
" merges. Not cherrypicking or"
3103
repository = tree.branch.repository
3104
interesting_ids = None
3106
conflicts = tree.conflicts()
3107
if file_list is not None:
3108
interesting_ids = set()
3109
for filename in file_list:
3110
file_id = tree.path2id(filename)
3112
raise errors.NotVersionedError(filename)
3113
interesting_ids.add(file_id)
3114
if tree.kind(file_id) != "directory":
3117
for name, ie in tree.inventory.iter_entries(file_id):
3118
interesting_ids.add(ie.file_id)
3119
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3121
# Remerge only supports resolving contents conflicts
3122
allowed_conflicts = ('text conflict', 'contents conflict')
3123
restore_files = [c.path for c in conflicts
3124
if c.typestring in allowed_conflicts]
3125
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3126
tree.set_conflicts(ConflictList(new_conflicts))
3127
if file_list is not None:
3128
restore_files = file_list
3129
for filename in restore_files:
3131
restore(tree.abspath(filename))
3132
except errors.NotConflicted:
3134
# Disable pending merges, because the file texts we are remerging
3135
# have not had those merges performed. If we use the wrong parents
3136
# list, we imply that the working tree text has seen and rejected
3137
# all the changes from the other tree, when in fact those changes
3138
# have not yet been seen.
3139
pb = ui.ui_factory.nested_progress_bar()
3140
tree.set_parent_ids(parents[:1])
3142
merger = _mod_merge.Merger.from_revision_ids(pb,
3144
merger.interesting_ids = interesting_ids
3145
merger.merge_type = merge_type
3146
merger.show_base = show_base
3147
merger.reprocess = reprocess
3148
conflicts = merger.do_merge()
3150
tree.set_parent_ids(parents)
3160
class cmd_revert(Command):
3161
"""Revert files to a previous revision.
3163
Giving a list of files will revert only those files. Otherwise, all files
3164
will be reverted. If the revision is not specified with '--revision', the
3165
last committed revision is used.
3167
To remove only some changes, without reverting to a prior version, use
3168
merge instead. For example, "merge . --revision -2..-3" will remove the
3169
changes introduced by -2, without affecting the changes introduced by -1.
3170
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3172
By default, any files that have been manually changed will be backed up
3173
first. (Files changed only by merge are not backed up.) Backup files have
3174
'.~#~' appended to their name, where # is a number.
3176
When you provide files, you can use their current pathname or the pathname
3177
from the target revision. So you can use revert to "undelete" a file by
3178
name. If you name a directory, all the contents of that directory will be
3181
Any files that have been newly added since that revision will be deleted,
3182
with a backup kept if appropriate. Directories containing unknown files
3183
will not be deleted.
3185
The working tree contains a list of pending merged revisions, which will
3186
be included as parents in the next commit. Normally, revert clears that
3187
list as well as reverting the files. If any files are specified, revert
3188
leaves the pending merge list alone and reverts only the files. Use "bzr
3189
revert ." in the tree root to revert all files but keep the merge record,
3190
and "bzr revert --forget-merges" to clear the pending merge list without
3191
reverting any files.
3194
_see_also = ['cat', 'export']
3197
Option('no-backup', "Do not save backups of reverted files."),
3198
Option('forget-merges',
3199
'Remove pending merge marker, without changing any files.'),
3201
takes_args = ['file*']
3203
def run(self, revision=None, no_backup=False, file_list=None,
3204
forget_merges=None):
3205
tree, file_list = tree_files(file_list)
3207
tree.set_parent_ids(tree.get_parent_ids()[:1])
3209
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3212
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3213
if revision is None:
3214
rev_id = tree.last_revision()
3215
elif len(revision) != 1:
3216
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3218
rev_id = revision[0].as_revision_id(tree.branch)
3219
pb = ui.ui_factory.nested_progress_bar()
3221
tree.revert(file_list,
3222
tree.branch.repository.revision_tree(rev_id),
3223
not no_backup, pb, report_changes=True)
3228
class cmd_assert_fail(Command):
3229
"""Test reporting of assertion failures"""
3230
# intended just for use in testing
3235
raise AssertionError("always fails")
3238
class cmd_help(Command):
3239
"""Show help on a command or other topic.
3242
_see_also = ['topics']
3244
Option('long', 'Show help on all commands.'),
3246
takes_args = ['topic?']
3247
aliases = ['?', '--help', '-?', '-h']
3250
def run(self, topic=None, long=False):
3252
if topic is None and long:
3254
bzrlib.help.help(topic)
3257
class cmd_shell_complete(Command):
3258
"""Show appropriate completions for context.
3260
For a list of all available commands, say 'bzr shell-complete'.
3262
takes_args = ['context?']
3267
def run(self, context=None):
3268
import shellcomplete
3269
shellcomplete.shellcomplete(context)
3272
class cmd_fetch(Command):
3273
"""Copy in history from another branch but don't merge it.
3275
This is an internal method used for pull and merge.
3278
takes_args = ['from_branch', 'to_branch']
3279
def run(self, from_branch, to_branch):
3280
from bzrlib.fetch import Fetcher
3281
from_b = Branch.open(from_branch)
3282
to_b = Branch.open(to_branch)
3283
Fetcher(to_b, from_b)
3286
class cmd_missing(Command):
3287
"""Show unmerged/unpulled revisions between two branches.
3289
OTHER_BRANCH may be local or remote.
3292
_see_also = ['merge', 'pull']
3293
takes_args = ['other_branch?']
3295
Option('reverse', 'Reverse the order of revisions.'),
3297
'Display changes in the local branch only.'),
3298
Option('this' , 'Same as --mine-only.'),
3299
Option('theirs-only',
3300
'Display changes in the remote branch only.'),
3301
Option('other', 'Same as --theirs-only.'),
3306
encoding_type = 'replace'
3309
def run(self, other_branch=None, reverse=False, mine_only=False,
3310
theirs_only=False, log_format=None, long=False, short=False, line=False,
3311
show_ids=False, verbose=False, this=False, other=False):
3312
from bzrlib.missing import find_unmerged, iter_log_revisions
3318
# TODO: We should probably check that we don't have mine-only and
3319
# theirs-only set, but it gets complicated because we also have
3320
# this and other which could be used.
3327
local_branch = Branch.open_containing(u".")[0]
3328
parent = local_branch.get_parent()
3329
if other_branch is None:
3330
other_branch = parent
3331
if other_branch is None:
3332
raise errors.BzrCommandError("No peer location known"
3334
display_url = urlutils.unescape_for_display(parent,
3336
self.outf.write("Using last location: " + display_url + "\n")
3338
remote_branch = Branch.open(other_branch)
3339
if remote_branch.base == local_branch.base:
3340
remote_branch = local_branch
3341
local_branch.lock_read()
3343
remote_branch.lock_read()
3345
local_extra, remote_extra = find_unmerged(
3346
local_branch, remote_branch, restrict)
3348
if log_format is None:
3349
registry = log.log_formatter_registry
3350
log_format = registry.get_default(local_branch)
3351
lf = log_format(to_file=self.outf,
3353
show_timezone='original')
3354
if reverse is False:
3355
if local_extra is not None:
3356
local_extra.reverse()
3357
if remote_extra is not None:
3358
remote_extra.reverse()
3361
if local_extra and not theirs_only:
3362
self.outf.write("You have %d extra revision(s):\n" %
3364
for revision in iter_log_revisions(local_extra,
3365
local_branch.repository,
3367
lf.log_revision(revision)
3368
printed_local = True
3371
printed_local = False
3373
if remote_extra and not mine_only:
3374
if printed_local is True:
3375
self.outf.write("\n\n\n")
3376
self.outf.write("You are missing %d revision(s):\n" %
3378
for revision in iter_log_revisions(remote_extra,
3379
remote_branch.repository,
3381
lf.log_revision(revision)
3384
if mine_only and not local_extra:
3385
# We checked local, and found nothing extra
3386
self.outf.write('This branch is up to date.\n')
3387
elif theirs_only and not remote_extra:
3388
# We checked remote, and found nothing extra
3389
self.outf.write('Other branch is up to date.\n')
3390
elif not (mine_only or theirs_only or local_extra or
3392
# We checked both branches, and neither one had extra
3394
self.outf.write("Branches are up to date.\n")
3396
remote_branch.unlock()
3398
local_branch.unlock()
3399
if not status_code and parent is None and other_branch is not None:
3400
local_branch.lock_write()
3402
# handle race conditions - a parent might be set while we run.
3403
if local_branch.get_parent() is None:
3404
local_branch.set_parent(remote_branch.base)
3406
local_branch.unlock()
3410
class cmd_pack(Command):
3411
"""Compress the data within a repository."""
3413
_see_also = ['repositories']
3414
takes_args = ['branch_or_repo?']
3416
def run(self, branch_or_repo='.'):
3417
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3419
branch = dir.open_branch()
3420
repository = branch.repository
3421
except errors.NotBranchError:
3422
repository = dir.open_repository()
3426
class cmd_plugins(Command):
3427
"""List the installed plugins.
3429
This command displays the list of installed plugins including
3430
version of plugin and a short description of each.
3432
--verbose shows the path where each plugin is located.
3434
A plugin is an external component for Bazaar that extends the
3435
revision control system, by adding or replacing code in Bazaar.
3436
Plugins can do a variety of things, including overriding commands,
3437
adding new commands, providing additional network transports and
3438
customizing log output.
3440
See the Bazaar web site, http://bazaar-vcs.org, for further
3441
information on plugins including where to find them and how to
3442
install them. Instructions are also provided there on how to
3443
write new plugins using the Python programming language.
3445
takes_options = ['verbose']
3448
def run(self, verbose=False):
3449
import bzrlib.plugin
3450
from inspect import getdoc
3452
for name, plugin in bzrlib.plugin.plugins().items():
3453
version = plugin.__version__
3454
if version == 'unknown':
3456
name_ver = '%s %s' % (name, version)
3457
d = getdoc(plugin.module)
3459
doc = d.split('\n')[0]
3461
doc = '(no description)'
3462
result.append((name_ver, doc, plugin.path()))
3463
for name_ver, doc, path in sorted(result):
3471
class cmd_testament(Command):
3472
"""Show testament (signing-form) of a revision."""
3475
Option('long', help='Produce long-format testament.'),
3477
help='Produce a strict-format testament.')]
3478
takes_args = ['branch?']
3480
def run(self, branch=u'.', revision=None, long=False, strict=False):
3481
from bzrlib.testament import Testament, StrictTestament
3483
testament_class = StrictTestament
3485
testament_class = Testament
3486
b = WorkingTree.open_containing(branch)[0].branch
3489
if revision is None:
3490
rev_id = b.last_revision()
3492
rev_id = revision[0].as_revision_id(b)
3493
t = testament_class.from_revision(b.repository, rev_id)
3495
sys.stdout.writelines(t.as_text_lines())
3497
sys.stdout.write(t.as_short_text())
3502
class cmd_annotate(Command):
3503
"""Show the origin of each line in a file.
3505
This prints out the given file with an annotation on the left side
3506
indicating which revision, author and date introduced the change.
3508
If the origin is the same for a run of consecutive lines, it is
3509
shown only at the top, unless the --all option is given.
3511
# TODO: annotate directories; showing when each file was last changed
3512
# TODO: if the working copy is modified, show annotations on that
3513
# with new uncommitted lines marked
3514
aliases = ['ann', 'blame', 'praise']
3515
takes_args = ['filename']
3516
takes_options = [Option('all', help='Show annotations on all lines.'),
3517
Option('long', help='Show commit date in annotations.'),
3521
encoding_type = 'exact'
3524
def run(self, filename, all=False, long=False, revision=None,
3526
from bzrlib.annotate import annotate_file
3527
wt, branch, relpath = \
3528
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3534
if revision is None:
3535
revision_id = branch.last_revision()
3536
elif len(revision) != 1:
3537
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3539
revision_id = revision[0].as_revision_id(branch)
3540
tree = branch.repository.revision_tree(revision_id)
3542
file_id = wt.path2id(relpath)
3544
file_id = tree.path2id(relpath)
3546
raise errors.NotVersionedError(filename)
3547
file_version = tree.inventory[file_id].revision
3548
annotate_file(branch, file_version, file_id, long, all, self.outf,
3557
class cmd_re_sign(Command):
3558
"""Create a digital signature for an existing revision."""
3559
# TODO be able to replace existing ones.
3561
hidden = True # is this right ?
3562
takes_args = ['revision_id*']
3563
takes_options = ['revision']
3565
def run(self, revision_id_list=None, revision=None):
3566
if revision_id_list is not None and revision is not None:
3567
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3568
if revision_id_list is None and revision is None:
3569
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3570
b = WorkingTree.open_containing(u'.')[0].branch
3573
return self._run(b, revision_id_list, revision)
3577
def _run(self, b, revision_id_list, revision):
3578
import bzrlib.gpg as gpg
3579
gpg_strategy = gpg.GPGStrategy(b.get_config())
3580
if revision_id_list is not None:
3581
b.repository.start_write_group()
3583
for revision_id in revision_id_list:
3584
b.repository.sign_revision(revision_id, gpg_strategy)
3586
b.repository.abort_write_group()
3589
b.repository.commit_write_group()
3590
elif revision is not None:
3591
if len(revision) == 1:
3592
revno, rev_id = revision[0].in_history(b)
3593
b.repository.start_write_group()
3595
b.repository.sign_revision(rev_id, gpg_strategy)
3597
b.repository.abort_write_group()
3600
b.repository.commit_write_group()
3601
elif len(revision) == 2:
3602
# are they both on rh- if so we can walk between them
3603
# might be nice to have a range helper for arbitrary
3604
# revision paths. hmm.
3605
from_revno, from_revid = revision[0].in_history(b)
3606
to_revno, to_revid = revision[1].in_history(b)
3607
if to_revid is None:
3608
to_revno = b.revno()
3609
if from_revno is None or to_revno is None:
3610
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3611
b.repository.start_write_group()
3613
for revno in range(from_revno, to_revno + 1):
3614
b.repository.sign_revision(b.get_rev_id(revno),
3617
b.repository.abort_write_group()
3620
b.repository.commit_write_group()
3622
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3625
class cmd_bind(Command):
3626
"""Convert the current branch into a checkout of the supplied branch.
3628
Once converted into a checkout, commits must succeed on the master branch
3629
before they will be applied to the local branch.
3632
_see_also = ['checkouts', 'unbind']
3633
takes_args = ['location?']
3636
def run(self, location=None):
3637
b, relpath = Branch.open_containing(u'.')
3638
if location is None:
3640
location = b.get_old_bound_location()
3641
except errors.UpgradeRequired:
3642
raise errors.BzrCommandError('No location supplied. '
3643
'This format does not remember old locations.')
3645
if location is None:
3646
raise errors.BzrCommandError('No location supplied and no '
3647
'previous location known')
3648
b_other = Branch.open(location)
3651
except errors.DivergedBranches:
3652
raise errors.BzrCommandError('These branches have diverged.'
3653
' Try merging, and then bind again.')
3656
class cmd_unbind(Command):
3657
"""Convert the current checkout into a regular branch.
3659
After unbinding, the local branch is considered independent and subsequent
3660
commits will be local only.
3663
_see_also = ['checkouts', 'bind']
3668
b, relpath = Branch.open_containing(u'.')
3670
raise errors.BzrCommandError('Local branch is not bound')
3673
class cmd_uncommit(Command):
3674
"""Remove the last committed revision.
3676
--verbose will print out what is being removed.
3677
--dry-run will go through all the motions, but not actually
3680
If --revision is specified, uncommit revisions to leave the branch at the
3681
specified revision. For example, "bzr uncommit -r 15" will leave the
3682
branch at revision 15.
3684
Uncommit leaves the working tree ready for a new commit. The only change
3685
it may make is to restore any pending merges that were present before
3689
# TODO: jam 20060108 Add an option to allow uncommit to remove
3690
# unreferenced information in 'branch-as-repository' branches.
3691
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3692
# information in shared branches as well.
3693
_see_also = ['commit']
3694
takes_options = ['verbose', 'revision',
3695
Option('dry-run', help='Don\'t actually make changes.'),
3696
Option('force', help='Say yes to all questions.'),
3698
help="Only remove the commits from the local branch"
3699
" when in a checkout."
3702
takes_args = ['location?']
3704
encoding_type = 'replace'
3706
def run(self, location=None,
3707
dry_run=False, verbose=False,
3708
revision=None, force=False, local=False):
3709
if location is None:
3711
control, relpath = bzrdir.BzrDir.open_containing(location)
3713
tree = control.open_workingtree()
3715
except (errors.NoWorkingTree, errors.NotLocalUrl):
3717
b = control.open_branch()
3719
if tree is not None:
3724
return self._run(b, tree, dry_run, verbose, revision, force,
3727
if tree is not None:
3732
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3733
from bzrlib.log import log_formatter, show_log
3734
from bzrlib.uncommit import uncommit
3736
last_revno, last_rev_id = b.last_revision_info()
3739
if revision is None:
3741
rev_id = last_rev_id
3743
# 'bzr uncommit -r 10' actually means uncommit
3744
# so that the final tree is at revno 10.
3745
# but bzrlib.uncommit.uncommit() actually uncommits
3746
# the revisions that are supplied.
3747
# So we need to offset it by one
3748
revno = revision[0].in_history(b).revno + 1
3749
if revno <= last_revno:
3750
rev_id = b.get_rev_id(revno)
3752
if rev_id is None or _mod_revision.is_null(rev_id):
3753
self.outf.write('No revisions to uncommit.\n')
3756
lf = log_formatter('short',
3758
show_timezone='original')
3763
direction='forward',
3764
start_revision=revno,
3765
end_revision=last_revno)
3768
print 'Dry-run, pretending to remove the above revisions.'
3770
val = raw_input('Press <enter> to continue')
3772
print 'The above revision(s) will be removed.'
3774
val = raw_input('Are you sure [y/N]? ')
3775
if val.lower() not in ('y', 'yes'):
3779
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3780
revno=revno, local=local)
3783
class cmd_break_lock(Command):
3784
"""Break a dead lock on a repository, branch or working directory.
3786
CAUTION: Locks should only be broken when you are sure that the process
3787
holding the lock has been stopped.
3789
You can get information on what locks are open via the 'bzr info' command.
3794
takes_args = ['location?']
3796
def run(self, location=None, show=False):
3797
if location is None:
3799
control, relpath = bzrdir.BzrDir.open_containing(location)
3801
control.break_lock()
3802
except NotImplementedError:
3806
class cmd_wait_until_signalled(Command):
3807
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3809
This just prints a line to signal when it is ready, then blocks on stdin.
3815
sys.stdout.write("running\n")
3817
sys.stdin.readline()
3820
class cmd_serve(Command):
3821
"""Run the bzr server."""
3823
aliases = ['server']
3827
help='Serve on stdin/out for use from inetd or sshd.'),
3829
help='Listen for connections on nominated port of the form '
3830
'[hostname:]portnumber. Passing 0 as the port number will '
3831
'result in a dynamically allocated port. The default port is '
3835
help='Serve contents of this directory.',
3837
Option('allow-writes',
3838
help='By default the server is a readonly server. Supplying '
3839
'--allow-writes enables write access to the contents of '
3840
'the served directory and below.'
3844
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3845
from bzrlib import lockdir
3846
from bzrlib.smart import medium, server
3847
from bzrlib.transport import get_transport
3848
from bzrlib.transport.chroot import ChrootServer
3849
if directory is None:
3850
directory = os.getcwd()
3851
url = urlutils.local_path_to_url(directory)
3852
if not allow_writes:
3853
url = 'readonly+' + url
3854
chroot_server = ChrootServer(get_transport(url))
3855
chroot_server.setUp()
3856
t = get_transport(chroot_server.get_url())
3858
smart_server = medium.SmartServerPipeStreamMedium(
3859
sys.stdin, sys.stdout, t)
3861
host = medium.BZR_DEFAULT_INTERFACE
3863
port = medium.BZR_DEFAULT_PORT
3866
host, port = port.split(':')
3868
smart_server = server.SmartTCPServer(t, host=host, port=port)
3869
print 'listening on port: ', smart_server.port
3871
# for the duration of this server, no UI output is permitted.
3872
# note that this may cause problems with blackbox tests. This should
3873
# be changed with care though, as we dont want to use bandwidth sending
3874
# progress over stderr to smart server clients!
3875
old_factory = ui.ui_factory
3876
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3878
ui.ui_factory = ui.SilentUIFactory()
3879
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3880
smart_server.serve()
3882
ui.ui_factory = old_factory
3883
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
3886
class cmd_join(Command):
3887
"""Combine a subtree into its containing tree.
3889
This command is for experimental use only. It requires the target tree
3890
to be in dirstate-with-subtree format, which cannot be converted into
3893
The TREE argument should be an independent tree, inside another tree, but
3894
not part of it. (Such trees can be produced by "bzr split", but also by
3895
running "bzr branch" with the target inside a tree.)
3897
The result is a combined tree, with the subtree no longer an independant
3898
part. This is marked as a merge of the subtree into the containing tree,
3899
and all history is preserved.
3901
If --reference is specified, the subtree retains its independence. It can
3902
be branched by itself, and can be part of multiple projects at the same
3903
time. But operations performed in the containing tree, such as commit
3904
and merge, will recurse into the subtree.
3907
_see_also = ['split']
3908
takes_args = ['tree']
3910
Option('reference', help='Join by reference.'),
3914
def run(self, tree, reference=False):
3915
sub_tree = WorkingTree.open(tree)
3916
parent_dir = osutils.dirname(sub_tree.basedir)
3917
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3918
repo = containing_tree.branch.repository
3919
if not repo.supports_rich_root():
3920
raise errors.BzrCommandError(
3921
"Can't join trees because %s doesn't support rich root data.\n"
3922
"You can use bzr upgrade on the repository."
3926
containing_tree.add_reference(sub_tree)
3927
except errors.BadReferenceTarget, e:
3928
# XXX: Would be better to just raise a nicely printable
3929
# exception from the real origin. Also below. mbp 20070306
3930
raise errors.BzrCommandError("Cannot join %s. %s" %
3934
containing_tree.subsume(sub_tree)
3935
except errors.BadSubsumeSource, e:
3936
raise errors.BzrCommandError("Cannot join %s. %s" %
3940
class cmd_split(Command):
3941
"""Split a subdirectory of a tree into a separate tree.
3943
This command will produce a target tree in a format that supports
3944
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
3945
converted into earlier formats like 'dirstate-tags'.
3947
The TREE argument should be a subdirectory of a working tree. That
3948
subdirectory will be converted into an independent tree, with its own
3949
branch. Commits in the top-level tree will not apply to the new subtree.
3952
# join is not un-hidden yet
3953
#_see_also = ['join']
3954
takes_args = ['tree']
3956
def run(self, tree):
3957
containing_tree, subdir = WorkingTree.open_containing(tree)
3958
sub_id = containing_tree.path2id(subdir)
3960
raise errors.NotVersionedError(subdir)
3962
containing_tree.extract(sub_id)
3963
except errors.RootNotRich:
3964
raise errors.UpgradeRequired(containing_tree.branch.base)
3967
class cmd_merge_directive(Command):
3968
"""Generate a merge directive for auto-merge tools.
3970
A directive requests a merge to be performed, and also provides all the
3971
information necessary to do so. This means it must either include a
3972
revision bundle, or the location of a branch containing the desired
3975
A submit branch (the location to merge into) must be supplied the first
3976
time the command is issued. After it has been supplied once, it will
3977
be remembered as the default.
3979
A public branch is optional if a revision bundle is supplied, but required
3980
if --diff or --plain is specified. It will be remembered as the default
3981
after the first use.
3984
takes_args = ['submit_branch?', 'public_branch?']
3988
_see_also = ['send']
3991
RegistryOption.from_kwargs('patch-type',
3992
'The type of patch to include in the directive.',
3994
value_switches=True,
3996
bundle='Bazaar revision bundle (default).',
3997
diff='Normal unified diff.',
3998
plain='No patch, just directive.'),
3999
Option('sign', help='GPG-sign the directive.'), 'revision',
4000
Option('mail-to', type=str,
4001
help='Instead of printing the directive, email to this address.'),
4002
Option('message', type=str, short_name='m',
4003
help='Message to use when committing this merge.')
4006
encoding_type = 'exact'
4008
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4009
sign=False, revision=None, mail_to=None, message=None):
4010
from bzrlib.revision import ensure_null, NULL_REVISION
4011
include_patch, include_bundle = {
4012
'plain': (False, False),
4013
'diff': (True, False),
4014
'bundle': (True, True),
4016
branch = Branch.open('.')
4017
stored_submit_branch = branch.get_submit_branch()
4018
if submit_branch is None:
4019
submit_branch = stored_submit_branch
4021
if stored_submit_branch is None:
4022
branch.set_submit_branch(submit_branch)
4023
if submit_branch is None:
4024
submit_branch = branch.get_parent()
4025
if submit_branch is None:
4026
raise errors.BzrCommandError('No submit branch specified or known')
4028
stored_public_branch = branch.get_public_branch()
4029
if public_branch is None:
4030
public_branch = stored_public_branch
4031
elif stored_public_branch is None:
4032
branch.set_public_branch(public_branch)
4033
if not include_bundle and public_branch is None:
4034
raise errors.BzrCommandError('No public branch specified or'
4036
base_revision_id = None
4037
if revision is not None:
4038
if len(revision) > 2:
4039
raise errors.BzrCommandError('bzr merge-directive takes '
4040
'at most two one revision identifiers')
4041
revision_id = revision[-1].as_revision_id(branch)
4042
if len(revision) == 2:
4043
base_revision_id = revision[0].as_revision_id(branch)
4045
revision_id = branch.last_revision()
4046
revision_id = ensure_null(revision_id)
4047
if revision_id == NULL_REVISION:
4048
raise errors.BzrCommandError('No revisions to bundle.')
4049
directive = merge_directive.MergeDirective2.from_objects(
4050
branch.repository, revision_id, time.time(),
4051
osutils.local_time_offset(), submit_branch,
4052
public_branch=public_branch, include_patch=include_patch,
4053
include_bundle=include_bundle, message=message,
4054
base_revision_id=base_revision_id)
4057
self.outf.write(directive.to_signed(branch))
4059
self.outf.writelines(directive.to_lines())
4061
message = directive.to_email(mail_to, branch, sign)
4062
s = SMTPConnection(branch.get_config())
4063
s.send_email(message)
4066
class cmd_send(Command):
4067
"""Mail or create a merge-directive for submiting changes.
4069
A merge directive provides many things needed for requesting merges:
4071
* A machine-readable description of the merge to perform
4073
* An optional patch that is a preview of the changes requested
4075
* An optional bundle of revision data, so that the changes can be applied
4076
directly from the merge directive, without retrieving data from a
4079
If --no-bundle is specified, then public_branch is needed (and must be
4080
up-to-date), so that the receiver can perform the merge using the
4081
public_branch. The public_branch is always included if known, so that
4082
people can check it later.
4084
The submit branch defaults to the parent, but can be overridden. Both
4085
submit branch and public branch will be remembered if supplied.
4087
If a public_branch is known for the submit_branch, that public submit
4088
branch is used in the merge instructions. This means that a local mirror
4089
can be used as your actual submit branch, once you have set public_branch
4092
Mail is sent using your preferred mail program. This should be transparent
4093
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4094
If the preferred client can't be found (or used), your editor will be used.
4096
To use a specific mail program, set the mail_client configuration option.
4097
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4098
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4099
generic options are "default", "editor", "mapi", and "xdg-email".
4101
If mail is being sent, a to address is required. This can be supplied
4102
either on the commandline, by setting the submit_to configuration
4103
option in the branch itself or the child_submit_to configuration option
4104
in the submit branch.
4106
Two formats are currently supported: "4" uses revision bundle format 4 and
4107
merge directive format 2. It is significantly faster and smaller than
4108
older formats. It is compatible with Bazaar 0.19 and later. It is the
4109
default. "0.9" uses revision bundle format 0.9 and merge directive
4110
format 1. It is compatible with Bazaar 0.12 - 0.18.
4112
Merge directives are applied using the merge command or the pull command.
4115
encoding_type = 'exact'
4117
_see_also = ['merge', 'pull']
4119
takes_args = ['submit_branch?', 'public_branch?']
4123
help='Do not include a bundle in the merge directive.'),
4124
Option('no-patch', help='Do not include a preview patch in the merge'
4127
help='Remember submit and public branch.'),
4129
help='Branch to generate the submission from, '
4130
'rather than the one containing the working directory.',
4133
Option('output', short_name='o',
4134
help='Write merge directive to this file; '
4135
'use - for stdout.',
4137
Option('mail-to', help='Mail the request to this address.',
4141
RegistryOption.from_kwargs('format',
4142
'Use the specified output format.',
4143
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4144
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4147
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4148
no_patch=False, revision=None, remember=False, output=None,
4149
format='4', mail_to=None, message=None, **kwargs):
4150
return self._run(submit_branch, revision, public_branch, remember,
4151
format, no_bundle, no_patch, output,
4152
kwargs.get('from', '.'), mail_to, message)
4154
def _run(self, submit_branch, revision, public_branch, remember, format,
4155
no_bundle, no_patch, output, from_, mail_to, message):
4156
from bzrlib.revision import NULL_REVISION
4157
branch = Branch.open_containing(from_)[0]
4159
outfile = StringIO()
4163
outfile = open(output, 'wb')
4164
# we may need to write data into branch's repository to calculate
4169
config = branch.get_config()
4171
mail_to = config.get_user_option('submit_to')
4172
mail_client = config.get_mail_client()
4173
if remember and submit_branch is None:
4174
raise errors.BzrCommandError(
4175
'--remember requires a branch to be specified.')
4176
stored_submit_branch = branch.get_submit_branch()
4177
remembered_submit_branch = False
4178
if submit_branch is None:
4179
submit_branch = stored_submit_branch
4180
remembered_submit_branch = True
4182
if stored_submit_branch is None or remember:
4183
branch.set_submit_branch(submit_branch)
4184
if submit_branch is None:
4185
submit_branch = branch.get_parent()
4186
remembered_submit_branch = True
4187
if submit_branch is None:
4188
raise errors.BzrCommandError('No submit branch known or'
4190
if remembered_submit_branch:
4191
note('Using saved location: %s', submit_branch)
4194
submit_config = Branch.open(submit_branch).get_config()
4195
mail_to = submit_config.get_user_option("child_submit_to")
4197
stored_public_branch = branch.get_public_branch()
4198
if public_branch is None:
4199
public_branch = stored_public_branch
4200
elif stored_public_branch is None or remember:
4201
branch.set_public_branch(public_branch)
4202
if no_bundle and public_branch is None:
4203
raise errors.BzrCommandError('No public branch specified or'
4205
base_revision_id = None
4207
if revision is not None:
4208
if len(revision) > 2:
4209
raise errors.BzrCommandError('bzr send takes '
4210
'at most two one revision identifiers')
4211
revision_id = revision[-1].as_revision_id(branch)
4212
if len(revision) == 2:
4213
base_revision_id = revision[0].as_revision_id(branch)
4214
if revision_id is None:
4215
revision_id = branch.last_revision()
4216
if revision_id == NULL_REVISION:
4217
raise errors.BzrCommandError('No revisions to submit.')
4219
directive = merge_directive.MergeDirective2.from_objects(
4220
branch.repository, revision_id, time.time(),
4221
osutils.local_time_offset(), submit_branch,
4222
public_branch=public_branch, include_patch=not no_patch,
4223
include_bundle=not no_bundle, message=message,
4224
base_revision_id=base_revision_id)
4225
elif format == '0.9':
4228
patch_type = 'bundle'
4230
raise errors.BzrCommandError('Format 0.9 does not'
4231
' permit bundle with no patch')
4237
directive = merge_directive.MergeDirective.from_objects(
4238
branch.repository, revision_id, time.time(),
4239
osutils.local_time_offset(), submit_branch,
4240
public_branch=public_branch, patch_type=patch_type,
4243
outfile.writelines(directive.to_lines())
4245
subject = '[MERGE] '
4246
if message is not None:
4249
revision = branch.repository.get_revision(revision_id)
4250
subject += revision.get_summary()
4251
basename = directive.get_disk_name(branch)
4252
mail_client.compose_merge_request(mail_to, subject,
4253
outfile.getvalue(), basename)
4260
class cmd_bundle_revisions(cmd_send):
4262
"""Create a merge-directive for submiting changes.
4264
A merge directive provides many things needed for requesting merges:
4266
* A machine-readable description of the merge to perform
4268
* An optional patch that is a preview of the changes requested
4270
* An optional bundle of revision data, so that the changes can be applied
4271
directly from the merge directive, without retrieving data from a
4274
If --no-bundle is specified, then public_branch is needed (and must be
4275
up-to-date), so that the receiver can perform the merge using the
4276
public_branch. The public_branch is always included if known, so that
4277
people can check it later.
4279
The submit branch defaults to the parent, but can be overridden. Both
4280
submit branch and public branch will be remembered if supplied.
4282
If a public_branch is known for the submit_branch, that public submit
4283
branch is used in the merge instructions. This means that a local mirror
4284
can be used as your actual submit branch, once you have set public_branch
4287
Two formats are currently supported: "4" uses revision bundle format 4 and
4288
merge directive format 2. It is significantly faster and smaller than
4289
older formats. It is compatible with Bazaar 0.19 and later. It is the
4290
default. "0.9" uses revision bundle format 0.9 and merge directive
4291
format 1. It is compatible with Bazaar 0.12 - 0.18.
4296
help='Do not include a bundle in the merge directive.'),
4297
Option('no-patch', help='Do not include a preview patch in the merge'
4300
help='Remember submit and public branch.'),
4302
help='Branch to generate the submission from, '
4303
'rather than the one containing the working directory.',
4306
Option('output', short_name='o', help='Write directive to this file.',
4309
RegistryOption.from_kwargs('format',
4310
'Use the specified output format.',
4311
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4312
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4314
aliases = ['bundle']
4316
_see_also = ['send', 'merge']
4320
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4321
no_patch=False, revision=None, remember=False, output=None,
4322
format='4', **kwargs):
4325
return self._run(submit_branch, revision, public_branch, remember,
4326
format, no_bundle, no_patch, output,
4327
kwargs.get('from', '.'), None, None)
4330
class cmd_tag(Command):
4331
"""Create, remove or modify a tag naming a revision.
4333
Tags give human-meaningful names to revisions. Commands that take a -r
4334
(--revision) option can be given -rtag:X, where X is any previously
4337
Tags are stored in the branch. Tags are copied from one branch to another
4338
along when you branch, push, pull or merge.
4340
It is an error to give a tag name that already exists unless you pass
4341
--force, in which case the tag is moved to point to the new revision.
4344
_see_also = ['commit', 'tags']
4345
takes_args = ['tag_name']
4348
help='Delete this tag rather than placing it.',
4351
help='Branch in which to place the tag.',
4356
help='Replace existing tags.',
4361
def run(self, tag_name,
4367
branch, relpath = Branch.open_containing(directory)
4371
branch.tags.delete_tag(tag_name)
4372
self.outf.write('Deleted tag %s.\n' % tag_name)
4375
if len(revision) != 1:
4376
raise errors.BzrCommandError(
4377
"Tags can only be placed on a single revision, "
4379
revision_id = revision[0].as_revision_id(branch)
4381
revision_id = branch.last_revision()
4382
if (not force) and branch.tags.has_tag(tag_name):
4383
raise errors.TagAlreadyExists(tag_name)
4384
branch.tags.set_tag(tag_name, revision_id)
4385
self.outf.write('Created tag %s.\n' % tag_name)
4390
class cmd_tags(Command):
4393
This command shows a table of tag names and the revisions they reference.
4399
help='Branch whose tags should be displayed.',
4403
RegistryOption.from_kwargs('sort',
4404
'Sort tags by different criteria.', title='Sorting',
4405
alpha='Sort tags lexicographically (default).',
4406
time='Sort tags chronologically.',
4417
branch, relpath = Branch.open_containing(directory)
4418
tags = branch.tags.get_tag_dict().items()
4421
elif sort == 'time':
4423
for tag, revid in tags:
4425
revobj = branch.repository.get_revision(revid)
4426
except errors.NoSuchRevision:
4427
timestamp = sys.maxint # place them at the end
4429
timestamp = revobj.timestamp
4430
timestamps[revid] = timestamp
4431
tags.sort(key=lambda x: timestamps[x[1]])
4433
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4434
revno_map = branch.get_revision_id_to_revno_map()
4435
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4436
for tag, revid in tags ]
4437
for tag, revspec in tags:
4438
self.outf.write('%-20s %s\n' % (tag, revspec))
4441
class cmd_reconfigure(Command):
4442
"""Reconfigure the type of a bzr directory.
4444
A target configuration must be specified.
4446
For checkouts, the bind-to location will be auto-detected if not specified.
4447
The order of preference is
4448
1. For a lightweight checkout, the current bound location.
4449
2. For branches that used to be checkouts, the previously-bound location.
4450
3. The push location.
4451
4. The parent location.
4452
If none of these is available, --bind-to must be specified.
4455
takes_args = ['location?']
4456
takes_options = [RegistryOption.from_kwargs('target_type',
4457
title='Target type',
4458
help='The type to reconfigure the directory to.',
4459
value_switches=True, enum_switch=False,
4460
branch='Reconfigure to a branch.',
4461
tree='Reconfigure to a tree.',
4462
checkout='Reconfigure to a checkout.',
4463
lightweight_checkout='Reconfigure to a lightweight'
4465
standalone='Reconfigure to be standalone.',
4466
use_shared='Reconfigure to use a shared repository.'),
4467
Option('bind-to', help='Branch to bind checkout to.',
4470
help='Perform reconfiguration even if local changes'
4474
def run(self, location=None, target_type=None, bind_to=None, force=False):
4475
directory = bzrdir.BzrDir.open(location)
4476
if target_type is None:
4477
raise errors.BzrCommandError('No target configuration specified')
4478
elif target_type == 'branch':
4479
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4480
elif target_type == 'tree':
4481
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4482
elif target_type == 'checkout':
4483
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4485
elif target_type == 'lightweight-checkout':
4486
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4488
elif target_type == 'use-shared':
4489
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4490
elif target_type == 'standalone':
4491
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4492
reconfiguration.apply(force)
4495
class cmd_switch(Command):
4496
"""Set the branch of a checkout and update.
4498
For lightweight checkouts, this changes the branch being referenced.
4499
For heavyweight checkouts, this checks that there are no local commits
4500
versus the current bound branch, then it makes the local branch a mirror
4501
of the new location and binds to it.
4503
In both cases, the working tree is updated and uncommitted changes
4504
are merged. The user can commit or revert these as they desire.
4506
Pending merges need to be committed or reverted before using switch.
4508
The path to the branch to switch to can be specified relative to the parent
4509
directory of the current branch. For example, if you are currently in a
4510
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4514
takes_args = ['to_location']
4515
takes_options = [Option('force',
4516
help='Switch even if local commits will be lost.')
4519
def run(self, to_location, force=False):
4520
from bzrlib import switch
4522
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4524
to_branch = Branch.open(to_location)
4525
except errors.NotBranchError:
4526
to_branch = Branch.open(
4527
control_dir.open_branch().base + '../' + to_location)
4528
switch.switch(control_dir, to_branch, force)
4529
note('Switched to branch: %s',
4530
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4533
class cmd_hooks(Command):
4534
"""Show a branch's currently registered hooks.
4538
takes_args = ['path?']
4540
def run(self, path=None):
4543
branch_hooks = Branch.open(path).hooks
4544
for hook_type in branch_hooks:
4545
hooks = branch_hooks[hook_type]
4546
self.outf.write("%s:\n" % (hook_type,))
4549
self.outf.write(" %s\n" %
4550
(branch_hooks.get_hook_name(hook),))
4552
self.outf.write(" <no hooks installed>\n")
4555
def _create_prefix(cur_transport):
4556
needed = [cur_transport]
4557
# Recurse upwards until we can create a directory successfully
4559
new_transport = cur_transport.clone('..')
4560
if new_transport.base == cur_transport.base:
4561
raise errors.BzrCommandError(
4562
"Failed to create path prefix for %s."
4563
% cur_transport.base)
4565
new_transport.mkdir('.')
4566
except errors.NoSuchFile:
4567
needed.append(new_transport)
4568
cur_transport = new_transport
4571
# Now we only need to create child directories
4573
cur_transport = needed.pop()
4574
cur_transport.ensure_base()
4577
# these get imported and then picked up by the scan for cmd_*
4578
# TODO: Some more consistent way to split command definitions across files;
4579
# we do need to load at least some information about them to know of
4580
# aliases. ideally we would avoid loading the implementation until the
4581
# details were needed.
4582
from bzrlib.cmd_version_info import cmd_version_info
4583
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4584
from bzrlib.bundle.commands import (
4587
from bzrlib.sign_my_commits import cmd_sign_my_commits
4588
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4589
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
