1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
43
revision as _mod_revision,
51
from bzrlib.branch import Branch
52
from bzrlib.conflicts import ConflictList
53
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
54
from bzrlib.smtp_connection import SMTPConnection
55
from bzrlib.workingtree import WorkingTree
58
from bzrlib.commands import Command, display_command
59
from bzrlib.option import (
66
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
69
def tree_files(file_list, default_branch=u'.', canonicalize=True,
72
return internal_tree_files(file_list, default_branch, canonicalize,
74
except errors.FileInWrongBranch, e:
75
raise errors.BzrCommandError("%s is not in the same branch as %s" %
76
(e.path, file_list[0]))
79
def tree_files_for_add(file_list):
80
"""Add handles files a bit differently so it a custom implementation."""
82
tree = WorkingTree.open_containing(file_list[0])[0]
83
if tree.supports_views():
84
view_files = tree.views.lookup_view()
85
for filename in file_list:
86
if not osutils.is_inside_any(view_files, filename):
87
raise errors.FileOutsideView(filename, view_files)
89
tree = WorkingTree.open_containing(u'.')[0]
90
if tree.supports_views():
91
view_files = tree.views.lookup_view()
93
file_list = view_files
94
view_str = views.view_display_str(view_files)
95
note("ignoring files outside view: %s" % view_str)
96
return tree, file_list
99
def _get_one_revision(command_name, revisions):
100
if revisions is None:
102
if len(revisions) != 1:
103
raise errors.BzrCommandError(
104
'bzr %s --revision takes exactly one revision identifier' % (
109
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
112
if revisions is None:
114
rev_tree = tree.basis_tree()
116
rev_tree = branch.basis_tree()
118
revision = _get_one_revision(command_name, revisions)
119
rev_tree = revision.as_tree(branch)
123
# XXX: Bad function name; should possibly also be a class method of
124
# WorkingTree rather than a function.
125
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
127
"""Convert command-line paths to a WorkingTree and relative paths.
129
This is typically used for command-line processors that take one or
130
more filenames, and infer the workingtree that contains them.
132
The filenames given are not required to exist.
134
:param file_list: Filenames to convert.
136
:param default_branch: Fallback tree path to use if file_list is empty or
139
:param apply_view: if True and a view is set, apply it or check that
140
specified files are within it
142
:return: workingtree, [relative_paths]
144
if file_list is None or len(file_list) == 0:
145
tree = WorkingTree.open_containing(default_branch)[0]
146
if tree.supports_views() and apply_view:
147
view_files = tree.views.lookup_view()
149
file_list = view_files
150
view_str = views.view_display_str(view_files)
151
note("ignoring files outside view: %s" % view_str)
152
return tree, file_list
153
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
154
return tree, safe_relpath_files(tree, file_list, canonicalize,
155
apply_view=apply_view)
158
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
159
"""Convert file_list into a list of relpaths in tree.
161
:param tree: A tree to operate on.
162
:param file_list: A list of user provided paths or None.
163
:param apply_view: if True and a view is set, apply it or check that
164
specified files are within it
165
:return: A list of relative paths.
166
:raises errors.PathNotChild: When a provided path is in a different tree
169
if file_list is None:
171
if tree.supports_views() and apply_view:
172
view_files = tree.views.lookup_view()
176
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
177
# doesn't - fix that up here before we enter the loop.
179
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
182
for filename in file_list:
184
relpath = fixer(osutils.dereference_path(filename))
185
if view_files and not osutils.is_inside_any(view_files, relpath):
186
raise errors.FileOutsideView(filename, view_files)
187
new_list.append(relpath)
188
except errors.PathNotChild:
189
raise errors.FileInWrongBranch(tree.branch, filename)
193
def _get_view_info_for_change_reporter(tree):
194
"""Get the view information from a tree for change reporting."""
197
current_view = tree.views.get_view_info()[0]
198
if current_view is not None:
199
view_info = (current_view, tree.views.lookup_view())
200
except errors.ViewsNotSupported:
205
# TODO: Make sure no commands unconditionally use the working directory as a
206
# branch. If a filename argument is used, the first of them should be used to
207
# specify the branch. (Perhaps this can be factored out into some kind of
208
# Argument class, representing a file in a branch, where the first occurrence
211
class cmd_status(Command):
212
"""Display status summary.
214
This reports on versioned and unknown files, reporting them
215
grouped by state. Possible states are:
218
Versioned in the working copy but not in the previous revision.
221
Versioned in the previous revision but removed or deleted
225
Path of this file changed from the previous revision;
226
the text may also have changed. This includes files whose
227
parent directory was renamed.
230
Text has changed since the previous revision.
233
File kind has been changed (e.g. from file to directory).
236
Not versioned and not matching an ignore pattern.
238
To see ignored files use 'bzr ignored'. For details on the
239
changes to file texts, use 'bzr diff'.
241
Note that --short or -S gives status flags for each item, similar
242
to Subversion's status command. To get output similar to svn -q,
245
If no arguments are specified, the status of the entire working
246
directory is shown. Otherwise, only the status of the specified
247
files or directories is reported. If a directory is given, status
248
is reported for everything inside that directory.
250
Before merges are committed, the pending merge tip revisions are
251
shown. To see all pending merge revisions, use the -v option.
252
To skip the display of pending merge information altogether, use
253
the no-pending option or specify a file/directory.
255
If a revision argument is given, the status is calculated against
256
that revision, or between two revisions if two are provided.
259
# TODO: --no-recurse, --recurse options
261
takes_args = ['file*']
262
takes_options = ['show-ids', 'revision', 'change', 'verbose',
263
Option('short', help='Use short status indicators.',
265
Option('versioned', help='Only show versioned files.',
267
Option('no-pending', help='Don\'t show pending merges.',
270
aliases = ['st', 'stat']
272
encoding_type = 'replace'
273
_see_also = ['diff', 'revert', 'status-flags']
276
def run(self, show_ids=False, file_list=None, revision=None, short=False,
277
versioned=False, no_pending=False, verbose=False):
278
from bzrlib.status import show_tree_status
280
if revision and len(revision) > 2:
281
raise errors.BzrCommandError('bzr status --revision takes exactly'
282
' one or two revision specifiers')
284
tree, relfile_list = tree_files(file_list)
285
# Avoid asking for specific files when that is not needed.
286
if relfile_list == ['']:
288
# Don't disable pending merges for full trees other than '.'.
289
if file_list == ['.']:
291
# A specific path within a tree was given.
292
elif relfile_list is not None:
294
show_tree_status(tree, show_ids=show_ids,
295
specific_files=relfile_list, revision=revision,
296
to_file=self.outf, short=short, versioned=versioned,
297
show_pending=(not no_pending), verbose=verbose)
300
class cmd_cat_revision(Command):
301
"""Write out metadata for a revision.
303
The revision to print can either be specified by a specific
304
revision identifier, or you can use --revision.
308
takes_args = ['revision_id?']
309
takes_options = ['revision']
310
# cat-revision is more for frontends so should be exact
314
def run(self, revision_id=None, revision=None):
315
if revision_id is not None and revision is not None:
316
raise errors.BzrCommandError('You can only supply one of'
317
' revision_id or --revision')
318
if revision_id is None and revision is None:
319
raise errors.BzrCommandError('You must supply either'
320
' --revision or a revision_id')
321
b = WorkingTree.open_containing(u'.')[0].branch
323
# TODO: jam 20060112 should cat-revision always output utf-8?
324
if revision_id is not None:
325
revision_id = osutils.safe_revision_id(revision_id, warn=False)
327
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
328
except errors.NoSuchRevision:
329
msg = "The repository %s contains no revision %s." % (b.repository.base,
331
raise errors.BzrCommandError(msg)
332
elif revision is not None:
335
raise errors.BzrCommandError('You cannot specify a NULL'
337
rev_id = rev.as_revision_id(b)
338
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
341
class cmd_dump_btree(Command):
342
"""Dump the contents of a btree index file to stdout.
344
PATH is a btree index file, it can be any URL. This includes things like
345
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
347
By default, the tuples stored in the index file will be displayed. With
348
--raw, we will uncompress the pages, but otherwise display the raw bytes
352
# TODO: Do we want to dump the internal nodes as well?
353
# TODO: It would be nice to be able to dump the un-parsed information,
354
# rather than only going through iter_all_entries. However, this is
355
# good enough for a start
357
encoding_type = 'exact'
358
takes_args = ['path']
359
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
360
' rather than the parsed tuples.'),
363
def run(self, path, raw=False):
364
dirname, basename = osutils.split(path)
365
t = transport.get_transport(dirname)
367
self._dump_raw_bytes(t, basename)
369
self._dump_entries(t, basename)
371
def _get_index_and_bytes(self, trans, basename):
372
"""Create a BTreeGraphIndex and raw bytes."""
373
bt = btree_index.BTreeGraphIndex(trans, basename, None)
374
bytes = trans.get_bytes(basename)
375
bt._file = cStringIO.StringIO(bytes)
376
bt._size = len(bytes)
379
def _dump_raw_bytes(self, trans, basename):
382
# We need to parse at least the root node.
383
# This is because the first page of every row starts with an
384
# uncompressed header.
385
bt, bytes = self._get_index_and_bytes(trans, basename)
386
for page_idx, page_start in enumerate(xrange(0, len(bytes),
387
btree_index._PAGE_SIZE)):
388
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
389
page_bytes = bytes[page_start:page_end]
391
self.outf.write('Root node:\n')
392
header_end, data = bt._parse_header_from_bytes(page_bytes)
393
self.outf.write(page_bytes[:header_end])
395
self.outf.write('\nPage %d\n' % (page_idx,))
396
decomp_bytes = zlib.decompress(page_bytes)
397
self.outf.write(decomp_bytes)
398
self.outf.write('\n')
400
def _dump_entries(self, trans, basename):
402
st = trans.stat(basename)
403
except errors.TransportNotPossible:
404
# We can't stat, so we'll fake it because we have to do the 'get()'
406
bt, _ = self._get_index_and_bytes(trans, basename)
408
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
409
for node in bt.iter_all_entries():
410
# Node is made up of:
411
# (index, key, value, [references])
412
self.outf.write('%s\n' % (node[1:],))
415
class cmd_remove_tree(Command):
416
"""Remove the working tree from a given branch/checkout.
418
Since a lightweight checkout is little more than a working tree
419
this will refuse to run against one.
421
To re-create the working tree, use "bzr checkout".
423
_see_also = ['checkout', 'working-trees']
424
takes_args = ['location?']
427
help='Remove the working tree even if it has '
428
'uncommitted changes.'),
431
def run(self, location='.', force=False):
432
d = bzrdir.BzrDir.open(location)
435
working = d.open_workingtree()
436
except errors.NoWorkingTree:
437
raise errors.BzrCommandError("No working tree to remove")
438
except errors.NotLocalUrl:
439
raise errors.BzrCommandError("You cannot remove the working tree of a "
442
changes = working.changes_from(working.basis_tree())
443
if changes.has_changed():
444
raise errors.UncommittedChanges(working)
446
working_path = working.bzrdir.root_transport.base
447
branch_path = working.branch.bzrdir.root_transport.base
448
if working_path != branch_path:
449
raise errors.BzrCommandError("You cannot remove the working tree from "
450
"a lightweight checkout")
452
d.destroy_workingtree()
455
class cmd_revno(Command):
456
"""Show current revision number.
458
This is equal to the number of revisions on this branch.
462
takes_args = ['location?']
465
def run(self, location=u'.'):
466
self.outf.write(str(Branch.open_containing(location)[0].revno()))
467
self.outf.write('\n')
470
class cmd_revision_info(Command):
471
"""Show revision number and revision id for a given revision identifier.
474
takes_args = ['revision_info*']
478
help='Branch to examine, '
479
'rather than the one containing the working directory.',
486
def run(self, revision=None, directory=u'.', revision_info_list=[]):
489
if revision is not None:
490
revs.extend(revision)
491
if revision_info_list is not None:
492
for rev in revision_info_list:
493
revs.append(RevisionSpec.from_string(rev))
495
b = Branch.open_containing(directory)[0]
498
revs.append(RevisionSpec.from_string('-1'))
501
revision_id = rev.as_revision_id(b)
503
revno = '%4d' % (b.revision_id_to_revno(revision_id))
504
except errors.NoSuchRevision:
505
dotted_map = b.get_revision_id_to_revno_map()
506
revno = '.'.join(str(i) for i in dotted_map[revision_id])
507
print '%s %s' % (revno, revision_id)
510
class cmd_add(Command):
511
"""Add specified files or directories.
513
In non-recursive mode, all the named items are added, regardless
514
of whether they were previously ignored. A warning is given if
515
any of the named files are already versioned.
517
In recursive mode (the default), files are treated the same way
518
but the behaviour for directories is different. Directories that
519
are already versioned do not give a warning. All directories,
520
whether already versioned or not, are searched for files or
521
subdirectories that are neither versioned or ignored, and these
522
are added. This search proceeds recursively into versioned
523
directories. If no names are given '.' is assumed.
525
Therefore simply saying 'bzr add' will version all files that
526
are currently unknown.
528
Adding a file whose parent directory is not versioned will
529
implicitly add the parent, and so on up to the root. This means
530
you should never need to explicitly add a directory, they'll just
531
get added when you add a file in the directory.
533
--dry-run will show which files would be added, but not actually
536
--file-ids-from will try to use the file ids from the supplied path.
537
It looks up ids trying to find a matching parent directory with the
538
same filename, and then by pure path. This option is rarely needed
539
but can be useful when adding the same logical file into two
540
branches that will be merged later (without showing the two different
541
adds as a conflict). It is also useful when merging another project
542
into a subdirectory of this one.
544
takes_args = ['file*']
547
help="Don't recursively add the contents of directories."),
549
help="Show what would be done, but don't actually do anything."),
551
Option('file-ids-from',
553
help='Lookup file ids from this tree.'),
555
encoding_type = 'replace'
556
_see_also = ['remove']
558
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
563
if file_ids_from is not None:
565
base_tree, base_path = WorkingTree.open_containing(
567
except errors.NoWorkingTree:
568
base_branch, base_path = Branch.open_containing(
570
base_tree = base_branch.basis_tree()
572
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
573
to_file=self.outf, should_print=(not is_quiet()))
575
action = bzrlib.add.AddAction(to_file=self.outf,
576
should_print=(not is_quiet()))
579
base_tree.lock_read()
581
file_list = self._maybe_expand_globs(file_list)
582
tree, file_list = tree_files_for_add(file_list)
583
added, ignored = tree.smart_add(file_list, not
584
no_recurse, action=action, save=not dry_run)
586
if base_tree is not None:
590
for glob in sorted(ignored.keys()):
591
for path in ignored[glob]:
592
self.outf.write("ignored %s matching \"%s\"\n"
596
for glob, paths in ignored.items():
597
match_len += len(paths)
598
self.outf.write("ignored %d file(s).\n" % match_len)
599
self.outf.write("If you wish to add some of these files,"
600
" please add them by name.\n")
603
class cmd_mkdir(Command):
604
"""Create a new versioned directory.
606
This is equivalent to creating the directory and then adding it.
609
takes_args = ['dir+']
610
encoding_type = 'replace'
612
def run(self, dir_list):
615
wt, dd = WorkingTree.open_containing(d)
617
self.outf.write('added %s\n' % d)
620
class cmd_relpath(Command):
621
"""Show path of a file relative to root"""
623
takes_args = ['filename']
627
def run(self, filename):
628
# TODO: jam 20050106 Can relpath return a munged path if
629
# sys.stdout encoding cannot represent it?
630
tree, relpath = WorkingTree.open_containing(filename)
631
self.outf.write(relpath)
632
self.outf.write('\n')
635
class cmd_inventory(Command):
636
"""Show inventory of the current working copy or a revision.
638
It is possible to limit the output to a particular entry
639
type using the --kind option. For example: --kind file.
641
It is also possible to restrict the list of files to a specific
642
set. For example: bzr inventory --show-ids this/file
651
help='List entries of a particular kind: file, directory, symlink.',
654
takes_args = ['file*']
657
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
658
if kind and kind not in ['file', 'directory', 'symlink']:
659
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
661
revision = _get_one_revision('inventory', revision)
662
work_tree, file_list = tree_files(file_list)
663
work_tree.lock_read()
665
if revision is not None:
666
tree = revision.as_tree(work_tree.branch)
668
extra_trees = [work_tree]
674
if file_list is not None:
675
file_ids = tree.paths2ids(file_list, trees=extra_trees,
676
require_versioned=True)
677
# find_ids_across_trees may include some paths that don't
679
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
680
for file_id in file_ids if file_id in tree)
682
entries = tree.inventory.entries()
685
if tree is not work_tree:
688
for path, entry in entries:
689
if kind and kind != entry.kind:
692
self.outf.write('%-50s %s\n' % (path, entry.file_id))
694
self.outf.write(path)
695
self.outf.write('\n')
698
class cmd_mv(Command):
699
"""Move or rename a file.
702
bzr mv OLDNAME NEWNAME
704
bzr mv SOURCE... DESTINATION
706
If the last argument is a versioned directory, all the other names
707
are moved into it. Otherwise, there must be exactly two arguments
708
and the file is changed to a new name.
710
If OLDNAME does not exist on the filesystem but is versioned and
711
NEWNAME does exist on the filesystem but is not versioned, mv
712
assumes that the file has been manually moved and only updates
713
its internal inventory to reflect that change.
714
The same is valid when moving many SOURCE files to a DESTINATION.
716
Files cannot be moved between branches.
719
takes_args = ['names*']
720
takes_options = [Option("after", help="Move only the bzr identifier"
721
" of the file, because the file has already been moved."),
723
aliases = ['move', 'rename']
724
encoding_type = 'replace'
726
def run(self, names_list, after=False):
727
if names_list is None:
730
if len(names_list) < 2:
731
raise errors.BzrCommandError("missing file argument")
732
tree, rel_names = tree_files(names_list, canonicalize=False)
735
self._run(tree, names_list, rel_names, after)
739
def _run(self, tree, names_list, rel_names, after):
740
into_existing = osutils.isdir(names_list[-1])
741
if into_existing and len(names_list) == 2:
743
# a. case-insensitive filesystem and change case of dir
744
# b. move directory after the fact (if the source used to be
745
# a directory, but now doesn't exist in the working tree
746
# and the target is an existing directory, just rename it)
747
if (not tree.case_sensitive
748
and rel_names[0].lower() == rel_names[1].lower()):
749
into_existing = False
752
# 'fix' the case of a potential 'from'
753
from_id = tree.path2id(
754
tree.get_canonical_inventory_path(rel_names[0]))
755
if (not osutils.lexists(names_list[0]) and
756
from_id and inv.get_file_kind(from_id) == "directory"):
757
into_existing = False
760
# move into existing directory
761
# All entries reference existing inventory items, so fix them up
762
# for cicp file-systems.
763
rel_names = tree.get_canonical_inventory_paths(rel_names)
764
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
765
self.outf.write("%s => %s\n" % pair)
767
if len(names_list) != 2:
768
raise errors.BzrCommandError('to mv multiple files the'
769
' destination must be a versioned'
772
# for cicp file-systems: the src references an existing inventory
774
src = tree.get_canonical_inventory_path(rel_names[0])
775
# Find the canonical version of the destination: In all cases, the
776
# parent of the target must be in the inventory, so we fetch the
777
# canonical version from there (we do not always *use* the
778
# canonicalized tail portion - we may be attempting to rename the
780
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
781
dest_parent = osutils.dirname(canon_dest)
782
spec_tail = osutils.basename(rel_names[1])
783
# For a CICP file-system, we need to avoid creating 2 inventory
784
# entries that differ only by case. So regardless of the case
785
# we *want* to use (ie, specified by the user or the file-system),
786
# we must always choose to use the case of any existing inventory
787
# items. The only exception to this is when we are attempting a
788
# case-only rename (ie, canonical versions of src and dest are
790
dest_id = tree.path2id(canon_dest)
791
if dest_id is None or tree.path2id(src) == dest_id:
792
# No existing item we care about, so work out what case we
793
# are actually going to use.
795
# If 'after' is specified, the tail must refer to a file on disk.
797
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
799
# pathjoin with an empty tail adds a slash, which breaks
801
dest_parent_fq = tree.basedir
803
dest_tail = osutils.canonical_relpath(
805
osutils.pathjoin(dest_parent_fq, spec_tail))
807
# not 'after', so case as specified is used
808
dest_tail = spec_tail
810
# Use the existing item so 'mv' fails with AlreadyVersioned.
811
dest_tail = os.path.basename(canon_dest)
812
dest = osutils.pathjoin(dest_parent, dest_tail)
813
mutter("attempting to move %s => %s", src, dest)
814
tree.rename_one(src, dest, after=after)
815
self.outf.write("%s => %s\n" % (src, dest))
818
class cmd_pull(Command):
819
"""Turn this branch into a mirror of another branch.
821
This command only works on branches that have not diverged. Branches are
822
considered diverged if the destination branch's most recent commit is one
823
that has not been merged (directly or indirectly) into the parent.
825
If branches have diverged, you can use 'bzr merge' to integrate the changes
826
from one into the other. Once one branch has merged, the other should
827
be able to pull it again.
829
If you want to forget your local changes and just update your branch to
830
match the remote one, use pull --overwrite.
832
If there is no default location set, the first pull will set it. After
833
that, you can omit the location to use the default. To change the
834
default, use --remember. The value will only be saved if the remote
835
location can be accessed.
837
Note: The location can be specified either in the form of a branch,
838
or in the form of a path to a file containing a merge directive generated
842
_see_also = ['push', 'update', 'status-flags']
843
takes_options = ['remember', 'overwrite', 'revision',
844
custom_help('verbose',
845
help='Show logs of pulled revisions.'),
847
help='Branch to pull into, '
848
'rather than the one containing the working directory.',
853
takes_args = ['location?']
854
encoding_type = 'replace'
856
def run(self, location=None, remember=False, overwrite=False,
857
revision=None, verbose=False,
859
# FIXME: too much stuff is in the command class
862
if directory is None:
865
tree_to = WorkingTree.open_containing(directory)[0]
866
branch_to = tree_to.branch
867
except errors.NoWorkingTree:
869
branch_to = Branch.open_containing(directory)[0]
871
possible_transports = []
872
if location is not None:
874
mergeable = bundle.read_mergeable_from_url(location,
875
possible_transports=possible_transports)
876
except errors.NotABundle:
879
stored_loc = branch_to.get_parent()
881
if stored_loc is None:
882
raise errors.BzrCommandError("No pull location known or"
885
display_url = urlutils.unescape_for_display(stored_loc,
888
self.outf.write("Using saved parent location: %s\n" % display_url)
889
location = stored_loc
891
revision = _get_one_revision('pull', revision)
892
if mergeable is not None:
893
if revision is not None:
894
raise errors.BzrCommandError(
895
'Cannot use -r with merge directives or bundles')
896
mergeable.install_revisions(branch_to.repository)
897
base_revision_id, revision_id, verified = \
898
mergeable.get_merge_request(branch_to.repository)
899
branch_from = branch_to
901
branch_from = Branch.open(location,
902
possible_transports=possible_transports)
904
if branch_to.get_parent() is None or remember:
905
branch_to.set_parent(branch_from.base)
907
if revision is not None:
908
revision_id = revision.as_revision_id(branch_from)
910
branch_to.lock_write()
912
if tree_to is not None:
913
view_info = _get_view_info_for_change_reporter(tree_to)
914
change_reporter = delta._ChangeReporter(
915
unversioned_filter=tree_to.is_ignored, view_info=view_info)
916
result = tree_to.pull(branch_from, overwrite, revision_id,
918
possible_transports=possible_transports)
920
result = branch_to.pull(branch_from, overwrite, revision_id)
922
result.report(self.outf)
923
if verbose and result.old_revid != result.new_revid:
924
log.show_branch_change(branch_to, self.outf, result.old_revno,
930
class cmd_push(Command):
931
"""Update a mirror of this branch.
933
The target branch will not have its working tree populated because this
934
is both expensive, and is not supported on remote file systems.
936
Some smart servers or protocols *may* put the working tree in place in
939
This command only works on branches that have not diverged. Branches are
940
considered diverged if the destination branch's most recent commit is one
941
that has not been merged (directly or indirectly) by the source branch.
943
If branches have diverged, you can use 'bzr push --overwrite' to replace
944
the other branch completely, discarding its unmerged changes.
946
If you want to ensure you have the different changes in the other branch,
947
do a merge (see bzr help merge) from the other branch, and commit that.
948
After that you will be able to do a push without '--overwrite'.
950
If there is no default push location set, the first push will set it.
951
After that, you can omit the location to use the default. To change the
952
default, use --remember. The value will only be saved if the remote
953
location can be accessed.
956
_see_also = ['pull', 'update', 'working-trees']
957
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
958
Option('create-prefix',
959
help='Create the path leading up to the branch '
960
'if it does not already exist.'),
962
help='Branch to push from, '
963
'rather than the one containing the working directory.',
967
Option('use-existing-dir',
968
help='By default push will fail if the target'
969
' directory exists, but does not already'
970
' have a control directory. This flag will'
971
' allow push to proceed.'),
973
help='Create a stacked branch that references the public location '
974
'of the parent branch.'),
976
help='Create a stacked branch that refers to another branch '
977
'for the commit history. Only the work not present in the '
978
'referenced branch is included in the branch created.',
981
takes_args = ['location?']
982
encoding_type = 'replace'
984
def run(self, location=None, remember=False, overwrite=False,
985
create_prefix=False, verbose=False, revision=None,
986
use_existing_dir=False, directory=None, stacked_on=None,
988
from bzrlib.push import _show_push_branch
990
# Get the source branch and revision_id
991
if directory is None:
993
br_from = Branch.open_containing(directory)[0]
994
revision = _get_one_revision('push', revision)
995
if revision is not None:
996
revision_id = revision.in_history(br_from).rev_id
998
revision_id = br_from.last_revision()
1000
# Get the stacked_on branch, if any
1001
if stacked_on is not None:
1002
stacked_on = urlutils.normalize_url(stacked_on)
1004
parent_url = br_from.get_parent()
1006
parent = Branch.open(parent_url)
1007
stacked_on = parent.get_public_branch()
1009
# I considered excluding non-http url's here, thus forcing
1010
# 'public' branches only, but that only works for some
1011
# users, so it's best to just depend on the user spotting an
1012
# error by the feedback given to them. RBC 20080227.
1013
stacked_on = parent_url
1015
raise errors.BzrCommandError(
1016
"Could not determine branch to refer to.")
1018
# Get the destination location
1019
if location is None:
1020
stored_loc = br_from.get_push_location()
1021
if stored_loc is None:
1022
raise errors.BzrCommandError(
1023
"No push location known or specified.")
1025
display_url = urlutils.unescape_for_display(stored_loc,
1027
self.outf.write("Using saved push location: %s\n" % display_url)
1028
location = stored_loc
1030
_show_push_branch(br_from, revision_id, location, self.outf,
1031
verbose=verbose, overwrite=overwrite, remember=remember,
1032
stacked_on=stacked_on, create_prefix=create_prefix,
1033
use_existing_dir=use_existing_dir)
1036
class cmd_branch(Command):
1037
"""Create a new copy of a branch.
1039
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1040
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1041
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1042
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1043
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1046
To retrieve the branch as of a particular revision, supply the --revision
1047
parameter, as in "branch foo/bar -r 5".
1050
_see_also = ['checkout']
1051
takes_args = ['from_location', 'to_location?']
1052
takes_options = ['revision', Option('hardlink',
1053
help='Hard-link working tree files where possible.'),
1055
help="Create a branch without a working-tree."),
1057
help='Create a stacked branch referring to the source branch. '
1058
'The new branch will depend on the availability of the source '
1059
'branch for all operations.'),
1060
Option('standalone',
1061
help='Do not use a shared repository, even if available.'),
1063
aliases = ['get', 'clone']
1065
def run(self, from_location, to_location=None, revision=None,
1066
hardlink=False, stacked=False, standalone=False, no_tree=False):
1067
from bzrlib.tag import _merge_tags_if_possible
1069
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1071
revision = _get_one_revision('branch', revision)
1074
if revision is not None:
1075
revision_id = revision.as_revision_id(br_from)
1077
# FIXME - wt.last_revision, fallback to branch, fall back to
1078
# None or perhaps NULL_REVISION to mean copy nothing
1080
revision_id = br_from.last_revision()
1081
if to_location is None:
1082
to_location = urlutils.derive_to_location(from_location)
1083
to_transport = transport.get_transport(to_location)
1085
to_transport.mkdir('.')
1086
except errors.FileExists:
1087
raise errors.BzrCommandError('Target directory "%s" already'
1088
' exists.' % to_location)
1089
except errors.NoSuchFile:
1090
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1093
# preserve whatever source format we have.
1094
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1095
possible_transports=[to_transport],
1096
accelerator_tree=accelerator_tree,
1097
hardlink=hardlink, stacked=stacked,
1098
force_new_repo=standalone,
1099
create_tree_if_local=not no_tree,
1100
source_branch=br_from)
1101
branch = dir.open_branch()
1102
except errors.NoSuchRevision:
1103
to_transport.delete_tree('.')
1104
msg = "The branch %s has no revision %s." % (from_location,
1106
raise errors.BzrCommandError(msg)
1107
_merge_tags_if_possible(br_from, branch)
1108
# If the source branch is stacked, the new branch may
1109
# be stacked whether we asked for that explicitly or not.
1110
# We therefore need a try/except here and not just 'if stacked:'
1112
note('Created new stacked branch referring to %s.' %
1113
branch.get_stacked_on_url())
1114
except (errors.NotStacked, errors.UnstackableBranchFormat,
1115
errors.UnstackableRepositoryFormat), e:
1116
note('Branched %d revision(s).' % branch.revno())
1121
class cmd_checkout(Command):
1122
"""Create a new checkout of an existing branch.
1124
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1125
the branch found in '.'. This is useful if you have removed the working tree
1126
or if it was never created - i.e. if you pushed the branch to its current
1127
location using SFTP.
1129
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1130
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1131
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1132
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1133
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1136
To retrieve the branch as of a particular revision, supply the --revision
1137
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1138
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1142
_see_also = ['checkouts', 'branch']
1143
takes_args = ['branch_location?', 'to_location?']
1144
takes_options = ['revision',
1145
Option('lightweight',
1146
help="Perform a lightweight checkout. Lightweight "
1147
"checkouts depend on access to the branch for "
1148
"every operation. Normal checkouts can perform "
1149
"common operations like diff and status without "
1150
"such access, and also support local commits."
1152
Option('files-from', type=str,
1153
help="Get file contents from this tree."),
1155
help='Hard-link working tree files where possible.'
1160
def run(self, branch_location=None, to_location=None, revision=None,
1161
lightweight=False, files_from=None, hardlink=False):
1162
if branch_location is None:
1163
branch_location = osutils.getcwd()
1164
to_location = branch_location
1165
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1167
revision = _get_one_revision('checkout', revision)
1168
if files_from is not None:
1169
accelerator_tree = WorkingTree.open(files_from)
1170
if revision is not None:
1171
revision_id = revision.as_revision_id(source)
1174
if to_location is None:
1175
to_location = urlutils.derive_to_location(branch_location)
1176
# if the source and to_location are the same,
1177
# and there is no working tree,
1178
# then reconstitute a branch
1179
if (osutils.abspath(to_location) ==
1180
osutils.abspath(branch_location)):
1182
source.bzrdir.open_workingtree()
1183
except errors.NoWorkingTree:
1184
source.bzrdir.create_workingtree(revision_id)
1186
source.create_checkout(to_location, revision_id, lightweight,
1187
accelerator_tree, hardlink)
1190
class cmd_renames(Command):
1191
"""Show list of renamed files.
1193
# TODO: Option to show renames between two historical versions.
1195
# TODO: Only show renames under dir, rather than in the whole branch.
1196
_see_also = ['status']
1197
takes_args = ['dir?']
1200
def run(self, dir=u'.'):
1201
tree = WorkingTree.open_containing(dir)[0]
1204
new_inv = tree.inventory
1205
old_tree = tree.basis_tree()
1206
old_tree.lock_read()
1208
old_inv = old_tree.inventory
1210
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1211
for f, paths, c, v, p, n, k, e in iterator:
1212
if paths[0] == paths[1]:
1216
renames.append(paths)
1218
for old_name, new_name in renames:
1219
self.outf.write("%s => %s\n" % (old_name, new_name))
1226
class cmd_update(Command):
1227
"""Update a tree to have the latest code committed to its branch.
1229
This will perform a merge into the working tree, and may generate
1230
conflicts. If you have any local changes, you will still
1231
need to commit them after the update for the update to be complete.
1233
If you want to discard your local changes, you can just do a
1234
'bzr revert' instead of 'bzr commit' after the update.
1237
_see_also = ['pull', 'working-trees', 'status-flags']
1238
takes_args = ['dir?']
1241
def run(self, dir='.'):
1242
tree = WorkingTree.open_containing(dir)[0]
1243
possible_transports = []
1244
master = tree.branch.get_master_branch(
1245
possible_transports=possible_transports)
1246
if master is not None:
1249
tree.lock_tree_write()
1251
existing_pending_merges = tree.get_parent_ids()[1:]
1252
last_rev = _mod_revision.ensure_null(tree.last_revision())
1253
if last_rev == _mod_revision.ensure_null(
1254
tree.branch.last_revision()):
1255
# may be up to date, check master too.
1256
if master is None or last_rev == _mod_revision.ensure_null(
1257
master.last_revision()):
1258
revno = tree.branch.revision_id_to_revno(last_rev)
1259
note("Tree is up to date at revision %d." % (revno,))
1261
view_info = _get_view_info_for_change_reporter(tree)
1262
conflicts = tree.update(
1263
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1264
view_info=view_info), possible_transports=possible_transports)
1265
revno = tree.branch.revision_id_to_revno(
1266
_mod_revision.ensure_null(tree.last_revision()))
1267
note('Updated to revision %d.' % (revno,))
1268
if tree.get_parent_ids()[1:] != existing_pending_merges:
1269
note('Your local commits will now show as pending merges with '
1270
"'bzr status', and can be committed with 'bzr commit'.")
1279
class cmd_info(Command):
1280
"""Show information about a working tree, branch or repository.
1282
This command will show all known locations and formats associated to the
1283
tree, branch or repository.
1285
In verbose mode, statistical information is included with each report.
1286
To see extended statistic information, use a verbosity level of 2 or
1287
higher by specifying the verbose option multiple times, e.g. -vv.
1289
Branches and working trees will also report any missing revisions.
1293
Display information on the format and related locations:
1297
Display the above together with extended format information and
1298
basic statistics (like the number of files in the working tree and
1299
number of revisions in the branch and repository):
1303
Display the above together with number of committers to the branch:
1307
_see_also = ['revno', 'working-trees', 'repositories']
1308
takes_args = ['location?']
1309
takes_options = ['verbose']
1310
encoding_type = 'replace'
1313
def run(self, location=None, verbose=False):
1315
noise_level = get_verbosity_level()
1318
from bzrlib.info import show_bzrdir_info
1319
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1320
verbose=noise_level, outfile=self.outf)
1323
class cmd_remove(Command):
1324
"""Remove files or directories.
1326
This makes bzr stop tracking changes to the specified files. bzr will delete
1327
them if they can easily be recovered using revert. If no options or
1328
parameters are given bzr will scan for files that are being tracked by bzr
1329
but missing in your tree and stop tracking them for you.
1331
takes_args = ['file*']
1332
takes_options = ['verbose',
1333
Option('new', help='Only remove files that have never been committed.'),
1334
RegistryOption.from_kwargs('file-deletion-strategy',
1335
'The file deletion mode to be used.',
1336
title='Deletion Strategy', value_switches=True, enum_switch=False,
1337
safe='Only delete files if they can be'
1338
' safely recovered (default).',
1339
keep="Don't delete any files.",
1340
force='Delete all the specified files, even if they can not be '
1341
'recovered and even if they are non-empty directories.')]
1342
aliases = ['rm', 'del']
1343
encoding_type = 'replace'
1345
def run(self, file_list, verbose=False, new=False,
1346
file_deletion_strategy='safe'):
1347
tree, file_list = tree_files(file_list)
1349
if file_list is not None:
1350
file_list = [f for f in file_list]
1354
# Heuristics should probably all move into tree.remove_smart or
1357
added = tree.changes_from(tree.basis_tree(),
1358
specific_files=file_list).added
1359
file_list = sorted([f[0] for f in added], reverse=True)
1360
if len(file_list) == 0:
1361
raise errors.BzrCommandError('No matching files.')
1362
elif file_list is None:
1363
# missing files show up in iter_changes(basis) as
1364
# versioned-with-no-kind.
1366
for change in tree.iter_changes(tree.basis_tree()):
1367
# Find paths in the working tree that have no kind:
1368
if change[1][1] is not None and change[6][1] is None:
1369
missing.append(change[1][1])
1370
file_list = sorted(missing, reverse=True)
1371
file_deletion_strategy = 'keep'
1372
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1373
keep_files=file_deletion_strategy=='keep',
1374
force=file_deletion_strategy=='force')
1379
class cmd_file_id(Command):
1380
"""Print file_id of a particular file or directory.
1382
The file_id is assigned when the file is first added and remains the
1383
same through all revisions where the file exists, even when it is
1388
_see_also = ['inventory', 'ls']
1389
takes_args = ['filename']
1392
def run(self, filename):
1393
tree, relpath = WorkingTree.open_containing(filename)
1394
i = tree.path2id(relpath)
1396
raise errors.NotVersionedError(filename)
1398
self.outf.write(i + '\n')
1401
class cmd_file_path(Command):
1402
"""Print path of file_ids to a file or directory.
1404
This prints one line for each directory down to the target,
1405
starting at the branch root.
1409
takes_args = ['filename']
1412
def run(self, filename):
1413
tree, relpath = WorkingTree.open_containing(filename)
1414
fid = tree.path2id(relpath)
1416
raise errors.NotVersionedError(filename)
1417
segments = osutils.splitpath(relpath)
1418
for pos in range(1, len(segments) + 1):
1419
path = osutils.joinpath(segments[:pos])
1420
self.outf.write("%s\n" % tree.path2id(path))
1423
class cmd_reconcile(Command):
1424
"""Reconcile bzr metadata in a branch.
1426
This can correct data mismatches that may have been caused by
1427
previous ghost operations or bzr upgrades. You should only
1428
need to run this command if 'bzr check' or a bzr developer
1429
advises you to run it.
1431
If a second branch is provided, cross-branch reconciliation is
1432
also attempted, which will check that data like the tree root
1433
id which was not present in very early bzr versions is represented
1434
correctly in both branches.
1436
At the same time it is run it may recompress data resulting in
1437
a potential saving in disk space or performance gain.
1439
The branch *MUST* be on a listable system such as local disk or sftp.
1442
_see_also = ['check']
1443
takes_args = ['branch?']
1445
def run(self, branch="."):
1446
from bzrlib.reconcile import reconcile
1447
dir = bzrdir.BzrDir.open(branch)
1451
class cmd_revision_history(Command):
1452
"""Display the list of revision ids on a branch."""
1455
takes_args = ['location?']
1460
def run(self, location="."):
1461
branch = Branch.open_containing(location)[0]
1462
for revid in branch.revision_history():
1463
self.outf.write(revid)
1464
self.outf.write('\n')
1467
class cmd_ancestry(Command):
1468
"""List all revisions merged into this branch."""
1470
_see_also = ['log', 'revision-history']
1471
takes_args = ['location?']
1476
def run(self, location="."):
1478
wt = WorkingTree.open_containing(location)[0]
1479
except errors.NoWorkingTree:
1480
b = Branch.open(location)
1481
last_revision = b.last_revision()
1484
last_revision = wt.last_revision()
1486
revision_ids = b.repository.get_ancestry(last_revision)
1488
for revision_id in revision_ids:
1489
self.outf.write(revision_id + '\n')
1492
class cmd_init(Command):
1493
"""Make a directory into a versioned branch.
1495
Use this to create an empty branch, or before importing an
1498
If there is a repository in a parent directory of the location, then
1499
the history of the branch will be stored in the repository. Otherwise
1500
init creates a standalone branch which carries its own history
1501
in the .bzr directory.
1503
If there is already a branch at the location but it has no working tree,
1504
the tree can be populated with 'bzr checkout'.
1506
Recipe for importing a tree of files::
1512
bzr commit -m "imported project"
1515
_see_also = ['init-repository', 'branch', 'checkout']
1516
takes_args = ['location?']
1518
Option('create-prefix',
1519
help='Create the path leading up to the branch '
1520
'if it does not already exist.'),
1521
RegistryOption('format',
1522
help='Specify a format for this branch. '
1523
'See "help formats".',
1524
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1525
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1526
value_switches=True,
1527
title="Branch Format",
1529
Option('append-revisions-only',
1530
help='Never change revnos or the existing log.'
1531
' Append revisions to it only.')
1533
def run(self, location=None, format=None, append_revisions_only=False,
1534
create_prefix=False):
1536
format = bzrdir.format_registry.make_bzrdir('default')
1537
if location is None:
1540
to_transport = transport.get_transport(location)
1542
# The path has to exist to initialize a
1543
# branch inside of it.
1544
# Just using os.mkdir, since I don't
1545
# believe that we want to create a bunch of
1546
# locations if the user supplies an extended path
1548
to_transport.ensure_base()
1549
except errors.NoSuchFile:
1550
if not create_prefix:
1551
raise errors.BzrCommandError("Parent directory of %s"
1553
"\nYou may supply --create-prefix to create all"
1554
" leading parent directories."
1556
_create_prefix(to_transport)
1559
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1560
except errors.NotBranchError:
1561
# really a NotBzrDir error...
1562
create_branch = bzrdir.BzrDir.create_branch_convenience
1563
branch = create_branch(to_transport.base, format=format,
1564
possible_transports=[to_transport])
1565
a_bzrdir = branch.bzrdir
1567
from bzrlib.transport.local import LocalTransport
1568
if a_bzrdir.has_branch():
1569
if (isinstance(to_transport, LocalTransport)
1570
and not a_bzrdir.has_workingtree()):
1571
raise errors.BranchExistsWithoutWorkingTree(location)
1572
raise errors.AlreadyBranchError(location)
1573
branch = a_bzrdir.create_branch()
1574
a_bzrdir.create_workingtree()
1575
if append_revisions_only:
1577
branch.set_append_revisions_only(True)
1578
except errors.UpgradeRequired:
1579
raise errors.BzrCommandError('This branch format cannot be set'
1580
' to append-revisions-only. Try --experimental-branch6')
1582
from bzrlib.info import describe_layout, describe_format
1584
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1585
except (errors.NoWorkingTree, errors.NotLocalUrl):
1587
repository = branch.repository
1588
layout = describe_layout(repository, branch, tree).lower()
1589
format = describe_format(a_bzrdir, repository, branch, tree)
1590
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1591
if repository.is_shared():
1592
#XXX: maybe this can be refactored into transport.path_or_url()
1593
url = repository.bzrdir.root_transport.external_url()
1595
url = urlutils.local_path_from_url(url)
1596
except errors.InvalidURL:
1598
self.outf.write("Using shared repository: %s\n" % url)
1601
class cmd_init_repository(Command):
1602
"""Create a shared repository to hold branches.
1604
New branches created under the repository directory will store their
1605
revisions in the repository, not in the branch directory.
1607
If the --no-trees option is used then the branches in the repository
1608
will not have working trees by default.
1611
Create a shared repositories holding just branches::
1613
bzr init-repo --no-trees repo
1616
Make a lightweight checkout elsewhere::
1618
bzr checkout --lightweight repo/trunk trunk-checkout
1623
_see_also = ['init', 'branch', 'checkout', 'repositories']
1624
takes_args = ["location"]
1625
takes_options = [RegistryOption('format',
1626
help='Specify a format for this repository. See'
1627
' "bzr help formats" for details.',
1628
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1629
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1630
value_switches=True, title='Repository format'),
1632
help='Branches in the repository will default to'
1633
' not having a working tree.'),
1635
aliases = ["init-repo"]
1637
def run(self, location, format=None, no_trees=False):
1639
format = bzrdir.format_registry.make_bzrdir('default')
1641
if location is None:
1644
to_transport = transport.get_transport(location)
1645
to_transport.ensure_base()
1647
newdir = format.initialize_on_transport(to_transport)
1648
repo = newdir.create_repository(shared=True)
1649
repo.set_make_working_trees(not no_trees)
1651
from bzrlib.info import show_bzrdir_info
1652
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1655
class cmd_diff(Command):
1656
"""Show differences in the working tree, between revisions or branches.
1658
If no arguments are given, all changes for the current tree are listed.
1659
If files are given, only the changes in those files are listed.
1660
Remote and multiple branches can be compared by using the --old and
1661
--new options. If not provided, the default for both is derived from
1662
the first argument, if any, or the current tree if no arguments are
1665
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1666
produces patches suitable for "patch -p1".
1670
2 - unrepresentable changes
1675
Shows the difference in the working tree versus the last commit::
1679
Difference between the working tree and revision 1::
1683
Difference between revision 2 and revision 1::
1687
Difference between revision 2 and revision 1 for branch xxx::
1691
Show just the differences for file NEWS::
1695
Show the differences in working tree xxx for file NEWS::
1699
Show the differences from branch xxx to this working tree:
1703
Show the differences between two branches for file NEWS::
1705
bzr diff --old xxx --new yyy NEWS
1707
Same as 'bzr diff' but prefix paths with old/ and new/::
1709
bzr diff --prefix old/:new/
1711
_see_also = ['status']
1712
takes_args = ['file*']
1714
Option('diff-options', type=str,
1715
help='Pass these options to the external diff program.'),
1716
Option('prefix', type=str,
1718
help='Set prefixes added to old and new filenames, as '
1719
'two values separated by a colon. (eg "old/:new/").'),
1721
help='Branch/tree to compare from.',
1725
help='Branch/tree to compare to.',
1731
help='Use this command to compare files.',
1735
aliases = ['di', 'dif']
1736
encoding_type = 'exact'
1739
def run(self, revision=None, file_list=None, diff_options=None,
1740
prefix=None, old=None, new=None, using=None):
1741
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1743
if (prefix is None) or (prefix == '0'):
1751
old_label, new_label = prefix.split(":")
1753
raise errors.BzrCommandError(
1754
'--prefix expects two values separated by a colon'
1755
' (eg "old/:new/")')
1757
if revision and len(revision) > 2:
1758
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1759
' one or two revision specifiers')
1761
old_tree, new_tree, specific_files, extra_trees = \
1762
_get_trees_to_diff(file_list, revision, old, new,
1764
return show_diff_trees(old_tree, new_tree, sys.stdout,
1765
specific_files=specific_files,
1766
external_diff_options=diff_options,
1767
old_label=old_label, new_label=new_label,
1768
extra_trees=extra_trees, using=using)
1771
class cmd_deleted(Command):
1772
"""List files deleted in the working tree.
1774
# TODO: Show files deleted since a previous revision, or
1775
# between two revisions.
1776
# TODO: Much more efficient way to do this: read in new
1777
# directories with readdir, rather than stating each one. Same
1778
# level of effort but possibly much less IO. (Or possibly not,
1779
# if the directories are very large...)
1780
_see_also = ['status', 'ls']
1781
takes_options = ['show-ids']
1784
def run(self, show_ids=False):
1785
tree = WorkingTree.open_containing(u'.')[0]
1788
old = tree.basis_tree()
1791
for path, ie in old.inventory.iter_entries():
1792
if not tree.has_id(ie.file_id):
1793
self.outf.write(path)
1795
self.outf.write(' ')
1796
self.outf.write(ie.file_id)
1797
self.outf.write('\n')
1804
class cmd_modified(Command):
1805
"""List files modified in working tree.
1809
_see_also = ['status', 'ls']
1812
help='Write an ascii NUL (\\0) separator '
1813
'between files rather than a newline.')
1817
def run(self, null=False):
1818
tree = WorkingTree.open_containing(u'.')[0]
1819
td = tree.changes_from(tree.basis_tree())
1820
for path, id, kind, text_modified, meta_modified in td.modified:
1822
self.outf.write(path + '\0')
1824
self.outf.write(osutils.quotefn(path) + '\n')
1827
class cmd_added(Command):
1828
"""List files added in working tree.
1832
_see_also = ['status', 'ls']
1835
help='Write an ascii NUL (\\0) separator '
1836
'between files rather than a newline.')
1840
def run(self, null=False):
1841
wt = WorkingTree.open_containing(u'.')[0]
1844
basis = wt.basis_tree()
1847
basis_inv = basis.inventory
1850
if file_id in basis_inv:
1852
if inv.is_root(file_id) and len(basis_inv) == 0:
1854
path = inv.id2path(file_id)
1855
if not os.access(osutils.abspath(path), os.F_OK):
1858
self.outf.write(path + '\0')
1860
self.outf.write(osutils.quotefn(path) + '\n')
1867
class cmd_root(Command):
1868
"""Show the tree root directory.
1870
The root is the nearest enclosing directory with a .bzr control
1873
takes_args = ['filename?']
1875
def run(self, filename=None):
1876
"""Print the branch root."""
1877
tree = WorkingTree.open_containing(filename)[0]
1878
self.outf.write(tree.basedir + '\n')
1881
def _parse_limit(limitstring):
1883
return int(limitstring)
1885
msg = "The limit argument must be an integer."
1886
raise errors.BzrCommandError(msg)
1889
def _parse_levels(s):
1893
msg = "The levels argument must be an integer."
1894
raise errors.BzrCommandError(msg)
1897
class cmd_log(Command):
1898
"""Show historical log for a branch or subset of a branch.
1900
log is bzr's default tool for exploring the history of a branch.
1901
The branch to use is taken from the first parameter. If no parameters
1902
are given, the branch containing the working directory is logged.
1903
Here are some simple examples::
1905
bzr log log the current branch
1906
bzr log foo.py log a file in its branch
1907
bzr log http://server/branch log a branch on a server
1909
The filtering, ordering and information shown for each revision can
1910
be controlled as explained below. By default, all revisions are
1911
shown sorted (topologically) so that newer revisions appear before
1912
older ones and descendants always appear before ancestors. If displayed,
1913
merged revisions are shown indented under the revision in which they
1918
The log format controls how information about each revision is
1919
displayed. The standard log formats are called ``long``, ``short``
1920
and ``line``. The default is long. See ``bzr help log-formats``
1921
for more details on log formats.
1923
The following options can be used to control what information is
1926
-l N display a maximum of N revisions
1927
-n N display N levels of revisions (0 for all, 1 for collapsed)
1928
-v display a status summary (delta) for each revision
1929
-p display a diff (patch) for each revision
1930
--show-ids display revision-ids (and file-ids), not just revnos
1932
Note that the default number of levels to display is a function of the
1933
log format. If the -n option is not used, ``short`` and ``line`` show
1934
just the top level (mainline) while ``long`` shows all levels of merged
1937
Status summaries are shown using status flags like A, M, etc. To see
1938
the changes explained using words like ``added`` and ``modified``
1939
instead, use the -vv option.
1943
To display revisions from oldest to newest, use the --forward option.
1944
In most cases, using this option will have little impact on the total
1945
time taken to produce a log, though --forward does not incrementally
1946
display revisions like --reverse does when it can.
1948
:Revision filtering:
1950
The -r option can be used to specify what revision or range of revisions
1951
to filter against. The various forms are shown below::
1953
-rX display revision X
1954
-rX.. display revision X and later
1955
-r..Y display up to and including revision Y
1956
-rX..Y display from X to Y inclusive
1958
See ``bzr help revisionspec`` for details on how to specify X and Y.
1959
Some common examples are given below::
1961
-r-1 show just the tip
1962
-r-10.. show the last 10 mainline revisions
1963
-rsubmit:.. show what's new on this branch
1964
-rancestor:path.. show changes since the common ancestor of this
1965
branch and the one at location path
1966
-rdate:yesterday.. show changes since yesterday
1968
When logging a range of revisions using -rX..Y, log starts at
1969
revision Y and searches back in history through the primary
1970
("left-hand") parents until it finds X. When logging just the
1971
top level (using -n1), an error is reported if X is not found
1972
along the way. If multi-level logging is used (-n0), X may be
1973
a nested merge revision and the log will be truncated accordingly.
1977
If a parameter is given and it's not a branch, the log will be filtered
1978
to show only those revisions that changed the nominated file or
1981
Filenames are interpreted within their historical context. To log a
1982
deleted file, specify a revision range so that the file existed at
1983
the end or start of the range.
1985
Historical context is also important when interpreting pathnames of
1986
renamed files/directories. Consider the following example:
1988
* revision 1: add tutorial.txt
1989
* revision 2: modify tutorial.txt
1990
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
1994
* ``bzr log guide.txt`` will log the file added in revision 1
1996
* ``bzr log tutorial.txt`` will log the new file added in revision 3
1998
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
1999
the original file in revision 2.
2001
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2002
was no file called guide.txt in revision 2.
2004
Renames are always followed by log. By design, there is no need to
2005
explicitly ask for this (and no way to stop logging a file back
2006
until it was last renamed).
2008
Note: If the path is a directory, only revisions that directly changed
2009
that directory object are currently shown. This is considered a bug.
2010
(Support for filtering against multiple files and for files within a
2011
directory is under development.)
2015
The --message option can be used for finding revisions that match a
2016
regular expression in a commit message.
2020
GUI tools and IDEs are often better at exploring history than command
2021
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2022
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2023
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2025
Web interfaces are often better at exploring history than command line
2026
tools, particularly for branches on servers. You may prefer Loggerhead
2027
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2029
You may find it useful to add the aliases below to ``bazaar.conf``::
2033
top = log -r-10.. --short --forward
2034
show = log -v -p -n1 --long
2036
``bzr tip`` will then show the latest revision while ``bzr top``
2037
will show the last 10 mainline revisions. To see the details of a
2038
particular revision X, ``bzr show -rX``.
2040
As many GUI tools and Web interfaces do, you may prefer viewing
2041
history collapsed initially. If you are interested in looking deeper
2042
into a particular merge X, use ``bzr log -n0 -rX``. If you like
2043
working this way, you may wish to either:
2045
* change your default log format to short (or line)
2046
* add this alias: log = log -n1
2048
``bzr log -v`` on a branch with lots of history is currently
2049
very slow. A fix for this issue is currently under development.
2050
With or without that fix, it is recommended that a revision range
2051
be given when using the -v option.
2053
bzr has a generic full-text matching plugin, bzr-search, that can be
2054
used to find revisions matching user names, commit messages, etc.
2055
Among other features, this plugin can find all revisions containing
2056
a list of words but not others.
2058
When exploring non-mainline history on large projects with deep
2059
history, the performance of log can be greatly improved by installing
2060
the revnocache plugin. This plugin buffers historical information
2061
trading disk space for faster speed.
2063
takes_args = ['location?']
2064
_see_also = ['log-formats', 'revisionspec']
2067
help='Show from oldest to newest.'),
2069
custom_help('verbose',
2070
help='Show files changed in each revision.'),
2074
type=bzrlib.option._parse_revision_str,
2076
help='Show just the specified revision.'
2077
' See also "help revisionspec".'),
2081
help='Number of levels to display - 0 for all, 1 for flat.',
2083
type=_parse_levels),
2086
help='Show revisions whose message matches this '
2087
'regular expression.',
2091
help='Limit the output to the first N revisions.',
2096
help='Show changes made in each revision as a patch.'),
2098
encoding_type = 'replace'
2101
def run(self, location=None, timezone='original',
2112
from bzrlib.log import show_log, _get_fileid_to_log
2113
direction = (forward and 'forward') or 'reverse'
2115
if change is not None:
2117
raise errors.RangeInChangeOption()
2118
if revision is not None:
2119
raise errors.BzrCommandError(
2120
'--revision and --change are mutually exclusive')
2127
# find the file id to log:
2129
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
2132
file_id = _get_fileid_to_log(revision, tree, b, fp)
2134
raise errors.BzrCommandError(
2135
"Path unknown at end or start of revision range: %s" %
2139
# FIXME ? log the current subdir only RBC 20060203
2140
if revision is not None \
2141
and len(revision) > 0 and revision[0].get_branch():
2142
location = revision[0].get_branch()
2145
dir, relpath = bzrdir.BzrDir.open_containing(location)
2146
b = dir.open_branch()
2150
rev1, rev2 = _get_revision_range(revision, b, self.name())
2151
if log_format is None:
2152
log_format = log.log_formatter_registry.get_default(b)
2154
lf = log_format(show_ids=show_ids, to_file=self.outf,
2155
show_timezone=timezone,
2156
delta_format=get_verbosity_level(),
2163
direction=direction,
2164
start_revision=rev1,
2168
show_diff=show_diff)
2173
def _get_revision_range(revisionspec_list, branch, command_name):
2174
"""Take the input of a revision option and turn it into a revision range.
2176
It returns RevisionInfo objects which can be used to obtain the rev_id's
2177
of the desired revisons. It does some user input validations.
2179
if revisionspec_list is None:
2182
elif len(revisionspec_list) == 1:
2183
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2184
elif len(revisionspec_list) == 2:
2185
start_spec = revisionspec_list[0]
2186
end_spec = revisionspec_list[1]
2187
if end_spec.get_branch() != start_spec.get_branch():
2188
# b is taken from revision[0].get_branch(), and
2189
# show_log will use its revision_history. Having
2190
# different branches will lead to weird behaviors.
2191
raise errors.BzrCommandError(
2192
"bzr %s doesn't accept two revisions in different"
2193
" branches." % command_name)
2194
rev1 = start_spec.in_history(branch)
2195
# Avoid loading all of history when we know a missing
2196
# end of range means the last revision ...
2197
if end_spec.spec is None:
2198
last_revno, last_revision_id = branch.last_revision_info()
2199
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2201
rev2 = end_spec.in_history(branch)
2203
raise errors.BzrCommandError(
2204
'bzr %s --revision takes one or two values.' % command_name)
2208
def _revision_range_to_revid_range(revision_range):
2211
if revision_range[0] is not None:
2212
rev_id1 = revision_range[0].rev_id
2213
if revision_range[1] is not None:
2214
rev_id2 = revision_range[1].rev_id
2215
return rev_id1, rev_id2
2217
def get_log_format(long=False, short=False, line=False, default='long'):
2218
log_format = default
2222
log_format = 'short'
2228
class cmd_touching_revisions(Command):
2229
"""Return revision-ids which affected a particular file.
2231
A more user-friendly interface is "bzr log FILE".
2235
takes_args = ["filename"]
2238
def run(self, filename):
2239
tree, relpath = WorkingTree.open_containing(filename)
2241
file_id = tree.path2id(relpath)
2242
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2243
self.outf.write("%6d %s\n" % (revno, what))
2246
class cmd_ls(Command):
2247
"""List files in a tree.
2250
_see_also = ['status', 'cat']
2251
takes_args = ['path?']
2252
# TODO: Take a revision or remote path and list that tree instead.
2256
Option('non-recursive',
2257
help='Don\'t recurse into subdirectories.'),
2259
help='Print paths relative to the root of the branch.'),
2260
Option('unknown', help='Print unknown files.'),
2261
Option('versioned', help='Print versioned files.',
2263
Option('ignored', help='Print ignored files.'),
2265
help='Write an ascii NUL (\\0) separator '
2266
'between files rather than a newline.'),
2268
help='List entries of a particular kind: file, directory, symlink.',
2273
def run(self, revision=None, verbose=False,
2274
non_recursive=False, from_root=False,
2275
unknown=False, versioned=False, ignored=False,
2276
null=False, kind=None, show_ids=False, path=None):
2278
if kind and kind not in ('file', 'directory', 'symlink'):
2279
raise errors.BzrCommandError('invalid kind specified')
2281
if verbose and null:
2282
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2283
all = not (unknown or versioned or ignored)
2285
selection = {'I':ignored, '?':unknown, 'V':versioned}
2292
raise errors.BzrCommandError('cannot specify both --from-root'
2296
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2302
if revision is not None or tree is None:
2303
tree = _get_one_revision_tree('ls', revision, branch=branch)
2306
if isinstance(tree, WorkingTree) and tree.supports_views():
2307
view_files = tree.views.lookup_view()
2310
view_str = views.view_display_str(view_files)
2311
note("ignoring files outside view: %s" % view_str)
2315
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2316
if fp.startswith(relpath):
2317
fp = osutils.pathjoin(prefix, fp[len(relpath):])
2318
if non_recursive and '/' in fp:
2320
if not all and not selection[fc]:
2322
if kind is not None and fkind != kind:
2326
views.check_path_in_view(tree, fp)
2327
except errors.FileOutsideView:
2329
kindch = entry.kind_character()
2330
outstring = fp + kindch
2332
outstring = '%-8s %s' % (fc, outstring)
2333
if show_ids and fid is not None:
2334
outstring = "%-50s %s" % (outstring, fid)
2335
self.outf.write(outstring + '\n')
2337
self.outf.write(fp + '\0')
2340
self.outf.write(fid)
2341
self.outf.write('\0')
2349
self.outf.write('%-50s %s\n' % (outstring, my_id))
2351
self.outf.write(outstring + '\n')
2356
class cmd_unknowns(Command):
2357
"""List unknown files.
2365
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2366
self.outf.write(osutils.quotefn(f) + '\n')
2369
class cmd_ignore(Command):
2370
"""Ignore specified files or patterns.
2372
See ``bzr help patterns`` for details on the syntax of patterns.
2374
To remove patterns from the ignore list, edit the .bzrignore file.
2375
After adding, editing or deleting that file either indirectly by
2376
using this command or directly by using an editor, be sure to commit
2379
Note: ignore patterns containing shell wildcards must be quoted from
2383
Ignore the top level Makefile::
2385
bzr ignore ./Makefile
2387
Ignore class files in all directories::
2389
bzr ignore "*.class"
2391
Ignore .o files under the lib directory::
2393
bzr ignore "lib/**/*.o"
2395
Ignore .o files under the lib directory::
2397
bzr ignore "RE:lib/.*\.o"
2399
Ignore everything but the "debian" toplevel directory::
2401
bzr ignore "RE:(?!debian/).*"
2404
_see_also = ['status', 'ignored', 'patterns']
2405
takes_args = ['name_pattern*']
2407
Option('old-default-rules',
2408
help='Write out the ignore rules bzr < 0.9 always used.')
2411
def run(self, name_pattern_list=None, old_default_rules=None):
2412
from bzrlib import ignores
2413
if old_default_rules is not None:
2414
# dump the rules and exit
2415
for pattern in ignores.OLD_DEFAULTS:
2418
if not name_pattern_list:
2419
raise errors.BzrCommandError("ignore requires at least one "
2420
"NAME_PATTERN or --old-default-rules")
2421
name_pattern_list = [globbing.normalize_pattern(p)
2422
for p in name_pattern_list]
2423
for name_pattern in name_pattern_list:
2424
if (name_pattern[0] == '/' or
2425
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2426
raise errors.BzrCommandError(
2427
"NAME_PATTERN should not be an absolute path")
2428
tree, relpath = WorkingTree.open_containing(u'.')
2429
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2430
ignored = globbing.Globster(name_pattern_list)
2433
for entry in tree.list_files():
2437
if ignored.match(filename):
2438
matches.append(filename.encode('utf-8'))
2440
if len(matches) > 0:
2441
print "Warning: the following files are version controlled and" \
2442
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2445
class cmd_ignored(Command):
2446
"""List ignored files and the patterns that matched them.
2448
List all the ignored files and the ignore pattern that caused the file to
2451
Alternatively, to list just the files::
2456
encoding_type = 'replace'
2457
_see_also = ['ignore', 'ls']
2461
tree = WorkingTree.open_containing(u'.')[0]
2464
for path, file_class, kind, file_id, entry in tree.list_files():
2465
if file_class != 'I':
2467
## XXX: Slightly inefficient since this was already calculated
2468
pat = tree.is_ignored(path)
2469
self.outf.write('%-50s %s\n' % (path, pat))
2474
class cmd_lookup_revision(Command):
2475
"""Lookup the revision-id from a revision-number
2478
bzr lookup-revision 33
2481
takes_args = ['revno']
2484
def run(self, revno):
2488
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2490
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2493
class cmd_export(Command):
2494
"""Export current or past revision to a destination directory or archive.
2496
If no revision is specified this exports the last committed revision.
2498
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2499
given, try to find the format with the extension. If no extension
2500
is found exports to a directory (equivalent to --format=dir).
2502
If root is supplied, it will be used as the root directory inside
2503
container formats (tar, zip, etc). If it is not supplied it will default
2504
to the exported filename. The root option has no effect for 'dir' format.
2506
If branch is omitted then the branch containing the current working
2507
directory will be used.
2509
Note: Export of tree with non-ASCII filenames to zip is not supported.
2511
================= =========================
2512
Supported formats Autodetected by extension
2513
================= =========================
2516
tbz2 .tar.bz2, .tbz2
2519
================= =========================
2521
takes_args = ['dest', 'branch_or_subdir?']
2524
help="Type of file to export to.",
2529
help="Name of the root directory inside the exported file."),
2531
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2533
from bzrlib.export import export
2535
if branch_or_subdir is None:
2536
tree = WorkingTree.open_containing(u'.')[0]
2540
b, subdir = Branch.open_containing(branch_or_subdir)
2543
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2545
export(rev_tree, dest, format, root, subdir)
2546
except errors.NoSuchExportFormat, e:
2547
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2550
class cmd_cat(Command):
2551
"""Write the contents of a file as of a given revision to standard output.
2553
If no revision is nominated, the last revision is used.
2555
Note: Take care to redirect standard output when using this command on a
2561
Option('name-from-revision', help='The path name in the old tree.'),
2564
takes_args = ['filename']
2565
encoding_type = 'exact'
2568
def run(self, filename, revision=None, name_from_revision=False):
2569
if revision is not None and len(revision) != 1:
2570
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2571
" one revision specifier")
2572
tree, branch, relpath = \
2573
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2576
return self._run(tree, branch, relpath, filename, revision,
2581
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2583
tree = b.basis_tree()
2584
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2586
cur_file_id = tree.path2id(relpath)
2587
old_file_id = rev_tree.path2id(relpath)
2589
if name_from_revision:
2590
if old_file_id is None:
2591
raise errors.BzrCommandError(
2592
"%r is not present in revision %s" % (
2593
filename, rev_tree.get_revision_id()))
2595
content = rev_tree.get_file_text(old_file_id)
2596
elif cur_file_id is not None:
2597
content = rev_tree.get_file_text(cur_file_id)
2598
elif old_file_id is not None:
2599
content = rev_tree.get_file_text(old_file_id)
2601
raise errors.BzrCommandError(
2602
"%r is not present in revision %s" % (
2603
filename, rev_tree.get_revision_id()))
2604
self.outf.write(content)
2607
class cmd_local_time_offset(Command):
2608
"""Show the offset in seconds from GMT to local time."""
2612
print osutils.local_time_offset()
2616
class cmd_commit(Command):
2617
"""Commit changes into a new revision.
2619
If no arguments are given, the entire tree is committed.
2621
If selected files are specified, only changes to those files are
2622
committed. If a directory is specified then the directory and everything
2623
within it is committed.
2625
When excludes are given, they take precedence over selected files.
2626
For example, too commit only changes within foo, but not changes within
2629
bzr commit foo -x foo/bar
2631
If author of the change is not the same person as the committer, you can
2632
specify the author's name using the --author option. The name should be
2633
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2634
If there is more than one author of the change you can specify the option
2635
multiple times, once for each author.
2637
A selected-file commit may fail in some cases where the committed
2638
tree would be invalid. Consider::
2643
bzr commit foo -m "committing foo"
2644
bzr mv foo/bar foo/baz
2647
bzr commit foo/bar -m "committing bar but not baz"
2649
In the example above, the last commit will fail by design. This gives
2650
the user the opportunity to decide whether they want to commit the
2651
rename at the same time, separately first, or not at all. (As a general
2652
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2654
Note: A selected-file commit after a merge is not yet supported.
2656
# TODO: Run hooks on tree to-be-committed, and after commit.
2658
# TODO: Strict commit that fails if there are deleted files.
2659
# (what does "deleted files" mean ??)
2661
# TODO: Give better message for -s, --summary, used by tla people
2663
# XXX: verbose currently does nothing
2665
_see_also = ['bugs', 'uncommit']
2666
takes_args = ['selected*']
2668
ListOption('exclude', type=str, short_name='x',
2669
help="Do not consider changes made to a given path."),
2670
Option('message', type=unicode,
2672
help="Description of the new revision."),
2675
help='Commit even if nothing has changed.'),
2676
Option('file', type=str,
2679
help='Take commit message from this file.'),
2681
help="Refuse to commit if there are unknown "
2682
"files in the working tree."),
2683
ListOption('fixes', type=str,
2684
help="Mark a bug as being fixed by this revision."),
2685
ListOption('author', type=unicode,
2686
help="Set the author's name, if it's different "
2687
"from the committer."),
2689
help="Perform a local commit in a bound "
2690
"branch. Local commits are not pushed to "
2691
"the master branch until a normal commit "
2695
help='When no message is supplied, show the diff along'
2696
' with the status summary in the message editor.'),
2698
aliases = ['ci', 'checkin']
2700
def _get_bug_fix_properties(self, fixes, branch):
2702
# Configure the properties for bug fixing attributes.
2703
for fixed_bug in fixes:
2704
tokens = fixed_bug.split(':')
2705
if len(tokens) != 2:
2706
raise errors.BzrCommandError(
2707
"Invalid bug %s. Must be in the form of 'tag:id'. "
2708
"Commit refused." % fixed_bug)
2709
tag, bug_id = tokens
2711
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2712
except errors.UnknownBugTrackerAbbreviation:
2713
raise errors.BzrCommandError(
2714
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2715
except errors.MalformedBugIdentifier:
2716
raise errors.BzrCommandError(
2717
"Invalid bug identifier for %s. Commit refused."
2719
properties.append('%s fixed' % bug_url)
2720
return '\n'.join(properties)
2722
def run(self, message=None, file=None, verbose=False, selected_list=None,
2723
unchanged=False, strict=False, local=False, fixes=None,
2724
author=None, show_diff=False, exclude=None):
2725
from bzrlib.errors import (
2730
from bzrlib.msgeditor import (
2731
edit_commit_message_encoded,
2732
generate_commit_message_template,
2733
make_commit_message_template_encoded
2736
# TODO: Need a blackbox test for invoking the external editor; may be
2737
# slightly problematic to run this cross-platform.
2739
# TODO: do more checks that the commit will succeed before
2740
# spending the user's valuable time typing a commit message.
2744
tree, selected_list = tree_files(selected_list)
2745
if selected_list == ['']:
2746
# workaround - commit of root of tree should be exactly the same
2747
# as just default commit in that tree, and succeed even though
2748
# selected-file merge commit is not done yet
2753
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2755
properties['bugs'] = bug_property
2757
if local and not tree.branch.get_bound_location():
2758
raise errors.LocalRequiresBoundBranch()
2760
def get_message(commit_obj):
2761
"""Callback to get commit message"""
2762
my_message = message
2763
if my_message is None and not file:
2764
t = make_commit_message_template_encoded(tree,
2765
selected_list, diff=show_diff,
2766
output_encoding=osutils.get_user_encoding())
2767
start_message = generate_commit_message_template(commit_obj)
2768
my_message = edit_commit_message_encoded(t,
2769
start_message=start_message)
2770
if my_message is None:
2771
raise errors.BzrCommandError("please specify a commit"
2772
" message with either --message or --file")
2773
elif my_message and file:
2774
raise errors.BzrCommandError(
2775
"please specify either --message or --file")
2777
my_message = codecs.open(file, 'rt',
2778
osutils.get_user_encoding()).read()
2779
if my_message == "":
2780
raise errors.BzrCommandError("empty commit message specified")
2784
tree.commit(message_callback=get_message,
2785
specific_files=selected_list,
2786
allow_pointless=unchanged, strict=strict, local=local,
2787
reporter=None, verbose=verbose, revprops=properties,
2789
exclude=safe_relpath_files(tree, exclude))
2790
except PointlessCommit:
2791
# FIXME: This should really happen before the file is read in;
2792
# perhaps prepare the commit; get the message; then actually commit
2793
raise errors.BzrCommandError("no changes to commit."
2794
" use --unchanged to commit anyhow")
2795
except ConflictsInTree:
2796
raise errors.BzrCommandError('Conflicts detected in working '
2797
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2799
except StrictCommitFailed:
2800
raise errors.BzrCommandError("Commit refused because there are"
2801
" unknown files in the working tree.")
2802
except errors.BoundBranchOutOfDate, e:
2803
raise errors.BzrCommandError(str(e) + "\n"
2804
'To commit to master branch, run update and then commit.\n'
2805
'You can also pass --local to commit to continue working '
2809
class cmd_check(Command):
2810
"""Validate working tree structure, branch consistency and repository history.
2812
This command checks various invariants about branch and repository storage
2813
to detect data corruption or bzr bugs.
2815
The working tree and branch checks will only give output if a problem is
2816
detected. The output fields of the repository check are:
2818
revisions: This is just the number of revisions checked. It doesn't
2820
versionedfiles: This is just the number of versionedfiles checked. It
2821
doesn't indicate a problem.
2822
unreferenced ancestors: Texts that are ancestors of other texts, but
2823
are not properly referenced by the revision ancestry. This is a
2824
subtle problem that Bazaar can work around.
2825
unique file texts: This is the total number of unique file contents
2826
seen in the checked revisions. It does not indicate a problem.
2827
repeated file texts: This is the total number of repeated texts seen
2828
in the checked revisions. Texts can be repeated when their file
2829
entries are modified, but the file contents are not. It does not
2832
If no restrictions are specified, all Bazaar data that is found at the given
2833
location will be checked.
2837
Check the tree and branch at 'foo'::
2839
bzr check --tree --branch foo
2841
Check only the repository at 'bar'::
2843
bzr check --repo bar
2845
Check everything at 'baz'::
2850
_see_also = ['reconcile']
2851
takes_args = ['path?']
2852
takes_options = ['verbose',
2853
Option('branch', help="Check the branch related to the"
2854
" current directory."),
2855
Option('repo', help="Check the repository related to the"
2856
" current directory."),
2857
Option('tree', help="Check the working tree related to"
2858
" the current directory.")]
2860
def run(self, path=None, verbose=False, branch=False, repo=False,
2862
from bzrlib.check import check_dwim
2865
if not branch and not repo and not tree:
2866
branch = repo = tree = True
2867
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2870
class cmd_upgrade(Command):
2871
"""Upgrade branch storage to current format.
2873
The check command or bzr developers may sometimes advise you to run
2874
this command. When the default format has changed you may also be warned
2875
during other operations to upgrade.
2878
_see_also = ['check']
2879
takes_args = ['url?']
2881
RegistryOption('format',
2882
help='Upgrade to a specific format. See "bzr help'
2883
' formats" for details.',
2884
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2885
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2886
value_switches=True, title='Branch format'),
2889
def run(self, url='.', format=None):
2890
from bzrlib.upgrade import upgrade
2892
format = bzrdir.format_registry.make_bzrdir('default')
2893
upgrade(url, format)
2896
class cmd_whoami(Command):
2897
"""Show or set bzr user id.
2900
Show the email of the current user::
2904
Set the current user::
2906
bzr whoami "Frank Chu <fchu@example.com>"
2908
takes_options = [ Option('email',
2909
help='Display email address only.'),
2911
help='Set identity for the current branch instead of '
2914
takes_args = ['name?']
2915
encoding_type = 'replace'
2918
def run(self, email=False, branch=False, name=None):
2920
# use branch if we're inside one; otherwise global config
2922
c = Branch.open_containing('.')[0].get_config()
2923
except errors.NotBranchError:
2924
c = config.GlobalConfig()
2926
self.outf.write(c.user_email() + '\n')
2928
self.outf.write(c.username() + '\n')
2931
# display a warning if an email address isn't included in the given name.
2933
config.extract_email_address(name)
2934
except errors.NoEmailInUsername, e:
2935
warning('"%s" does not seem to contain an email address. '
2936
'This is allowed, but not recommended.', name)
2938
# use global config unless --branch given
2940
c = Branch.open_containing('.')[0].get_config()
2942
c = config.GlobalConfig()
2943
c.set_user_option('email', name)
2946
class cmd_nick(Command):
2947
"""Print or set the branch nickname.
2949
If unset, the tree root directory name is used as the nickname.
2950
To print the current nickname, execute with no argument.
2952
Bound branches use the nickname of its master branch unless it is set
2956
_see_also = ['info']
2957
takes_args = ['nickname?']
2958
def run(self, nickname=None):
2959
branch = Branch.open_containing(u'.')[0]
2960
if nickname is None:
2961
self.printme(branch)
2963
branch.nick = nickname
2966
def printme(self, branch):
2970
class cmd_alias(Command):
2971
"""Set/unset and display aliases.
2974
Show the current aliases::
2978
Show the alias specified for 'll'::
2982
Set an alias for 'll'::
2984
bzr alias ll="log --line -r-10..-1"
2986
To remove an alias for 'll'::
2988
bzr alias --remove ll
2991
takes_args = ['name?']
2993
Option('remove', help='Remove the alias.'),
2996
def run(self, name=None, remove=False):
2998
self.remove_alias(name)
3000
self.print_aliases()
3002
equal_pos = name.find('=')
3004
self.print_alias(name)
3006
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3008
def remove_alias(self, alias_name):
3009
if alias_name is None:
3010
raise errors.BzrCommandError(
3011
'bzr alias --remove expects an alias to remove.')
3012
# If alias is not found, print something like:
3013
# unalias: foo: not found
3014
c = config.GlobalConfig()
3015
c.unset_alias(alias_name)
3018
def print_aliases(self):
3019
"""Print out the defined aliases in a similar format to bash."""
3020
aliases = config.GlobalConfig().get_aliases()
3021
for key, value in sorted(aliases.iteritems()):
3022
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3025
def print_alias(self, alias_name):
3026
from bzrlib.commands import get_alias
3027
alias = get_alias(alias_name)
3029
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3032
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3034
def set_alias(self, alias_name, alias_command):
3035
"""Save the alias in the global config."""
3036
c = config.GlobalConfig()
3037
c.set_alias(alias_name, alias_command)
3040
class cmd_selftest(Command):
3041
"""Run internal test suite.
3043
If arguments are given, they are regular expressions that say which tests
3044
should run. Tests matching any expression are run, and other tests are
3047
Alternatively if --first is given, matching tests are run first and then
3048
all other tests are run. This is useful if you have been working in a
3049
particular area, but want to make sure nothing else was broken.
3051
If --exclude is given, tests that match that regular expression are
3052
excluded, regardless of whether they match --first or not.
3054
To help catch accidential dependencies between tests, the --randomize
3055
option is useful. In most cases, the argument used is the word 'now'.
3056
Note that the seed used for the random number generator is displayed
3057
when this option is used. The seed can be explicitly passed as the
3058
argument to this option if required. This enables reproduction of the
3059
actual ordering used if and when an order sensitive problem is encountered.
3061
If --list-only is given, the tests that would be run are listed. This is
3062
useful when combined with --first, --exclude and/or --randomize to
3063
understand their impact. The test harness reports "Listed nn tests in ..."
3064
instead of "Ran nn tests in ..." when list mode is enabled.
3066
If the global option '--no-plugins' is given, plugins are not loaded
3067
before running the selftests. This has two effects: features provided or
3068
modified by plugins will not be tested, and tests provided by plugins will
3071
Tests that need working space on disk use a common temporary directory,
3072
typically inside $TMPDIR or /tmp.
3075
Run only tests relating to 'ignore'::
3079
Disable plugins and list tests as they're run::
3081
bzr --no-plugins selftest -v
3083
# NB: this is used from the class without creating an instance, which is
3084
# why it does not have a self parameter.
3085
def get_transport_type(typestring):
3086
"""Parse and return a transport specifier."""
3087
if typestring == "sftp":
3088
from bzrlib.transport.sftp import SFTPAbsoluteServer
3089
return SFTPAbsoluteServer
3090
if typestring == "memory":
3091
from bzrlib.transport.memory import MemoryServer
3093
if typestring == "fakenfs":
3094
from bzrlib.transport.fakenfs import FakeNFSServer
3095
return FakeNFSServer
3096
msg = "No known transport type %s. Supported types are: sftp\n" %\
3098
raise errors.BzrCommandError(msg)
3101
takes_args = ['testspecs*']
3102
takes_options = ['verbose',
3104
help='Stop when one test fails.',
3108
help='Use a different transport by default '
3109
'throughout the test suite.',
3110
type=get_transport_type),
3112
help='Run the benchmarks rather than selftests.'),
3113
Option('lsprof-timed',
3114
help='Generate lsprof output for benchmarked'
3115
' sections of code.'),
3116
Option('cache-dir', type=str,
3117
help='Cache intermediate benchmark output in this '
3120
help='Run all tests, but run specified tests first.',
3124
help='List the tests instead of running them.'),
3125
Option('randomize', type=str, argname="SEED",
3126
help='Randomize the order of tests using the given'
3127
' seed or "now" for the current time.'),
3128
Option('exclude', type=str, argname="PATTERN",
3130
help='Exclude tests that match this regular'
3132
Option('strict', help='Fail on missing dependencies or '
3134
Option('load-list', type=str, argname='TESTLISTFILE',
3135
help='Load a test id list from a text file.'),
3136
ListOption('debugflag', type=str, short_name='E',
3137
help='Turn on a selftest debug flag.'),
3138
ListOption('starting-with', type=str, argname='TESTID',
3139
param_name='starting_with', short_name='s',
3141
'Load only the tests starting with TESTID.'),
3143
encoding_type = 'replace'
3146
Command.__init__(self)
3147
self.additional_selftest_args = {}
3149
def run(self, testspecs_list=None, verbose=False, one=False,
3150
transport=None, benchmark=None,
3151
lsprof_timed=None, cache_dir=None,
3152
first=False, list_only=False,
3153
randomize=None, exclude=None, strict=False,
3154
load_list=None, debugflag=None, starting_with=None):
3155
from bzrlib.tests import selftest
3156
import bzrlib.benchmarks as benchmarks
3157
from bzrlib.benchmarks import tree_creator
3159
# Make deprecation warnings visible, unless -Werror is set
3160
symbol_versioning.activate_deprecation_warnings(override=False)
3162
if cache_dir is not None:
3163
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3165
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
3166
print ' %s (%s python%s)' % (
3168
bzrlib.version_string,
3169
bzrlib._format_version_tuple(sys.version_info),
3172
if testspecs_list is not None:
3173
pattern = '|'.join(testspecs_list)
3177
test_suite_factory = benchmarks.test_suite
3178
# Unless user explicitly asks for quiet, be verbose in benchmarks
3179
verbose = not is_quiet()
3180
# TODO: should possibly lock the history file...
3181
benchfile = open(".perf_history", "at", buffering=1)
3183
test_suite_factory = None
3186
selftest_kwargs = {"verbose": verbose,
3188
"stop_on_failure": one,
3189
"transport": transport,
3190
"test_suite_factory": test_suite_factory,
3191
"lsprof_timed": lsprof_timed,
3192
"bench_history": benchfile,
3193
"matching_tests_first": first,
3194
"list_only": list_only,
3195
"random_seed": randomize,
3196
"exclude_pattern": exclude,
3198
"load_list": load_list,
3199
"debug_flags": debugflag,
3200
"starting_with": starting_with
3202
selftest_kwargs.update(self.additional_selftest_args)
3203
result = selftest(**selftest_kwargs)
3205
if benchfile is not None:
3208
note('tests passed')
3210
note('tests failed')
3211
return int(not result)
3214
class cmd_version(Command):
3215
"""Show version of bzr."""
3217
encoding_type = 'replace'
3219
Option("short", help="Print just the version number."),
3223
def run(self, short=False):
3224
from bzrlib.version import show_version
3226
self.outf.write(bzrlib.version_string + '\n')
3228
show_version(to_file=self.outf)
3231
class cmd_rocks(Command):
3232
"""Statement of optimism."""
3238
print "It sure does!"
3241
class cmd_find_merge_base(Command):
3242
"""Find and print a base revision for merging two branches."""
3243
# TODO: Options to specify revisions on either side, as if
3244
# merging only part of the history.
3245
takes_args = ['branch', 'other']
3249
def run(self, branch, other):
3250
from bzrlib.revision import ensure_null
3252
branch1 = Branch.open_containing(branch)[0]
3253
branch2 = Branch.open_containing(other)[0]
3258
last1 = ensure_null(branch1.last_revision())
3259
last2 = ensure_null(branch2.last_revision())
3261
graph = branch1.repository.get_graph(branch2.repository)
3262
base_rev_id = graph.find_unique_lca(last1, last2)
3264
print 'merge base is revision %s' % base_rev_id
3271
class cmd_merge(Command):
3272
"""Perform a three-way merge.
3274
The source of the merge can be specified either in the form of a branch,
3275
or in the form of a path to a file containing a merge directive generated
3276
with bzr send. If neither is specified, the default is the upstream branch
3277
or the branch most recently merged using --remember.
3279
When merging a branch, by default the tip will be merged. To pick a different
3280
revision, pass --revision. If you specify two values, the first will be used as
3281
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3282
available revisions, like this is commonly referred to as "cherrypicking".
3284
Revision numbers are always relative to the branch being merged.
3286
By default, bzr will try to merge in all new work from the other
3287
branch, automatically determining an appropriate base. If this
3288
fails, you may need to give an explicit base.
3290
Merge will do its best to combine the changes in two branches, but there
3291
are some kinds of problems only a human can fix. When it encounters those,
3292
it will mark a conflict. A conflict means that you need to fix something,
3293
before you should commit.
3295
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3297
If there is no default branch set, the first merge will set it. After
3298
that, you can omit the branch to use the default. To change the
3299
default, use --remember. The value will only be saved if the remote
3300
location can be accessed.
3302
The results of the merge are placed into the destination working
3303
directory, where they can be reviewed (with bzr diff), tested, and then
3304
committed to record the result of the merge.
3306
merge refuses to run if there are any uncommitted changes, unless
3310
To merge the latest revision from bzr.dev::
3312
bzr merge ../bzr.dev
3314
To merge changes up to and including revision 82 from bzr.dev::
3316
bzr merge -r 82 ../bzr.dev
3318
To merge the changes introduced by 82, without previous changes::
3320
bzr merge -r 81..82 ../bzr.dev
3322
To apply a merge directive contained in in /tmp/merge:
3324
bzr merge /tmp/merge
3327
encoding_type = 'exact'
3328
_see_also = ['update', 'remerge', 'status-flags']
3329
takes_args = ['location?']
3334
help='Merge even if the destination tree has uncommitted changes.'),
3338
Option('show-base', help="Show base revision text in "
3340
Option('uncommitted', help='Apply uncommitted changes'
3341
' from a working copy, instead of branch changes.'),
3342
Option('pull', help='If the destination is already'
3343
' completely merged into the source, pull from the'
3344
' source rather than merging. When this happens,'
3345
' you do not need to commit the result.'),
3347
help='Branch to merge into, '
3348
'rather than the one containing the working directory.',
3352
Option('preview', help='Instead of merging, show a diff of the merge.')
3355
def run(self, location=None, revision=None, force=False,
3356
merge_type=None, show_base=False, reprocess=None, remember=False,
3357
uncommitted=False, pull=False,
3361
if merge_type is None:
3362
merge_type = _mod_merge.Merge3Merger
3364
if directory is None: directory = u'.'
3365
possible_transports = []
3367
allow_pending = True
3368
verified = 'inapplicable'
3369
tree = WorkingTree.open_containing(directory)[0]
3371
# die as quickly as possible if there are uncommitted changes
3373
basis_tree = tree.revision_tree(tree.last_revision())
3374
except errors.NoSuchRevision:
3375
basis_tree = tree.basis_tree()
3376
changes = tree.changes_from(basis_tree)
3377
if changes.has_changed():
3378
raise errors.UncommittedChanges(tree)
3380
view_info = _get_view_info_for_change_reporter(tree)
3381
change_reporter = delta._ChangeReporter(
3382
unversioned_filter=tree.is_ignored, view_info=view_info)
3385
pb = ui.ui_factory.nested_progress_bar()
3386
cleanups.append(pb.finished)
3388
cleanups.append(tree.unlock)
3389
if location is not None:
3391
mergeable = bundle.read_mergeable_from_url(location,
3392
possible_transports=possible_transports)
3393
except errors.NotABundle:
3397
raise errors.BzrCommandError('Cannot use --uncommitted'
3398
' with bundles or merge directives.')
3400
if revision is not None:
3401
raise errors.BzrCommandError(
3402
'Cannot use -r with merge directives or bundles')
3403
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3406
if merger is None and uncommitted:
3407
if revision is not None and len(revision) > 0:
3408
raise errors.BzrCommandError('Cannot use --uncommitted and'
3409
' --revision at the same time.')
3410
location = self._select_branch_location(tree, location)[0]
3411
other_tree, other_path = WorkingTree.open_containing(location)
3412
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3414
allow_pending = False
3415
if other_path != '':
3416
merger.interesting_files = [other_path]
3419
merger, allow_pending = self._get_merger_from_branch(tree,
3420
location, revision, remember, possible_transports, pb)
3422
merger.merge_type = merge_type
3423
merger.reprocess = reprocess
3424
merger.show_base = show_base
3425
self.sanity_check_merger(merger)
3426
if (merger.base_rev_id == merger.other_rev_id and
3427
merger.other_rev_id is not None):
3428
note('Nothing to do.')
3431
if merger.interesting_files is not None:
3432
raise errors.BzrCommandError('Cannot pull individual files')
3433
if (merger.base_rev_id == tree.last_revision()):
3434
result = tree.pull(merger.other_branch, False,
3435
merger.other_rev_id)
3436
result.report(self.outf)
3438
merger.check_basis(False)
3440
return self._do_preview(merger)
3442
return self._do_merge(merger, change_reporter, allow_pending,
3445
for cleanup in reversed(cleanups):
3448
def _do_preview(self, merger):
3449
from bzrlib.diff import show_diff_trees
3450
tree_merger = merger.make_merger()
3451
tt = tree_merger.make_preview_transform()
3453
result_tree = tt.get_preview_tree()
3454
show_diff_trees(merger.this_tree, result_tree, self.outf,
3455
old_label='', new_label='')
3459
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3460
merger.change_reporter = change_reporter
3461
conflict_count = merger.do_merge()
3463
merger.set_pending()
3464
if verified == 'failed':
3465
warning('Preview patch does not match changes')
3466
if conflict_count != 0:
3471
def sanity_check_merger(self, merger):
3472
if (merger.show_base and
3473
not merger.merge_type is _mod_merge.Merge3Merger):
3474
raise errors.BzrCommandError("Show-base is not supported for this"
3475
" merge type. %s" % merger.merge_type)
3476
if merger.reprocess is None:
3477
if merger.show_base:
3478
merger.reprocess = False
3480
# Use reprocess if the merger supports it
3481
merger.reprocess = merger.merge_type.supports_reprocess
3482
if merger.reprocess and not merger.merge_type.supports_reprocess:
3483
raise errors.BzrCommandError("Conflict reduction is not supported"
3484
" for merge type %s." %
3486
if merger.reprocess and merger.show_base:
3487
raise errors.BzrCommandError("Cannot do conflict reduction and"
3490
def _get_merger_from_branch(self, tree, location, revision, remember,
3491
possible_transports, pb):
3492
"""Produce a merger from a location, assuming it refers to a branch."""
3493
from bzrlib.tag import _merge_tags_if_possible
3494
# find the branch locations
3495
other_loc, user_location = self._select_branch_location(tree, location,
3497
if revision is not None and len(revision) == 2:
3498
base_loc, _unused = self._select_branch_location(tree,
3499
location, revision, 0)
3501
base_loc = other_loc
3503
other_branch, other_path = Branch.open_containing(other_loc,
3504
possible_transports)
3505
if base_loc == other_loc:
3506
base_branch = other_branch
3508
base_branch, base_path = Branch.open_containing(base_loc,
3509
possible_transports)
3510
# Find the revision ids
3511
if revision is None or len(revision) < 1 or revision[-1] is None:
3512
other_revision_id = _mod_revision.ensure_null(
3513
other_branch.last_revision())
3515
other_revision_id = revision[-1].as_revision_id(other_branch)
3516
if (revision is not None and len(revision) == 2
3517
and revision[0] is not None):
3518
base_revision_id = revision[0].as_revision_id(base_branch)
3520
base_revision_id = None
3521
# Remember where we merge from
3522
if ((remember or tree.branch.get_submit_branch() is None) and
3523
user_location is not None):
3524
tree.branch.set_submit_branch(other_branch.base)
3525
_merge_tags_if_possible(other_branch, tree.branch)
3526
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3527
other_revision_id, base_revision_id, other_branch, base_branch)
3528
if other_path != '':
3529
allow_pending = False
3530
merger.interesting_files = [other_path]
3532
allow_pending = True
3533
return merger, allow_pending
3535
def _select_branch_location(self, tree, user_location, revision=None,
3537
"""Select a branch location, according to possible inputs.
3539
If provided, branches from ``revision`` are preferred. (Both
3540
``revision`` and ``index`` must be supplied.)
3542
Otherwise, the ``location`` parameter is used. If it is None, then the
3543
``submit`` or ``parent`` location is used, and a note is printed.
3545
:param tree: The working tree to select a branch for merging into
3546
:param location: The location entered by the user
3547
:param revision: The revision parameter to the command
3548
:param index: The index to use for the revision parameter. Negative
3549
indices are permitted.
3550
:return: (selected_location, user_location). The default location
3551
will be the user-entered location.
3553
if (revision is not None and index is not None
3554
and revision[index] is not None):
3555
branch = revision[index].get_branch()
3556
if branch is not None:
3557
return branch, branch
3558
if user_location is None:
3559
location = self._get_remembered(tree, 'Merging from')
3561
location = user_location
3562
return location, user_location
3564
def _get_remembered(self, tree, verb_string):
3565
"""Use tree.branch's parent if none was supplied.
3567
Report if the remembered location was used.
3569
stored_location = tree.branch.get_submit_branch()
3570
stored_location_type = "submit"
3571
if stored_location is None:
3572
stored_location = tree.branch.get_parent()
3573
stored_location_type = "parent"
3574
mutter("%s", stored_location)
3575
if stored_location is None:
3576
raise errors.BzrCommandError("No location specified or remembered")
3577
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3578
note(u"%s remembered %s location %s", verb_string,
3579
stored_location_type, display_url)
3580
return stored_location
3583
class cmd_remerge(Command):
3586
Use this if you want to try a different merge technique while resolving
3587
conflicts. Some merge techniques are better than others, and remerge
3588
lets you try different ones on different files.
3590
The options for remerge have the same meaning and defaults as the ones for
3591
merge. The difference is that remerge can (only) be run when there is a
3592
pending merge, and it lets you specify particular files.
3595
Re-do the merge of all conflicted files, and show the base text in
3596
conflict regions, in addition to the usual THIS and OTHER texts::
3598
bzr remerge --show-base
3600
Re-do the merge of "foobar", using the weave merge algorithm, with
3601
additional processing to reduce the size of conflict regions::
3603
bzr remerge --merge-type weave --reprocess foobar
3605
takes_args = ['file*']
3610
help="Show base revision text in conflicts."),
3613
def run(self, file_list=None, merge_type=None, show_base=False,
3615
if merge_type is None:
3616
merge_type = _mod_merge.Merge3Merger
3617
tree, file_list = tree_files(file_list)
3620
parents = tree.get_parent_ids()
3621
if len(parents) != 2:
3622
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3623
" merges. Not cherrypicking or"
3625
repository = tree.branch.repository
3626
interesting_ids = None
3628
conflicts = tree.conflicts()
3629
if file_list is not None:
3630
interesting_ids = set()
3631
for filename in file_list:
3632
file_id = tree.path2id(filename)
3634
raise errors.NotVersionedError(filename)
3635
interesting_ids.add(file_id)
3636
if tree.kind(file_id) != "directory":
3639
for name, ie in tree.inventory.iter_entries(file_id):
3640
interesting_ids.add(ie.file_id)
3641
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3643
# Remerge only supports resolving contents conflicts
3644
allowed_conflicts = ('text conflict', 'contents conflict')
3645
restore_files = [c.path for c in conflicts
3646
if c.typestring in allowed_conflicts]
3647
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3648
tree.set_conflicts(ConflictList(new_conflicts))
3649
if file_list is not None:
3650
restore_files = file_list
3651
for filename in restore_files:
3653
restore(tree.abspath(filename))
3654
except errors.NotConflicted:
3656
# Disable pending merges, because the file texts we are remerging
3657
# have not had those merges performed. If we use the wrong parents
3658
# list, we imply that the working tree text has seen and rejected
3659
# all the changes from the other tree, when in fact those changes
3660
# have not yet been seen.
3661
pb = ui.ui_factory.nested_progress_bar()
3662
tree.set_parent_ids(parents[:1])
3664
merger = _mod_merge.Merger.from_revision_ids(pb,
3666
merger.interesting_ids = interesting_ids
3667
merger.merge_type = merge_type
3668
merger.show_base = show_base
3669
merger.reprocess = reprocess
3670
conflicts = merger.do_merge()
3672
tree.set_parent_ids(parents)
3682
class cmd_revert(Command):
3683
"""Revert files to a previous revision.
3685
Giving a list of files will revert only those files. Otherwise, all files
3686
will be reverted. If the revision is not specified with '--revision', the
3687
last committed revision is used.
3689
To remove only some changes, without reverting to a prior version, use
3690
merge instead. For example, "merge . --revision -2..-3" will remove the
3691
changes introduced by -2, without affecting the changes introduced by -1.
3692
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3694
By default, any files that have been manually changed will be backed up
3695
first. (Files changed only by merge are not backed up.) Backup files have
3696
'.~#~' appended to their name, where # is a number.
3698
When you provide files, you can use their current pathname or the pathname
3699
from the target revision. So you can use revert to "undelete" a file by
3700
name. If you name a directory, all the contents of that directory will be
3703
Any files that have been newly added since that revision will be deleted,
3704
with a backup kept if appropriate. Directories containing unknown files
3705
will not be deleted.
3707
The working tree contains a list of pending merged revisions, which will
3708
be included as parents in the next commit. Normally, revert clears that
3709
list as well as reverting the files. If any files are specified, revert
3710
leaves the pending merge list alone and reverts only the files. Use "bzr
3711
revert ." in the tree root to revert all files but keep the merge record,
3712
and "bzr revert --forget-merges" to clear the pending merge list without
3713
reverting any files.
3716
_see_also = ['cat', 'export']
3719
Option('no-backup', "Do not save backups of reverted files."),
3720
Option('forget-merges',
3721
'Remove pending merge marker, without changing any files.'),
3723
takes_args = ['file*']
3725
def run(self, revision=None, no_backup=False, file_list=None,
3726
forget_merges=None):
3727
tree, file_list = tree_files(file_list)
3731
tree.set_parent_ids(tree.get_parent_ids()[:1])
3733
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3738
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3739
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3740
pb = ui.ui_factory.nested_progress_bar()
3742
tree.revert(file_list, rev_tree, not no_backup, pb,
3743
report_changes=True)
3748
class cmd_assert_fail(Command):
3749
"""Test reporting of assertion failures"""
3750
# intended just for use in testing
3755
raise AssertionError("always fails")
3758
class cmd_help(Command):
3759
"""Show help on a command or other topic.
3762
_see_also = ['topics']
3764
Option('long', 'Show help on all commands.'),
3766
takes_args = ['topic?']
3767
aliases = ['?', '--help', '-?', '-h']
3770
def run(self, topic=None, long=False):
3772
if topic is None and long:
3774
bzrlib.help.help(topic)
3777
class cmd_shell_complete(Command):
3778
"""Show appropriate completions for context.
3780
For a list of all available commands, say 'bzr shell-complete'.
3782
takes_args = ['context?']
3787
def run(self, context=None):
3788
import shellcomplete
3789
shellcomplete.shellcomplete(context)
3792
class cmd_missing(Command):
3793
"""Show unmerged/unpulled revisions between two branches.
3795
OTHER_BRANCH may be local or remote.
3797
To filter on a range of revirions, you can use the command -r begin..end
3798
-r revision requests a specific revision, -r ..end or -r begin.. are
3803
Determine the missing revisions between this and the branch at the
3804
remembered pull location::
3808
Determine the missing revisions between this and another branch::
3810
bzr missing http://server/branch
3812
Determine the missing revisions up to a specific revision on the other
3815
bzr missing -r ..-10
3817
Determine the missing revisions up to a specific revision on this
3820
bzr missing --my-revision ..-10
3823
_see_also = ['merge', 'pull']
3824
takes_args = ['other_branch?']
3826
Option('reverse', 'Reverse the order of revisions.'),
3828
'Display changes in the local branch only.'),
3829
Option('this' , 'Same as --mine-only.'),
3830
Option('theirs-only',
3831
'Display changes in the remote branch only.'),
3832
Option('other', 'Same as --theirs-only.'),
3836
custom_help('revision',
3837
help='Filter on other branch revisions (inclusive). '
3838
'See "help revisionspec" for details.'),
3839
Option('my-revision',
3840
type=_parse_revision_str,
3841
help='Filter on local branch revisions (inclusive). '
3842
'See "help revisionspec" for details.'),
3843
Option('include-merges', 'Show merged revisions.'),
3845
encoding_type = 'replace'
3848
def run(self, other_branch=None, reverse=False, mine_only=False,
3850
log_format=None, long=False, short=False, line=False,
3851
show_ids=False, verbose=False, this=False, other=False,
3852
include_merges=False, revision=None, my_revision=None):
3853
from bzrlib.missing import find_unmerged, iter_log_revisions
3862
# TODO: We should probably check that we don't have mine-only and
3863
# theirs-only set, but it gets complicated because we also have
3864
# this and other which could be used.
3871
local_branch = Branch.open_containing(u".")[0]
3872
parent = local_branch.get_parent()
3873
if other_branch is None:
3874
other_branch = parent
3875
if other_branch is None:
3876
raise errors.BzrCommandError("No peer location known"
3878
display_url = urlutils.unescape_for_display(parent,
3880
message("Using saved parent location: "
3881
+ display_url + "\n")
3883
remote_branch = Branch.open(other_branch)
3884
if remote_branch.base == local_branch.base:
3885
remote_branch = local_branch
3887
local_revid_range = _revision_range_to_revid_range(
3888
_get_revision_range(my_revision, local_branch,
3891
remote_revid_range = _revision_range_to_revid_range(
3892
_get_revision_range(revision,
3893
remote_branch, self.name()))
3895
local_branch.lock_read()
3897
remote_branch.lock_read()
3899
local_extra, remote_extra = find_unmerged(
3900
local_branch, remote_branch, restrict,
3901
backward=not reverse,
3902
include_merges=include_merges,
3903
local_revid_range=local_revid_range,
3904
remote_revid_range=remote_revid_range)
3906
if log_format is None:
3907
registry = log.log_formatter_registry
3908
log_format = registry.get_default(local_branch)
3909
lf = log_format(to_file=self.outf,
3911
show_timezone='original')
3914
if local_extra and not theirs_only:
3915
message("You have %d extra revision(s):\n" %
3917
for revision in iter_log_revisions(local_extra,
3918
local_branch.repository,
3920
lf.log_revision(revision)
3921
printed_local = True
3924
printed_local = False
3926
if remote_extra and not mine_only:
3927
if printed_local is True:
3929
message("You are missing %d revision(s):\n" %
3931
for revision in iter_log_revisions(remote_extra,
3932
remote_branch.repository,
3934
lf.log_revision(revision)
3937
if mine_only and not local_extra:
3938
# We checked local, and found nothing extra
3939
message('This branch is up to date.\n')
3940
elif theirs_only and not remote_extra:
3941
# We checked remote, and found nothing extra
3942
message('Other branch is up to date.\n')
3943
elif not (mine_only or theirs_only or local_extra or
3945
# We checked both branches, and neither one had extra
3947
message("Branches are up to date.\n")
3949
remote_branch.unlock()
3951
local_branch.unlock()
3952
if not status_code and parent is None and other_branch is not None:
3953
local_branch.lock_write()
3955
# handle race conditions - a parent might be set while we run.
3956
if local_branch.get_parent() is None:
3957
local_branch.set_parent(remote_branch.base)
3959
local_branch.unlock()
3963
class cmd_pack(Command):
3964
"""Compress the data within a repository."""
3966
_see_also = ['repositories']
3967
takes_args = ['branch_or_repo?']
3969
def run(self, branch_or_repo='.'):
3970
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3972
branch = dir.open_branch()
3973
repository = branch.repository
3974
except errors.NotBranchError:
3975
repository = dir.open_repository()
3979
class cmd_plugins(Command):
3980
"""List the installed plugins.
3982
This command displays the list of installed plugins including
3983
version of plugin and a short description of each.
3985
--verbose shows the path where each plugin is located.
3987
A plugin is an external component for Bazaar that extends the
3988
revision control system, by adding or replacing code in Bazaar.
3989
Plugins can do a variety of things, including overriding commands,
3990
adding new commands, providing additional network transports and
3991
customizing log output.
3993
See the Bazaar web site, http://bazaar-vcs.org, for further
3994
information on plugins including where to find them and how to
3995
install them. Instructions are also provided there on how to
3996
write new plugins using the Python programming language.
3998
takes_options = ['verbose']
4001
def run(self, verbose=False):
4002
import bzrlib.plugin
4003
from inspect import getdoc
4005
for name, plugin in bzrlib.plugin.plugins().items():
4006
version = plugin.__version__
4007
if version == 'unknown':
4009
name_ver = '%s %s' % (name, version)
4010
d = getdoc(plugin.module)
4012
doc = d.split('\n')[0]
4014
doc = '(no description)'
4015
result.append((name_ver, doc, plugin.path()))
4016
for name_ver, doc, path in sorted(result):
4024
class cmd_testament(Command):
4025
"""Show testament (signing-form) of a revision."""
4028
Option('long', help='Produce long-format testament.'),
4030
help='Produce a strict-format testament.')]
4031
takes_args = ['branch?']
4033
def run(self, branch=u'.', revision=None, long=False, strict=False):
4034
from bzrlib.testament import Testament, StrictTestament
4036
testament_class = StrictTestament
4038
testament_class = Testament
4040
b = Branch.open_containing(branch)[0]
4042
b = Branch.open(branch)
4045
if revision is None:
4046
rev_id = b.last_revision()
4048
rev_id = revision[0].as_revision_id(b)
4049
t = testament_class.from_revision(b.repository, rev_id)
4051
sys.stdout.writelines(t.as_text_lines())
4053
sys.stdout.write(t.as_short_text())
4058
class cmd_annotate(Command):
4059
"""Show the origin of each line in a file.
4061
This prints out the given file with an annotation on the left side
4062
indicating which revision, author and date introduced the change.
4064
If the origin is the same for a run of consecutive lines, it is
4065
shown only at the top, unless the --all option is given.
4067
# TODO: annotate directories; showing when each file was last changed
4068
# TODO: if the working copy is modified, show annotations on that
4069
# with new uncommitted lines marked
4070
aliases = ['ann', 'blame', 'praise']
4071
takes_args = ['filename']
4072
takes_options = [Option('all', help='Show annotations on all lines.'),
4073
Option('long', help='Show commit date in annotations.'),
4077
encoding_type = 'exact'
4080
def run(self, filename, all=False, long=False, revision=None,
4082
from bzrlib.annotate import annotate_file, annotate_file_tree
4083
wt, branch, relpath = \
4084
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4090
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4092
file_id = wt.path2id(relpath)
4094
file_id = tree.path2id(relpath)
4096
raise errors.NotVersionedError(filename)
4097
file_version = tree.inventory[file_id].revision
4098
if wt is not None and revision is None:
4099
# If there is a tree and we're not annotating historical
4100
# versions, annotate the working tree's content.
4101
annotate_file_tree(wt, file_id, self.outf, long, all,
4104
annotate_file(branch, file_version, file_id, long, all, self.outf,
4113
class cmd_re_sign(Command):
4114
"""Create a digital signature for an existing revision."""
4115
# TODO be able to replace existing ones.
4117
hidden = True # is this right ?
4118
takes_args = ['revision_id*']
4119
takes_options = ['revision']
4121
def run(self, revision_id_list=None, revision=None):
4122
if revision_id_list is not None and revision is not None:
4123
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4124
if revision_id_list is None and revision is None:
4125
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4126
b = WorkingTree.open_containing(u'.')[0].branch
4129
return self._run(b, revision_id_list, revision)
4133
def _run(self, b, revision_id_list, revision):
4134
import bzrlib.gpg as gpg
4135
gpg_strategy = gpg.GPGStrategy(b.get_config())
4136
if revision_id_list is not None:
4137
b.repository.start_write_group()
4139
for revision_id in revision_id_list:
4140
b.repository.sign_revision(revision_id, gpg_strategy)
4142
b.repository.abort_write_group()
4145
b.repository.commit_write_group()
4146
elif revision is not None:
4147
if len(revision) == 1:
4148
revno, rev_id = revision[0].in_history(b)
4149
b.repository.start_write_group()
4151
b.repository.sign_revision(rev_id, gpg_strategy)
4153
b.repository.abort_write_group()
4156
b.repository.commit_write_group()
4157
elif len(revision) == 2:
4158
# are they both on rh- if so we can walk between them
4159
# might be nice to have a range helper for arbitrary
4160
# revision paths. hmm.
4161
from_revno, from_revid = revision[0].in_history(b)
4162
to_revno, to_revid = revision[1].in_history(b)
4163
if to_revid is None:
4164
to_revno = b.revno()
4165
if from_revno is None or to_revno is None:
4166
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4167
b.repository.start_write_group()
4169
for revno in range(from_revno, to_revno + 1):
4170
b.repository.sign_revision(b.get_rev_id(revno),
4173
b.repository.abort_write_group()
4176
b.repository.commit_write_group()
4178
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4181
class cmd_bind(Command):
4182
"""Convert the current branch into a checkout of the supplied branch.
4184
Once converted into a checkout, commits must succeed on the master branch
4185
before they will be applied to the local branch.
4187
Bound branches use the nickname of its master branch unless it is set
4188
locally, in which case binding will update the the local nickname to be
4192
_see_also = ['checkouts', 'unbind']
4193
takes_args = ['location?']
4196
def run(self, location=None):
4197
b, relpath = Branch.open_containing(u'.')
4198
if location is None:
4200
location = b.get_old_bound_location()
4201
except errors.UpgradeRequired:
4202
raise errors.BzrCommandError('No location supplied. '
4203
'This format does not remember old locations.')
4205
if location is None:
4206
raise errors.BzrCommandError('No location supplied and no '
4207
'previous location known')
4208
b_other = Branch.open(location)
4211
except errors.DivergedBranches:
4212
raise errors.BzrCommandError('These branches have diverged.'
4213
' Try merging, and then bind again.')
4214
if b.get_config().has_explicit_nickname():
4215
b.nick = b_other.nick
4218
class cmd_unbind(Command):
4219
"""Convert the current checkout into a regular branch.
4221
After unbinding, the local branch is considered independent and subsequent
4222
commits will be local only.
4225
_see_also = ['checkouts', 'bind']
4230
b, relpath = Branch.open_containing(u'.')
4232
raise errors.BzrCommandError('Local branch is not bound')
4235
class cmd_uncommit(Command):
4236
"""Remove the last committed revision.
4238
--verbose will print out what is being removed.
4239
--dry-run will go through all the motions, but not actually
4242
If --revision is specified, uncommit revisions to leave the branch at the
4243
specified revision. For example, "bzr uncommit -r 15" will leave the
4244
branch at revision 15.
4246
Uncommit leaves the working tree ready for a new commit. The only change
4247
it may make is to restore any pending merges that were present before
4251
# TODO: jam 20060108 Add an option to allow uncommit to remove
4252
# unreferenced information in 'branch-as-repository' branches.
4253
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4254
# information in shared branches as well.
4255
_see_also = ['commit']
4256
takes_options = ['verbose', 'revision',
4257
Option('dry-run', help='Don\'t actually make changes.'),
4258
Option('force', help='Say yes to all questions.'),
4260
help="Only remove the commits from the local branch"
4261
" when in a checkout."
4264
takes_args = ['location?']
4266
encoding_type = 'replace'
4268
def run(self, location=None,
4269
dry_run=False, verbose=False,
4270
revision=None, force=False, local=False):
4271
if location is None:
4273
control, relpath = bzrdir.BzrDir.open_containing(location)
4275
tree = control.open_workingtree()
4277
except (errors.NoWorkingTree, errors.NotLocalUrl):
4279
b = control.open_branch()
4281
if tree is not None:
4286
return self._run(b, tree, dry_run, verbose, revision, force,
4289
if tree is not None:
4294
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4295
from bzrlib.log import log_formatter, show_log
4296
from bzrlib.uncommit import uncommit
4298
last_revno, last_rev_id = b.last_revision_info()
4301
if revision is None:
4303
rev_id = last_rev_id
4305
# 'bzr uncommit -r 10' actually means uncommit
4306
# so that the final tree is at revno 10.
4307
# but bzrlib.uncommit.uncommit() actually uncommits
4308
# the revisions that are supplied.
4309
# So we need to offset it by one
4310
revno = revision[0].in_history(b).revno + 1
4311
if revno <= last_revno:
4312
rev_id = b.get_rev_id(revno)
4314
if rev_id is None or _mod_revision.is_null(rev_id):
4315
self.outf.write('No revisions to uncommit.\n')
4318
lf = log_formatter('short',
4320
show_timezone='original')
4325
direction='forward',
4326
start_revision=revno,
4327
end_revision=last_revno)
4330
print 'Dry-run, pretending to remove the above revisions.'
4332
val = raw_input('Press <enter> to continue')
4334
print 'The above revision(s) will be removed.'
4336
val = raw_input('Are you sure [y/N]? ')
4337
if val.lower() not in ('y', 'yes'):
4341
mutter('Uncommitting from {%s} to {%s}',
4342
last_rev_id, rev_id)
4343
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4344
revno=revno, local=local)
4345
note('You can restore the old tip by running:\n'
4346
' bzr pull . -r revid:%s', last_rev_id)
4349
class cmd_break_lock(Command):
4350
"""Break a dead lock on a repository, branch or working directory.
4352
CAUTION: Locks should only be broken when you are sure that the process
4353
holding the lock has been stopped.
4355
You can get information on what locks are open via the 'bzr info' command.
4360
takes_args = ['location?']
4362
def run(self, location=None, show=False):
4363
if location is None:
4365
control, relpath = bzrdir.BzrDir.open_containing(location)
4367
control.break_lock()
4368
except NotImplementedError:
4372
class cmd_wait_until_signalled(Command):
4373
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4375
This just prints a line to signal when it is ready, then blocks on stdin.
4381
sys.stdout.write("running\n")
4383
sys.stdin.readline()
4386
class cmd_serve(Command):
4387
"""Run the bzr server."""
4389
aliases = ['server']
4393
help='Serve on stdin/out for use from inetd or sshd.'),
4395
help='Listen for connections on nominated port of the form '
4396
'[hostname:]portnumber. Passing 0 as the port number will '
4397
'result in a dynamically allocated port. The default port is '
4401
help='Serve contents of this directory.',
4403
Option('allow-writes',
4404
help='By default the server is a readonly server. Supplying '
4405
'--allow-writes enables write access to the contents of '
4406
'the served directory and below.'
4410
def run_smart_server(self, smart_server):
4411
"""Run 'smart_server' forever, with no UI output at all."""
4412
# For the duration of this server, no UI output is permitted. note
4413
# that this may cause problems with blackbox tests. This should be
4414
# changed with care though, as we dont want to use bandwidth sending
4415
# progress over stderr to smart server clients!
4416
from bzrlib import lockdir
4417
old_factory = ui.ui_factory
4418
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4420
ui.ui_factory = ui.SilentUIFactory()
4421
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4422
smart_server.serve()
4424
ui.ui_factory = old_factory
4425
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4427
def get_host_and_port(self, port):
4428
"""Return the host and port to run the smart server on.
4430
If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4431
and port (`medium.BZR_DEFAULT_PORT`) will be used.
4433
If 'port' has a colon in it, the string before the colon will be
4434
interpreted as the host.
4436
:param port: A string of the port to run the server on.
4437
:return: A tuple of (host, port), where 'host' is a host name or IP,
4438
and port is an integer TCP/IP port.
4440
from bzrlib.smart import medium
4441
host = medium.BZR_DEFAULT_INTERFACE
4443
port = medium.BZR_DEFAULT_PORT
4446
host, port = port.split(':')
4450
def get_smart_server(self, transport, inet, port):
4451
"""Construct a smart server.
4453
:param transport: The base transport from which branches will be
4455
:param inet: If True, serve over stdin and stdout. Used for running
4457
:param port: The port to listen on. By default, it's `
4458
medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4460
:return: A smart server.
4462
from bzrlib.smart import medium, server
4464
smart_server = medium.SmartServerPipeStreamMedium(
4465
sys.stdin, sys.stdout, transport)
4467
host, port = self.get_host_and_port(port)
4468
smart_server = server.SmartTCPServer(
4469
transport, host=host, port=port)
4470
note('listening on port: %s' % smart_server.port)
4473
def run(self, port=None, inet=False, directory=None, allow_writes=False):
4474
from bzrlib.transport import get_transport
4475
from bzrlib.transport.chroot import ChrootServer
4476
if directory is None:
4477
directory = os.getcwd()
4478
url = urlutils.local_path_to_url(directory)
4479
if not allow_writes:
4480
url = 'readonly+' + url
4481
chroot_server = ChrootServer(get_transport(url))
4482
chroot_server.setUp()
4483
t = get_transport(chroot_server.get_url())
4484
smart_server = self.get_smart_server(t, inet, port)
4485
self.run_smart_server(smart_server)
4488
class cmd_join(Command):
4489
"""Combine a subtree into its containing tree.
4491
This command is for experimental use only. It requires the target tree
4492
to be in dirstate-with-subtree format, which cannot be converted into
4495
The TREE argument should be an independent tree, inside another tree, but
4496
not part of it. (Such trees can be produced by "bzr split", but also by
4497
running "bzr branch" with the target inside a tree.)
4499
The result is a combined tree, with the subtree no longer an independant
4500
part. This is marked as a merge of the subtree into the containing tree,
4501
and all history is preserved.
4503
If --reference is specified, the subtree retains its independence. It can
4504
be branched by itself, and can be part of multiple projects at the same
4505
time. But operations performed in the containing tree, such as commit
4506
and merge, will recurse into the subtree.
4509
_see_also = ['split']
4510
takes_args = ['tree']
4512
Option('reference', help='Join by reference.'),
4516
def run(self, tree, reference=False):
4517
sub_tree = WorkingTree.open(tree)
4518
parent_dir = osutils.dirname(sub_tree.basedir)
4519
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4520
repo = containing_tree.branch.repository
4521
if not repo.supports_rich_root():
4522
raise errors.BzrCommandError(
4523
"Can't join trees because %s doesn't support rich root data.\n"
4524
"You can use bzr upgrade on the repository."
4528
containing_tree.add_reference(sub_tree)
4529
except errors.BadReferenceTarget, e:
4530
# XXX: Would be better to just raise a nicely printable
4531
# exception from the real origin. Also below. mbp 20070306
4532
raise errors.BzrCommandError("Cannot join %s. %s" %
4536
containing_tree.subsume(sub_tree)
4537
except errors.BadSubsumeSource, e:
4538
raise errors.BzrCommandError("Cannot join %s. %s" %
4542
class cmd_split(Command):
4543
"""Split a subdirectory of a tree into a separate tree.
4545
This command will produce a target tree in a format that supports
4546
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4547
converted into earlier formats like 'dirstate-tags'.
4549
The TREE argument should be a subdirectory of a working tree. That
4550
subdirectory will be converted into an independent tree, with its own
4551
branch. Commits in the top-level tree will not apply to the new subtree.
4554
# join is not un-hidden yet
4555
#_see_also = ['join']
4556
takes_args = ['tree']
4558
def run(self, tree):
4559
containing_tree, subdir = WorkingTree.open_containing(tree)
4560
sub_id = containing_tree.path2id(subdir)
4562
raise errors.NotVersionedError(subdir)
4564
containing_tree.extract(sub_id)
4565
except errors.RootNotRich:
4566
raise errors.UpgradeRequired(containing_tree.branch.base)
4569
class cmd_merge_directive(Command):
4570
"""Generate a merge directive for auto-merge tools.
4572
A directive requests a merge to be performed, and also provides all the
4573
information necessary to do so. This means it must either include a
4574
revision bundle, or the location of a branch containing the desired
4577
A submit branch (the location to merge into) must be supplied the first
4578
time the command is issued. After it has been supplied once, it will
4579
be remembered as the default.
4581
A public branch is optional if a revision bundle is supplied, but required
4582
if --diff or --plain is specified. It will be remembered as the default
4583
after the first use.
4586
takes_args = ['submit_branch?', 'public_branch?']
4590
_see_also = ['send']
4593
RegistryOption.from_kwargs('patch-type',
4594
'The type of patch to include in the directive.',
4596
value_switches=True,
4598
bundle='Bazaar revision bundle (default).',
4599
diff='Normal unified diff.',
4600
plain='No patch, just directive.'),
4601
Option('sign', help='GPG-sign the directive.'), 'revision',
4602
Option('mail-to', type=str,
4603
help='Instead of printing the directive, email to this address.'),
4604
Option('message', type=str, short_name='m',
4605
help='Message to use when committing this merge.')
4608
encoding_type = 'exact'
4610
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4611
sign=False, revision=None, mail_to=None, message=None):
4612
from bzrlib.revision import ensure_null, NULL_REVISION
4613
include_patch, include_bundle = {
4614
'plain': (False, False),
4615
'diff': (True, False),
4616
'bundle': (True, True),
4618
branch = Branch.open('.')
4619
stored_submit_branch = branch.get_submit_branch()
4620
if submit_branch is None:
4621
submit_branch = stored_submit_branch
4623
if stored_submit_branch is None:
4624
branch.set_submit_branch(submit_branch)
4625
if submit_branch is None:
4626
submit_branch = branch.get_parent()
4627
if submit_branch is None:
4628
raise errors.BzrCommandError('No submit branch specified or known')
4630
stored_public_branch = branch.get_public_branch()
4631
if public_branch is None:
4632
public_branch = stored_public_branch
4633
elif stored_public_branch is None:
4634
branch.set_public_branch(public_branch)
4635
if not include_bundle and public_branch is None:
4636
raise errors.BzrCommandError('No public branch specified or'
4638
base_revision_id = None
4639
if revision is not None:
4640
if len(revision) > 2:
4641
raise errors.BzrCommandError('bzr merge-directive takes '
4642
'at most two one revision identifiers')
4643
revision_id = revision[-1].as_revision_id(branch)
4644
if len(revision) == 2:
4645
base_revision_id = revision[0].as_revision_id(branch)
4647
revision_id = branch.last_revision()
4648
revision_id = ensure_null(revision_id)
4649
if revision_id == NULL_REVISION:
4650
raise errors.BzrCommandError('No revisions to bundle.')
4651
directive = merge_directive.MergeDirective2.from_objects(
4652
branch.repository, revision_id, time.time(),
4653
osutils.local_time_offset(), submit_branch,
4654
public_branch=public_branch, include_patch=include_patch,
4655
include_bundle=include_bundle, message=message,
4656
base_revision_id=base_revision_id)
4659
self.outf.write(directive.to_signed(branch))
4661
self.outf.writelines(directive.to_lines())
4663
message = directive.to_email(mail_to, branch, sign)
4664
s = SMTPConnection(branch.get_config())
4665
s.send_email(message)
4668
class cmd_send(Command):
4669
"""Mail or create a merge-directive for submitting changes.
4671
A merge directive provides many things needed for requesting merges:
4673
* A machine-readable description of the merge to perform
4675
* An optional patch that is a preview of the changes requested
4677
* An optional bundle of revision data, so that the changes can be applied
4678
directly from the merge directive, without retrieving data from a
4681
If --no-bundle is specified, then public_branch is needed (and must be
4682
up-to-date), so that the receiver can perform the merge using the
4683
public_branch. The public_branch is always included if known, so that
4684
people can check it later.
4686
The submit branch defaults to the parent, but can be overridden. Both
4687
submit branch and public branch will be remembered if supplied.
4689
If a public_branch is known for the submit_branch, that public submit
4690
branch is used in the merge instructions. This means that a local mirror
4691
can be used as your actual submit branch, once you have set public_branch
4694
Mail is sent using your preferred mail program. This should be transparent
4695
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4696
If the preferred client can't be found (or used), your editor will be used.
4698
To use a specific mail program, set the mail_client configuration option.
4699
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4700
specific clients are "claws", "evolution", "kmail", "mutt", and
4701
"thunderbird"; generic options are "default", "editor", "emacsclient",
4702
"mapi", and "xdg-email". Plugins may also add supported clients.
4704
If mail is being sent, a to address is required. This can be supplied
4705
either on the commandline, by setting the submit_to configuration
4706
option in the branch itself or the child_submit_to configuration option
4707
in the submit branch.
4709
Two formats are currently supported: "4" uses revision bundle format 4 and
4710
merge directive format 2. It is significantly faster and smaller than
4711
older formats. It is compatible with Bazaar 0.19 and later. It is the
4712
default. "0.9" uses revision bundle format 0.9 and merge directive
4713
format 1. It is compatible with Bazaar 0.12 - 0.18.
4715
Merge directives are applied using the merge command or the pull command.
4718
encoding_type = 'exact'
4720
_see_also = ['merge', 'pull']
4722
takes_args = ['submit_branch?', 'public_branch?']
4726
help='Do not include a bundle in the merge directive.'),
4727
Option('no-patch', help='Do not include a preview patch in the merge'
4730
help='Remember submit and public branch.'),
4732
help='Branch to generate the submission from, '
4733
'rather than the one containing the working directory.',
4736
Option('output', short_name='o',
4737
help='Write merge directive to this file; '
4738
'use - for stdout.',
4740
Option('mail-to', help='Mail the request to this address.',
4744
RegistryOption.from_kwargs('format',
4745
'Use the specified output format.',
4746
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4747
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4750
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4751
no_patch=False, revision=None, remember=False, output=None,
4752
format='4', mail_to=None, message=None, **kwargs):
4753
return self._run(submit_branch, revision, public_branch, remember,
4754
format, no_bundle, no_patch, output,
4755
kwargs.get('from', '.'), mail_to, message)
4757
def _run(self, submit_branch, revision, public_branch, remember, format,
4758
no_bundle, no_patch, output, from_, mail_to, message):
4759
from bzrlib.revision import NULL_REVISION
4760
branch = Branch.open_containing(from_)[0]
4762
outfile = cStringIO.StringIO()
4766
outfile = open(output, 'wb')
4767
# we may need to write data into branch's repository to calculate
4772
config = branch.get_config()
4774
mail_to = config.get_user_option('submit_to')
4775
mail_client = config.get_mail_client()
4776
if remember and submit_branch is None:
4777
raise errors.BzrCommandError(
4778
'--remember requires a branch to be specified.')
4779
stored_submit_branch = branch.get_submit_branch()
4780
remembered_submit_branch = None
4781
if submit_branch is None:
4782
submit_branch = stored_submit_branch
4783
remembered_submit_branch = "submit"
4785
if stored_submit_branch is None or remember:
4786
branch.set_submit_branch(submit_branch)
4787
if submit_branch is None:
4788
submit_branch = branch.get_parent()
4789
remembered_submit_branch = "parent"
4790
if submit_branch is None:
4791
raise errors.BzrCommandError('No submit branch known or'
4793
if remembered_submit_branch is not None:
4794
note('Using saved %s location "%s" to determine what '
4795
'changes to submit.', remembered_submit_branch,
4799
submit_config = Branch.open(submit_branch).get_config()
4800
mail_to = submit_config.get_user_option("child_submit_to")
4802
stored_public_branch = branch.get_public_branch()
4803
if public_branch is None:
4804
public_branch = stored_public_branch
4805
elif stored_public_branch is None or remember:
4806
branch.set_public_branch(public_branch)
4807
if no_bundle and public_branch is None:
4808
raise errors.BzrCommandError('No public branch specified or'
4810
base_revision_id = None
4812
if revision is not None:
4813
if len(revision) > 2:
4814
raise errors.BzrCommandError('bzr send takes '
4815
'at most two one revision identifiers')
4816
revision_id = revision[-1].as_revision_id(branch)
4817
if len(revision) == 2:
4818
base_revision_id = revision[0].as_revision_id(branch)
4819
if revision_id is None:
4820
revision_id = branch.last_revision()
4821
if revision_id == NULL_REVISION:
4822
raise errors.BzrCommandError('No revisions to submit.')
4824
directive = merge_directive.MergeDirective2.from_objects(
4825
branch.repository, revision_id, time.time(),
4826
osutils.local_time_offset(), submit_branch,
4827
public_branch=public_branch, include_patch=not no_patch,
4828
include_bundle=not no_bundle, message=message,
4829
base_revision_id=base_revision_id)
4830
elif format == '0.9':
4833
patch_type = 'bundle'
4835
raise errors.BzrCommandError('Format 0.9 does not'
4836
' permit bundle with no patch')
4842
directive = merge_directive.MergeDirective.from_objects(
4843
branch.repository, revision_id, time.time(),
4844
osutils.local_time_offset(), submit_branch,
4845
public_branch=public_branch, patch_type=patch_type,
4848
outfile.writelines(directive.to_lines())
4850
subject = '[MERGE] '
4851
if message is not None:
4854
revision = branch.repository.get_revision(revision_id)
4855
subject += revision.get_summary()
4856
basename = directive.get_disk_name(branch)
4857
mail_client.compose_merge_request(mail_to, subject,
4858
outfile.getvalue(), basename)
4865
class cmd_bundle_revisions(cmd_send):
4867
"""Create a merge-directive for submitting changes.
4869
A merge directive provides many things needed for requesting merges:
4871
* A machine-readable description of the merge to perform
4873
* An optional patch that is a preview of the changes requested
4875
* An optional bundle of revision data, so that the changes can be applied
4876
directly from the merge directive, without retrieving data from a
4879
If --no-bundle is specified, then public_branch is needed (and must be
4880
up-to-date), so that the receiver can perform the merge using the
4881
public_branch. The public_branch is always included if known, so that
4882
people can check it later.
4884
The submit branch defaults to the parent, but can be overridden. Both
4885
submit branch and public branch will be remembered if supplied.
4887
If a public_branch is known for the submit_branch, that public submit
4888
branch is used in the merge instructions. This means that a local mirror
4889
can be used as your actual submit branch, once you have set public_branch
4892
Two formats are currently supported: "4" uses revision bundle format 4 and
4893
merge directive format 2. It is significantly faster and smaller than
4894
older formats. It is compatible with Bazaar 0.19 and later. It is the
4895
default. "0.9" uses revision bundle format 0.9 and merge directive
4896
format 1. It is compatible with Bazaar 0.12 - 0.18.
4901
help='Do not include a bundle in the merge directive.'),
4902
Option('no-patch', help='Do not include a preview patch in the merge'
4905
help='Remember submit and public branch.'),
4907
help='Branch to generate the submission from, '
4908
'rather than the one containing the working directory.',
4911
Option('output', short_name='o', help='Write directive to this file.',
4914
RegistryOption.from_kwargs('format',
4915
'Use the specified output format.',
4916
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4917
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4919
aliases = ['bundle']
4921
_see_also = ['send', 'merge']
4925
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4926
no_patch=False, revision=None, remember=False, output=None,
4927
format='4', **kwargs):
4930
return self._run(submit_branch, revision, public_branch, remember,
4931
format, no_bundle, no_patch, output,
4932
kwargs.get('from', '.'), None, None)
4935
class cmd_tag(Command):
4936
"""Create, remove or modify a tag naming a revision.
4938
Tags give human-meaningful names to revisions. Commands that take a -r
4939
(--revision) option can be given -rtag:X, where X is any previously
4942
Tags are stored in the branch. Tags are copied from one branch to another
4943
along when you branch, push, pull or merge.
4945
It is an error to give a tag name that already exists unless you pass
4946
--force, in which case the tag is moved to point to the new revision.
4948
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4949
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4952
_see_also = ['commit', 'tags']
4953
takes_args = ['tag_name']
4956
help='Delete this tag rather than placing it.',
4959
help='Branch in which to place the tag.',
4964
help='Replace existing tags.',
4969
def run(self, tag_name,
4975
branch, relpath = Branch.open_containing(directory)
4979
branch.tags.delete_tag(tag_name)
4980
self.outf.write('Deleted tag %s.\n' % tag_name)
4983
if len(revision) != 1:
4984
raise errors.BzrCommandError(
4985
"Tags can only be placed on a single revision, "
4987
revision_id = revision[0].as_revision_id(branch)
4989
revision_id = branch.last_revision()
4990
if (not force) and branch.tags.has_tag(tag_name):
4991
raise errors.TagAlreadyExists(tag_name)
4992
branch.tags.set_tag(tag_name, revision_id)
4993
self.outf.write('Created tag %s.\n' % tag_name)
4998
class cmd_tags(Command):
5001
This command shows a table of tag names and the revisions they reference.
5007
help='Branch whose tags should be displayed.',
5011
RegistryOption.from_kwargs('sort',
5012
'Sort tags by different criteria.', title='Sorting',
5013
alpha='Sort tags lexicographically (default).',
5014
time='Sort tags chronologically.',
5027
branch, relpath = Branch.open_containing(directory)
5029
tags = branch.tags.get_tag_dict().items()
5036
graph = branch.repository.get_graph()
5037
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5038
revid1, revid2 = rev1.rev_id, rev2.rev_id
5039
# only show revisions between revid1 and revid2 (inclusive)
5040
tags = [(tag, revid) for tag, revid in tags if
5041
graph.is_between(revid, revid1, revid2)]
5046
elif sort == 'time':
5048
for tag, revid in tags:
5050
revobj = branch.repository.get_revision(revid)
5051
except errors.NoSuchRevision:
5052
timestamp = sys.maxint # place them at the end
5054
timestamp = revobj.timestamp
5055
timestamps[revid] = timestamp
5056
tags.sort(key=lambda x: timestamps[x[1]])
5058
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5059
revno_map = branch.get_revision_id_to_revno_map()
5060
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
5061
for tag, revid in tags ]
5062
for tag, revspec in tags:
5063
self.outf.write('%-20s %s\n' % (tag, revspec))
5066
class cmd_reconfigure(Command):
5067
"""Reconfigure the type of a bzr directory.
5069
A target configuration must be specified.
5071
For checkouts, the bind-to location will be auto-detected if not specified.
5072
The order of preference is
5073
1. For a lightweight checkout, the current bound location.
5074
2. For branches that used to be checkouts, the previously-bound location.
5075
3. The push location.
5076
4. The parent location.
5077
If none of these is available, --bind-to must be specified.
5080
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5081
takes_args = ['location?']
5083
RegistryOption.from_kwargs(
5085
title='Target type',
5086
help='The type to reconfigure the directory to.',
5087
value_switches=True, enum_switch=False,
5088
branch='Reconfigure to be an unbound branch with no working tree.',
5089
tree='Reconfigure to be an unbound branch with a working tree.',
5090
checkout='Reconfigure to be a bound branch with a working tree.',
5091
lightweight_checkout='Reconfigure to be a lightweight'
5092
' checkout (with no local history).',
5093
standalone='Reconfigure to be a standalone branch '
5094
'(i.e. stop using shared repository).',
5095
use_shared='Reconfigure to use a shared repository.',
5096
with_trees='Reconfigure repository to create '
5097
'working trees on branches by default.',
5098
with_no_trees='Reconfigure repository to not create '
5099
'working trees on branches by default.'
5101
Option('bind-to', help='Branch to bind checkout to.', type=str),
5103
help='Perform reconfiguration even if local changes'
5107
def run(self, location=None, target_type=None, bind_to=None, force=False):
5108
directory = bzrdir.BzrDir.open(location)
5109
if target_type is None:
5110
raise errors.BzrCommandError('No target configuration specified')
5111
elif target_type == 'branch':
5112
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5113
elif target_type == 'tree':
5114
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5115
elif target_type == 'checkout':
5116
reconfiguration = reconfigure.Reconfigure.to_checkout(
5118
elif target_type == 'lightweight-checkout':
5119
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5121
elif target_type == 'use-shared':
5122
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5123
elif target_type == 'standalone':
5124
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5125
elif target_type == 'with-trees':
5126
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5128
elif target_type == 'with-no-trees':
5129
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5131
reconfiguration.apply(force)
5134
class cmd_switch(Command):
5135
"""Set the branch of a checkout and update.
5137
For lightweight checkouts, this changes the branch being referenced.
5138
For heavyweight checkouts, this checks that there are no local commits
5139
versus the current bound branch, then it makes the local branch a mirror
5140
of the new location and binds to it.
5142
In both cases, the working tree is updated and uncommitted changes
5143
are merged. The user can commit or revert these as they desire.
5145
Pending merges need to be committed or reverted before using switch.
5147
The path to the branch to switch to can be specified relative to the parent
5148
directory of the current branch. For example, if you are currently in a
5149
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5152
Bound branches use the nickname of its master branch unless it is set
5153
locally, in which case switching will update the the local nickname to be
5157
takes_args = ['to_location']
5158
takes_options = [Option('force',
5159
help='Switch even if local commits will be lost.')
5162
def run(self, to_location, force=False):
5163
from bzrlib import switch
5165
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5166
branch = control_dir.open_branch()
5168
to_branch = Branch.open(to_location)
5169
except errors.NotBranchError:
5170
this_branch = control_dir.open_branch()
5171
# This may be a heavy checkout, where we want the master branch
5172
this_url = this_branch.get_bound_location()
5173
# If not, use a local sibling
5174
if this_url is None:
5175
this_url = this_branch.base
5176
to_branch = Branch.open(
5177
urlutils.join(this_url, '..', to_location))
5178
switch.switch(control_dir, to_branch, force)
5179
if branch.get_config().has_explicit_nickname():
5180
branch = control_dir.open_branch() #get the new branch!
5181
branch.nick = to_branch.nick
5182
note('Switched to branch: %s',
5183
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5186
class cmd_view(Command):
5187
"""Manage filtered views.
5189
Views provide a mask over the tree so that users can focus on
5190
a subset of a tree when doing their work. After creating a view,
5191
commands that support a list of files - status, diff, commit, etc -
5192
effectively have that list of files implicitly given each time.
5193
An explicit list of files can still be given but those files
5194
must be within the current view.
5196
In most cases, a view has a short life-span: it is created to make
5197
a selected change and is deleted once that change is committed.
5198
At other times, you may wish to create one or more named views
5199
and switch between them.
5201
To disable the current view without deleting it, you can switch to
5202
the pseudo view called ``off``. This can be useful when you need
5203
to see the whole tree for an operation or two (e.g. merge) but
5204
want to switch back to your view after that.
5207
To define the current view::
5209
bzr view file1 dir1 ...
5211
To list the current view::
5215
To delete the current view::
5219
To disable the current view without deleting it::
5221
bzr view --switch off
5223
To define a named view and switch to it::
5225
bzr view --name view-name file1 dir1 ...
5227
To list a named view::
5229
bzr view --name view-name
5231
To delete a named view::
5233
bzr view --name view-name --delete
5235
To switch to a named view::
5237
bzr view --switch view-name
5239
To list all views defined::
5243
To delete all views::
5245
bzr view --delete --all
5249
takes_args = ['file*']
5252
help='Apply list or delete action to all views.',
5255
help='Delete the view.',
5258
help='Name of the view to define, list or delete.',
5262
help='Name of the view to switch to.',
5267
def run(self, file_list,
5273
tree, file_list = tree_files(file_list, apply_view=False)
5274
current_view, view_dict = tree.views.get_view_info()
5279
raise errors.BzrCommandError(
5280
"Both --delete and a file list specified")
5282
raise errors.BzrCommandError(
5283
"Both --delete and --switch specified")
5285
tree.views.set_view_info(None, {})
5286
self.outf.write("Deleted all views.\n")
5288
raise errors.BzrCommandError("No current view to delete")
5290
tree.views.delete_view(name)
5291
self.outf.write("Deleted '%s' view.\n" % name)
5294
raise errors.BzrCommandError(
5295
"Both --switch and a file list specified")
5297
raise errors.BzrCommandError(
5298
"Both --switch and --all specified")
5299
elif switch == 'off':
5300
if current_view is None:
5301
raise errors.BzrCommandError("No current view to disable")
5302
tree.views.set_view_info(None, view_dict)
5303
self.outf.write("Disabled '%s' view.\n" % (current_view))
5305
tree.views.set_view_info(switch, view_dict)
5306
view_str = views.view_display_str(tree.views.lookup_view())
5307
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5310
self.outf.write('Views defined:\n')
5311
for view in sorted(view_dict):
5312
if view == current_view:
5316
view_str = views.view_display_str(view_dict[view])
5317
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5319
self.outf.write('No views defined.\n')
5322
# No name given and no current view set
5325
raise errors.BzrCommandError(
5326
"Cannot change the 'off' pseudo view")
5327
tree.views.set_view(name, sorted(file_list))
5328
view_str = views.view_display_str(tree.views.lookup_view())
5329
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5333
# No name given and no current view set
5334
self.outf.write('No current view.\n')
5336
view_str = views.view_display_str(tree.views.lookup_view(name))
5337
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5340
class cmd_hooks(Command):
5341
"""Show a branch's currently registered hooks.
5345
takes_args = ['path?']
5347
def run(self, path=None):
5350
branch_hooks = Branch.open(path).hooks
5351
for hook_type in branch_hooks:
5352
hooks = branch_hooks[hook_type]
5353
self.outf.write("%s:\n" % (hook_type,))
5356
self.outf.write(" %s\n" %
5357
(branch_hooks.get_hook_name(hook),))
5359
self.outf.write(" <no hooks installed>\n")
5362
class cmd_shelve(Command):
5363
"""Temporarily set aside some changes from the current tree.
5365
Shelve allows you to temporarily put changes you've made "on the shelf",
5366
ie. out of the way, until a later time when you can bring them back from
5367
the shelf with the 'unshelve' command. The changes are stored alongside
5368
your working tree, and so they aren't propagated along with your branch nor
5369
will they survive its deletion.
5371
If shelve --list is specified, previously-shelved changes are listed.
5373
Shelve is intended to help separate several sets of changes that have
5374
been inappropriately mingled. If you just want to get rid of all changes
5375
and you don't need to restore them later, use revert. If you want to
5376
shelve all text changes at once, use shelve --all.
5378
If filenames are specified, only the changes to those files will be
5379
shelved. Other files will be left untouched.
5381
If a revision is specified, changes since that revision will be shelved.
5383
You can put multiple items on the shelf, and by default, 'unshelve' will
5384
restore the most recently shelved changes.
5387
takes_args = ['file*']
5391
Option('all', help='Shelve all changes.'),
5393
RegistryOption('writer', 'Method to use for writing diffs.',
5394
bzrlib.option.diff_writer_registry,
5395
value_switches=True, enum_switch=False),
5397
Option('list', help='List shelved changes.'),
5399
_see_also = ['unshelve']
5401
def run(self, revision=None, all=False, file_list=None, message=None,
5402
writer=None, list=False):
5404
return self.run_for_list()
5405
from bzrlib.shelf_ui import Shelver
5407
writer = bzrlib.option.diff_writer_registry.get()
5409
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5411
except errors.UserAbort:
5414
def run_for_list(self):
5415
tree = WorkingTree.open_containing('.')[0]
5418
manager = tree.get_shelf_manager()
5419
shelves = manager.active_shelves()
5420
if len(shelves) == 0:
5421
note('No shelved changes.')
5423
for shelf_id in reversed(shelves):
5424
message = manager.get_metadata(shelf_id).get('message')
5426
message = '<no message>'
5427
self.outf.write('%3d: %s\n' % (shelf_id, message))
5433
class cmd_unshelve(Command):
5434
"""Restore shelved changes.
5436
By default, the most recently shelved changes are restored. However if you
5437
specify a shelf by id those changes will be restored instead. This works
5438
best when the changes don't depend on each other.
5441
takes_args = ['shelf_id?']
5443
RegistryOption.from_kwargs(
5444
'action', help="The action to perform.",
5445
enum_switch=False, value_switches=True,
5446
apply="Apply changes and remove from the shelf.",
5447
dry_run="Show changes, but do not apply or remove them.",
5448
delete_only="Delete changes without applying them."
5451
_see_also = ['shelve']
5453
def run(self, shelf_id=None, action='apply'):
5454
from bzrlib.shelf_ui import Unshelver
5455
Unshelver.from_args(shelf_id, action).run()
5458
def _create_prefix(cur_transport):
5459
needed = [cur_transport]
5460
# Recurse upwards until we can create a directory successfully
5462
new_transport = cur_transport.clone('..')
5463
if new_transport.base == cur_transport.base:
5464
raise errors.BzrCommandError(
5465
"Failed to create path prefix for %s."
5466
% cur_transport.base)
5468
new_transport.mkdir('.')
5469
except errors.NoSuchFile:
5470
needed.append(new_transport)
5471
cur_transport = new_transport
5474
# Now we only need to create child directories
5476
cur_transport = needed.pop()
5477
cur_transport.ensure_base()
5480
# these get imported and then picked up by the scan for cmd_*
5481
# TODO: Some more consistent way to split command definitions across files;
5482
# we do need to load at least some information about them to know of
5483
# aliases. ideally we would avoid loading the implementation until the
5484
# details were needed.
5485
from bzrlib.cmd_version_info import cmd_version_info
5486
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5487
from bzrlib.bundle.commands import (
5490
from bzrlib.sign_my_commits import cmd_sign_my_commits
5491
from bzrlib.weave_commands import cmd_versionedfile_list, \
5492
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
