1
# Copyright (C) 2005-2012 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin brz commands"""
19
from __future__ import absolute_import
25
import breezy.bzr.bzrdir
27
from . import lazy_import
28
lazy_import.lazy_import(globals(), """
40
config as _mod_config,
50
revision as _mod_revision,
60
from breezy.branch import Branch
61
from breezy.conflicts import ConflictList
62
from breezy.transport import memory
63
from breezy.revisionspec import RevisionSpec, RevisionInfo
64
from breezy.smtp_connection import SMTPConnection
65
from breezy.workingtree import WorkingTree
66
from breezy.i18n import gettext, ngettext
69
from .commands import (
71
builtin_command_registry,
87
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
90
def _get_branch_location(control_dir, possible_transports=None):
91
"""Return location of branch for this control dir."""
93
target = control_dir.get_branch_reference()
94
except errors.NotBranchError:
95
return control_dir.root_transport.base
96
if target is not None:
98
this_branch = control_dir.open_branch(
99
possible_transports=possible_transports)
100
# This may be a heavy checkout, where we want the master branch
101
master_location = this_branch.get_bound_location()
102
if master_location is not None:
103
return master_location
104
# If not, use a local sibling
105
return this_branch.base
108
def _is_colocated(control_dir, possible_transports=None):
109
"""Check if the branch in control_dir is colocated.
111
:param control_dir: Control directory
112
:return: Tuple with boolean indicating whether the branch is colocated
113
and the full URL to the actual branch
115
# This path is meant to be relative to the existing branch
116
this_url = _get_branch_location(control_dir,
117
possible_transports=possible_transports)
118
# Perhaps the target control dir supports colocated branches?
120
root = controldir.ControlDir.open(this_url,
121
possible_transports=possible_transports)
122
except errors.NotBranchError:
123
return (False, this_url)
126
wt = control_dir.open_workingtree()
127
except (errors.NoWorkingTree, errors.NotLocalUrl):
128
return (False, this_url)
131
root._format.colocated_branches and
132
control_dir.control_url == root.control_url,
136
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
137
"""Lookup the location for a new sibling branch.
139
:param control_dir: Control directory to find sibling branches from
140
:param location: Name of the new branch
141
:return: Full location to the new branch
143
location = directory_service.directories.dereference(location)
144
if '/' not in location and '\\' not in location:
145
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
148
return urlutils.join_segment_parameters(this_url,
149
{"branch": urlutils.escape(location)})
151
return urlutils.join(this_url, '..', urlutils.escape(location))
155
def open_sibling_branch(control_dir, location, possible_transports=None):
156
"""Open a branch, possibly a sibling of another.
158
:param control_dir: Control directory relative to which to lookup the
160
:param location: Location to look up
161
:return: branch to open
164
# Perhaps it's a colocated branch?
165
return control_dir.open_branch(location,
166
possible_transports=possible_transports)
167
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
168
this_url = _get_branch_location(control_dir)
171
this_url, '..', urlutils.escape(location)))
174
def open_nearby_branch(near=None, location=None, possible_transports=None):
175
"""Open a nearby branch.
177
:param near: Optional location of container from which to open branch
178
:param location: Location of the branch
179
:return: Branch instance
185
return Branch.open(location,
186
possible_transports=possible_transports)
187
except errors.NotBranchError:
189
cdir = controldir.ControlDir.open(near,
190
possible_transports=possible_transports)
191
return open_sibling_branch(cdir, location,
192
possible_transports=possible_transports)
195
def iter_sibling_branches(control_dir, possible_transports=None):
196
"""Iterate over the siblings of a branch.
198
:param control_dir: Control directory for which to look up the siblings
199
:return: Iterator over tuples with branch name and branch object
203
reference = control_dir.get_branch_reference()
204
except errors.NotBranchError:
205
# There is no active branch, just return the colocated branches.
206
for name, branch in viewitems(control_dir.get_branches()):
209
if reference is not None:
210
ref_branch = Branch.open(reference,
211
possible_transports=possible_transports)
214
if ref_branch is None or ref_branch.name:
215
if ref_branch is not None:
216
control_dir = ref_branch.bzrdir
217
for name, branch in viewitems(control_dir.get_branches()):
220
repo = ref_branch.bzrdir.find_repository()
221
for branch in repo.find_branches(using=True):
222
name = urlutils.relative_url(repo.user_url,
223
branch.user_url).rstrip("/")
227
def tree_files_for_add(file_list):
229
Return a tree and list of absolute paths from a file list.
231
Similar to tree_files, but add handles files a bit differently, so it a
232
custom implementation. In particular, MutableTreeTree.smart_add expects
233
absolute paths, which it immediately converts to relative paths.
235
# FIXME Would be nice to just return the relative paths like
236
# internal_tree_files does, but there are a large number of unit tests
237
# that assume the current interface to mutabletree.smart_add
239
tree, relpath = WorkingTree.open_containing(file_list[0])
240
if tree.supports_views():
241
view_files = tree.views.lookup_view()
243
for filename in file_list:
244
if not osutils.is_inside_any(view_files, filename):
245
raise errors.FileOutsideView(filename, view_files)
246
file_list = file_list[:]
247
file_list[0] = tree.abspath(relpath)
249
tree = WorkingTree.open_containing(u'.')[0]
250
if tree.supports_views():
251
view_files = tree.views.lookup_view()
253
file_list = view_files
254
view_str = views.view_display_str(view_files)
255
note(gettext("Ignoring files outside view. View is %s") % view_str)
256
return tree, file_list
259
def _get_one_revision(command_name, revisions):
260
if revisions is None:
262
if len(revisions) != 1:
263
raise errors.BzrCommandError(gettext(
264
'brz %s --revision takes exactly one revision identifier') % (
269
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
270
"""Get a revision tree. Not suitable for commands that change the tree.
272
Specifically, the basis tree in dirstate trees is coupled to the dirstate
273
and doing a commit/uncommit/pull will at best fail due to changing the
276
If tree is passed in, it should be already locked, for lifetime management
277
of the trees internal cached state.
281
if revisions is None:
283
rev_tree = tree.basis_tree()
285
rev_tree = branch.basis_tree()
287
revision = _get_one_revision(command_name, revisions)
288
rev_tree = revision.as_tree(branch)
292
def _get_view_info_for_change_reporter(tree):
293
"""Get the view information from a tree for change reporting."""
296
current_view = tree.views.get_view_info()[0]
297
if current_view is not None:
298
view_info = (current_view, tree.views.lookup_view())
299
except errors.ViewsNotSupported:
304
def _open_directory_or_containing_tree_or_branch(filename, directory):
305
"""Open the tree or branch containing the specified file, unless
306
the --directory option is used to specify a different branch."""
307
if directory is not None:
308
return (None, Branch.open(directory), filename)
309
return controldir.ControlDir.open_containing_tree_or_branch(filename)
312
# TODO: Make sure no commands unconditionally use the working directory as a
313
# branch. If a filename argument is used, the first of them should be used to
314
# specify the branch. (Perhaps this can be factored out into some kind of
315
# Argument class, representing a file in a branch, where the first occurrence
318
class cmd_status(Command):
319
__doc__ = """Display status summary.
321
This reports on versioned and unknown files, reporting them
322
grouped by state. Possible states are:
325
Versioned in the working copy but not in the previous revision.
328
Versioned in the previous revision but removed or deleted
332
Path of this file changed from the previous revision;
333
the text may also have changed. This includes files whose
334
parent directory was renamed.
337
Text has changed since the previous revision.
340
File kind has been changed (e.g. from file to directory).
343
Not versioned and not matching an ignore pattern.
345
Additionally for directories, symlinks and files with a changed
346
executable bit, Bazaar indicates their type using a trailing
347
character: '/', '@' or '*' respectively. These decorations can be
348
disabled using the '--no-classify' option.
350
To see ignored files use 'brz ignored'. For details on the
351
changes to file texts, use 'brz diff'.
353
Note that --short or -S gives status flags for each item, similar
354
to Subversion's status command. To get output similar to svn -q,
357
If no arguments are specified, the status of the entire working
358
directory is shown. Otherwise, only the status of the specified
359
files or directories is reported. If a directory is given, status
360
is reported for everything inside that directory.
362
Before merges are committed, the pending merge tip revisions are
363
shown. To see all pending merge revisions, use the -v option.
364
To skip the display of pending merge information altogether, use
365
the no-pending option or specify a file/directory.
367
To compare the working directory to a specific revision, pass a
368
single revision to the revision argument.
370
To see which files have changed in a specific revision, or between
371
two revisions, pass a revision range to the revision argument.
372
This will produce the same results as calling 'brz diff --summarize'.
375
# TODO: --no-recurse/-N, --recurse options
377
takes_args = ['file*']
378
takes_options = ['show-ids', 'revision', 'change', 'verbose',
379
Option('short', help='Use short status indicators.',
381
Option('versioned', help='Only show versioned files.',
383
Option('no-pending', help='Don\'t show pending merges.',
385
Option('no-classify',
386
help='Do not mark object type using indicator.',
389
aliases = ['st', 'stat']
391
encoding_type = 'replace'
392
_see_also = ['diff', 'revert', 'status-flags']
395
def run(self, show_ids=False, file_list=None, revision=None, short=False,
396
versioned=False, no_pending=False, verbose=False,
398
from .status import show_tree_status
400
if revision and len(revision) > 2:
401
raise errors.BzrCommandError(gettext('brz status --revision takes exactly'
402
' one or two revision specifiers'))
404
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
405
# Avoid asking for specific files when that is not needed.
406
if relfile_list == ['']:
408
# Don't disable pending merges for full trees other than '.'.
409
if file_list == ['.']:
411
# A specific path within a tree was given.
412
elif relfile_list is not None:
414
show_tree_status(tree, show_ids=show_ids,
415
specific_files=relfile_list, revision=revision,
416
to_file=self.outf, short=short, versioned=versioned,
417
show_pending=(not no_pending), verbose=verbose,
418
classify=not no_classify)
421
class cmd_cat_revision(Command):
422
__doc__ = """Write out metadata for a revision.
424
The revision to print can either be specified by a specific
425
revision identifier, or you can use --revision.
429
takes_args = ['revision_id?']
430
takes_options = ['directory', 'revision']
431
# cat-revision is more for frontends so should be exact
434
def print_revision(self, revisions, revid):
435
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
436
record = next(stream)
437
if record.storage_kind == 'absent':
438
raise errors.NoSuchRevision(revisions, revid)
439
revtext = record.get_bytes_as('fulltext')
440
self.outf.write(revtext.decode('utf-8'))
443
def run(self, revision_id=None, revision=None, directory=u'.'):
444
if revision_id is not None and revision is not None:
445
raise errors.BzrCommandError(gettext('You can only supply one of'
446
' revision_id or --revision'))
447
if revision_id is None and revision is None:
448
raise errors.BzrCommandError(gettext('You must supply either'
449
' --revision or a revision_id'))
451
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
453
revisions = b.repository.revisions
454
if revisions is None:
455
raise errors.BzrCommandError(gettext('Repository %r does not support '
456
'access to raw revision texts'))
458
b.repository.lock_read()
460
# TODO: jam 20060112 should cat-revision always output utf-8?
461
if revision_id is not None:
462
revision_id = cache_utf8.encode(revision_id)
464
self.print_revision(revisions, revision_id)
465
except errors.NoSuchRevision:
466
msg = gettext("The repository {0} contains no revision {1}.").format(
467
b.repository.base, revision_id)
468
raise errors.BzrCommandError(msg)
469
elif revision is not None:
472
raise errors.BzrCommandError(
473
gettext('You cannot specify a NULL revision.'))
474
rev_id = rev.as_revision_id(b)
475
self.print_revision(revisions, rev_id)
477
b.repository.unlock()
480
class cmd_dump_btree(Command):
481
__doc__ = """Dump the contents of a btree index file to stdout.
483
PATH is a btree index file, it can be any URL. This includes things like
484
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
486
By default, the tuples stored in the index file will be displayed. With
487
--raw, we will uncompress the pages, but otherwise display the raw bytes
491
# TODO: Do we want to dump the internal nodes as well?
492
# TODO: It would be nice to be able to dump the un-parsed information,
493
# rather than only going through iter_all_entries. However, this is
494
# good enough for a start
496
encoding_type = 'exact'
497
takes_args = ['path']
498
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
499
' rather than the parsed tuples.'),
502
def run(self, path, raw=False):
503
dirname, basename = osutils.split(path)
504
t = transport.get_transport(dirname)
506
self._dump_raw_bytes(t, basename)
508
self._dump_entries(t, basename)
510
def _get_index_and_bytes(self, trans, basename):
511
"""Create a BTreeGraphIndex and raw bytes."""
512
bt = btree_index.BTreeGraphIndex(trans, basename, None)
513
bytes = trans.get_bytes(basename)
514
bt._file = BytesIO(bytes)
515
bt._size = len(bytes)
518
def _dump_raw_bytes(self, trans, basename):
521
# We need to parse at least the root node.
522
# This is because the first page of every row starts with an
523
# uncompressed header.
524
bt, bytes = self._get_index_and_bytes(trans, basename)
525
for page_idx, page_start in enumerate(range(0, len(bytes),
526
btree_index._PAGE_SIZE)):
527
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
528
page_bytes = bytes[page_start:page_end]
530
self.outf.write('Root node:\n')
531
header_end, data = bt._parse_header_from_bytes(page_bytes)
532
self.outf.write(page_bytes[:header_end])
534
self.outf.write('\nPage %d\n' % (page_idx,))
535
if len(page_bytes) == 0:
536
self.outf.write('(empty)\n');
538
decomp_bytes = zlib.decompress(page_bytes)
539
self.outf.write(decomp_bytes)
540
self.outf.write('\n')
542
def _dump_entries(self, trans, basename):
544
st = trans.stat(basename)
545
except errors.TransportNotPossible:
546
# We can't stat, so we'll fake it because we have to do the 'get()'
548
bt, _ = self._get_index_and_bytes(trans, basename)
550
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
551
for node in bt.iter_all_entries():
552
# Node is made up of:
553
# (index, key, value, [references])
557
refs_as_tuples = None
559
refs_as_tuples = static_tuple.as_tuples(refs)
560
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
561
self.outf.write('%s\n' % (as_tuple,))
564
class cmd_remove_tree(Command):
565
__doc__ = """Remove the working tree from a given branch/checkout.
567
Since a lightweight checkout is little more than a working tree
568
this will refuse to run against one.
570
To re-create the working tree, use "brz checkout".
572
_see_also = ['checkout', 'working-trees']
573
takes_args = ['location*']
576
help='Remove the working tree even if it has '
577
'uncommitted or shelved changes.'),
580
def run(self, location_list, force=False):
581
if not location_list:
584
for location in location_list:
585
d = controldir.ControlDir.open(location)
588
working = d.open_workingtree()
589
except errors.NoWorkingTree:
590
raise errors.BzrCommandError(gettext("No working tree to remove"))
591
except errors.NotLocalUrl:
592
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
593
" of a remote path"))
595
if (working.has_changes()):
596
raise errors.UncommittedChanges(working)
597
if working.get_shelf_manager().last_shelf() is not None:
598
raise errors.ShelvedChanges(working)
600
if working.user_url != working.branch.user_url:
601
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
602
" from a lightweight checkout"))
604
d.destroy_workingtree()
607
class cmd_repair_workingtree(Command):
608
__doc__ = """Reset the working tree state file.
610
This is not meant to be used normally, but more as a way to recover from
611
filesystem corruption, etc. This rebuilds the working inventory back to a
612
'known good' state. Any new modifications (adding a file, renaming, etc)
613
will be lost, though modified files will still be detected as such.
615
Most users will want something more like "brz revert" or "brz update"
616
unless the state file has become corrupted.
618
By default this attempts to recover the current state by looking at the
619
headers of the state file. If the state file is too corrupted to even do
620
that, you can supply --revision to force the state of the tree.
623
takes_options = ['revision', 'directory',
625
help='Reset the tree even if it doesn\'t appear to be'
630
def run(self, revision=None, directory='.', force=False):
631
tree, _ = WorkingTree.open_containing(directory)
632
self.add_cleanup(tree.lock_tree_write().unlock)
636
except errors.BzrError:
637
pass # There seems to be a real error here, so we'll reset
640
raise errors.BzrCommandError(gettext(
641
'The tree does not appear to be corrupt. You probably'
642
' want "brz revert" instead. Use "--force" if you are'
643
' sure you want to reset the working tree.'))
647
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
649
tree.reset_state(revision_ids)
650
except errors.BzrError as e:
651
if revision_ids is None:
652
extra = (gettext(', the header appears corrupt, try passing -r -1'
653
' to set the state to the last commit'))
656
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
659
class cmd_revno(Command):
660
__doc__ = """Show current revision number.
662
This is equal to the number of revisions on this branch.
666
takes_args = ['location?']
668
Option('tree', help='Show revno of working tree.'),
673
def run(self, tree=False, location=u'.', revision=None):
674
if revision is not None and tree:
675
raise errors.BzrCommandError(gettext("--tree and --revision can "
676
"not be used together"))
680
wt = WorkingTree.open_containing(location)[0]
681
self.add_cleanup(wt.lock_read().unlock)
682
except (errors.NoWorkingTree, errors.NotLocalUrl):
683
raise errors.NoWorkingTree(location)
685
revid = wt.last_revision()
687
b = Branch.open_containing(location)[0]
688
self.add_cleanup(b.lock_read().unlock)
690
if len(revision) != 1:
691
raise errors.BzrCommandError(gettext(
692
"Revision numbers only make sense for single "
693
"revisions, not ranges"))
694
revid = revision[0].as_revision_id(b)
696
revid = b.last_revision()
698
revno_t = b.revision_id_to_dotted_revno(revid)
699
except errors.NoSuchRevision:
701
revno = ".".join(str(n) for n in revno_t)
703
self.outf.write(revno + '\n')
706
class cmd_revision_info(Command):
707
__doc__ = """Show revision number and revision id for a given revision identifier.
710
takes_args = ['revision_info*']
713
custom_help('directory',
714
help='Branch to examine, '
715
'rather than the one containing the working directory.'),
716
Option('tree', help='Show revno of working tree.'),
720
def run(self, revision=None, directory=u'.', tree=False,
721
revision_info_list=[]):
724
wt = WorkingTree.open_containing(directory)[0]
726
self.add_cleanup(wt.lock_read().unlock)
727
except (errors.NoWorkingTree, errors.NotLocalUrl):
729
b = Branch.open_containing(directory)[0]
730
self.add_cleanup(b.lock_read().unlock)
732
if revision is not None:
733
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
734
if revision_info_list is not None:
735
for rev_str in revision_info_list:
736
rev_spec = RevisionSpec.from_string(rev_str)
737
revision_ids.append(rev_spec.as_revision_id(b))
738
# No arguments supplied, default to the last revision
739
if len(revision_ids) == 0:
742
raise errors.NoWorkingTree(directory)
743
revision_ids.append(wt.last_revision())
745
revision_ids.append(b.last_revision())
749
for revision_id in revision_ids:
751
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
752
revno = '.'.join(str(i) for i in dotted_revno)
753
except errors.NoSuchRevision:
755
maxlen = max(maxlen, len(revno))
756
revinfos.append([revno, revision_id])
760
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
763
class cmd_add(Command):
764
__doc__ = """Add specified files or directories.
766
In non-recursive mode, all the named items are added, regardless
767
of whether they were previously ignored. A warning is given if
768
any of the named files are already versioned.
770
In recursive mode (the default), files are treated the same way
771
but the behaviour for directories is different. Directories that
772
are already versioned do not give a warning. All directories,
773
whether already versioned or not, are searched for files or
774
subdirectories that are neither versioned or ignored, and these
775
are added. This search proceeds recursively into versioned
776
directories. If no names are given '.' is assumed.
778
A warning will be printed when nested trees are encountered,
779
unless they are explicitly ignored.
781
Therefore simply saying 'brz add' will version all files that
782
are currently unknown.
784
Adding a file whose parent directory is not versioned will
785
implicitly add the parent, and so on up to the root. This means
786
you should never need to explicitly add a directory, they'll just
787
get added when you add a file in the directory.
789
--dry-run will show which files would be added, but not actually
792
--file-ids-from will try to use the file ids from the supplied path.
793
It looks up ids trying to find a matching parent directory with the
794
same filename, and then by pure path. This option is rarely needed
795
but can be useful when adding the same logical file into two
796
branches that will be merged later (without showing the two different
797
adds as a conflict). It is also useful when merging another project
798
into a subdirectory of this one.
800
Any files matching patterns in the ignore list will not be added
801
unless they are explicitly mentioned.
803
In recursive mode, files larger than the configuration option
804
add.maximum_file_size will be skipped. Named items are never skipped due
807
takes_args = ['file*']
810
help="Don't recursively add the contents of directories.",
813
help="Show what would be done, but don't actually do anything."),
815
Option('file-ids-from',
817
help='Lookup file ids from this tree.'),
819
encoding_type = 'replace'
820
_see_also = ['remove', 'ignore']
822
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
827
if file_ids_from is not None:
829
base_tree, base_path = WorkingTree.open_containing(
831
except errors.NoWorkingTree:
832
base_branch, base_path = Branch.open_containing(
834
base_tree = base_branch.basis_tree()
836
action = breezy.add.AddFromBaseAction(base_tree, base_path,
837
to_file=self.outf, should_print=(not is_quiet()))
839
action = breezy.add.AddWithSkipLargeAction(to_file=self.outf,
840
should_print=(not is_quiet()))
843
self.add_cleanup(base_tree.lock_read().unlock)
844
tree, file_list = tree_files_for_add(file_list)
845
added, ignored = tree.smart_add(file_list, not
846
no_recurse, action=action, save=not dry_run)
850
for glob in sorted(ignored):
851
for path in ignored[glob]:
853
gettext("ignored {0} matching \"{1}\"\n").format(
857
class cmd_mkdir(Command):
858
__doc__ = """Create a new versioned directory.
860
This is equivalent to creating the directory and then adding it.
863
takes_args = ['dir+']
867
help='No error if existing, make parent directories as needed.',
871
encoding_type = 'replace'
874
def add_file_with_parents(cls, wt, relpath):
875
if wt.path2id(relpath) is not None:
877
cls.add_file_with_parents(wt, osutils.dirname(relpath))
881
def add_file_single(cls, wt, relpath):
884
def run(self, dir_list, parents=False):
886
add_file = self.add_file_with_parents
888
add_file = self.add_file_single
890
wt, relpath = WorkingTree.open_containing(dir)
895
if e.errno != errno.EEXIST:
899
add_file(wt, relpath)
901
self.outf.write(gettext('added %s\n') % dir)
904
class cmd_relpath(Command):
905
__doc__ = """Show path of a file relative to root"""
907
takes_args = ['filename']
911
def run(self, filename):
912
# TODO: jam 20050106 Can relpath return a munged path if
913
# sys.stdout encoding cannot represent it?
914
tree, relpath = WorkingTree.open_containing(filename)
915
self.outf.write(relpath)
916
self.outf.write('\n')
919
class cmd_inventory(Command):
920
__doc__ = """Show inventory of the current working copy or a revision.
922
It is possible to limit the output to a particular entry
923
type using the --kind option. For example: --kind file.
925
It is also possible to restrict the list of files to a specific
926
set. For example: brz inventory --show-ids this/file
935
help='List entries of a particular kind: file, directory, symlink.',
938
takes_args = ['file*']
941
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
942
if kind and kind not in ['file', 'directory', 'symlink']:
943
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
945
revision = _get_one_revision('inventory', revision)
946
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
947
self.add_cleanup(work_tree.lock_read().unlock)
948
if revision is not None:
949
tree = revision.as_tree(work_tree.branch)
951
extra_trees = [work_tree]
952
self.add_cleanup(tree.lock_read().unlock)
957
self.add_cleanup(tree.lock_read().unlock)
958
if file_list is not None:
959
file_ids = tree.paths2ids(file_list, trees=extra_trees,
960
require_versioned=True)
961
# find_ids_across_trees may include some paths that don't
963
entries = tree.iter_entries_by_dir(specific_file_ids=file_ids)
965
entries = tree.iter_entries_by_dir()
967
for path, entry in sorted(entries):
968
if kind and kind != entry.kind:
973
self.outf.write('%-50s %s\n' % (path, entry.file_id))
975
self.outf.write(path)
976
self.outf.write('\n')
979
class cmd_mv(Command):
980
__doc__ = """Move or rename a file.
983
brz mv OLDNAME NEWNAME
985
brz mv SOURCE... DESTINATION
987
If the last argument is a versioned directory, all the other names
988
are moved into it. Otherwise, there must be exactly two arguments
989
and the file is changed to a new name.
991
If OLDNAME does not exist on the filesystem but is versioned and
992
NEWNAME does exist on the filesystem but is not versioned, mv
993
assumes that the file has been manually moved and only updates
994
its internal inventory to reflect that change.
995
The same is valid when moving many SOURCE files to a DESTINATION.
997
Files cannot be moved between branches.
1000
takes_args = ['names*']
1001
takes_options = [Option("after", help="Move only the brz identifier"
1002
" of the file, because the file has already been moved."),
1003
Option('auto', help='Automatically guess renames.'),
1004
Option('dry-run', help='Avoid making changes when guessing renames.'),
1006
aliases = ['move', 'rename']
1007
encoding_type = 'replace'
1009
def run(self, names_list, after=False, auto=False, dry_run=False):
1011
return self.run_auto(names_list, after, dry_run)
1013
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1014
if names_list is None:
1016
if len(names_list) < 2:
1017
raise errors.BzrCommandError(gettext("missing file argument"))
1018
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1019
for file_name in rel_names[0:-1]:
1021
raise errors.BzrCommandError(gettext("can not move root of branch"))
1022
self.add_cleanup(tree.lock_tree_write().unlock)
1023
self._run(tree, names_list, rel_names, after)
1025
def run_auto(self, names_list, after, dry_run):
1026
if names_list is not None and len(names_list) > 1:
1027
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1030
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1032
work_tree, file_list = WorkingTree.open_containing_paths(
1033
names_list, default_directory='.')
1034
self.add_cleanup(work_tree.lock_tree_write().unlock)
1035
rename_map.RenameMap.guess_renames(work_tree, dry_run)
1037
def _run(self, tree, names_list, rel_names, after):
1038
into_existing = osutils.isdir(names_list[-1])
1039
if into_existing and len(names_list) == 2:
1041
# a. case-insensitive filesystem and change case of dir
1042
# b. move directory after the fact (if the source used to be
1043
# a directory, but now doesn't exist in the working tree
1044
# and the target is an existing directory, just rename it)
1045
if (not tree.case_sensitive
1046
and rel_names[0].lower() == rel_names[1].lower()):
1047
into_existing = False
1049
# 'fix' the case of a potential 'from'
1050
from_id = tree.path2id(
1051
tree.get_canonical_inventory_path(rel_names[0]))
1052
if (not osutils.lexists(names_list[0]) and
1053
from_id and tree.stored_kind(from_id) == "directory"):
1054
into_existing = False
1057
# move into existing directory
1058
# All entries reference existing inventory items, so fix them up
1059
# for cicp file-systems.
1060
rel_names = tree.get_canonical_inventory_paths(rel_names)
1061
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1063
self.outf.write("%s => %s\n" % (src, dest))
1065
if len(names_list) != 2:
1066
raise errors.BzrCommandError(gettext('to mv multiple files the'
1067
' destination must be a versioned'
1070
# for cicp file-systems: the src references an existing inventory
1072
src = tree.get_canonical_inventory_path(rel_names[0])
1073
# Find the canonical version of the destination: In all cases, the
1074
# parent of the target must be in the inventory, so we fetch the
1075
# canonical version from there (we do not always *use* the
1076
# canonicalized tail portion - we may be attempting to rename the
1078
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
1079
dest_parent = osutils.dirname(canon_dest)
1080
spec_tail = osutils.basename(rel_names[1])
1081
# For a CICP file-system, we need to avoid creating 2 inventory
1082
# entries that differ only by case. So regardless of the case
1083
# we *want* to use (ie, specified by the user or the file-system),
1084
# we must always choose to use the case of any existing inventory
1085
# items. The only exception to this is when we are attempting a
1086
# case-only rename (ie, canonical versions of src and dest are
1088
dest_id = tree.path2id(canon_dest)
1089
if dest_id is None or tree.path2id(src) == dest_id:
1090
# No existing item we care about, so work out what case we
1091
# are actually going to use.
1093
# If 'after' is specified, the tail must refer to a file on disk.
1095
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1097
# pathjoin with an empty tail adds a slash, which breaks
1099
dest_parent_fq = tree.basedir
1101
dest_tail = osutils.canonical_relpath(
1103
osutils.pathjoin(dest_parent_fq, spec_tail))
1105
# not 'after', so case as specified is used
1106
dest_tail = spec_tail
1108
# Use the existing item so 'mv' fails with AlreadyVersioned.
1109
dest_tail = os.path.basename(canon_dest)
1110
dest = osutils.pathjoin(dest_parent, dest_tail)
1111
mutter("attempting to move %s => %s", src, dest)
1112
tree.rename_one(src, dest, after=after)
1114
self.outf.write("%s => %s\n" % (src, dest))
1117
class cmd_pull(Command):
1118
__doc__ = """Turn this branch into a mirror of another branch.
1120
By default, this command only works on branches that have not diverged.
1121
Branches are considered diverged if the destination branch's most recent
1122
commit is one that has not been merged (directly or indirectly) into the
1125
If branches have diverged, you can use 'brz merge' to integrate the changes
1126
from one into the other. Once one branch has merged, the other should
1127
be able to pull it again.
1129
If you want to replace your local changes and just want your branch to
1130
match the remote one, use pull --overwrite. This will work even if the two
1131
branches have diverged.
1133
If there is no default location set, the first pull will set it (use
1134
--no-remember to avoid setting it). After that, you can omit the
1135
location to use the default. To change the default, use --remember. The
1136
value will only be saved if the remote location can be accessed.
1138
The --verbose option will display the revisions pulled using the log_format
1139
configuration option. You can use a different format by overriding it with
1140
-Olog_format=<other_format>.
1142
Note: The location can be specified either in the form of a branch,
1143
or in the form of a path to a file containing a merge directive generated
1147
_see_also = ['push', 'update', 'status-flags', 'send']
1148
takes_options = ['remember', 'overwrite', 'revision',
1149
custom_help('verbose',
1150
help='Show logs of pulled revisions.'),
1151
custom_help('directory',
1152
help='Branch to pull into, '
1153
'rather than the one containing the working directory.'),
1155
help="Perform a local pull in a bound "
1156
"branch. Local pulls are not applied to "
1157
"the master branch."
1160
help="Show base revision text in conflicts."),
1161
Option('overwrite-tags',
1162
help="Overwrite tags only."),
1164
takes_args = ['location?']
1165
encoding_type = 'replace'
1167
def run(self, location=None, remember=None, overwrite=False,
1168
revision=None, verbose=False,
1169
directory=None, local=False,
1170
show_base=False, overwrite_tags=False):
1173
overwrite = ["history", "tags"]
1174
elif overwrite_tags:
1175
overwrite = ["tags"]
1178
# FIXME: too much stuff is in the command class
1181
if directory is None:
1184
tree_to = WorkingTree.open_containing(directory)[0]
1185
branch_to = tree_to.branch
1186
self.add_cleanup(tree_to.lock_write().unlock)
1187
except errors.NoWorkingTree:
1189
branch_to = Branch.open_containing(directory)[0]
1190
self.add_cleanup(branch_to.lock_write().unlock)
1192
warning(gettext("No working tree, ignoring --show-base"))
1194
if local and not branch_to.get_bound_location():
1195
raise errors.LocalRequiresBoundBranch()
1197
possible_transports = []
1198
if location is not None:
1200
mergeable = bundle.read_mergeable_from_url(location,
1201
possible_transports=possible_transports)
1202
except errors.NotABundle:
1205
stored_loc = branch_to.get_parent()
1206
if location is None:
1207
if stored_loc is None:
1208
raise errors.BzrCommandError(gettext("No pull location known or"
1211
display_url = urlutils.unescape_for_display(stored_loc,
1214
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1215
location = stored_loc
1217
revision = _get_one_revision('pull', revision)
1218
if mergeable is not None:
1219
if revision is not None:
1220
raise errors.BzrCommandError(gettext(
1221
'Cannot use -r with merge directives or bundles'))
1222
mergeable.install_revisions(branch_to.repository)
1223
base_revision_id, revision_id, verified = \
1224
mergeable.get_merge_request(branch_to.repository)
1225
branch_from = branch_to
1227
branch_from = Branch.open(location,
1228
possible_transports=possible_transports)
1229
self.add_cleanup(branch_from.lock_read().unlock)
1230
# Remembers if asked explicitly or no previous location is set
1232
or (remember is None and branch_to.get_parent() is None)):
1233
# FIXME: This shouldn't be done before the pull
1234
# succeeds... -- vila 2012-01-02
1235
branch_to.set_parent(branch_from.base)
1237
if revision is not None:
1238
revision_id = revision.as_revision_id(branch_from)
1240
if tree_to is not None:
1241
view_info = _get_view_info_for_change_reporter(tree_to)
1242
change_reporter = delta._ChangeReporter(
1243
unversioned_filter=tree_to.is_ignored,
1244
view_info=view_info)
1245
result = tree_to.pull(
1246
branch_from, overwrite, revision_id, change_reporter,
1247
local=local, show_base=show_base)
1249
result = branch_to.pull(
1250
branch_from, overwrite, revision_id, local=local)
1252
result.report(self.outf)
1253
if verbose and result.old_revid != result.new_revid:
1254
log.show_branch_change(
1255
branch_to, self.outf, result.old_revno,
1257
if getattr(result, 'tag_conflicts', None):
1263
class cmd_push(Command):
1264
__doc__ = """Update a mirror of this branch.
1266
The target branch will not have its working tree populated because this
1267
is both expensive, and is not supported on remote file systems.
1269
Some smart servers or protocols *may* put the working tree in place in
1272
This command only works on branches that have not diverged. Branches are
1273
considered diverged if the destination branch's most recent commit is one
1274
that has not been merged (directly or indirectly) by the source branch.
1276
If branches have diverged, you can use 'brz push --overwrite' to replace
1277
the other branch completely, discarding its unmerged changes.
1279
If you want to ensure you have the different changes in the other branch,
1280
do a merge (see brz help merge) from the other branch, and commit that.
1281
After that you will be able to do a push without '--overwrite'.
1283
If there is no default push location set, the first push will set it (use
1284
--no-remember to avoid setting it). After that, you can omit the
1285
location to use the default. To change the default, use --remember. The
1286
value will only be saved if the remote location can be accessed.
1288
The --verbose option will display the revisions pushed using the log_format
1289
configuration option. You can use a different format by overriding it with
1290
-Olog_format=<other_format>.
1293
_see_also = ['pull', 'update', 'working-trees']
1294
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1295
Option('create-prefix',
1296
help='Create the path leading up to the branch '
1297
'if it does not already exist.'),
1298
custom_help('directory',
1299
help='Branch to push from, '
1300
'rather than the one containing the working directory.'),
1301
Option('use-existing-dir',
1302
help='By default push will fail if the target'
1303
' directory exists, but does not already'
1304
' have a control directory. This flag will'
1305
' allow push to proceed.'),
1307
help='Create a stacked branch that references the public location '
1308
'of the parent branch.'),
1309
Option('stacked-on',
1310
help='Create a stacked branch that refers to another branch '
1311
'for the commit history. Only the work not present in the '
1312
'referenced branch is included in the branch created.',
1315
help='Refuse to push if there are uncommitted changes in'
1316
' the working tree, --no-strict disables the check.'),
1318
help="Don't populate the working tree, even for protocols"
1319
" that support it."),
1320
Option('overwrite-tags',
1321
help="Overwrite tags only."),
1323
takes_args = ['location?']
1324
encoding_type = 'replace'
1326
def run(self, location=None, remember=None, overwrite=False,
1327
create_prefix=False, verbose=False, revision=None,
1328
use_existing_dir=False, directory=None, stacked_on=None,
1329
stacked=False, strict=None, no_tree=False,
1330
overwrite_tags=False):
1331
from .push import _show_push_branch
1334
overwrite = ["history", "tags"]
1335
elif overwrite_tags:
1336
overwrite = ["tags"]
1340
if directory is None:
1342
# Get the source branch
1344
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1345
# Get the tip's revision_id
1346
revision = _get_one_revision('push', revision)
1347
if revision is not None:
1348
revision_id = revision.in_history(br_from).rev_id
1351
if tree is not None and revision_id is None:
1352
tree.check_changed_or_out_of_date(
1353
strict, 'push_strict',
1354
more_error='Use --no-strict to force the push.',
1355
more_warning='Uncommitted changes will not be pushed.')
1356
# Get the stacked_on branch, if any
1357
if stacked_on is not None:
1358
stacked_on = urlutils.normalize_url(stacked_on)
1360
parent_url = br_from.get_parent()
1362
parent = Branch.open(parent_url)
1363
stacked_on = parent.get_public_branch()
1365
# I considered excluding non-http url's here, thus forcing
1366
# 'public' branches only, but that only works for some
1367
# users, so it's best to just depend on the user spotting an
1368
# error by the feedback given to them. RBC 20080227.
1369
stacked_on = parent_url
1371
raise errors.BzrCommandError(gettext(
1372
"Could not determine branch to refer to."))
1374
# Get the destination location
1375
if location is None:
1376
stored_loc = br_from.get_push_location()
1377
if stored_loc is None:
1378
parent_loc = br_from.get_parent()
1380
raise errors.BzrCommandError(gettext(
1381
"No push location known or specified. To push to the "
1382
"parent branch (at %s), use 'brz push :parent'." %
1383
urlutils.unescape_for_display(parent_loc,
1384
self.outf.encoding)))
1386
raise errors.BzrCommandError(gettext(
1387
"No push location known or specified."))
1389
display_url = urlutils.unescape_for_display(stored_loc,
1391
note(gettext("Using saved push location: %s") % display_url)
1392
location = stored_loc
1394
_show_push_branch(br_from, revision_id, location, self.outf,
1395
verbose=verbose, overwrite=overwrite, remember=remember,
1396
stacked_on=stacked_on, create_prefix=create_prefix,
1397
use_existing_dir=use_existing_dir, no_tree=no_tree)
1400
class cmd_branch(Command):
1401
__doc__ = """Create a new branch that is a copy of an existing branch.
1403
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1404
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1405
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1406
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1407
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1410
To retrieve the branch as of a particular revision, supply the --revision
1411
parameter, as in "branch foo/bar -r 5".
1413
The synonyms 'clone' and 'get' for this command are deprecated.
1416
_see_also = ['checkout']
1417
takes_args = ['from_location', 'to_location?']
1418
takes_options = ['revision',
1419
Option('hardlink', help='Hard-link working tree files where possible.'),
1420
Option('files-from', type=str,
1421
help="Get file contents from this tree."),
1423
help="Create a branch without a working-tree."),
1425
help="Switch the checkout in the current directory "
1426
"to the new branch."),
1428
help='Create a stacked branch referring to the source branch. '
1429
'The new branch will depend on the availability of the source '
1430
'branch for all operations.'),
1431
Option('standalone',
1432
help='Do not use a shared repository, even if available.'),
1433
Option('use-existing-dir',
1434
help='By default branch will fail if the target'
1435
' directory exists, but does not already'
1436
' have a control directory. This flag will'
1437
' allow branch to proceed.'),
1439
help="Bind new branch to from location."),
1441
aliases = ['get', 'clone']
1443
def run(self, from_location, to_location=None, revision=None,
1444
hardlink=False, stacked=False, standalone=False, no_tree=False,
1445
use_existing_dir=False, switch=False, bind=False,
1447
from breezy import switch as _mod_switch
1448
if self.invoked_as in ['get', 'clone']:
1449
ui.ui_factory.show_user_warning(
1450
'deprecated_command',
1451
deprecated_name=self.invoked_as,
1452
recommended_name='branch',
1453
deprecated_in_version='2.4')
1454
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1456
if not (hardlink or files_from):
1457
# accelerator_tree is usually slower because you have to read N
1458
# files (no readahead, lots of seeks, etc), but allow the user to
1459
# explicitly request it
1460
accelerator_tree = None
1461
if files_from is not None and files_from != from_location:
1462
accelerator_tree = WorkingTree.open(files_from)
1463
revision = _get_one_revision('branch', revision)
1464
self.add_cleanup(br_from.lock_read().unlock)
1465
if revision is not None:
1466
revision_id = revision.as_revision_id(br_from)
1468
# FIXME - wt.last_revision, fallback to branch, fall back to
1469
# None or perhaps NULL_REVISION to mean copy nothing
1471
revision_id = br_from.last_revision()
1472
if to_location is None:
1473
to_location = getattr(br_from, "name", None)
1475
to_location = urlutils.derive_to_location(from_location)
1476
to_transport = transport.get_transport(to_location)
1478
to_transport.mkdir('.')
1479
except errors.FileExists:
1481
to_dir = controldir.ControlDir.open_from_transport(
1483
except errors.NotBranchError:
1484
if not use_existing_dir:
1485
raise errors.BzrCommandError(gettext('Target directory "%s" '
1486
'already exists.') % to_location)
1491
to_dir.open_branch()
1492
except errors.NotBranchError:
1495
raise errors.AlreadyBranchError(to_location)
1496
except errors.NoSuchFile:
1497
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1503
# preserve whatever source format we have.
1504
to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1505
possible_transports=[to_transport],
1506
accelerator_tree=accelerator_tree,
1507
hardlink=hardlink, stacked=stacked,
1508
force_new_repo=standalone,
1509
create_tree_if_local=not no_tree,
1510
source_branch=br_from)
1511
branch = to_dir.open_branch(
1512
possible_transports=[
1513
br_from.bzrdir.root_transport, to_transport])
1514
except errors.NoSuchRevision:
1515
to_transport.delete_tree('.')
1516
msg = gettext("The branch {0} has no revision {1}.").format(
1517
from_location, revision)
1518
raise errors.BzrCommandError(msg)
1521
to_repo = to_dir.open_repository()
1522
except errors.NoRepositoryPresent:
1523
to_repo = to_dir.create_repository()
1524
to_repo.fetch(br_from.repository, revision_id=revision_id)
1525
branch = br_from.sprout(to_dir, revision_id=revision_id)
1526
br_from.tags.merge_to(branch.tags)
1528
# If the source branch is stacked, the new branch may
1529
# be stacked whether we asked for that explicitly or not.
1530
# We therefore need a try/except here and not just 'if stacked:'
1532
note(gettext('Created new stacked branch referring to %s.') %
1533
branch.get_stacked_on_url())
1534
except (errors.NotStacked, errors.UnstackableBranchFormat,
1535
errors.UnstackableRepositoryFormat) as e:
1536
note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1538
# Bind to the parent
1539
parent_branch = Branch.open(from_location)
1540
branch.bind(parent_branch)
1541
note(gettext('New branch bound to %s') % from_location)
1543
# Switch to the new branch
1544
wt, _ = WorkingTree.open_containing('.')
1545
_mod_switch.switch(wt.bzrdir, branch)
1546
note(gettext('Switched to branch: %s'),
1547
urlutils.unescape_for_display(branch.base, 'utf-8'))
1550
class cmd_branches(Command):
1551
__doc__ = """List the branches available at the current location.
1553
This command will print the names of all the branches at the current
1557
takes_args = ['location?']
1559
Option('recursive', short_name='R',
1560
help='Recursively scan for branches rather than '
1561
'just looking in the specified location.')]
1563
def run(self, location=".", recursive=False):
1565
t = transport.get_transport(location)
1566
if not t.listable():
1567
raise errors.BzrCommandError(
1568
"Can't scan this type of location.")
1569
for b in controldir.ControlDir.find_branches(t):
1570
self.outf.write("%s\n" % urlutils.unescape_for_display(
1571
urlutils.relative_url(t.base, b.base),
1572
self.outf.encoding).rstrip("/"))
1574
dir = controldir.ControlDir.open_containing(location)[0]
1576
active_branch = dir.open_branch(name="")
1577
except errors.NotBranchError:
1578
active_branch = None
1580
for name, branch in iter_sibling_branches(dir):
1583
active = (active_branch is not None and
1584
active_branch.base == branch.base)
1585
names[name] = active
1586
# Only mention the current branch explicitly if it's not
1587
# one of the colocated branches
1588
if not any(viewvalues(names)) and active_branch is not None:
1589
self.outf.write("* %s\n" % gettext("(default)"))
1590
for name in sorted(names):
1591
active = names[name]
1596
self.outf.write("%s %s\n" % (
1597
prefix, name.encode(self.outf.encoding)))
1600
class cmd_checkout(Command):
1601
__doc__ = """Create a new checkout of an existing branch.
1603
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1604
the branch found in '.'. This is useful if you have removed the working tree
1605
or if it was never created - i.e. if you pushed the branch to its current
1606
location using SFTP.
1608
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1609
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1610
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1611
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1612
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1615
To retrieve the branch as of a particular revision, supply the --revision
1616
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1617
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1621
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1622
takes_args = ['branch_location?', 'to_location?']
1623
takes_options = ['revision',
1624
Option('lightweight',
1625
help="Perform a lightweight checkout. Lightweight "
1626
"checkouts depend on access to the branch for "
1627
"every operation. Normal checkouts can perform "
1628
"common operations like diff and status without "
1629
"such access, and also support local commits."
1631
Option('files-from', type=str,
1632
help="Get file contents from this tree."),
1634
help='Hard-link working tree files where possible.'
1639
def run(self, branch_location=None, to_location=None, revision=None,
1640
lightweight=False, files_from=None, hardlink=False):
1641
if branch_location is None:
1642
branch_location = osutils.getcwd()
1643
to_location = branch_location
1644
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1646
if not (hardlink or files_from):
1647
# accelerator_tree is usually slower because you have to read N
1648
# files (no readahead, lots of seeks, etc), but allow the user to
1649
# explicitly request it
1650
accelerator_tree = None
1651
revision = _get_one_revision('checkout', revision)
1652
if files_from is not None and files_from != branch_location:
1653
accelerator_tree = WorkingTree.open(files_from)
1654
if revision is not None:
1655
revision_id = revision.as_revision_id(source)
1658
if to_location is None:
1659
to_location = urlutils.derive_to_location(branch_location)
1660
# if the source and to_location are the same,
1661
# and there is no working tree,
1662
# then reconstitute a branch
1663
if (osutils.abspath(to_location) ==
1664
osutils.abspath(branch_location)):
1666
source.bzrdir.open_workingtree()
1667
except errors.NoWorkingTree:
1668
source.bzrdir.create_workingtree(revision_id)
1670
source.create_checkout(to_location, revision_id, lightweight,
1671
accelerator_tree, hardlink)
1674
class cmd_renames(Command):
1675
__doc__ = """Show list of renamed files.
1677
# TODO: Option to show renames between two historical versions.
1679
# TODO: Only show renames under dir, rather than in the whole branch.
1680
_see_also = ['status']
1681
takes_args = ['dir?']
1684
def run(self, dir=u'.'):
1685
tree = WorkingTree.open_containing(dir)[0]
1686
self.add_cleanup(tree.lock_read().unlock)
1687
old_tree = tree.basis_tree()
1688
self.add_cleanup(old_tree.lock_read().unlock)
1690
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1691
for f, paths, c, v, p, n, k, e in iterator:
1692
if paths[0] == paths[1]:
1696
renames.append(paths)
1698
for old_name, new_name in renames:
1699
self.outf.write("%s => %s\n" % (old_name, new_name))
1702
class cmd_update(Command):
1703
__doc__ = """Update a working tree to a new revision.
1705
This will perform a merge of the destination revision (the tip of the
1706
branch, or the specified revision) into the working tree, and then make
1707
that revision the basis revision for the working tree.
1709
You can use this to visit an older revision, or to update a working tree
1710
that is out of date from its branch.
1712
If there are any uncommitted changes in the tree, they will be carried
1713
across and remain as uncommitted changes after the update. To discard
1714
these changes, use 'brz revert'. The uncommitted changes may conflict
1715
with the changes brought in by the change in basis revision.
1717
If the tree's branch is bound to a master branch, brz will also update
1718
the branch from the master.
1720
You cannot update just a single file or directory, because each Bazaar
1721
working tree has just a single basis revision. If you want to restore a
1722
file that has been removed locally, use 'brz revert' instead of 'brz
1723
update'. If you want to restore a file to its state in a previous
1724
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1725
out the old content of that file to a new location.
1727
The 'dir' argument, if given, must be the location of the root of a
1728
working tree to update. By default, the working tree that contains the
1729
current working directory is used.
1732
_see_also = ['pull', 'working-trees', 'status-flags']
1733
takes_args = ['dir?']
1734
takes_options = ['revision',
1736
help="Show base revision text in conflicts."),
1740
def run(self, dir=None, revision=None, show_base=None):
1741
if revision is not None and len(revision) != 1:
1742
raise errors.brzCommandError(gettext(
1743
"brz update --revision takes exactly one revision"))
1745
tree = WorkingTree.open_containing('.')[0]
1747
tree, relpath = WorkingTree.open_containing(dir)
1750
raise errors.BzrCommandError(gettext(
1751
"brz update can only update a whole tree, "
1752
"not a file or subdirectory"))
1753
branch = tree.branch
1754
possible_transports = []
1755
master = branch.get_master_branch(
1756
possible_transports=possible_transports)
1757
if master is not None:
1758
branch_location = master.base
1761
branch_location = tree.branch.base
1762
tree.lock_tree_write()
1763
self.add_cleanup(tree.unlock)
1764
# get rid of the final '/' and be ready for display
1765
branch_location = urlutils.unescape_for_display(
1766
branch_location.rstrip('/'),
1768
existing_pending_merges = tree.get_parent_ids()[1:]
1772
# may need to fetch data into a heavyweight checkout
1773
# XXX: this may take some time, maybe we should display a
1775
old_tip = branch.update(possible_transports)
1776
if revision is not None:
1777
revision_id = revision[0].as_revision_id(branch)
1779
revision_id = branch.last_revision()
1780
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1781
revno = branch.revision_id_to_dotted_revno(revision_id)
1782
note(gettext("Tree is up to date at revision {0} of branch {1}"
1783
).format('.'.join(map(str, revno)), branch_location))
1785
view_info = _get_view_info_for_change_reporter(tree)
1786
change_reporter = delta._ChangeReporter(
1787
unversioned_filter=tree.is_ignored,
1788
view_info=view_info)
1790
conflicts = tree.update(
1792
possible_transports=possible_transports,
1793
revision=revision_id,
1795
show_base=show_base)
1796
except errors.NoSuchRevision as e:
1797
raise errors.BzrCommandError(gettext(
1798
"branch has no revision %s\n"
1799
"brz update --revision only works"
1800
" for a revision in the branch history")
1802
revno = tree.branch.revision_id_to_dotted_revno(
1803
_mod_revision.ensure_null(tree.last_revision()))
1804
note(gettext('Updated to revision {0} of branch {1}').format(
1805
'.'.join(map(str, revno)), branch_location))
1806
parent_ids = tree.get_parent_ids()
1807
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1808
note(gettext('Your local commits will now show as pending merges with '
1809
"'brz status', and can be committed with 'brz commit'."))
1816
class cmd_info(Command):
1817
__doc__ = """Show information about a working tree, branch or repository.
1819
This command will show all known locations and formats associated to the
1820
tree, branch or repository.
1822
In verbose mode, statistical information is included with each report.
1823
To see extended statistic information, use a verbosity level of 2 or
1824
higher by specifying the verbose option multiple times, e.g. -vv.
1826
Branches and working trees will also report any missing revisions.
1830
Display information on the format and related locations:
1834
Display the above together with extended format information and
1835
basic statistics (like the number of files in the working tree and
1836
number of revisions in the branch and repository):
1840
Display the above together with number of committers to the branch:
1844
_see_also = ['revno', 'working-trees', 'repositories']
1845
takes_args = ['location?']
1846
takes_options = ['verbose']
1847
encoding_type = 'replace'
1850
def run(self, location=None, verbose=False):
1852
noise_level = get_verbosity_level()
1855
from .info import show_bzrdir_info
1856
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1857
verbose=noise_level, outfile=self.outf)
1860
class cmd_remove(Command):
1861
__doc__ = """Remove files or directories.
1863
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1864
delete them if they can easily be recovered using revert otherwise they
1865
will be backed up (adding an extension of the form .~#~). If no options or
1866
parameters are given Bazaar will scan for files that are being tracked by
1867
Bazaar but missing in your tree and stop tracking them for you.
1869
takes_args = ['file*']
1870
takes_options = ['verbose',
1871
Option('new', help='Only remove files that have never been committed.'),
1872
RegistryOption.from_kwargs('file-deletion-strategy',
1873
'The file deletion mode to be used.',
1874
title='Deletion Strategy', value_switches=True, enum_switch=False,
1875
safe='Backup changed files (default).',
1876
keep='Delete from brz but leave the working copy.',
1877
no_backup='Don\'t backup changed files.'),
1879
aliases = ['rm', 'del']
1880
encoding_type = 'replace'
1882
def run(self, file_list, verbose=False, new=False,
1883
file_deletion_strategy='safe'):
1885
tree, file_list = WorkingTree.open_containing_paths(file_list)
1887
if file_list is not None:
1888
file_list = [f for f in file_list]
1890
self.add_cleanup(tree.lock_write().unlock)
1891
# Heuristics should probably all move into tree.remove_smart or
1894
added = tree.changes_from(tree.basis_tree(),
1895
specific_files=file_list).added
1896
file_list = sorted([f[0] for f in added], reverse=True)
1897
if len(file_list) == 0:
1898
raise errors.BzrCommandError(gettext('No matching files.'))
1899
elif file_list is None:
1900
# missing files show up in iter_changes(basis) as
1901
# versioned-with-no-kind.
1903
for change in tree.iter_changes(tree.basis_tree()):
1904
# Find paths in the working tree that have no kind:
1905
if change[1][1] is not None and change[6][1] is None:
1906
missing.append(change[1][1])
1907
file_list = sorted(missing, reverse=True)
1908
file_deletion_strategy = 'keep'
1909
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1910
keep_files=file_deletion_strategy=='keep',
1911
force=(file_deletion_strategy=='no-backup'))
1914
class cmd_file_id(Command):
1915
__doc__ = """Print file_id of a particular file or directory.
1917
The file_id is assigned when the file is first added and remains the
1918
same through all revisions where the file exists, even when it is
1923
_see_also = ['inventory', 'ls']
1924
takes_args = ['filename']
1927
def run(self, filename):
1928
tree, relpath = WorkingTree.open_containing(filename)
1929
i = tree.path2id(relpath)
1931
raise errors.NotVersionedError(filename)
1933
self.outf.write(i + '\n')
1936
class cmd_file_path(Command):
1937
__doc__ = """Print path of file_ids to a file or directory.
1939
This prints one line for each directory down to the target,
1940
starting at the branch root.
1944
takes_args = ['filename']
1947
def run(self, filename):
1948
tree, relpath = WorkingTree.open_containing(filename)
1949
fid = tree.path2id(relpath)
1951
raise errors.NotVersionedError(filename)
1952
segments = osutils.splitpath(relpath)
1953
for pos in range(1, len(segments) + 1):
1954
path = osutils.joinpath(segments[:pos])
1955
self.outf.write("%s\n" % tree.path2id(path))
1958
class cmd_reconcile(Command):
1959
__doc__ = """Reconcile brz metadata in a branch.
1961
This can correct data mismatches that may have been caused by
1962
previous ghost operations or brz upgrades. You should only
1963
need to run this command if 'brz check' or a brz developer
1964
advises you to run it.
1966
If a second branch is provided, cross-branch reconciliation is
1967
also attempted, which will check that data like the tree root
1968
id which was not present in very early brz versions is represented
1969
correctly in both branches.
1971
At the same time it is run it may recompress data resulting in
1972
a potential saving in disk space or performance gain.
1974
The branch *MUST* be on a listable system such as local disk or sftp.
1977
_see_also = ['check']
1978
takes_args = ['branch?']
1980
Option('canonicalize-chks',
1981
help='Make sure CHKs are in canonical form (repairs '
1986
def run(self, branch=".", canonicalize_chks=False):
1987
from .reconcile import reconcile
1988
dir = controldir.ControlDir.open(branch)
1989
reconcile(dir, canonicalize_chks=canonicalize_chks)
1992
class cmd_revision_history(Command):
1993
__doc__ = """Display the list of revision ids on a branch."""
1996
takes_args = ['location?']
2001
def run(self, location="."):
2002
branch = Branch.open_containing(location)[0]
2003
self.add_cleanup(branch.lock_read().unlock)
2004
graph = branch.repository.get_graph()
2005
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
2006
[_mod_revision.NULL_REVISION]))
2007
for revid in reversed(history):
2008
self.outf.write(revid)
2009
self.outf.write('\n')
2012
class cmd_ancestry(Command):
2013
__doc__ = """List all revisions merged into this branch."""
2015
_see_also = ['log', 'revision-history']
2016
takes_args = ['location?']
2021
def run(self, location="."):
2023
wt = WorkingTree.open_containing(location)[0]
2024
except errors.NoWorkingTree:
2025
b = Branch.open(location)
2026
last_revision = b.last_revision()
2029
last_revision = wt.last_revision()
2031
self.add_cleanup(b.repository.lock_read().unlock)
2032
graph = b.repository.get_graph()
2033
revisions = [revid for revid, parents in
2034
graph.iter_ancestry([last_revision])]
2035
for revision_id in reversed(revisions):
2036
if _mod_revision.is_null(revision_id):
2038
self.outf.write(revision_id + '\n')
2041
class cmd_init(Command):
2042
__doc__ = """Make a directory into a versioned branch.
2044
Use this to create an empty branch, or before importing an
2047
If there is a repository in a parent directory of the location, then
2048
the history of the branch will be stored in the repository. Otherwise
2049
init creates a standalone branch which carries its own history
2050
in the .bzr directory.
2052
If there is already a branch at the location but it has no working tree,
2053
the tree can be populated with 'brz checkout'.
2055
Recipe for importing a tree of files::
2061
brz commit -m "imported project"
2064
_see_also = ['init-repository', 'branch', 'checkout']
2065
takes_args = ['location?']
2067
Option('create-prefix',
2068
help='Create the path leading up to the branch '
2069
'if it does not already exist.'),
2070
RegistryOption('format',
2071
help='Specify a format for this branch. '
2072
'See "help formats".',
2073
lazy_registry=('breezy.controldir', 'format_registry'),
2074
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2075
value_switches=True,
2076
title="Branch format",
2078
Option('append-revisions-only',
2079
help='Never change revnos or the existing log.'
2080
' Append revisions to it only.'),
2082
'Create a branch without a working tree.')
2084
def run(self, location=None, format=None, append_revisions_only=False,
2085
create_prefix=False, no_tree=False):
2087
format = controldir.format_registry.make_bzrdir('default')
2088
if location is None:
2091
to_transport = transport.get_transport(location)
2093
# The path has to exist to initialize a
2094
# branch inside of it.
2095
# Just using os.mkdir, since I don't
2096
# believe that we want to create a bunch of
2097
# locations if the user supplies an extended path
2099
to_transport.ensure_base()
2100
except errors.NoSuchFile:
2101
if not create_prefix:
2102
raise errors.BzrCommandError(gettext("Parent directory of %s"
2104
"\nYou may supply --create-prefix to create all"
2105
" leading parent directories.")
2107
to_transport.create_prefix()
2110
a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
2111
except errors.NotBranchError:
2112
# really a NotBzrDir error...
2113
create_branch = controldir.ControlDir.create_branch_convenience
2115
force_new_tree = False
2117
force_new_tree = None
2118
branch = create_branch(to_transport.base, format=format,
2119
possible_transports=[to_transport],
2120
force_new_tree=force_new_tree)
2121
a_bzrdir = branch.bzrdir
2123
from .transport.local import LocalTransport
2124
if a_bzrdir.has_branch():
2125
if (isinstance(to_transport, LocalTransport)
2126
and not a_bzrdir.has_workingtree()):
2127
raise errors.BranchExistsWithoutWorkingTree(location)
2128
raise errors.AlreadyBranchError(location)
2129
branch = a_bzrdir.create_branch()
2130
if not no_tree and not a_bzrdir.has_workingtree():
2131
a_bzrdir.create_workingtree()
2132
if append_revisions_only:
2134
branch.set_append_revisions_only(True)
2135
except errors.UpgradeRequired:
2136
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2137
' to append-revisions-only. Try --default.'))
2139
from .info import describe_layout, describe_format
2141
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
2142
except (errors.NoWorkingTree, errors.NotLocalUrl):
2144
repository = branch.repository
2145
layout = describe_layout(repository, branch, tree).lower()
2146
format = describe_format(a_bzrdir, repository, branch, tree)
2147
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2149
if repository.is_shared():
2150
#XXX: maybe this can be refactored into transport.path_or_url()
2151
url = repository.bzrdir.root_transport.external_url()
2153
url = urlutils.local_path_from_url(url)
2154
except errors.InvalidURL:
2156
self.outf.write(gettext("Using shared repository: %s\n") % url)
2159
class cmd_init_repository(Command):
2160
__doc__ = """Create a shared repository for branches to share storage space.
2162
New branches created under the repository directory will store their
2163
revisions in the repository, not in the branch directory. For branches
2164
with shared history, this reduces the amount of storage needed and
2165
speeds up the creation of new branches.
2167
If the --no-trees option is given then the branches in the repository
2168
will not have working trees by default. They will still exist as
2169
directories on disk, but they will not have separate copies of the
2170
files at a certain revision. This can be useful for repositories that
2171
store branches which are interacted with through checkouts or remote
2172
branches, such as on a server.
2175
Create a shared repository holding just branches::
2177
brz init-repo --no-trees repo
2180
Make a lightweight checkout elsewhere::
2182
brz checkout --lightweight repo/trunk trunk-checkout
2187
_see_also = ['init', 'branch', 'checkout', 'repositories']
2188
takes_args = ["location"]
2189
takes_options = [RegistryOption('format',
2190
help='Specify a format for this repository. See'
2191
' "brz help formats" for details.',
2192
lazy_registry=('breezy.controldir', 'format_registry'),
2193
converter=lambda name: controldir.format_registry.make_bzrdir(name),
2194
value_switches=True, title='Repository format'),
2196
help='Branches in the repository will default to'
2197
' not having a working tree.'),
2199
aliases = ["init-repo"]
2201
def run(self, location, format=None, no_trees=False):
2203
format = controldir.format_registry.make_bzrdir('default')
2205
if location is None:
2208
to_transport = transport.get_transport(location)
2210
(repo, newdir, require_stacking, repository_policy) = (
2211
format.initialize_on_transport_ex(to_transport,
2212
create_prefix=True, make_working_trees=not no_trees,
2213
shared_repo=True, force_new_repo=True,
2214
use_existing_dir=True,
2215
repo_format_name=format.repository_format.get_format_string()))
2217
from .info import show_bzrdir_info
2218
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2221
class cmd_diff(Command):
2222
__doc__ = """Show differences in the working tree, between revisions or branches.
2224
If no arguments are given, all changes for the current tree are listed.
2225
If files are given, only the changes in those files are listed.
2226
Remote and multiple branches can be compared by using the --old and
2227
--new options. If not provided, the default for both is derived from
2228
the first argument, if any, or the current tree if no arguments are
2231
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2232
produces patches suitable for "patch -p1".
2234
Note that when using the -r argument with a range of revisions, the
2235
differences are computed between the two specified revisions. That
2236
is, the command does not show the changes introduced by the first
2237
revision in the range. This differs from the interpretation of
2238
revision ranges used by "brz log" which includes the first revision
2243
2 - unrepresentable changes
2248
Shows the difference in the working tree versus the last commit::
2252
Difference between the working tree and revision 1::
2256
Difference between revision 3 and revision 1::
2260
Difference between revision 3 and revision 1 for branch xxx::
2264
The changes introduced by revision 2 (equivalent to -r1..2)::
2268
To see the changes introduced by revision X::
2272
Note that in the case of a merge, the -c option shows the changes
2273
compared to the left hand parent. To see the changes against
2274
another parent, use::
2276
brz diff -r<chosen_parent>..X
2278
The changes between the current revision and the previous revision
2279
(equivalent to -c-1 and -r-2..-1)
2283
Show just the differences for file NEWS::
2287
Show the differences in working tree xxx for file NEWS::
2291
Show the differences from branch xxx to this working tree:
2295
Show the differences between two branches for file NEWS::
2297
brz diff --old xxx --new yyy NEWS
2299
Same as 'brz diff' but prefix paths with old/ and new/::
2301
brz diff --prefix old/:new/
2303
Show the differences using a custom diff program with options::
2305
brz diff --using /usr/bin/diff --diff-options -wu
2307
_see_also = ['status']
2308
takes_args = ['file*']
2310
Option('diff-options', type=str,
2311
help='Pass these options to the external diff program.'),
2312
Option('prefix', type=str,
2314
help='Set prefixes added to old and new filenames, as '
2315
'two values separated by a colon. (eg "old/:new/").'),
2317
help='Branch/tree to compare from.',
2321
help='Branch/tree to compare to.',
2327
help='Use this command to compare files.',
2330
RegistryOption('format',
2332
help='Diff format to use.',
2333
lazy_registry=('breezy.diff', 'format_registry'),
2334
title='Diff format'),
2336
help='How many lines of context to show.',
2340
aliases = ['di', 'dif']
2341
encoding_type = 'exact'
2344
def run(self, revision=None, file_list=None, diff_options=None,
2345
prefix=None, old=None, new=None, using=None, format=None,
2347
from .diff import (get_trees_and_branches_to_diff_locked,
2354
elif prefix == '1' or prefix is None:
2358
old_label, new_label = prefix.split(":")
2360
raise errors.BzrCommandError(gettext(
2361
'--prefix expects two values separated by a colon'
2362
' (eg "old/:new/")'))
2364
if revision and len(revision) > 2:
2365
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2366
' one or two revision specifiers'))
2368
if using is not None and format is not None:
2369
raise errors.BzrCommandError(gettext(
2370
'{0} and {1} are mutually exclusive').format(
2371
'--using', '--format'))
2373
(old_tree, new_tree,
2374
old_branch, new_branch,
2375
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2376
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2377
# GNU diff on Windows uses ANSI encoding for filenames
2378
path_encoding = osutils.get_diff_header_encoding()
2379
return show_diff_trees(old_tree, new_tree, sys.stdout,
2380
specific_files=specific_files,
2381
external_diff_options=diff_options,
2382
old_label=old_label, new_label=new_label,
2383
extra_trees=extra_trees,
2384
path_encoding=path_encoding,
2385
using=using, context=context,
2389
class cmd_deleted(Command):
2390
__doc__ = """List files deleted in the working tree.
2392
# TODO: Show files deleted since a previous revision, or
2393
# between two revisions.
2394
# TODO: Much more efficient way to do this: read in new
2395
# directories with readdir, rather than stating each one. Same
2396
# level of effort but possibly much less IO. (Or possibly not,
2397
# if the directories are very large...)
2398
_see_also = ['status', 'ls']
2399
takes_options = ['directory', 'show-ids']
2402
def run(self, show_ids=False, directory=u'.'):
2403
tree = WorkingTree.open_containing(directory)[0]
2404
self.add_cleanup(tree.lock_read().unlock)
2405
old = tree.basis_tree()
2406
self.add_cleanup(old.lock_read().unlock)
2407
for path, ie in old.iter_entries_by_dir():
2408
if not tree.has_id(ie.file_id):
2409
self.outf.write(path)
2411
self.outf.write(' ')
2412
self.outf.write(ie.file_id)
2413
self.outf.write('\n')
2416
class cmd_modified(Command):
2417
__doc__ = """List files modified in working tree.
2421
_see_also = ['status', 'ls']
2422
takes_options = ['directory', 'null']
2425
def run(self, null=False, directory=u'.'):
2426
tree = WorkingTree.open_containing(directory)[0]
2427
self.add_cleanup(tree.lock_read().unlock)
2428
td = tree.changes_from(tree.basis_tree())
2430
for path, id, kind, text_modified, meta_modified in td.modified:
2432
self.outf.write(path + '\0')
2434
self.outf.write(osutils.quotefn(path) + '\n')
2437
class cmd_added(Command):
2438
__doc__ = """List files added in working tree.
2442
_see_also = ['status', 'ls']
2443
takes_options = ['directory', 'null']
2446
def run(self, null=False, directory=u'.'):
2447
wt = WorkingTree.open_containing(directory)[0]
2448
self.add_cleanup(wt.lock_read().unlock)
2449
basis = wt.basis_tree()
2450
self.add_cleanup(basis.lock_read().unlock)
2451
root_id = wt.get_root_id()
2452
for file_id in wt.all_file_ids():
2453
if basis.has_id(file_id):
2455
if root_id == file_id:
2457
path = wt.id2path(file_id)
2458
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2461
self.outf.write(path + '\0')
2463
self.outf.write(osutils.quotefn(path) + '\n')
2466
class cmd_root(Command):
2467
__doc__ = """Show the tree root directory.
2469
The root is the nearest enclosing directory with a .bzr control
2472
takes_args = ['filename?']
2474
def run(self, filename=None):
2475
"""Print the branch root."""
2476
tree = WorkingTree.open_containing(filename)[0]
2477
self.outf.write(tree.basedir + '\n')
2480
def _parse_limit(limitstring):
2482
return int(limitstring)
2484
msg = gettext("The limit argument must be an integer.")
2485
raise errors.BzrCommandError(msg)
2488
def _parse_levels(s):
2492
msg = gettext("The levels argument must be an integer.")
2493
raise errors.BzrCommandError(msg)
2496
class cmd_log(Command):
2497
__doc__ = """Show historical log for a branch or subset of a branch.
2499
log is brz's default tool for exploring the history of a branch.
2500
The branch to use is taken from the first parameter. If no parameters
2501
are given, the branch containing the working directory is logged.
2502
Here are some simple examples::
2504
brz log log the current branch
2505
brz log foo.py log a file in its branch
2506
brz log http://server/branch log a branch on a server
2508
The filtering, ordering and information shown for each revision can
2509
be controlled as explained below. By default, all revisions are
2510
shown sorted (topologically) so that newer revisions appear before
2511
older ones and descendants always appear before ancestors. If displayed,
2512
merged revisions are shown indented under the revision in which they
2517
The log format controls how information about each revision is
2518
displayed. The standard log formats are called ``long``, ``short``
2519
and ``line``. The default is long. See ``brz help log-formats``
2520
for more details on log formats.
2522
The following options can be used to control what information is
2525
-l N display a maximum of N revisions
2526
-n N display N levels of revisions (0 for all, 1 for collapsed)
2527
-v display a status summary (delta) for each revision
2528
-p display a diff (patch) for each revision
2529
--show-ids display revision-ids (and file-ids), not just revnos
2531
Note that the default number of levels to display is a function of the
2532
log format. If the -n option is not used, the standard log formats show
2533
just the top level (mainline).
2535
Status summaries are shown using status flags like A, M, etc. To see
2536
the changes explained using words like ``added`` and ``modified``
2537
instead, use the -vv option.
2541
To display revisions from oldest to newest, use the --forward option.
2542
In most cases, using this option will have little impact on the total
2543
time taken to produce a log, though --forward does not incrementally
2544
display revisions like --reverse does when it can.
2546
:Revision filtering:
2548
The -r option can be used to specify what revision or range of revisions
2549
to filter against. The various forms are shown below::
2551
-rX display revision X
2552
-rX.. display revision X and later
2553
-r..Y display up to and including revision Y
2554
-rX..Y display from X to Y inclusive
2556
See ``brz help revisionspec`` for details on how to specify X and Y.
2557
Some common examples are given below::
2559
-r-1 show just the tip
2560
-r-10.. show the last 10 mainline revisions
2561
-rsubmit:.. show what's new on this branch
2562
-rancestor:path.. show changes since the common ancestor of this
2563
branch and the one at location path
2564
-rdate:yesterday.. show changes since yesterday
2566
When logging a range of revisions using -rX..Y, log starts at
2567
revision Y and searches back in history through the primary
2568
("left-hand") parents until it finds X. When logging just the
2569
top level (using -n1), an error is reported if X is not found
2570
along the way. If multi-level logging is used (-n0), X may be
2571
a nested merge revision and the log will be truncated accordingly.
2575
If parameters are given and the first one is not a branch, the log
2576
will be filtered to show only those revisions that changed the
2577
nominated files or directories.
2579
Filenames are interpreted within their historical context. To log a
2580
deleted file, specify a revision range so that the file existed at
2581
the end or start of the range.
2583
Historical context is also important when interpreting pathnames of
2584
renamed files/directories. Consider the following example:
2586
* revision 1: add tutorial.txt
2587
* revision 2: modify tutorial.txt
2588
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2592
* ``brz log guide.txt`` will log the file added in revision 1
2594
* ``brz log tutorial.txt`` will log the new file added in revision 3
2596
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2597
the original file in revision 2.
2599
* ``brz log -r2 -p guide.txt`` will display an error message as there
2600
was no file called guide.txt in revision 2.
2602
Renames are always followed by log. By design, there is no need to
2603
explicitly ask for this (and no way to stop logging a file back
2604
until it was last renamed).
2608
The --match option can be used for finding revisions that match a
2609
regular expression in a commit message, committer, author or bug.
2610
Specifying the option several times will match any of the supplied
2611
expressions. --match-author, --match-bugs, --match-committer and
2612
--match-message can be used to only match a specific field.
2616
GUI tools and IDEs are often better at exploring history than command
2617
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2618
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2619
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2620
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2622
You may find it useful to add the aliases below to ``bazaar.conf``::
2626
top = log -l10 --line
2629
``brz tip`` will then show the latest revision while ``brz top``
2630
will show the last 10 mainline revisions. To see the details of a
2631
particular revision X, ``brz show -rX``.
2633
If you are interested in looking deeper into a particular merge X,
2634
use ``brz log -n0 -rX``.
2636
``brz log -v`` on a branch with lots of history is currently
2637
very slow. A fix for this issue is currently under development.
2638
With or without that fix, it is recommended that a revision range
2639
be given when using the -v option.
2641
brz has a generic full-text matching plugin, brz-search, that can be
2642
used to find revisions matching user names, commit messages, etc.
2643
Among other features, this plugin can find all revisions containing
2644
a list of words but not others.
2646
When exploring non-mainline history on large projects with deep
2647
history, the performance of log can be greatly improved by installing
2648
the historycache plugin. This plugin buffers historical information
2649
trading disk space for faster speed.
2651
takes_args = ['file*']
2652
_see_also = ['log-formats', 'revisionspec']
2655
help='Show from oldest to newest.'),
2657
custom_help('verbose',
2658
help='Show files changed in each revision.'),
2662
type=breezy.option._parse_revision_str,
2664
help='Show just the specified revision.'
2665
' See also "help revisionspec".'),
2667
RegistryOption('authors',
2668
'What names to list as authors - first, all or committer.',
2670
lazy_registry=('breezy.log', 'author_list_registry'),
2674
help='Number of levels to display - 0 for all, 1 for flat.',
2676
type=_parse_levels),
2678
help='Show revisions whose message matches this '
2679
'regular expression.',
2684
help='Limit the output to the first N revisions.',
2689
help='Show changes made in each revision as a patch.'),
2690
Option('include-merged',
2691
help='Show merged revisions like --levels 0 does.'),
2692
Option('include-merges', hidden=True,
2693
help='Historical alias for --include-merged.'),
2694
Option('omit-merges',
2695
help='Do not report commits with more than one parent.'),
2696
Option('exclude-common-ancestry',
2697
help='Display only the revisions that are not part'
2698
' of both ancestries (require -rX..Y).'
2700
Option('signatures',
2701
help='Show digital signature validity.'),
2704
help='Show revisions whose properties match this '
2707
ListOption('match-message',
2708
help='Show revisions whose message matches this '
2711
ListOption('match-committer',
2712
help='Show revisions whose committer matches this '
2715
ListOption('match-author',
2716
help='Show revisions whose authors match this '
2719
ListOption('match-bugs',
2720
help='Show revisions whose bugs match this '
2724
encoding_type = 'replace'
2727
def run(self, file_list=None, timezone='original',
2738
include_merged=None,
2740
exclude_common_ancestry=False,
2744
match_committer=None,
2751
make_log_request_dict,
2752
_get_info_for_log_files,
2754
direction = (forward and 'forward') or 'reverse'
2755
if include_merged is None:
2756
include_merged = False
2757
if (exclude_common_ancestry
2758
and (revision is None or len(revision) != 2)):
2759
raise errors.BzrCommandError(gettext(
2760
'--exclude-common-ancestry requires -r with two revisions'))
2765
raise errors.BzrCommandError(gettext(
2766
'{0} and {1} are mutually exclusive').format(
2767
'--levels', '--include-merged'))
2769
if change is not None:
2771
raise errors.RangeInChangeOption()
2772
if revision is not None:
2773
raise errors.BzrCommandError(gettext(
2774
'{0} and {1} are mutually exclusive').format(
2775
'--revision', '--change'))
2780
filter_by_dir = False
2782
# find the file ids to log and check for directory filtering
2783
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2784
revision, file_list, self.add_cleanup)
2785
for relpath, file_id, kind in file_info_list:
2787
raise errors.BzrCommandError(gettext(
2788
"Path unknown at end or start of revision range: %s") %
2790
# If the relpath is the top of the tree, we log everything
2795
file_ids.append(file_id)
2796
filter_by_dir = filter_by_dir or (
2797
kind in ['directory', 'tree-reference'])
2800
# FIXME ? log the current subdir only RBC 20060203
2801
if revision is not None \
2802
and len(revision) > 0 and revision[0].get_branch():
2803
location = revision[0].get_branch()
2806
dir, relpath = controldir.ControlDir.open_containing(location)
2807
b = dir.open_branch()
2808
self.add_cleanup(b.lock_read().unlock)
2809
rev1, rev2 = _get_revision_range(revision, b, self.name())
2811
if b.get_config_stack().get('validate_signatures_in_log'):
2815
if not gpg.GPGStrategy.verify_signatures_available():
2816
raise errors.GpgmeNotInstalled(None)
2818
# Decide on the type of delta & diff filtering to use
2819
# TODO: add an --all-files option to make this configurable & consistent
2827
diff_type = 'partial'
2831
# Build the log formatter
2832
if log_format is None:
2833
log_format = log.log_formatter_registry.get_default(b)
2834
# Make a non-encoding output to include the diffs - bug 328007
2835
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2836
lf = log_format(show_ids=show_ids, to_file=self.outf,
2837
to_exact_file=unencoded_output,
2838
show_timezone=timezone,
2839
delta_format=get_verbosity_level(),
2841
show_advice=levels is None,
2842
author_list_handler=authors)
2844
# Choose the algorithm for doing the logging. It's annoying
2845
# having multiple code paths like this but necessary until
2846
# the underlying repository format is faster at generating
2847
# deltas or can provide everything we need from the indices.
2848
# The default algorithm - match-using-deltas - works for
2849
# multiple files and directories and is faster for small
2850
# amounts of history (200 revisions say). However, it's too
2851
# slow for logging a single file in a repository with deep
2852
# history, i.e. > 10K revisions. In the spirit of "do no
2853
# evil when adding features", we continue to use the
2854
# original algorithm - per-file-graph - for the "single
2855
# file that isn't a directory without showing a delta" case.
2856
partial_history = revision and b.repository._format.supports_chks
2857
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2858
or delta_type or partial_history)
2862
match_dict[''] = match
2864
match_dict['message'] = match_message
2866
match_dict['committer'] = match_committer
2868
match_dict['author'] = match_author
2870
match_dict['bugs'] = match_bugs
2872
# Build the LogRequest and execute it
2873
if len(file_ids) == 0:
2875
rqst = make_log_request_dict(
2876
direction=direction, specific_fileids=file_ids,
2877
start_revision=rev1, end_revision=rev2, limit=limit,
2878
message_search=message, delta_type=delta_type,
2879
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2880
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2881
signature=signatures, omit_merges=omit_merges,
2883
Logger(b, rqst).show(lf)
2886
def _get_revision_range(revisionspec_list, branch, command_name):
2887
"""Take the input of a revision option and turn it into a revision range.
2889
It returns RevisionInfo objects which can be used to obtain the rev_id's
2890
of the desired revisions. It does some user input validations.
2892
if revisionspec_list is None:
2895
elif len(revisionspec_list) == 1:
2896
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2897
elif len(revisionspec_list) == 2:
2898
start_spec = revisionspec_list[0]
2899
end_spec = revisionspec_list[1]
2900
if end_spec.get_branch() != start_spec.get_branch():
2901
# b is taken from revision[0].get_branch(), and
2902
# show_log will use its revision_history. Having
2903
# different branches will lead to weird behaviors.
2904
raise errors.BzrCommandError(gettext(
2905
"brz %s doesn't accept two revisions in different"
2906
" branches.") % command_name)
2907
if start_spec.spec is None:
2908
# Avoid loading all the history.
2909
rev1 = RevisionInfo(branch, None, None)
2911
rev1 = start_spec.in_history(branch)
2912
# Avoid loading all of history when we know a missing
2913
# end of range means the last revision ...
2914
if end_spec.spec is None:
2915
last_revno, last_revision_id = branch.last_revision_info()
2916
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2918
rev2 = end_spec.in_history(branch)
2920
raise errors.BzrCommandError(gettext(
2921
'brz %s --revision takes one or two values.') % command_name)
2925
def _revision_range_to_revid_range(revision_range):
2928
if revision_range[0] is not None:
2929
rev_id1 = revision_range[0].rev_id
2930
if revision_range[1] is not None:
2931
rev_id2 = revision_range[1].rev_id
2932
return rev_id1, rev_id2
2934
def get_log_format(long=False, short=False, line=False, default='long'):
2935
log_format = default
2939
log_format = 'short'
2945
class cmd_touching_revisions(Command):
2946
__doc__ = """Return revision-ids which affected a particular file.
2948
A more user-friendly interface is "brz log FILE".
2952
takes_args = ["filename"]
2955
def run(self, filename):
2956
tree, relpath = WorkingTree.open_containing(filename)
2957
file_id = tree.path2id(relpath)
2959
self.add_cleanup(b.lock_read().unlock)
2960
touching_revs = log.find_touching_revisions(b, file_id)
2961
for revno, revision_id, what in touching_revs:
2962
self.outf.write("%6d %s\n" % (revno, what))
2965
class cmd_ls(Command):
2966
__doc__ = """List files in a tree.
2969
_see_also = ['status', 'cat']
2970
takes_args = ['path?']
2974
Option('recursive', short_name='R',
2975
help='Recurse into subdirectories.'),
2977
help='Print paths relative to the root of the branch.'),
2978
Option('unknown', short_name='u',
2979
help='Print unknown files.'),
2980
Option('versioned', help='Print versioned files.',
2982
Option('ignored', short_name='i',
2983
help='Print ignored files.'),
2984
Option('kind', short_name='k',
2985
help='List entries of a particular kind: file, directory, symlink.',
2992
def run(self, revision=None, verbose=False,
2993
recursive=False, from_root=False,
2994
unknown=False, versioned=False, ignored=False,
2995
null=False, kind=None, show_ids=False, path=None, directory=None):
2997
if kind and kind not in ('file', 'directory', 'symlink'):
2998
raise errors.BzrCommandError(gettext('invalid kind specified'))
3000
if verbose and null:
3001
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
3002
all = not (unknown or versioned or ignored)
3004
selection = {'I':ignored, '?':unknown, 'V':versioned}
3010
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3013
tree, branch, relpath = \
3014
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3016
# Calculate the prefix to use
3020
prefix = relpath + '/'
3021
elif fs_path != '.' and not fs_path.endswith('/'):
3022
prefix = fs_path + '/'
3024
if revision is not None or tree is None:
3025
tree = _get_one_revision_tree('ls', revision, branch=branch)
3028
if isinstance(tree, WorkingTree) and tree.supports_views():
3029
view_files = tree.views.lookup_view()
3032
view_str = views.view_display_str(view_files)
3033
note(gettext("Ignoring files outside view. View is %s") % view_str)
3035
self.add_cleanup(tree.lock_read().unlock)
3036
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3037
from_dir=relpath, recursive=recursive):
3038
# Apply additional masking
3039
if not all and not selection[fc]:
3041
if kind is not None and fkind != kind:
3046
fullpath = osutils.pathjoin(relpath, fp)
3049
views.check_path_in_view(tree, fullpath)
3050
except errors.FileOutsideView:
3055
fp = osutils.pathjoin(prefix, fp)
3056
kindch = entry.kind_character()
3057
outstring = fp + kindch
3058
ui.ui_factory.clear_term()
3060
outstring = '%-8s %s' % (fc, outstring)
3061
if show_ids and fid is not None:
3062
outstring = "%-50s %s" % (outstring, fid)
3063
self.outf.write(outstring + '\n')
3065
self.outf.write(fp + '\0')
3068
self.outf.write(fid)
3069
self.outf.write('\0')
3077
self.outf.write('%-50s %s\n' % (outstring, my_id))
3079
self.outf.write(outstring + '\n')
3082
class cmd_unknowns(Command):
3083
__doc__ = """List unknown files.
3088
takes_options = ['directory']
3091
def run(self, directory=u'.'):
3092
for f in WorkingTree.open_containing(directory)[0].unknowns():
3093
self.outf.write(osutils.quotefn(f) + '\n')
3096
class cmd_ignore(Command):
3097
__doc__ = """Ignore specified files or patterns.
3099
See ``brz help patterns`` for details on the syntax of patterns.
3101
If a .bzrignore file does not exist, the ignore command
3102
will create one and add the specified files or patterns to the newly
3103
created file. The ignore command will also automatically add the
3104
.bzrignore file to be versioned. Creating a .bzrignore file without
3105
the use of the ignore command will require an explicit add command.
3107
To remove patterns from the ignore list, edit the .bzrignore file.
3108
After adding, editing or deleting that file either indirectly by
3109
using this command or directly by using an editor, be sure to commit
3112
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3113
the global ignore file can be found in the application data directory as
3114
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3115
Global ignores are not touched by this command. The global ignore file
3116
can be edited directly using an editor.
3118
Patterns prefixed with '!' are exceptions to ignore patterns and take
3119
precedence over regular ignores. Such exceptions are used to specify
3120
files that should be versioned which would otherwise be ignored.
3122
Patterns prefixed with '!!' act as regular ignore patterns, but have
3123
precedence over the '!' exception patterns.
3127
* Ignore patterns containing shell wildcards must be quoted from
3130
* Ignore patterns starting with "#" act as comments in the ignore file.
3131
To ignore patterns that begin with that character, use the "RE:" prefix.
3134
Ignore the top level Makefile::
3136
brz ignore ./Makefile
3138
Ignore .class files in all directories...::
3140
brz ignore "*.class"
3142
...but do not ignore "special.class"::
3144
brz ignore "!special.class"
3146
Ignore files whose name begins with the "#" character::
3150
Ignore .o files under the lib directory::
3152
brz ignore "lib/**/*.o"
3154
Ignore .o files under the lib directory::
3156
brz ignore "RE:lib/.*\.o"
3158
Ignore everything but the "debian" toplevel directory::
3160
brz ignore "RE:(?!debian/).*"
3162
Ignore everything except the "local" toplevel directory,
3163
but always ignore autosave files ending in ~, even under local/::
3166
brz ignore "!./local"
3170
_see_also = ['status', 'ignored', 'patterns']
3171
takes_args = ['name_pattern*']
3172
takes_options = ['directory',
3173
Option('default-rules',
3174
help='Display the default ignore rules that brz uses.')
3177
def run(self, name_pattern_list=None, default_rules=None,
3179
from breezy import ignores
3180
if default_rules is not None:
3181
# dump the default rules and exit
3182
for pattern in ignores.USER_DEFAULTS:
3183
self.outf.write("%s\n" % pattern)
3185
if not name_pattern_list:
3186
raise errors.BzrCommandError(gettext("ignore requires at least one "
3187
"NAME_PATTERN or --default-rules."))
3188
name_pattern_list = [globbing.normalize_pattern(p)
3189
for p in name_pattern_list]
3191
bad_patterns_count = 0
3192
for p in name_pattern_list:
3193
if not globbing.Globster.is_pattern_valid(p):
3194
bad_patterns_count += 1
3195
bad_patterns += ('\n %s' % p)
3197
msg = (ngettext('Invalid ignore pattern found. %s',
3198
'Invalid ignore patterns found. %s',
3199
bad_patterns_count) % bad_patterns)
3200
ui.ui_factory.show_error(msg)
3201
raise errors.InvalidPattern('')
3202
for name_pattern in name_pattern_list:
3203
if (name_pattern[0] == '/' or
3204
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3205
raise errors.BzrCommandError(gettext(
3206
"NAME_PATTERN should not be an absolute path"))
3207
tree, relpath = WorkingTree.open_containing(directory)
3208
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3209
ignored = globbing.Globster(name_pattern_list)
3211
self.add_cleanup(tree.lock_read().unlock)
3212
for entry in tree.list_files():
3216
if ignored.match(filename):
3217
matches.append(filename)
3218
if len(matches) > 0:
3219
self.outf.write(gettext("Warning: the following files are version "
3220
"controlled and match your ignore pattern:\n%s"
3221
"\nThese files will continue to be version controlled"
3222
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3225
class cmd_ignored(Command):
3226
__doc__ = """List ignored files and the patterns that matched them.
3228
List all the ignored files and the ignore pattern that caused the file to
3231
Alternatively, to list just the files::
3236
encoding_type = 'replace'
3237
_see_also = ['ignore', 'ls']
3238
takes_options = ['directory']
3241
def run(self, directory=u'.'):
3242
tree = WorkingTree.open_containing(directory)[0]
3243
self.add_cleanup(tree.lock_read().unlock)
3244
for path, file_class, kind, file_id, entry in tree.list_files():
3245
if file_class != 'I':
3247
## XXX: Slightly inefficient since this was already calculated
3248
pat = tree.is_ignored(path)
3249
self.outf.write('%-50s %s\n' % (path, pat))
3252
class cmd_lookup_revision(Command):
3253
__doc__ = """Lookup the revision-id from a revision-number
3256
brz lookup-revision 33
3259
takes_args = ['revno']
3260
takes_options = ['directory']
3263
def run(self, revno, directory=u'.'):
3267
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3269
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3270
self.outf.write("%s\n" % revid)
3273
class cmd_export(Command):
3274
__doc__ = """Export current or past revision to a destination directory or archive.
3276
If no revision is specified this exports the last committed revision.
3278
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3279
given, try to find the format with the extension. If no extension
3280
is found exports to a directory (equivalent to --format=dir).
3282
If root is supplied, it will be used as the root directory inside
3283
container formats (tar, zip, etc). If it is not supplied it will default
3284
to the exported filename. The root option has no effect for 'dir' format.
3286
If branch is omitted then the branch containing the current working
3287
directory will be used.
3289
Note: Export of tree with non-ASCII filenames to zip is not supported.
3291
================= =========================
3292
Supported formats Autodetected by extension
3293
================= =========================
3296
tbz2 .tar.bz2, .tbz2
3299
================= =========================
3302
takes_args = ['dest', 'branch_or_subdir?']
3303
takes_options = ['directory',
3305
help="Type of file to export to.",
3308
Option('filters', help='Apply content filters to export the '
3309
'convenient form.'),
3312
help="Name of the root directory inside the exported file."),
3313
Option('per-file-timestamps',
3314
help='Set modification time of files to that of the last '
3315
'revision in which it was changed.'),
3316
Option('uncommitted',
3317
help='Export the working tree contents rather than that of the '
3320
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3321
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3323
from .export import export
3325
if branch_or_subdir is None:
3326
branch_or_subdir = directory
3328
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3330
if tree is not None:
3331
self.add_cleanup(tree.lock_read().unlock)
3335
raise errors.BzrCommandError(
3336
gettext("--uncommitted requires a working tree"))
3339
export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3341
export(export_tree, dest, format, root, subdir, filtered=filters,
3342
per_file_timestamps=per_file_timestamps)
3343
except errors.NoSuchExportFormat as e:
3344
raise errors.BzrCommandError(
3345
gettext('Unsupported export format: %s') % e.format)
3348
class cmd_cat(Command):
3349
__doc__ = """Write the contents of a file as of a given revision to standard output.
3351
If no revision is nominated, the last revision is used.
3353
Note: Take care to redirect standard output when using this command on a
3358
takes_options = ['directory',
3359
Option('name-from-revision', help='The path name in the old tree.'),
3360
Option('filters', help='Apply content filters to display the '
3361
'convenience form.'),
3364
takes_args = ['filename']
3365
encoding_type = 'exact'
3368
def run(self, filename, revision=None, name_from_revision=False,
3369
filters=False, directory=None):
3370
if revision is not None and len(revision) != 1:
3371
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3372
" one revision specifier"))
3373
tree, branch, relpath = \
3374
_open_directory_or_containing_tree_or_branch(filename, directory)
3375
self.add_cleanup(branch.lock_read().unlock)
3376
return self._run(tree, branch, relpath, filename, revision,
3377
name_from_revision, filters)
3379
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3382
tree = b.basis_tree()
3383
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3384
self.add_cleanup(rev_tree.lock_read().unlock)
3386
old_file_id = rev_tree.path2id(relpath)
3388
# TODO: Split out this code to something that generically finds the
3389
# best id for a path across one or more trees; it's like
3390
# find_ids_across_trees but restricted to find just one. -- mbp
3392
if name_from_revision:
3393
# Try in revision if requested
3394
if old_file_id is None:
3395
raise errors.BzrCommandError(gettext(
3396
"{0!r} is not present in revision {1}").format(
3397
filename, rev_tree.get_revision_id()))
3399
actual_file_id = old_file_id
3401
cur_file_id = tree.path2id(relpath)
3402
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3403
actual_file_id = cur_file_id
3404
elif old_file_id is not None:
3405
actual_file_id = old_file_id
3407
raise errors.BzrCommandError(gettext(
3408
"{0!r} is not present in revision {1}").format(
3409
filename, rev_tree.get_revision_id()))
3411
from .filter_tree import ContentFilterTree
3412
filter_tree = ContentFilterTree(rev_tree,
3413
rev_tree._content_filter_stack)
3414
content = filter_tree.get_file_text(actual_file_id)
3416
content = rev_tree.get_file_text(actual_file_id)
3418
self.outf.write(content)
3421
class cmd_local_time_offset(Command):
3422
__doc__ = """Show the offset in seconds from GMT to local time."""
3426
self.outf.write("%s\n" % osutils.local_time_offset())
3430
class cmd_commit(Command):
3431
__doc__ = """Commit changes into a new revision.
3433
An explanatory message needs to be given for each commit. This is
3434
often done by using the --message option (getting the message from the
3435
command line) or by using the --file option (getting the message from
3436
a file). If neither of these options is given, an editor is opened for
3437
the user to enter the message. To see the changed files in the
3438
boilerplate text loaded into the editor, use the --show-diff option.
3440
By default, the entire tree is committed and the person doing the
3441
commit is assumed to be the author. These defaults can be overridden
3446
If selected files are specified, only changes to those files are
3447
committed. If a directory is specified then the directory and
3448
everything within it is committed.
3450
When excludes are given, they take precedence over selected files.
3451
For example, to commit only changes within foo, but not changes
3454
brz commit foo -x foo/bar
3456
A selective commit after a merge is not yet supported.
3460
If the author of the change is not the same person as the committer,
3461
you can specify the author's name using the --author option. The
3462
name should be in the same format as a committer-id, e.g.
3463
"John Doe <jdoe@example.com>". If there is more than one author of
3464
the change you can specify the option multiple times, once for each
3469
A common mistake is to forget to add a new file or directory before
3470
running the commit command. The --strict option checks for unknown
3471
files and aborts the commit if any are found. More advanced pre-commit
3472
checks can be implemented by defining hooks. See ``brz help hooks``
3477
If you accidentially commit the wrong changes or make a spelling
3478
mistake in the commit message say, you can use the uncommit command
3479
to undo it. See ``brz help uncommit`` for details.
3481
Hooks can also be configured to run after a commit. This allows you
3482
to trigger updates to external systems like bug trackers. The --fixes
3483
option can be used to record the association between a revision and
3484
one or more bugs. See ``brz help bugs`` for details.
3487
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3488
takes_args = ['selected*']
3490
ListOption('exclude', type=str, short_name='x',
3491
help="Do not consider changes made to a given path."),
3492
Option('message', type=text_type,
3494
help="Description of the new revision."),
3497
help='Commit even if nothing has changed.'),
3498
Option('file', type=str,
3501
help='Take commit message from this file.'),
3503
help="Refuse to commit if there are unknown "
3504
"files in the working tree."),
3505
Option('commit-time', type=str,
3506
help="Manually set a commit time using commit date "
3507
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3508
ListOption('fixes', type=str,
3509
help="Mark a bug as being fixed by this revision "
3510
"(see \"brz help bugs\")."),
3511
ListOption('author', type=text_type,
3512
help="Set the author's name, if it's different "
3513
"from the committer."),
3515
help="Perform a local commit in a bound "
3516
"branch. Local commits are not pushed to "
3517
"the master branch until a normal commit "
3520
Option('show-diff', short_name='p',
3521
help='When no message is supplied, show the diff along'
3522
' with the status summary in the message editor.'),
3524
help='When committing to a foreign version control '
3525
'system do not push data that can not be natively '
3528
aliases = ['ci', 'checkin']
3530
def _iter_bug_fix_urls(self, fixes, branch):
3531
default_bugtracker = None
3532
# Configure the properties for bug fixing attributes.
3533
for fixed_bug in fixes:
3534
tokens = fixed_bug.split(':')
3535
if len(tokens) == 1:
3536
if default_bugtracker is None:
3537
branch_config = branch.get_config_stack()
3538
default_bugtracker = branch_config.get(
3540
if default_bugtracker is None:
3541
raise errors.BzrCommandError(gettext(
3542
"No tracker specified for bug %s. Use the form "
3543
"'tracker:id' or specify a default bug tracker "
3544
"using the `bugtracker` option.\nSee "
3545
"\"brz help bugs\" for more information on this "
3546
"feature. Commit refused.") % fixed_bug)
3547
tag = default_bugtracker
3549
elif len(tokens) != 2:
3550
raise errors.BzrCommandError(gettext(
3551
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3552
"See \"brz help bugs\" for more information on this "
3553
"feature.\nCommit refused.") % fixed_bug)
3555
tag, bug_id = tokens
3557
yield bugtracker.get_bug_url(tag, branch, bug_id)
3558
except errors.UnknownBugTrackerAbbreviation:
3559
raise errors.BzrCommandError(gettext(
3560
'Unrecognized bug %s. Commit refused.') % fixed_bug)
3561
except errors.MalformedBugIdentifier as e:
3562
raise errors.BzrCommandError(gettext(
3563
"%s\nCommit refused.") % (str(e),))
3565
def run(self, message=None, file=None, verbose=False, selected_list=None,
3566
unchanged=False, strict=False, local=False, fixes=None,
3567
author=None, show_diff=False, exclude=None, commit_time=None,
3569
from .errors import (
3574
from .msgeditor import (
3575
edit_commit_message_encoded,
3576
generate_commit_message_template,
3577
make_commit_message_template_encoded,
3581
commit_stamp = offset = None
3582
if commit_time is not None:
3584
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3585
except ValueError as e:
3586
raise errors.BzrCommandError(gettext(
3587
"Could not parse --commit-time: " + str(e)))
3591
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3592
if selected_list == ['']:
3593
# workaround - commit of root of tree should be exactly the same
3594
# as just default commit in that tree, and succeed even though
3595
# selected-file merge commit is not done yet
3600
bug_property = bugtracker.encode_fixes_bug_urls(
3601
self._iter_bug_fix_urls(fixes, tree.branch))
3603
properties['bugs'] = bug_property
3605
if local and not tree.branch.get_bound_location():
3606
raise errors.LocalRequiresBoundBranch()
3608
if message is not None:
3610
file_exists = osutils.lexists(message)
3611
except UnicodeError:
3612
# The commit message contains unicode characters that can't be
3613
# represented in the filesystem encoding, so that can't be a
3618
'The commit message is a file name: "%(f)s".\n'
3619
'(use --file "%(f)s" to take commit message from that file)'
3621
ui.ui_factory.show_warning(warning_msg)
3623
message = message.replace('\r\n', '\n')
3624
message = message.replace('\r', '\n')
3626
raise errors.BzrCommandError(gettext(
3627
"please specify either --message or --file"))
3629
def get_message(commit_obj):
3630
"""Callback to get commit message"""
3634
my_message = f.read().decode(osutils.get_user_encoding())
3637
elif message is not None:
3638
my_message = message
3640
# No message supplied: make one up.
3641
# text is the status of the tree
3642
text = make_commit_message_template_encoded(tree,
3643
selected_list, diff=show_diff,
3644
output_encoding=osutils.get_user_encoding())
3645
# start_message is the template generated from hooks
3646
# XXX: Warning - looks like hooks return unicode,
3647
# make_commit_message_template_encoded returns user encoding.
3648
# We probably want to be using edit_commit_message instead to
3650
my_message = set_commit_message(commit_obj)
3651
if my_message is None:
3652
start_message = generate_commit_message_template(commit_obj)
3653
my_message = edit_commit_message_encoded(text,
3654
start_message=start_message)
3655
if my_message is None:
3656
raise errors.BzrCommandError(gettext("please specify a commit"
3657
" message with either --message or --file"))
3658
if my_message == "":
3659
raise errors.BzrCommandError(gettext("Empty commit message specified."
3660
" Please specify a commit message with either"
3661
" --message or --file or leave a blank message"
3662
" with --message \"\"."))
3665
# The API permits a commit with a filter of [] to mean 'select nothing'
3666
# but the command line should not do that.
3667
if not selected_list:
3668
selected_list = None
3670
tree.commit(message_callback=get_message,
3671
specific_files=selected_list,
3672
allow_pointless=unchanged, strict=strict, local=local,
3673
reporter=None, verbose=verbose, revprops=properties,
3674
authors=author, timestamp=commit_stamp,
3676
exclude=tree.safe_relpath_files(exclude),
3678
except PointlessCommit:
3679
raise errors.BzrCommandError(gettext("No changes to commit."
3680
" Please 'brz add' the files you want to commit, or use"
3681
" --unchanged to force an empty commit."))
3682
except ConflictsInTree:
3683
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3684
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3686
except StrictCommitFailed:
3687
raise errors.BzrCommandError(gettext("Commit refused because there are"
3688
" unknown files in the working tree."))
3689
except errors.BoundBranchOutOfDate as e:
3690
e.extra_help = (gettext("\n"
3691
'To commit to master branch, run update and then commit.\n'
3692
'You can also pass --local to commit to continue working '
3697
class cmd_check(Command):
3698
__doc__ = """Validate working tree structure, branch consistency and repository history.
3700
This command checks various invariants about branch and repository storage
3701
to detect data corruption or brz bugs.
3703
The working tree and branch checks will only give output if a problem is
3704
detected. The output fields of the repository check are:
3707
This is just the number of revisions checked. It doesn't
3711
This is just the number of versionedfiles checked. It
3712
doesn't indicate a problem.
3714
unreferenced ancestors
3715
Texts that are ancestors of other texts, but
3716
are not properly referenced by the revision ancestry. This is a
3717
subtle problem that Bazaar can work around.
3720
This is the total number of unique file contents
3721
seen in the checked revisions. It does not indicate a problem.
3724
This is the total number of repeated texts seen
3725
in the checked revisions. Texts can be repeated when their file
3726
entries are modified, but the file contents are not. It does not
3729
If no restrictions are specified, all Bazaar data that is found at the given
3730
location will be checked.
3734
Check the tree and branch at 'foo'::
3736
brz check --tree --branch foo
3738
Check only the repository at 'bar'::
3740
brz check --repo bar
3742
Check everything at 'baz'::
3747
_see_also = ['reconcile']
3748
takes_args = ['path?']
3749
takes_options = ['verbose',
3750
Option('branch', help="Check the branch related to the"
3751
" current directory."),
3752
Option('repo', help="Check the repository related to the"
3753
" current directory."),
3754
Option('tree', help="Check the working tree related to"
3755
" the current directory.")]
3757
def run(self, path=None, verbose=False, branch=False, repo=False,
3759
from .check import check_dwim
3762
if not branch and not repo and not tree:
3763
branch = repo = tree = True
3764
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3767
class cmd_upgrade(Command):
3768
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3770
When the default format has changed after a major new release of
3771
Bazaar, you may be informed during certain operations that you
3772
should upgrade. Upgrading to a newer format may improve performance
3773
or make new features available. It may however limit interoperability
3774
with older repositories or with older versions of Bazaar.
3776
If you wish to upgrade to a particular format rather than the
3777
current default, that can be specified using the --format option.
3778
As a consequence, you can use the upgrade command this way to
3779
"downgrade" to an earlier format, though some conversions are
3780
a one way process (e.g. changing from the 1.x default to the
3781
2.x default) so downgrading is not always possible.
3783
A backup.bzr.~#~ directory is created at the start of the conversion
3784
process (where # is a number). By default, this is left there on
3785
completion. If the conversion fails, delete the new .bzr directory
3786
and rename this one back in its place. Use the --clean option to ask
3787
for the backup.bzr directory to be removed on successful conversion.
3788
Alternatively, you can delete it by hand if everything looks good
3791
If the location given is a shared repository, dependent branches
3792
are also converted provided the repository converts successfully.
3793
If the conversion of a branch fails, remaining branches are still
3796
For more information on upgrades, see the Bazaar Upgrade Guide,
3797
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3800
_see_also = ['check', 'reconcile', 'formats']
3801
takes_args = ['url?']
3803
RegistryOption('format',
3804
help='Upgrade to a specific format. See "brz help'
3805
' formats" for details.',
3806
lazy_registry=('breezy.controldir', 'format_registry'),
3807
converter=lambda name: controldir.format_registry.make_bzrdir(name),
3808
value_switches=True, title='Branch format'),
3810
help='Remove the backup.bzr directory if successful.'),
3812
help="Show what would be done, but don't actually do anything."),
3815
def run(self, url='.', format=None, clean=False, dry_run=False):
3816
from .upgrade import upgrade
3817
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3819
if len(exceptions) == 1:
3820
# Compatibility with historical behavior
3826
class cmd_whoami(Command):
3827
__doc__ = """Show or set brz user id.
3830
Show the email of the current user::
3834
Set the current user::
3836
brz whoami "Frank Chu <fchu@example.com>"
3838
takes_options = [ 'directory',
3840
help='Display email address only.'),
3842
help='Set identity for the current branch instead of '
3845
takes_args = ['name?']
3846
encoding_type = 'replace'
3849
def run(self, email=False, branch=False, name=None, directory=None):
3851
if directory is None:
3852
# use branch if we're inside one; otherwise global config
3854
c = Branch.open_containing(u'.')[0].get_config_stack()
3855
except errors.NotBranchError:
3856
c = _mod_config.GlobalStack()
3858
c = Branch.open(directory).get_config_stack()
3859
identity = c.get('email')
3861
self.outf.write(_mod_config.extract_email_address(identity)
3864
self.outf.write(identity + '\n')
3868
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3871
# display a warning if an email address isn't included in the given name.
3873
_mod_config.extract_email_address(name)
3874
except errors.NoEmailInUsername as e:
3875
warning('"%s" does not seem to contain an email address. '
3876
'This is allowed, but not recommended.', name)
3878
# use global config unless --branch given
3880
if directory is None:
3881
c = Branch.open_containing(u'.')[0].get_config_stack()
3883
b = Branch.open(directory)
3884
self.add_cleanup(b.lock_write().unlock)
3885
c = b.get_config_stack()
3887
c = _mod_config.GlobalStack()
3888
c.set('email', name)
3891
class cmd_nick(Command):
3892
__doc__ = """Print or set the branch nickname.
3894
If unset, the colocated branch name is used for colocated branches, and
3895
the branch directory name is used for other branches. To print the
3896
current nickname, execute with no argument.
3898
Bound branches use the nickname of its master branch unless it is set
3902
_see_also = ['info']
3903
takes_args = ['nickname?']
3904
takes_options = ['directory']
3905
def run(self, nickname=None, directory=u'.'):
3906
branch = Branch.open_containing(directory)[0]
3907
if nickname is None:
3908
self.printme(branch)
3910
branch.nick = nickname
3913
def printme(self, branch):
3914
self.outf.write('%s\n' % branch.nick)
3917
class cmd_alias(Command):
3918
__doc__ = """Set/unset and display aliases.
3921
Show the current aliases::
3925
Show the alias specified for 'll'::
3929
Set an alias for 'll'::
3931
brz alias ll="log --line -r-10..-1"
3933
To remove an alias for 'll'::
3935
brz alias --remove ll
3938
takes_args = ['name?']
3940
Option('remove', help='Remove the alias.'),
3943
def run(self, name=None, remove=False):
3945
self.remove_alias(name)
3947
self.print_aliases()
3949
equal_pos = name.find('=')
3951
self.print_alias(name)
3953
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3955
def remove_alias(self, alias_name):
3956
if alias_name is None:
3957
raise errors.BzrCommandError(gettext(
3958
'brz alias --remove expects an alias to remove.'))
3959
# If alias is not found, print something like:
3960
# unalias: foo: not found
3961
c = _mod_config.GlobalConfig()
3962
c.unset_alias(alias_name)
3965
def print_aliases(self):
3966
"""Print out the defined aliases in a similar format to bash."""
3967
aliases = _mod_config.GlobalConfig().get_aliases()
3968
for key, value in sorted(viewitems(aliases)):
3969
self.outf.write('brz alias %s="%s"\n' % (key, value))
3972
def print_alias(self, alias_name):
3973
from .commands import get_alias
3974
alias = get_alias(alias_name)
3976
self.outf.write("brz alias: %s: not found\n" % alias_name)
3979
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3981
def set_alias(self, alias_name, alias_command):
3982
"""Save the alias in the global config."""
3983
c = _mod_config.GlobalConfig()
3984
c.set_alias(alias_name, alias_command)
3987
class cmd_selftest(Command):
3988
__doc__ = """Run internal test suite.
3990
If arguments are given, they are regular expressions that say which tests
3991
should run. Tests matching any expression are run, and other tests are
3994
Alternatively if --first is given, matching tests are run first and then
3995
all other tests are run. This is useful if you have been working in a
3996
particular area, but want to make sure nothing else was broken.
3998
If --exclude is given, tests that match that regular expression are
3999
excluded, regardless of whether they match --first or not.
4001
To help catch accidential dependencies between tests, the --randomize
4002
option is useful. In most cases, the argument used is the word 'now'.
4003
Note that the seed used for the random number generator is displayed
4004
when this option is used. The seed can be explicitly passed as the
4005
argument to this option if required. This enables reproduction of the
4006
actual ordering used if and when an order sensitive problem is encountered.
4008
If --list-only is given, the tests that would be run are listed. This is
4009
useful when combined with --first, --exclude and/or --randomize to
4010
understand their impact. The test harness reports "Listed nn tests in ..."
4011
instead of "Ran nn tests in ..." when list mode is enabled.
4013
If the global option '--no-plugins' is given, plugins are not loaded
4014
before running the selftests. This has two effects: features provided or
4015
modified by plugins will not be tested, and tests provided by plugins will
4018
Tests that need working space on disk use a common temporary directory,
4019
typically inside $TMPDIR or /tmp.
4021
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4022
into a pdb postmortem session.
4024
The --coverage=DIRNAME global option produces a report with covered code
4028
Run only tests relating to 'ignore'::
4032
Disable plugins and list tests as they're run::
4034
brz --no-plugins selftest -v
4036
# NB: this is used from the class without creating an instance, which is
4037
# why it does not have a self parameter.
4038
def get_transport_type(typestring):
4039
"""Parse and return a transport specifier."""
4040
if typestring == "sftp":
4041
from .tests import stub_sftp
4042
return stub_sftp.SFTPAbsoluteServer
4043
elif typestring == "memory":
4044
from .tests import test_server
4045
return memory.MemoryServer
4046
elif typestring == "fakenfs":
4047
from .tests import test_server
4048
return test_server.FakeNFSServer
4049
msg = "No known transport type %s. Supported types are: sftp\n" %\
4051
raise errors.BzrCommandError(msg)
4054
takes_args = ['testspecs*']
4055
takes_options = ['verbose',
4057
help='Stop when one test fails.',
4061
help='Use a different transport by default '
4062
'throughout the test suite.',
4063
type=get_transport_type),
4065
help='Run the benchmarks rather than selftests.',
4067
Option('lsprof-timed',
4068
help='Generate lsprof output for benchmarked'
4069
' sections of code.'),
4070
Option('lsprof-tests',
4071
help='Generate lsprof output for each test.'),
4073
help='Run all tests, but run specified tests first.',
4077
help='List the tests instead of running them.'),
4078
RegistryOption('parallel',
4079
help="Run the test suite in parallel.",
4080
lazy_registry=('breezy.tests', 'parallel_registry'),
4081
value_switches=False,
4083
Option('randomize', type=str, argname="SEED",
4084
help='Randomize the order of tests using the given'
4085
' seed or "now" for the current time.'),
4086
ListOption('exclude', type=str, argname="PATTERN",
4088
help='Exclude tests that match this regular'
4091
help='Output test progress via subunit.'),
4092
Option('strict', help='Fail on missing dependencies or '
4094
Option('load-list', type=str, argname='TESTLISTFILE',
4095
help='Load a test id list from a text file.'),
4096
ListOption('debugflag', type=str, short_name='E',
4097
help='Turn on a selftest debug flag.'),
4098
ListOption('starting-with', type=str, argname='TESTID',
4099
param_name='starting_with', short_name='s',
4101
'Load only the tests starting with TESTID.'),
4103
help="By default we disable fsync and fdatasync"
4104
" while running the test suite.")
4106
encoding_type = 'replace'
4109
Command.__init__(self)
4110
self.additional_selftest_args = {}
4112
def run(self, testspecs_list=None, verbose=False, one=False,
4113
transport=None, benchmark=None,
4115
first=False, list_only=False,
4116
randomize=None, exclude=None, strict=False,
4117
load_list=None, debugflag=None, starting_with=None, subunit=False,
4118
parallel=None, lsprof_tests=False,
4121
# During selftest, disallow proxying, as it can cause severe
4122
# performance penalties and is only needed for thread
4123
# safety. The selftest command is assumed to not use threads
4124
# too heavily. The call should be as early as possible, as
4125
# error reporting for past duplicate imports won't have useful
4127
lazy_import.disallow_proxying()
4131
if testspecs_list is not None:
4132
pattern = '|'.join(testspecs_list)
4137
from .tests import SubUnitBzrRunner
4139
raise errors.BzrCommandError(gettext("subunit not available. subunit "
4140
"needs to be installed to use --subunit."))
4141
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4142
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4143
# stdout, which would corrupt the subunit stream.
4144
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4145
# following code can be deleted when it's sufficiently deployed
4146
# -- vila/mgz 20100514
4147
if (sys.platform == "win32"
4148
and getattr(sys.stdout, 'fileno', None) is not None):
4150
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4152
self.additional_selftest_args.setdefault(
4153
'suite_decorators', []).append(parallel)
4155
raise errors.BzrCommandError(gettext(
4156
"--benchmark is no longer supported from brz 2.2; "
4157
"use bzr-usertest instead"))
4158
test_suite_factory = None
4160
exclude_pattern = None
4162
exclude_pattern = '(' + '|'.join(exclude) + ')'
4164
self._disable_fsync()
4165
selftest_kwargs = {"verbose": verbose,
4167
"stop_on_failure": one,
4168
"transport": transport,
4169
"test_suite_factory": test_suite_factory,
4170
"lsprof_timed": lsprof_timed,
4171
"lsprof_tests": lsprof_tests,
4172
"matching_tests_first": first,
4173
"list_only": list_only,
4174
"random_seed": randomize,
4175
"exclude_pattern": exclude_pattern,
4177
"load_list": load_list,
4178
"debug_flags": debugflag,
4179
"starting_with": starting_with
4181
selftest_kwargs.update(self.additional_selftest_args)
4183
# Make deprecation warnings visible, unless -Werror is set
4184
cleanup = symbol_versioning.activate_deprecation_warnings(
4187
result = tests.selftest(**selftest_kwargs)
4190
return int(not result)
4192
def _disable_fsync(self):
4193
"""Change the 'os' functionality to not synchronize."""
4194
self._orig_fsync = getattr(os, 'fsync', None)
4195
if self._orig_fsync is not None:
4196
os.fsync = lambda filedes: None
4197
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4198
if self._orig_fdatasync is not None:
4199
os.fdatasync = lambda filedes: None
4202
class cmd_version(Command):
4203
__doc__ = """Show version of brz."""
4205
encoding_type = 'replace'
4207
Option("short", help="Print just the version number."),
4211
def run(self, short=False):
4212
from .version import show_version
4214
self.outf.write(breezy.version_string + '\n')
4216
show_version(to_file=self.outf)
4219
class cmd_rocks(Command):
4220
__doc__ = """Statement of optimism."""
4226
self.outf.write(gettext("It sure does!\n"))
4229
class cmd_find_merge_base(Command):
4230
__doc__ = """Find and print a base revision for merging two branches."""
4231
# TODO: Options to specify revisions on either side, as if
4232
# merging only part of the history.
4233
takes_args = ['branch', 'other']
4237
def run(self, branch, other):
4238
from .revision import ensure_null
4240
branch1 = Branch.open_containing(branch)[0]
4241
branch2 = Branch.open_containing(other)[0]
4242
self.add_cleanup(branch1.lock_read().unlock)
4243
self.add_cleanup(branch2.lock_read().unlock)
4244
last1 = ensure_null(branch1.last_revision())
4245
last2 = ensure_null(branch2.last_revision())
4247
graph = branch1.repository.get_graph(branch2.repository)
4248
base_rev_id = graph.find_unique_lca(last1, last2)
4250
self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
4253
class cmd_merge(Command):
4254
__doc__ = """Perform a three-way merge.
4256
The source of the merge can be specified either in the form of a branch,
4257
or in the form of a path to a file containing a merge directive generated
4258
with brz send. If neither is specified, the default is the upstream branch
4259
or the branch most recently merged using --remember. The source of the
4260
merge may also be specified in the form of a path to a file in another
4261
branch: in this case, only the modifications to that file are merged into
4262
the current working tree.
4264
When merging from a branch, by default brz will try to merge in all new
4265
work from the other branch, automatically determining an appropriate base
4266
revision. If this fails, you may need to give an explicit base.
4268
To pick a different ending revision, pass "--revision OTHER". brz will
4269
try to merge in all new work up to and including revision OTHER.
4271
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4272
through OTHER, excluding BASE but including OTHER, will be merged. If this
4273
causes some revisions to be skipped, i.e. if the destination branch does
4274
not already contain revision BASE, such a merge is commonly referred to as
4275
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4276
cherrypicks. The changes look like a normal commit, and the history of the
4277
changes from the other branch is not stored in the commit.
4279
Revision numbers are always relative to the source branch.
4281
Merge will do its best to combine the changes in two branches, but there
4282
are some kinds of problems only a human can fix. When it encounters those,
4283
it will mark a conflict. A conflict means that you need to fix something,
4284
before you can commit.
4286
Use brz resolve when you have fixed a problem. See also brz conflicts.
4288
If there is no default branch set, the first merge will set it (use
4289
--no-remember to avoid setting it). After that, you can omit the branch
4290
to use the default. To change the default, use --remember. The value will
4291
only be saved if the remote location can be accessed.
4293
The results of the merge are placed into the destination working
4294
directory, where they can be reviewed (with brz diff), tested, and then
4295
committed to record the result of the merge.
4297
merge refuses to run if there are any uncommitted changes, unless
4298
--force is given. If --force is given, then the changes from the source
4299
will be merged with the current working tree, including any uncommitted
4300
changes in the tree. The --force option can also be used to create a
4301
merge revision which has more than two parents.
4303
If one would like to merge changes from the working tree of the other
4304
branch without merging any committed revisions, the --uncommitted option
4307
To select only some changes to merge, use "merge -i", which will prompt
4308
you to apply each diff hunk and file change, similar to "shelve".
4311
To merge all new revisions from brz.dev::
4313
brz merge ../brz.dev
4315
To merge changes up to and including revision 82 from brz.dev::
4317
brz merge -r 82 ../brz.dev
4319
To merge the changes introduced by 82, without previous changes::
4321
brz merge -r 81..82 ../brz.dev
4323
To apply a merge directive contained in /tmp/merge::
4325
brz merge /tmp/merge
4327
To create a merge revision with three parents from two branches
4328
feature1a and feature1b:
4330
brz merge ../feature1a
4331
brz merge ../feature1b --force
4332
brz commit -m 'revision with three parents'
4335
encoding_type = 'exact'
4336
_see_also = ['update', 'remerge', 'status-flags', 'send']
4337
takes_args = ['location?']
4342
help='Merge even if the destination tree has uncommitted changes.'),
4346
Option('show-base', help="Show base revision text in "
4348
Option('uncommitted', help='Apply uncommitted changes'
4349
' from a working copy, instead of branch changes.'),
4350
Option('pull', help='If the destination is already'
4351
' completely merged into the source, pull from the'
4352
' source rather than merging. When this happens,'
4353
' you do not need to commit the result.'),
4354
custom_help('directory',
4355
help='Branch to merge into, '
4356
'rather than the one containing the working directory.'),
4357
Option('preview', help='Instead of merging, show a diff of the'
4359
Option('interactive', help='Select changes interactively.',
4363
def run(self, location=None, revision=None, force=False,
4364
merge_type=None, show_base=False, reprocess=None, remember=None,
4365
uncommitted=False, pull=False,
4370
if merge_type is None:
4371
merge_type = _mod_merge.Merge3Merger
4373
if directory is None: directory = u'.'
4374
possible_transports = []
4376
allow_pending = True
4377
verified = 'inapplicable'
4379
tree = WorkingTree.open_containing(directory)[0]
4380
if tree.branch.revno() == 0:
4381
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4382
'https://bugs.launchpad.net/bzr/+bug/308562'))
4385
basis_tree = tree.revision_tree(tree.last_revision())
4386
except errors.NoSuchRevision:
4387
basis_tree = tree.basis_tree()
4389
# die as quickly as possible if there are uncommitted changes
4391
if tree.has_changes():
4392
raise errors.UncommittedChanges(tree)
4394
view_info = _get_view_info_for_change_reporter(tree)
4395
change_reporter = delta._ChangeReporter(
4396
unversioned_filter=tree.is_ignored, view_info=view_info)
4397
pb = ui.ui_factory.nested_progress_bar()
4398
self.add_cleanup(pb.finished)
4399
self.add_cleanup(tree.lock_write().unlock)
4400
if location is not None:
4402
mergeable = bundle.read_mergeable_from_url(location,
4403
possible_transports=possible_transports)
4404
except errors.NotABundle:
4408
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4409
' with bundles or merge directives.'))
4411
if revision is not None:
4412
raise errors.BzrCommandError(gettext(
4413
'Cannot use -r with merge directives or bundles'))
4414
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4417
if merger is None and uncommitted:
4418
if revision is not None and len(revision) > 0:
4419
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4420
' --revision at the same time.'))
4421
merger = self.get_merger_from_uncommitted(tree, location, None)
4422
allow_pending = False
4425
merger, allow_pending = self._get_merger_from_branch(tree,
4426
location, revision, remember, possible_transports, None)
4428
merger.merge_type = merge_type
4429
merger.reprocess = reprocess
4430
merger.show_base = show_base
4431
self.sanity_check_merger(merger)
4432
if (merger.base_rev_id == merger.other_rev_id and
4433
merger.other_rev_id is not None):
4434
# check if location is a nonexistent file (and not a branch) to
4435
# disambiguate the 'Nothing to do'
4436
if merger.interesting_files:
4437
if not merger.other_tree.has_filename(
4438
merger.interesting_files[0]):
4439
note(gettext("merger: ") + str(merger))
4440
raise errors.PathsDoNotExist([location])
4441
note(gettext('Nothing to do.'))
4443
if pull and not preview:
4444
if merger.interesting_files is not None:
4445
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4446
if (merger.base_rev_id == tree.last_revision()):
4447
result = tree.pull(merger.other_branch, False,
4448
merger.other_rev_id)
4449
result.report(self.outf)
4451
if merger.this_basis is None:
4452
raise errors.BzrCommandError(gettext(
4453
"This branch has no commits."
4454
" (perhaps you would prefer 'brz pull')"))
4456
return self._do_preview(merger)
4458
return self._do_interactive(merger)
4460
return self._do_merge(merger, change_reporter, allow_pending,
4463
def _get_preview(self, merger):
4464
tree_merger = merger.make_merger()
4465
tt = tree_merger.make_preview_transform()
4466
self.add_cleanup(tt.finalize)
4467
result_tree = tt.get_preview_tree()
4470
def _do_preview(self, merger):
4471
from .diff import show_diff_trees
4472
result_tree = self._get_preview(merger)
4473
path_encoding = osutils.get_diff_header_encoding()
4474
show_diff_trees(merger.this_tree, result_tree, self.outf,
4475
old_label='', new_label='',
4476
path_encoding=path_encoding)
4478
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4479
merger.change_reporter = change_reporter
4480
conflict_count = merger.do_merge()
4482
merger.set_pending()
4483
if verified == 'failed':
4484
warning('Preview patch does not match changes')
4485
if conflict_count != 0:
4490
def _do_interactive(self, merger):
4491
"""Perform an interactive merge.
4493
This works by generating a preview tree of the merge, then using
4494
Shelver to selectively remove the differences between the working tree
4495
and the preview tree.
4497
from . import shelf_ui
4498
result_tree = self._get_preview(merger)
4499
writer = breezy.option.diff_writer_registry.get()
4500
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4501
reporter=shelf_ui.ApplyReporter(),
4502
diff_writer=writer(sys.stdout))
4508
def sanity_check_merger(self, merger):
4509
if (merger.show_base and
4510
not merger.merge_type is _mod_merge.Merge3Merger):
4511
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4512
" merge type. %s") % merger.merge_type)
4513
if merger.reprocess is None:
4514
if merger.show_base:
4515
merger.reprocess = False
4517
# Use reprocess if the merger supports it
4518
merger.reprocess = merger.merge_type.supports_reprocess
4519
if merger.reprocess and not merger.merge_type.supports_reprocess:
4520
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4521
" for merge type %s.") %
4523
if merger.reprocess and merger.show_base:
4524
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4527
def _get_merger_from_branch(self, tree, location, revision, remember,
4528
possible_transports, pb):
4529
"""Produce a merger from a location, assuming it refers to a branch."""
4530
# find the branch locations
4531
other_loc, user_location = self._select_branch_location(tree, location,
4533
if revision is not None and len(revision) == 2:
4534
base_loc, _unused = self._select_branch_location(tree,
4535
location, revision, 0)
4537
base_loc = other_loc
4539
other_branch, other_path = Branch.open_containing(other_loc,
4540
possible_transports)
4541
if base_loc == other_loc:
4542
base_branch = other_branch
4544
base_branch, base_path = Branch.open_containing(base_loc,
4545
possible_transports)
4546
# Find the revision ids
4547
other_revision_id = None
4548
base_revision_id = None
4549
if revision is not None:
4550
if len(revision) >= 1:
4551
other_revision_id = revision[-1].as_revision_id(other_branch)
4552
if len(revision) == 2:
4553
base_revision_id = revision[0].as_revision_id(base_branch)
4554
if other_revision_id is None:
4555
other_revision_id = _mod_revision.ensure_null(
4556
other_branch.last_revision())
4557
# Remember where we merge from. We need to remember if:
4558
# - user specify a location (and we don't merge from the parent
4560
# - user ask to remember or there is no previous location set to merge
4561
# from and user didn't ask to *not* remember
4562
if (user_location is not None
4564
or (remember is None
4565
and tree.branch.get_submit_branch() is None)))):
4566
tree.branch.set_submit_branch(other_branch.base)
4567
# Merge tags (but don't set them in the master branch yet, the user
4568
# might revert this merge). Commit will propagate them.
4569
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4570
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4571
other_revision_id, base_revision_id, other_branch, base_branch)
4572
if other_path != '':
4573
allow_pending = False
4574
merger.interesting_files = [other_path]
4576
allow_pending = True
4577
return merger, allow_pending
4579
def get_merger_from_uncommitted(self, tree, location, pb):
4580
"""Get a merger for uncommitted changes.
4582
:param tree: The tree the merger should apply to.
4583
:param location: The location containing uncommitted changes.
4584
:param pb: The progress bar to use for showing progress.
4586
location = self._select_branch_location(tree, location)[0]
4587
other_tree, other_path = WorkingTree.open_containing(location)
4588
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4589
if other_path != '':
4590
merger.interesting_files = [other_path]
4593
def _select_branch_location(self, tree, user_location, revision=None,
4595
"""Select a branch location, according to possible inputs.
4597
If provided, branches from ``revision`` are preferred. (Both
4598
``revision`` and ``index`` must be supplied.)
4600
Otherwise, the ``location`` parameter is used. If it is None, then the
4601
``submit`` or ``parent`` location is used, and a note is printed.
4603
:param tree: The working tree to select a branch for merging into
4604
:param location: The location entered by the user
4605
:param revision: The revision parameter to the command
4606
:param index: The index to use for the revision parameter. Negative
4607
indices are permitted.
4608
:return: (selected_location, user_location). The default location
4609
will be the user-entered location.
4611
if (revision is not None and index is not None
4612
and revision[index] is not None):
4613
branch = revision[index].get_branch()
4614
if branch is not None:
4615
return branch, branch
4616
if user_location is None:
4617
location = self._get_remembered(tree, 'Merging from')
4619
location = user_location
4620
return location, user_location
4622
def _get_remembered(self, tree, verb_string):
4623
"""Use tree.branch's parent if none was supplied.
4625
Report if the remembered location was used.
4627
stored_location = tree.branch.get_submit_branch()
4628
stored_location_type = "submit"
4629
if stored_location is None:
4630
stored_location = tree.branch.get_parent()
4631
stored_location_type = "parent"
4632
mutter("%s", stored_location)
4633
if stored_location is None:
4634
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4635
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4636
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4637
stored_location_type, display_url))
4638
return stored_location
4641
class cmd_remerge(Command):
4642
__doc__ = """Redo a merge.
4644
Use this if you want to try a different merge technique while resolving
4645
conflicts. Some merge techniques are better than others, and remerge
4646
lets you try different ones on different files.
4648
The options for remerge have the same meaning and defaults as the ones for
4649
merge. The difference is that remerge can (only) be run when there is a
4650
pending merge, and it lets you specify particular files.
4653
Re-do the merge of all conflicted files, and show the base text in
4654
conflict regions, in addition to the usual THIS and OTHER texts::
4656
brz remerge --show-base
4658
Re-do the merge of "foobar", using the weave merge algorithm, with
4659
additional processing to reduce the size of conflict regions::
4661
brz remerge --merge-type weave --reprocess foobar
4663
takes_args = ['file*']
4668
help="Show base revision text in conflicts."),
4671
def run(self, file_list=None, merge_type=None, show_base=False,
4673
from .conflicts import restore
4674
if merge_type is None:
4675
merge_type = _mod_merge.Merge3Merger
4676
tree, file_list = WorkingTree.open_containing_paths(file_list)
4677
self.add_cleanup(tree.lock_write().unlock)
4678
parents = tree.get_parent_ids()
4679
if len(parents) != 2:
4680
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4681
" merges. Not cherrypicking or"
4683
repository = tree.branch.repository
4684
interesting_ids = None
4686
conflicts = tree.conflicts()
4687
if file_list is not None:
4688
interesting_ids = set()
4689
for filename in file_list:
4690
file_id = tree.path2id(filename)
4692
raise errors.NotVersionedError(filename)
4693
interesting_ids.add(file_id)
4694
if tree.kind(file_id) != "directory":
4697
# FIXME: Support nested trees
4698
for name, ie in tree.root_inventory.iter_entries(file_id):
4699
interesting_ids.add(ie.file_id)
4700
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4702
# Remerge only supports resolving contents conflicts
4703
allowed_conflicts = ('text conflict', 'contents conflict')
4704
restore_files = [c.path for c in conflicts
4705
if c.typestring in allowed_conflicts]
4706
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4707
tree.set_conflicts(ConflictList(new_conflicts))
4708
if file_list is not None:
4709
restore_files = file_list
4710
for filename in restore_files:
4712
restore(tree.abspath(filename))
4713
except errors.NotConflicted:
4715
# Disable pending merges, because the file texts we are remerging
4716
# have not had those merges performed. If we use the wrong parents
4717
# list, we imply that the working tree text has seen and rejected
4718
# all the changes from the other tree, when in fact those changes
4719
# have not yet been seen.
4720
tree.set_parent_ids(parents[:1])
4722
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4723
merger.interesting_ids = interesting_ids
4724
merger.merge_type = merge_type
4725
merger.show_base = show_base
4726
merger.reprocess = reprocess
4727
conflicts = merger.do_merge()
4729
tree.set_parent_ids(parents)
4736
class cmd_revert(Command):
4738
Set files in the working tree back to the contents of a previous revision.
4740
Giving a list of files will revert only those files. Otherwise, all files
4741
will be reverted. If the revision is not specified with '--revision', the
4742
working tree basis revision is used. A revert operation affects only the
4743
working tree, not any revision history like the branch and repository or
4744
the working tree basis revision.
4746
To remove only some changes, without reverting to a prior version, use
4747
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4748
will remove the changes introduced by the second last commit (-2), without
4749
affecting the changes introduced by the last commit (-1). To remove
4750
certain changes on a hunk-by-hunk basis, see the shelve command.
4751
To update the branch to a specific revision or the latest revision and
4752
update the working tree accordingly while preserving local changes, see the
4755
Uncommitted changes to files that are reverted will be discarded.
4756
Howver, by default, any files that have been manually changed will be
4757
backed up first. (Files changed only by merge are not backed up.) Backup
4758
files have '.~#~' appended to their name, where # is a number.
4760
When you provide files, you can use their current pathname or the pathname
4761
from the target revision. So you can use revert to "undelete" a file by
4762
name. If you name a directory, all the contents of that directory will be
4765
If you have newly added files since the target revision, they will be
4766
removed. If the files to be removed have been changed, backups will be
4767
created as above. Directories containing unknown files will not be
4770
The working tree contains a list of revisions that have been merged but
4771
not yet committed. These revisions will be included as additional parents
4772
of the next commit. Normally, using revert clears that list as well as
4773
reverting the files. If any files are specified, revert leaves the list
4774
of uncommitted merges alone and reverts only the files. Use ``brz revert
4775
.`` in the tree root to revert all files but keep the recorded merges,
4776
and ``brz revert --forget-merges`` to clear the pending merge list without
4777
reverting any files.
4779
Using "brz revert --forget-merges", it is possible to apply all of the
4780
changes from a branch in a single revision. To do this, perform the merge
4781
as desired. Then doing revert with the "--forget-merges" option will keep
4782
the content of the tree as it was, but it will clear the list of pending
4783
merges. The next commit will then contain all of the changes that are
4784
present in the other branch, but without any other parent revisions.
4785
Because this technique forgets where these changes originated, it may
4786
cause additional conflicts on later merges involving the same source and
4790
_see_also = ['cat', 'export', 'merge', 'shelve']
4793
Option('no-backup', "Do not save backups of reverted files."),
4794
Option('forget-merges',
4795
'Remove pending merge marker, without changing any files.'),
4797
takes_args = ['file*']
4799
def run(self, revision=None, no_backup=False, file_list=None,
4800
forget_merges=None):
4801
tree, file_list = WorkingTree.open_containing_paths(file_list)
4802
self.add_cleanup(tree.lock_tree_write().unlock)
4804
tree.set_parent_ids(tree.get_parent_ids()[:1])
4806
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4809
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4810
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4811
tree.revert(file_list, rev_tree, not no_backup, None,
4812
report_changes=True)
4815
class cmd_assert_fail(Command):
4816
__doc__ = """Test reporting of assertion failures"""
4817
# intended just for use in testing
4822
raise AssertionError("always fails")
4825
class cmd_help(Command):
4826
__doc__ = """Show help on a command or other topic.
4829
_see_also = ['topics']
4831
Option('long', 'Show help on all commands.'),
4833
takes_args = ['topic?']
4834
aliases = ['?', '--help', '-?', '-h']
4837
def run(self, topic=None, long=False):
4839
if topic is None and long:
4841
breezy.help.help(topic)
4844
class cmd_shell_complete(Command):
4845
__doc__ = """Show appropriate completions for context.
4847
For a list of all available commands, say 'brz shell-complete'.
4849
takes_args = ['context?']
4854
def run(self, context=None):
4855
from . import shellcomplete
4856
shellcomplete.shellcomplete(context)
4859
class cmd_missing(Command):
4860
__doc__ = """Show unmerged/unpulled revisions between two branches.
4862
OTHER_BRANCH may be local or remote.
4864
To filter on a range of revisions, you can use the command -r begin..end
4865
-r revision requests a specific revision, -r ..end or -r begin.. are
4869
1 - some missing revisions
4870
0 - no missing revisions
4874
Determine the missing revisions between this and the branch at the
4875
remembered pull location::
4879
Determine the missing revisions between this and another branch::
4881
brz missing http://server/branch
4883
Determine the missing revisions up to a specific revision on the other
4886
brz missing -r ..-10
4888
Determine the missing revisions up to a specific revision on this
4891
brz missing --my-revision ..-10
4894
_see_also = ['merge', 'pull']
4895
takes_args = ['other_branch?']
4898
Option('reverse', 'Reverse the order of revisions.'),
4900
'Display changes in the local branch only.'),
4901
Option('this' , 'Same as --mine-only.'),
4902
Option('theirs-only',
4903
'Display changes in the remote branch only.'),
4904
Option('other', 'Same as --theirs-only.'),
4908
custom_help('revision',
4909
help='Filter on other branch revisions (inclusive). '
4910
'See "help revisionspec" for details.'),
4911
Option('my-revision',
4912
type=_parse_revision_str,
4913
help='Filter on local branch revisions (inclusive). '
4914
'See "help revisionspec" for details.'),
4915
Option('include-merged',
4916
'Show all revisions in addition to the mainline ones.'),
4917
Option('include-merges', hidden=True,
4918
help='Historical alias for --include-merged.'),
4920
encoding_type = 'replace'
4923
def run(self, other_branch=None, reverse=False, mine_only=False,
4925
log_format=None, long=False, short=False, line=False,
4926
show_ids=False, verbose=False, this=False, other=False,
4927
include_merged=None, revision=None, my_revision=None,
4929
from breezy.missing import find_unmerged, iter_log_revisions
4934
if include_merged is None:
4935
include_merged = False
4940
# TODO: We should probably check that we don't have mine-only and
4941
# theirs-only set, but it gets complicated because we also have
4942
# this and other which could be used.
4949
local_branch = Branch.open_containing(directory)[0]
4950
self.add_cleanup(local_branch.lock_read().unlock)
4952
parent = local_branch.get_parent()
4953
if other_branch is None:
4954
other_branch = parent
4955
if other_branch is None:
4956
raise errors.BzrCommandError(gettext("No peer location known"
4958
display_url = urlutils.unescape_for_display(parent,
4960
message(gettext("Using saved parent location: {0}\n").format(
4963
remote_branch = Branch.open(other_branch)
4964
if remote_branch.base == local_branch.base:
4965
remote_branch = local_branch
4967
self.add_cleanup(remote_branch.lock_read().unlock)
4969
local_revid_range = _revision_range_to_revid_range(
4970
_get_revision_range(my_revision, local_branch,
4973
remote_revid_range = _revision_range_to_revid_range(
4974
_get_revision_range(revision,
4975
remote_branch, self.name()))
4977
local_extra, remote_extra = find_unmerged(
4978
local_branch, remote_branch, restrict,
4979
backward=not reverse,
4980
include_merged=include_merged,
4981
local_revid_range=local_revid_range,
4982
remote_revid_range=remote_revid_range)
4984
if log_format is None:
4985
registry = log.log_formatter_registry
4986
log_format = registry.get_default(local_branch)
4987
lf = log_format(to_file=self.outf,
4989
show_timezone='original')
4992
if local_extra and not theirs_only:
4993
message(ngettext("You have %d extra revision:\n",
4994
"You have %d extra revisions:\n",
4998
if local_branch.supports_tags():
4999
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5000
for revision in iter_log_revisions(local_extra,
5001
local_branch.repository,
5004
lf.log_revision(revision)
5005
printed_local = True
5008
printed_local = False
5010
if remote_extra and not mine_only:
5011
if printed_local is True:
5013
message(ngettext("You are missing %d revision:\n",
5014
"You are missing %d revisions:\n",
5015
len(remote_extra)) %
5017
if remote_branch.supports_tags():
5018
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5019
for revision in iter_log_revisions(remote_extra,
5020
remote_branch.repository,
5023
lf.log_revision(revision)
5026
if mine_only and not local_extra:
5027
# We checked local, and found nothing extra
5028
message(gettext('This branch has no new revisions.\n'))
5029
elif theirs_only and not remote_extra:
5030
# We checked remote, and found nothing extra
5031
message(gettext('Other branch has no new revisions.\n'))
5032
elif not (mine_only or theirs_only or local_extra or
5034
# We checked both branches, and neither one had extra
5036
message(gettext("Branches are up to date.\n"))
5038
if not status_code and parent is None and other_branch is not None:
5039
self.add_cleanup(local_branch.lock_write().unlock)
5040
# handle race conditions - a parent might be set while we run.
5041
if local_branch.get_parent() is None:
5042
local_branch.set_parent(remote_branch.base)
5046
class cmd_pack(Command):
5047
__doc__ = """Compress the data within a repository.
5049
This operation compresses the data within a bazaar repository. As
5050
bazaar supports automatic packing of repository, this operation is
5051
normally not required to be done manually.
5053
During the pack operation, bazaar takes a backup of existing repository
5054
data, i.e. pack files. This backup is eventually removed by bazaar
5055
automatically when it is safe to do so. To save disk space by removing
5056
the backed up pack files, the --clean-obsolete-packs option may be
5059
Warning: If you use --clean-obsolete-packs and your machine crashes
5060
during or immediately after repacking, you may be left with a state
5061
where the deletion has been written to disk but the new packs have not
5062
been. In this case the repository may be unusable.
5065
_see_also = ['repositories']
5066
takes_args = ['branch_or_repo?']
5068
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5071
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5072
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5074
branch = dir.open_branch()
5075
repository = branch.repository
5076
except errors.NotBranchError:
5077
repository = dir.open_repository()
5078
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5081
class cmd_plugins(Command):
5082
__doc__ = """List the installed plugins.
5084
This command displays the list of installed plugins including
5085
version of plugin and a short description of each.
5087
--verbose shows the path where each plugin is located.
5089
A plugin is an external component for Bazaar that extends the
5090
revision control system, by adding or replacing code in Bazaar.
5091
Plugins can do a variety of things, including overriding commands,
5092
adding new commands, providing additional network transports and
5093
customizing log output.
5095
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5096
for further information on plugins including where to find them and how to
5097
install them. Instructions are also provided there on how to write new
5098
plugins using the Python programming language.
5100
takes_options = ['verbose']
5103
def run(self, verbose=False):
5104
from . import plugin
5105
# Don't give writelines a generator as some codecs don't like that
5106
self.outf.writelines(
5107
list(plugin.describe_plugins(show_paths=verbose)))
5110
class cmd_testament(Command):
5111
__doc__ = """Show testament (signing-form) of a revision."""
5114
Option('long', help='Produce long-format testament.'),
5116
help='Produce a strict-format testament.')]
5117
takes_args = ['branch?']
5118
encoding_type = 'exact'
5120
def run(self, branch=u'.', revision=None, long=False, strict=False):
5121
from .testament import Testament, StrictTestament
5123
testament_class = StrictTestament
5125
testament_class = Testament
5127
b = Branch.open_containing(branch)[0]
5129
b = Branch.open(branch)
5130
self.add_cleanup(b.lock_read().unlock)
5131
if revision is None:
5132
rev_id = b.last_revision()
5134
rev_id = revision[0].as_revision_id(b)
5135
t = testament_class.from_revision(b.repository, rev_id)
5137
self.outf.writelines(t.as_text_lines())
5139
self.outf.write(t.as_short_text())
5142
class cmd_annotate(Command):
5143
__doc__ = """Show the origin of each line in a file.
5145
This prints out the given file with an annotation on the left side
5146
indicating which revision, author and date introduced the change.
5148
If the origin is the same for a run of consecutive lines, it is
5149
shown only at the top, unless the --all option is given.
5151
# TODO: annotate directories; showing when each file was last changed
5152
# TODO: if the working copy is modified, show annotations on that
5153
# with new uncommitted lines marked
5154
aliases = ['ann', 'blame', 'praise']
5155
takes_args = ['filename']
5156
takes_options = [Option('all', help='Show annotations on all lines.'),
5157
Option('long', help='Show commit date in annotations.'),
5162
encoding_type = 'exact'
5165
def run(self, filename, all=False, long=False, revision=None,
5166
show_ids=False, directory=None):
5167
from .annotate import (
5170
wt, branch, relpath = \
5171
_open_directory_or_containing_tree_or_branch(filename, directory)
5173
self.add_cleanup(wt.lock_read().unlock)
5175
self.add_cleanup(branch.lock_read().unlock)
5176
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5177
self.add_cleanup(tree.lock_read().unlock)
5178
if wt is not None and revision is None:
5179
file_id = wt.path2id(relpath)
5181
file_id = tree.path2id(relpath)
5183
raise errors.NotVersionedError(filename)
5184
if wt is not None and revision is None:
5185
# If there is a tree and we're not annotating historical
5186
# versions, annotate the working tree's content.
5187
annotate_file_tree(wt, file_id, self.outf, long, all,
5190
annotate_file_tree(tree, file_id, self.outf, long, all,
5191
show_ids=show_ids, branch=branch)
5194
class cmd_re_sign(Command):
5195
__doc__ = """Create a digital signature for an existing revision."""
5196
# TODO be able to replace existing ones.
5198
hidden = True # is this right ?
5199
takes_args = ['revision_id*']
5200
takes_options = ['directory', 'revision']
5202
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5203
if revision_id_list is not None and revision is not None:
5204
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5205
if revision_id_list is None and revision is None:
5206
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5207
b = WorkingTree.open_containing(directory)[0].branch
5208
self.add_cleanup(b.lock_write().unlock)
5209
return self._run(b, revision_id_list, revision)
5211
def _run(self, b, revision_id_list, revision):
5213
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5214
if revision_id_list is not None:
5215
b.repository.start_write_group()
5217
for revision_id in revision_id_list:
5218
b.repository.sign_revision(revision_id, gpg_strategy)
5220
b.repository.abort_write_group()
5223
b.repository.commit_write_group()
5224
elif revision is not None:
5225
if len(revision) == 1:
5226
revno, rev_id = revision[0].in_history(b)
5227
b.repository.start_write_group()
5229
b.repository.sign_revision(rev_id, gpg_strategy)
5231
b.repository.abort_write_group()
5234
b.repository.commit_write_group()
5235
elif len(revision) == 2:
5236
# are they both on rh- if so we can walk between them
5237
# might be nice to have a range helper for arbitrary
5238
# revision paths. hmm.
5239
from_revno, from_revid = revision[0].in_history(b)
5240
to_revno, to_revid = revision[1].in_history(b)
5241
if to_revid is None:
5242
to_revno = b.revno()
5243
if from_revno is None or to_revno is None:
5244
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5245
b.repository.start_write_group()
5247
for revno in range(from_revno, to_revno + 1):
5248
b.repository.sign_revision(b.get_rev_id(revno),
5251
b.repository.abort_write_group()
5254
b.repository.commit_write_group()
5256
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5259
class cmd_bind(Command):
5260
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5261
If no branch is supplied, rebind to the last bound location.
5263
Once converted into a checkout, commits must succeed on the master branch
5264
before they will be applied to the local branch.
5266
Bound branches use the nickname of its master branch unless it is set
5267
locally, in which case binding will update the local nickname to be
5271
_see_also = ['checkouts', 'unbind']
5272
takes_args = ['location?']
5273
takes_options = ['directory']
5275
def run(self, location=None, directory=u'.'):
5276
b, relpath = Branch.open_containing(directory)
5277
if location is None:
5279
location = b.get_old_bound_location()
5280
except errors.UpgradeRequired:
5281
raise errors.BzrCommandError(gettext('No location supplied. '
5282
'This format does not remember old locations.'))
5284
if location is None:
5285
if b.get_bound_location() is not None:
5286
raise errors.BzrCommandError(
5287
gettext('Branch is already bound'))
5289
raise errors.BzrCommandError(
5290
gettext('No location supplied'
5291
' and no previous location known'))
5292
b_other = Branch.open(location)
5295
except errors.DivergedBranches:
5296
raise errors.BzrCommandError(gettext('These branches have diverged.'
5297
' Try merging, and then bind again.'))
5298
if b.get_config().has_explicit_nickname():
5299
b.nick = b_other.nick
5302
class cmd_unbind(Command):
5303
__doc__ = """Convert the current checkout into a regular branch.
5305
After unbinding, the local branch is considered independent and subsequent
5306
commits will be local only.
5309
_see_also = ['checkouts', 'bind']
5311
takes_options = ['directory']
5313
def run(self, directory=u'.'):
5314
b, relpath = Branch.open_containing(directory)
5316
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5319
class cmd_uncommit(Command):
5320
__doc__ = """Remove the last committed revision.
5322
--verbose will print out what is being removed.
5323
--dry-run will go through all the motions, but not actually
5326
If --revision is specified, uncommit revisions to leave the branch at the
5327
specified revision. For example, "brz uncommit -r 15" will leave the
5328
branch at revision 15.
5330
Uncommit leaves the working tree ready for a new commit. The only change
5331
it may make is to restore any pending merges that were present before
5335
# TODO: jam 20060108 Add an option to allow uncommit to remove
5336
# unreferenced information in 'branch-as-repository' branches.
5337
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5338
# information in shared branches as well.
5339
_see_also = ['commit']
5340
takes_options = ['verbose', 'revision',
5341
Option('dry-run', help='Don\'t actually make changes.'),
5342
Option('force', help='Say yes to all questions.'),
5344
help='Keep tags that point to removed revisions.'),
5346
help="Only remove the commits from the local branch"
5347
" when in a checkout."
5350
takes_args = ['location?']
5352
encoding_type = 'replace'
5354
def run(self, location=None, dry_run=False, verbose=False,
5355
revision=None, force=False, local=False, keep_tags=False):
5356
if location is None:
5358
control, relpath = controldir.ControlDir.open_containing(location)
5360
tree = control.open_workingtree()
5362
except (errors.NoWorkingTree, errors.NotLocalUrl):
5364
b = control.open_branch()
5366
if tree is not None:
5367
self.add_cleanup(tree.lock_write().unlock)
5369
self.add_cleanup(b.lock_write().unlock)
5370
return self._run(b, tree, dry_run, verbose, revision, force,
5373
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5375
from .log import log_formatter, show_log
5376
from .uncommit import uncommit
5378
last_revno, last_rev_id = b.last_revision_info()
5381
if revision is None:
5383
rev_id = last_rev_id
5385
# 'brz uncommit -r 10' actually means uncommit
5386
# so that the final tree is at revno 10.
5387
# but breezy.uncommit.uncommit() actually uncommits
5388
# the revisions that are supplied.
5389
# So we need to offset it by one
5390
revno = revision[0].in_history(b).revno + 1
5391
if revno <= last_revno:
5392
rev_id = b.get_rev_id(revno)
5394
if rev_id is None or _mod_revision.is_null(rev_id):
5395
self.outf.write(gettext('No revisions to uncommit.\n'))
5398
lf = log_formatter('short',
5400
show_timezone='original')
5405
direction='forward',
5406
start_revision=revno,
5407
end_revision=last_revno)
5410
self.outf.write(gettext('Dry-run, pretending to remove'
5411
' the above revisions.\n'))
5413
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5416
if not ui.ui_factory.confirm_action(
5417
gettext(u'Uncommit these revisions'),
5418
'breezy.builtins.uncommit',
5420
self.outf.write(gettext('Canceled\n'))
5423
mutter('Uncommitting from {%s} to {%s}',
5424
last_rev_id, rev_id)
5425
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5426
revno=revno, local=local, keep_tags=keep_tags)
5427
self.outf.write(gettext('You can restore the old tip by running:\n'
5428
' brz pull . -r revid:%s\n') % last_rev_id)
5431
class cmd_break_lock(Command):
5432
__doc__ = """Break a dead lock.
5434
This command breaks a lock on a repository, branch, working directory or
5437
CAUTION: Locks should only be broken when you are sure that the process
5438
holding the lock has been stopped.
5440
You can get information on what locks are open via the 'brz info
5441
[location]' command.
5445
brz break-lock brz+ssh://example.com/brz/foo
5446
brz break-lock --conf ~/.bazaar
5449
takes_args = ['location?']
5452
help='LOCATION is the directory where the config lock is.'),
5454
help='Do not ask for confirmation before breaking the lock.'),
5457
def run(self, location=None, config=False, force=False):
5458
if location is None:
5461
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5463
{'breezy.lockdir.break': True})
5465
conf = _mod_config.LockableConfig(file_name=location)
5468
control, relpath = controldir.ControlDir.open_containing(location)
5470
control.break_lock()
5471
except NotImplementedError:
5475
class cmd_wait_until_signalled(Command):
5476
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5478
This just prints a line to signal when it is ready, then blocks on stdin.
5484
sys.stdout.write("running\n")
5486
sys.stdin.readline()
5489
class cmd_serve(Command):
5490
__doc__ = """Run the brz server."""
5492
aliases = ['server']
5496
help='Serve on stdin/out for use from inetd or sshd.'),
5497
RegistryOption('protocol',
5498
help="Protocol to serve.",
5499
lazy_registry=('breezy.transport', 'transport_server_registry'),
5500
value_switches=True),
5502
help='Listen for connections on nominated address.', type=str),
5504
help='Listen for connections on nominated port. Passing 0 as '
5505
'the port number will result in a dynamically allocated '
5506
'port. The default port depends on the protocol.',
5508
custom_help('directory',
5509
help='Serve contents of this directory.'),
5510
Option('allow-writes',
5511
help='By default the server is a readonly server. Supplying '
5512
'--allow-writes enables write access to the contents of '
5513
'the served directory and below. Note that ``brz serve`` '
5514
'does not perform authentication, so unless some form of '
5515
'external authentication is arranged supplying this '
5516
'option leads to global uncontrolled write access to your '
5519
Option('client-timeout', type=float,
5520
help='Override the default idle client timeout (5min).'),
5523
def run(self, listen=None, port=None, inet=False, directory=None,
5524
allow_writes=False, protocol=None, client_timeout=None):
5525
from . import transport
5526
if directory is None:
5527
directory = osutils.getcwd()
5528
if protocol is None:
5529
protocol = transport.transport_server_registry.get()
5530
url = transport.location_to_url(directory)
5531
if not allow_writes:
5532
url = 'readonly+' + url
5533
t = transport.get_transport_from_url(url)
5534
protocol(t, listen, port, inet, client_timeout)
5537
class cmd_join(Command):
5538
__doc__ = """Combine a tree into its containing tree.
5540
This command requires the target tree to be in a rich-root format.
5542
The TREE argument should be an independent tree, inside another tree, but
5543
not part of it. (Such trees can be produced by "brz split", but also by
5544
running "brz branch" with the target inside a tree.)
5546
The result is a combined tree, with the subtree no longer an independent
5547
part. This is marked as a merge of the subtree into the containing tree,
5548
and all history is preserved.
5551
_see_also = ['split']
5552
takes_args = ['tree']
5554
Option('reference', help='Join by reference.', hidden=True),
5557
def run(self, tree, reference=False):
5558
sub_tree = WorkingTree.open(tree)
5559
parent_dir = osutils.dirname(sub_tree.basedir)
5560
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5561
repo = containing_tree.branch.repository
5562
if not repo.supports_rich_root():
5563
raise errors.BzrCommandError(gettext(
5564
"Can't join trees because %s doesn't support rich root data.\n"
5565
"You can use brz upgrade on the repository.")
5569
containing_tree.add_reference(sub_tree)
5570
except errors.BadReferenceTarget as e:
5571
# XXX: Would be better to just raise a nicely printable
5572
# exception from the real origin. Also below. mbp 20070306
5573
raise errors.BzrCommandError(
5574
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5577
containing_tree.subsume(sub_tree)
5578
except errors.BadSubsumeSource as e:
5579
raise errors.BzrCommandError(
5580
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5583
class cmd_split(Command):
5584
__doc__ = """Split a subdirectory of a tree into a separate tree.
5586
This command will produce a target tree in a format that supports
5587
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5588
converted into earlier formats like 'dirstate-tags'.
5590
The TREE argument should be a subdirectory of a working tree. That
5591
subdirectory will be converted into an independent tree, with its own
5592
branch. Commits in the top-level tree will not apply to the new subtree.
5595
_see_also = ['join']
5596
takes_args = ['tree']
5598
def run(self, tree):
5599
containing_tree, subdir = WorkingTree.open_containing(tree)
5600
sub_id = containing_tree.path2id(subdir)
5602
raise errors.NotVersionedError(subdir)
5604
containing_tree.extract(sub_id)
5605
except errors.RootNotRich:
5606
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5609
class cmd_merge_directive(Command):
5610
__doc__ = """Generate a merge directive for auto-merge tools.
5612
A directive requests a merge to be performed, and also provides all the
5613
information necessary to do so. This means it must either include a
5614
revision bundle, or the location of a branch containing the desired
5617
A submit branch (the location to merge into) must be supplied the first
5618
time the command is issued. After it has been supplied once, it will
5619
be remembered as the default.
5621
A public branch is optional if a revision bundle is supplied, but required
5622
if --diff or --plain is specified. It will be remembered as the default
5623
after the first use.
5626
takes_args = ['submit_branch?', 'public_branch?']
5630
_see_also = ['send']
5634
RegistryOption.from_kwargs('patch-type',
5635
'The type of patch to include in the directive.',
5637
value_switches=True,
5639
bundle='Bazaar revision bundle (default).',
5640
diff='Normal unified diff.',
5641
plain='No patch, just directive.'),
5642
Option('sign', help='GPG-sign the directive.'), 'revision',
5643
Option('mail-to', type=str,
5644
help='Instead of printing the directive, email to this address.'),
5645
Option('message', type=str, short_name='m',
5646
help='Message to use when committing this merge.')
5649
encoding_type = 'exact'
5651
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5652
sign=False, revision=None, mail_to=None, message=None,
5654
from .revision import ensure_null, NULL_REVISION
5655
include_patch, include_bundle = {
5656
'plain': (False, False),
5657
'diff': (True, False),
5658
'bundle': (True, True),
5660
branch = Branch.open(directory)
5661
stored_submit_branch = branch.get_submit_branch()
5662
if submit_branch is None:
5663
submit_branch = stored_submit_branch
5665
if stored_submit_branch is None:
5666
branch.set_submit_branch(submit_branch)
5667
if submit_branch is None:
5668
submit_branch = branch.get_parent()
5669
if submit_branch is None:
5670
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5672
stored_public_branch = branch.get_public_branch()
5673
if public_branch is None:
5674
public_branch = stored_public_branch
5675
elif stored_public_branch is None:
5676
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5677
branch.set_public_branch(public_branch)
5678
if not include_bundle and public_branch is None:
5679
raise errors.BzrCommandError(gettext('No public branch specified or'
5681
base_revision_id = None
5682
if revision is not None:
5683
if len(revision) > 2:
5684
raise errors.BzrCommandError(gettext('brz merge-directive takes '
5685
'at most two one revision identifiers'))
5686
revision_id = revision[-1].as_revision_id(branch)
5687
if len(revision) == 2:
5688
base_revision_id = revision[0].as_revision_id(branch)
5690
revision_id = branch.last_revision()
5691
revision_id = ensure_null(revision_id)
5692
if revision_id == NULL_REVISION:
5693
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5694
directive = merge_directive.MergeDirective2.from_objects(
5695
branch.repository, revision_id, time.time(),
5696
osutils.local_time_offset(), submit_branch,
5697
public_branch=public_branch, include_patch=include_patch,
5698
include_bundle=include_bundle, message=message,
5699
base_revision_id=base_revision_id)
5702
self.outf.write(directive.to_signed(branch))
5704
self.outf.writelines(directive.to_lines())
5706
message = directive.to_email(mail_to, branch, sign)
5707
s = SMTPConnection(branch.get_config_stack())
5708
s.send_email(message)
5711
class cmd_send(Command):
5712
__doc__ = """Mail or create a merge-directive for submitting changes.
5714
A merge directive provides many things needed for requesting merges:
5716
* A machine-readable description of the merge to perform
5718
* An optional patch that is a preview of the changes requested
5720
* An optional bundle of revision data, so that the changes can be applied
5721
directly from the merge directive, without retrieving data from a
5724
`brz send` creates a compact data set that, when applied using brz
5725
merge, has the same effect as merging from the source branch.
5727
By default the merge directive is self-contained and can be applied to any
5728
branch containing submit_branch in its ancestory without needing access to
5731
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5732
revisions, but only a structured request to merge from the
5733
public_location. In that case the public_branch is needed and it must be
5734
up-to-date and accessible to the recipient. The public_branch is always
5735
included if known, so that people can check it later.
5737
The submit branch defaults to the parent of the source branch, but can be
5738
overridden. Both submit branch and public branch will be remembered in
5739
branch.conf the first time they are used for a particular branch. The
5740
source branch defaults to that containing the working directory, but can
5741
be changed using --from.
5743
Both the submit branch and the public branch follow the usual behavior with
5744
respect to --remember: If there is no default location set, the first send
5745
will set it (use --no-remember to avoid setting it). After that, you can
5746
omit the location to use the default. To change the default, use
5747
--remember. The value will only be saved if the location can be accessed.
5749
In order to calculate those changes, brz must analyse the submit branch.
5750
Therefore it is most efficient for the submit branch to be a local mirror.
5751
If a public location is known for the submit_branch, that location is used
5752
in the merge directive.
5754
The default behaviour is to send the merge directive by mail, unless -o is
5755
given, in which case it is sent to a file.
5757
Mail is sent using your preferred mail program. This should be transparent
5758
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5759
If the preferred client can't be found (or used), your editor will be used.
5761
To use a specific mail program, set the mail_client configuration option.
5762
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5763
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5764
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5765
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5768
If mail is being sent, a to address is required. This can be supplied
5769
either on the commandline, by setting the submit_to configuration
5770
option in the branch itself or the child_submit_to configuration option
5771
in the submit branch.
5773
Two formats are currently supported: "4" uses revision bundle format 4 and
5774
merge directive format 2. It is significantly faster and smaller than
5775
older formats. It is compatible with Bazaar 0.19 and later. It is the
5776
default. "0.9" uses revision bundle format 0.9 and merge directive
5777
format 1. It is compatible with Bazaar 0.12 - 0.18.
5779
The merge directives created by brz send may be applied using brz merge or
5780
brz pull by specifying a file containing a merge directive as the location.
5782
brz send makes extensive use of public locations to map local locations into
5783
URLs that can be used by other people. See `brz help configuration` to
5784
set them, and use `brz info` to display them.
5787
encoding_type = 'exact'
5789
_see_also = ['merge', 'pull']
5791
takes_args = ['submit_branch?', 'public_branch?']
5795
help='Do not include a bundle in the merge directive.'),
5796
Option('no-patch', help='Do not include a preview patch in the merge'
5799
help='Remember submit and public branch.'),
5801
help='Branch to generate the submission from, '
5802
'rather than the one containing the working directory.',
5805
Option('output', short_name='o',
5806
help='Write merge directive to this file or directory; '
5807
'use - for stdout.',
5810
help='Refuse to send if there are uncommitted changes in'
5811
' the working tree, --no-strict disables the check.'),
5812
Option('mail-to', help='Mail the request to this address.',
5816
Option('body', help='Body for the email.', type=text_type),
5817
RegistryOption('format',
5818
help='Use the specified output format.',
5819
lazy_registry=('breezy.send', 'format_registry')),
5822
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5823
no_patch=False, revision=None, remember=None, output=None,
5824
format=None, mail_to=None, message=None, body=None,
5825
strict=None, **kwargs):
5826
from .send import send
5827
return send(submit_branch, revision, public_branch, remember,
5828
format, no_bundle, no_patch, output,
5829
kwargs.get('from', '.'), mail_to, message, body,
5834
class cmd_bundle_revisions(cmd_send):
5835
__doc__ = """Create a merge-directive for submitting changes.
5837
A merge directive provides many things needed for requesting merges:
5839
* A machine-readable description of the merge to perform
5841
* An optional patch that is a preview of the changes requested
5843
* An optional bundle of revision data, so that the changes can be applied
5844
directly from the merge directive, without retrieving data from a
5847
If --no-bundle is specified, then public_branch is needed (and must be
5848
up-to-date), so that the receiver can perform the merge using the
5849
public_branch. The public_branch is always included if known, so that
5850
people can check it later.
5852
The submit branch defaults to the parent, but can be overridden. Both
5853
submit branch and public branch will be remembered if supplied.
5855
If a public_branch is known for the submit_branch, that public submit
5856
branch is used in the merge instructions. This means that a local mirror
5857
can be used as your actual submit branch, once you have set public_branch
5860
Two formats are currently supported: "4" uses revision bundle format 4 and
5861
merge directive format 2. It is significantly faster and smaller than
5862
older formats. It is compatible with Bazaar 0.19 and later. It is the
5863
default. "0.9" uses revision bundle format 0.9 and merge directive
5864
format 1. It is compatible with Bazaar 0.12 - 0.18.
5869
help='Do not include a bundle in the merge directive.'),
5870
Option('no-patch', help='Do not include a preview patch in the merge'
5873
help='Remember submit and public branch.'),
5875
help='Branch to generate the submission from, '
5876
'rather than the one containing the working directory.',
5879
Option('output', short_name='o', help='Write directive to this file.',
5882
help='Refuse to bundle revisions if there are uncommitted'
5883
' changes in the working tree, --no-strict disables the check.'),
5885
RegistryOption('format',
5886
help='Use the specified output format.',
5887
lazy_registry=('breezy.send', 'format_registry')),
5889
aliases = ['bundle']
5891
_see_also = ['send', 'merge']
5895
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5896
no_patch=False, revision=None, remember=False, output=None,
5897
format=None, strict=None, **kwargs):
5900
from .send import send
5901
return send(submit_branch, revision, public_branch, remember,
5902
format, no_bundle, no_patch, output,
5903
kwargs.get('from', '.'), None, None, None,
5904
self.outf, strict=strict)
5907
class cmd_tag(Command):
5908
__doc__ = """Create, remove or modify a tag naming a revision.
5910
Tags give human-meaningful names to revisions. Commands that take a -r
5911
(--revision) option can be given -rtag:X, where X is any previously
5914
Tags are stored in the branch. Tags are copied from one branch to another
5915
along when you branch, push, pull or merge.
5917
It is an error to give a tag name that already exists unless you pass
5918
--force, in which case the tag is moved to point to the new revision.
5920
To rename a tag (change the name but keep it on the same revsion), run ``brz
5921
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
5923
If no tag name is specified it will be determined through the
5924
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5925
upstream releases by reading configure.ac. See ``brz help hooks`` for
5929
_see_also = ['commit', 'tags']
5930
takes_args = ['tag_name?']
5933
help='Delete this tag rather than placing it.',
5935
custom_help('directory',
5936
help='Branch in which to place the tag.'),
5938
help='Replace existing tags.',
5943
def run(self, tag_name=None,
5949
branch, relpath = Branch.open_containing(directory)
5950
self.add_cleanup(branch.lock_write().unlock)
5952
if tag_name is None:
5953
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5954
branch.tags.delete_tag(tag_name)
5955
note(gettext('Deleted tag %s.') % tag_name)
5958
if len(revision) != 1:
5959
raise errors.BzrCommandError(gettext(
5960
"Tags can only be placed on a single revision, "
5962
revision_id = revision[0].as_revision_id(branch)
5964
revision_id = branch.last_revision()
5965
if tag_name is None:
5966
tag_name = branch.automatic_tag_name(revision_id)
5967
if tag_name is None:
5968
raise errors.BzrCommandError(gettext(
5969
"Please specify a tag name."))
5971
existing_target = branch.tags.lookup_tag(tag_name)
5972
except errors.NoSuchTag:
5973
existing_target = None
5974
if not force and existing_target not in (None, revision_id):
5975
raise errors.TagAlreadyExists(tag_name)
5976
if existing_target == revision_id:
5977
note(gettext('Tag %s already exists for that revision.') % tag_name)
5979
branch.tags.set_tag(tag_name, revision_id)
5980
if existing_target is None:
5981
note(gettext('Created tag %s.') % tag_name)
5983
note(gettext('Updated tag %s.') % tag_name)
5986
class cmd_tags(Command):
5987
__doc__ = """List tags.
5989
This command shows a table of tag names and the revisions they reference.
5994
custom_help('directory',
5995
help='Branch whose tags should be displayed.'),
5996
RegistryOption('sort',
5997
'Sort tags by different criteria.', title='Sorting',
5998
lazy_registry=('breezy.tag', 'tag_sort_methods')
6005
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6006
from .tag import tag_sort_methods
6007
branch, relpath = Branch.open_containing(directory)
6009
tags = list(viewitems(branch.tags.get_tag_dict()))
6013
self.add_cleanup(branch.lock_read().unlock)
6015
# Restrict to the specified range
6016
tags = self._tags_for_range(branch, revision)
6018
sort = tag_sort_methods.get()
6021
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6022
for index, (tag, revid) in enumerate(tags):
6024
revno = branch.revision_id_to_dotted_revno(revid)
6025
if isinstance(revno, tuple):
6026
revno = '.'.join(map(str, revno))
6027
except (errors.NoSuchRevision,
6028
errors.GhostRevisionsHaveNoRevno,
6029
errors.UnsupportedOperation):
6030
# Bad tag data/merges can lead to tagged revisions
6031
# which are not in this branch. Fail gracefully ...
6033
tags[index] = (tag, revno)
6035
for tag, revspec in tags:
6036
self.outf.write('%-20s %s\n' % (tag, revspec))
6038
def _tags_for_range(self, branch, revision):
6040
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6041
revid1, revid2 = rev1.rev_id, rev2.rev_id
6042
# _get_revision_range will always set revid2 if it's not specified.
6043
# If revid1 is None, it means we want to start from the branch
6044
# origin which is always a valid ancestor. If revid1 == revid2, the
6045
# ancestry check is useless.
6046
if revid1 and revid1 != revid2:
6047
# FIXME: We really want to use the same graph than
6048
# branch.iter_merge_sorted_revisions below, but this is not
6049
# easily available -- vila 2011-09-23
6050
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6051
# We don't want to output anything in this case...
6053
# only show revisions between revid1 and revid2 (inclusive)
6054
tagged_revids = branch.tags.get_reverse_tag_dict()
6056
for r in branch.iter_merge_sorted_revisions(
6057
start_revision_id=revid2, stop_revision_id=revid1,
6058
stop_rule='include'):
6059
revid_tags = tagged_revids.get(r[0], None)
6061
found.extend([(tag, r[0]) for tag in revid_tags])
6065
class cmd_reconfigure(Command):
6066
__doc__ = """Reconfigure the type of a brz directory.
6068
A target configuration must be specified.
6070
For checkouts, the bind-to location will be auto-detected if not specified.
6071
The order of preference is
6072
1. For a lightweight checkout, the current bound location.
6073
2. For branches that used to be checkouts, the previously-bound location.
6074
3. The push location.
6075
4. The parent location.
6076
If none of these is available, --bind-to must be specified.
6079
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6080
takes_args = ['location?']
6082
RegistryOption.from_kwargs(
6085
help='The relation between branch and tree.',
6086
value_switches=True, enum_switch=False,
6087
branch='Reconfigure to be an unbound branch with no working tree.',
6088
tree='Reconfigure to be an unbound branch with a working tree.',
6089
checkout='Reconfigure to be a bound branch with a working tree.',
6090
lightweight_checkout='Reconfigure to be a lightweight'
6091
' checkout (with no local history).',
6093
RegistryOption.from_kwargs(
6095
title='Repository type',
6096
help='Location fo the repository.',
6097
value_switches=True, enum_switch=False,
6098
standalone='Reconfigure to be a standalone branch '
6099
'(i.e. stop using shared repository).',
6100
use_shared='Reconfigure to use a shared repository.',
6102
RegistryOption.from_kwargs(
6104
title='Trees in Repository',
6105
help='Whether new branches in the repository have trees.',
6106
value_switches=True, enum_switch=False,
6107
with_trees='Reconfigure repository to create '
6108
'working trees on branches by default.',
6109
with_no_trees='Reconfigure repository to not create '
6110
'working trees on branches by default.'
6112
Option('bind-to', help='Branch to bind checkout to.', type=str),
6114
help='Perform reconfiguration even if local changes'
6116
Option('stacked-on',
6117
help='Reconfigure a branch to be stacked on another branch.',
6121
help='Reconfigure a branch to be unstacked. This '
6122
'may require copying substantial data into it.',
6126
def run(self, location=None, bind_to=None, force=False,
6127
tree_type=None, repository_type=None, repository_trees=None,
6128
stacked_on=None, unstacked=None):
6129
directory = controldir.ControlDir.open(location)
6130
if stacked_on and unstacked:
6131
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6132
elif stacked_on is not None:
6133
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6135
reconfigure.ReconfigureUnstacked().apply(directory)
6136
# At the moment you can use --stacked-on and a different
6137
# reconfiguration shape at the same time; there seems no good reason
6139
if (tree_type is None and
6140
repository_type is None and
6141
repository_trees is None):
6142
if stacked_on or unstacked:
6145
raise errors.BzrCommandError(gettext('No target configuration '
6147
reconfiguration = None
6148
if tree_type == 'branch':
6149
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6150
elif tree_type == 'tree':
6151
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6152
elif tree_type == 'checkout':
6153
reconfiguration = reconfigure.Reconfigure.to_checkout(
6155
elif tree_type == 'lightweight-checkout':
6156
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6159
reconfiguration.apply(force)
6160
reconfiguration = None
6161
if repository_type == 'use-shared':
6162
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6163
elif repository_type == 'standalone':
6164
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6166
reconfiguration.apply(force)
6167
reconfiguration = None
6168
if repository_trees == 'with-trees':
6169
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6171
elif repository_trees == 'with-no-trees':
6172
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6175
reconfiguration.apply(force)
6176
reconfiguration = None
6179
class cmd_switch(Command):
6180
__doc__ = """Set the branch of a checkout and update.
6182
For lightweight checkouts, this changes the branch being referenced.
6183
For heavyweight checkouts, this checks that there are no local commits
6184
versus the current bound branch, then it makes the local branch a mirror
6185
of the new location and binds to it.
6187
In both cases, the working tree is updated and uncommitted changes
6188
are merged. The user can commit or revert these as they desire.
6190
Pending merges need to be committed or reverted before using switch.
6192
The path to the branch to switch to can be specified relative to the parent
6193
directory of the current branch. For example, if you are currently in a
6194
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6197
Bound branches use the nickname of its master branch unless it is set
6198
locally, in which case switching will update the local nickname to be
6202
takes_args = ['to_location?']
6203
takes_options = ['directory',
6205
help='Switch even if local commits will be lost.'),
6207
Option('create-branch', short_name='b',
6208
help='Create the target branch from this one before'
6209
' switching to it.'),
6211
help='Store and restore uncommitted changes in the'
6215
def run(self, to_location=None, force=False, create_branch=False,
6216
revision=None, directory=u'.', store=False):
6217
from . import switch
6218
tree_location = directory
6219
revision = _get_one_revision('switch', revision)
6220
possible_transports = []
6221
control_dir = controldir.ControlDir.open_containing(tree_location,
6222
possible_transports=possible_transports)[0]
6223
if to_location is None:
6224
if revision is None:
6225
raise errors.BzrCommandError(gettext('You must supply either a'
6226
' revision or a location'))
6227
to_location = tree_location
6229
branch = control_dir.open_branch(
6230
possible_transports=possible_transports)
6231
had_explicit_nick = branch.get_config().has_explicit_nickname()
6232
except errors.NotBranchError:
6234
had_explicit_nick = False
6237
raise errors.BzrCommandError(
6238
gettext('cannot create branch without source branch'))
6239
to_location = lookup_new_sibling_branch(control_dir, to_location,
6240
possible_transports=possible_transports)
6241
to_branch = branch.bzrdir.sprout(to_location,
6242
possible_transports=possible_transports,
6243
source_branch=branch).open_branch()
6246
to_branch = Branch.open(to_location,
6247
possible_transports=possible_transports)
6248
except errors.NotBranchError:
6249
to_branch = open_sibling_branch(control_dir, to_location,
6250
possible_transports=possible_transports)
6251
if revision is not None:
6252
revision = revision.as_revision_id(to_branch)
6253
switch.switch(control_dir, to_branch, force, revision_id=revision,
6254
store_uncommitted=store)
6255
if had_explicit_nick:
6256
branch = control_dir.open_branch() #get the new branch!
6257
branch.nick = to_branch.nick
6258
note(gettext('Switched to branch: %s'),
6259
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6263
class cmd_view(Command):
6264
__doc__ = """Manage filtered views.
6266
Views provide a mask over the tree so that users can focus on
6267
a subset of a tree when doing their work. After creating a view,
6268
commands that support a list of files - status, diff, commit, etc -
6269
effectively have that list of files implicitly given each time.
6270
An explicit list of files can still be given but those files
6271
must be within the current view.
6273
In most cases, a view has a short life-span: it is created to make
6274
a selected change and is deleted once that change is committed.
6275
At other times, you may wish to create one or more named views
6276
and switch between them.
6278
To disable the current view without deleting it, you can switch to
6279
the pseudo view called ``off``. This can be useful when you need
6280
to see the whole tree for an operation or two (e.g. merge) but
6281
want to switch back to your view after that.
6284
To define the current view::
6286
brz view file1 dir1 ...
6288
To list the current view::
6292
To delete the current view::
6296
To disable the current view without deleting it::
6298
brz view --switch off
6300
To define a named view and switch to it::
6302
brz view --name view-name file1 dir1 ...
6304
To list a named view::
6306
brz view --name view-name
6308
To delete a named view::
6310
brz view --name view-name --delete
6312
To switch to a named view::
6314
brz view --switch view-name
6316
To list all views defined::
6320
To delete all views::
6322
brz view --delete --all
6326
takes_args = ['file*']
6329
help='Apply list or delete action to all views.',
6332
help='Delete the view.',
6335
help='Name of the view to define, list or delete.',
6339
help='Name of the view to switch to.',
6344
def run(self, file_list,
6350
tree, file_list = WorkingTree.open_containing_paths(file_list,
6352
current_view, view_dict = tree.views.get_view_info()
6357
raise errors.BzrCommandError(gettext(
6358
"Both --delete and a file list specified"))
6360
raise errors.BzrCommandError(gettext(
6361
"Both --delete and --switch specified"))
6363
tree.views.set_view_info(None, {})
6364
self.outf.write(gettext("Deleted all views.\n"))
6366
raise errors.BzrCommandError(gettext("No current view to delete"))
6368
tree.views.delete_view(name)
6369
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6372
raise errors.BzrCommandError(gettext(
6373
"Both --switch and a file list specified"))
6375
raise errors.BzrCommandError(gettext(
6376
"Both --switch and --all specified"))
6377
elif switch == 'off':
6378
if current_view is None:
6379
raise errors.BzrCommandError(gettext("No current view to disable"))
6380
tree.views.set_view_info(None, view_dict)
6381
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6383
tree.views.set_view_info(switch, view_dict)
6384
view_str = views.view_display_str(tree.views.lookup_view())
6385
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6388
self.outf.write(gettext('Views defined:\n'))
6389
for view in sorted(view_dict):
6390
if view == current_view:
6394
view_str = views.view_display_str(view_dict[view])
6395
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6397
self.outf.write(gettext('No views defined.\n'))
6400
# No name given and no current view set
6403
raise errors.BzrCommandError(gettext(
6404
"Cannot change the 'off' pseudo view"))
6405
tree.views.set_view(name, sorted(file_list))
6406
view_str = views.view_display_str(tree.views.lookup_view())
6407
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6411
# No name given and no current view set
6412
self.outf.write(gettext('No current view.\n'))
6414
view_str = views.view_display_str(tree.views.lookup_view(name))
6415
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6418
class cmd_hooks(Command):
6419
__doc__ = """Show hooks."""
6424
for hook_key in sorted(hooks.known_hooks.keys()):
6425
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6426
self.outf.write("%s:\n" % type(some_hooks).__name__)
6427
for hook_name, hook_point in sorted(some_hooks.items()):
6428
self.outf.write(" %s:\n" % (hook_name,))
6429
found_hooks = list(hook_point)
6431
for hook in found_hooks:
6432
self.outf.write(" %s\n" %
6433
(some_hooks.get_hook_name(hook),))
6435
self.outf.write(gettext(" <no hooks installed>\n"))
6438
class cmd_remove_branch(Command):
6439
__doc__ = """Remove a branch.
6441
This will remove the branch from the specified location but
6442
will keep any working tree or repository in place.
6446
Remove the branch at repo/trunk::
6448
brz remove-branch repo/trunk
6452
takes_args = ["location?"]
6454
takes_options = ['directory',
6455
Option('force', help='Remove branch even if it is the active branch.')]
6457
aliases = ["rmbranch"]
6459
def run(self, directory=None, location=None, force=False):
6460
br = open_nearby_branch(near=directory, location=location)
6461
if not force and br.bzrdir.has_workingtree():
6463
active_branch = br.bzrdir.open_branch(name="")
6464
except errors.NotBranchError:
6465
active_branch = None
6466
if (active_branch is not None and
6467
br.control_url == active_branch.control_url):
6468
raise errors.BzrCommandError(
6469
gettext("Branch is active. Use --force to remove it."))
6470
br.bzrdir.destroy_branch(br.name)
6473
class cmd_shelve(Command):
6474
__doc__ = """Temporarily set aside some changes from the current tree.
6476
Shelve allows you to temporarily put changes you've made "on the shelf",
6477
ie. out of the way, until a later time when you can bring them back from
6478
the shelf with the 'unshelve' command. The changes are stored alongside
6479
your working tree, and so they aren't propagated along with your branch nor
6480
will they survive its deletion.
6482
If shelve --list is specified, previously-shelved changes are listed.
6484
Shelve is intended to help separate several sets of changes that have
6485
been inappropriately mingled. If you just want to get rid of all changes
6486
and you don't need to restore them later, use revert. If you want to
6487
shelve all text changes at once, use shelve --all.
6489
If filenames are specified, only the changes to those files will be
6490
shelved. Other files will be left untouched.
6492
If a revision is specified, changes since that revision will be shelved.
6494
You can put multiple items on the shelf, and by default, 'unshelve' will
6495
restore the most recently shelved changes.
6497
For complicated changes, it is possible to edit the changes in a separate
6498
editor program to decide what the file remaining in the working copy
6499
should look like. To do this, add the configuration option
6501
change_editor = PROGRAM @new_path @old_path
6503
where @new_path is replaced with the path of the new version of the
6504
file and @old_path is replaced with the path of the old version of
6505
the file. The PROGRAM should save the new file with the desired
6506
contents of the file in the working tree.
6510
takes_args = ['file*']
6515
Option('all', help='Shelve all changes.'),
6517
RegistryOption('writer', 'Method to use for writing diffs.',
6518
breezy.option.diff_writer_registry,
6519
value_switches=True, enum_switch=False),
6521
Option('list', help='List shelved changes.'),
6523
help='Destroy removed changes instead of shelving them.'),
6525
_see_also = ['unshelve', 'configuration']
6527
def run(self, revision=None, all=False, file_list=None, message=None,
6528
writer=None, list=False, destroy=False, directory=None):
6530
return self.run_for_list(directory=directory)
6531
from .shelf_ui import Shelver
6533
writer = breezy.option.diff_writer_registry.get()
6535
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6536
file_list, message, destroy=destroy, directory=directory)
6541
except errors.UserAbort:
6544
def run_for_list(self, directory=None):
6545
if directory is None:
6547
tree = WorkingTree.open_containing(directory)[0]
6548
self.add_cleanup(tree.lock_read().unlock)
6549
manager = tree.get_shelf_manager()
6550
shelves = manager.active_shelves()
6551
if len(shelves) == 0:
6552
note(gettext('No shelved changes.'))
6554
for shelf_id in reversed(shelves):
6555
message = manager.get_metadata(shelf_id).get('message')
6557
message = '<no message>'
6558
self.outf.write('%3d: %s\n' % (shelf_id, message))
6562
class cmd_unshelve(Command):
6563
__doc__ = """Restore shelved changes.
6565
By default, the most recently shelved changes are restored. However if you
6566
specify a shelf by id those changes will be restored instead. This works
6567
best when the changes don't depend on each other.
6570
takes_args = ['shelf_id?']
6573
RegistryOption.from_kwargs(
6574
'action', help="The action to perform.",
6575
enum_switch=False, value_switches=True,
6576
apply="Apply changes and remove from the shelf.",
6577
dry_run="Show changes, but do not apply or remove them.",
6578
preview="Instead of unshelving the changes, show the diff that "
6579
"would result from unshelving.",
6580
delete_only="Delete changes without applying them.",
6581
keep="Apply changes but don't delete them.",
6584
_see_also = ['shelve']
6586
def run(self, shelf_id=None, action='apply', directory=u'.'):
6587
from .shelf_ui import Unshelver
6588
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6592
unshelver.tree.unlock()
6595
class cmd_clean_tree(Command):
6596
__doc__ = """Remove unwanted files from working tree.
6598
By default, only unknown files, not ignored files, are deleted. Versioned
6599
files are never deleted.
6601
Another class is 'detritus', which includes files emitted by brz during
6602
normal operations and selftests. (The value of these files decreases with
6605
If no options are specified, unknown files are deleted. Otherwise, option
6606
flags are respected, and may be combined.
6608
To check what clean-tree will do, use --dry-run.
6610
takes_options = ['directory',
6611
Option('ignored', help='Delete all ignored files.'),
6612
Option('detritus', help='Delete conflict files, merge and revert'
6613
' backups, and failed selftest dirs.'),
6615
help='Delete files unknown to brz (default).'),
6616
Option('dry-run', help='Show files to delete instead of'
6618
Option('force', help='Do not prompt before deleting.')]
6619
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6620
force=False, directory=u'.'):
6621
from .clean_tree import clean_tree
6622
if not (unknown or ignored or detritus):
6626
clean_tree(directory, unknown=unknown, ignored=ignored,
6627
detritus=detritus, dry_run=dry_run, no_prompt=force)
6630
class cmd_reference(Command):
6631
__doc__ = """list, view and set branch locations for nested trees.
6633
If no arguments are provided, lists the branch locations for nested trees.
6634
If one argument is provided, display the branch location for that tree.
6635
If two arguments are provided, set the branch location for that tree.
6640
takes_args = ['path?', 'location?']
6642
def run(self, path=None, location=None):
6644
if path is not None:
6646
tree, branch, relpath =(
6647
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6648
if path is not None:
6651
tree = branch.basis_tree()
6653
info = viewitems(branch._get_all_reference_info())
6654
self._display_reference_info(tree, branch, info)
6656
file_id = tree.path2id(path)
6658
raise errors.NotVersionedError(path)
6659
if location is None:
6660
info = [(file_id, branch.get_reference_info(file_id))]
6661
self._display_reference_info(tree, branch, info)
6663
branch.set_reference_info(file_id, path, location)
6665
def _display_reference_info(self, tree, branch, info):
6667
for file_id, (path, location) in info:
6669
path = tree.id2path(file_id)
6670
except errors.NoSuchId:
6672
ref_list.append((path, location))
6673
for path, location in sorted(ref_list):
6674
self.outf.write('%s %s\n' % (path, location))
6677
class cmd_export_pot(Command):
6678
__doc__ = """Export command helps and error messages in po format."""
6681
takes_options = [Option('plugin',
6682
help='Export help text from named command '\
6683
'(defaults to all built in commands).',
6685
Option('include-duplicates',
6686
help='Output multiple copies of the same msgid '
6687
'string if it appears more than once.'),
6690
def run(self, plugin=None, include_duplicates=False):
6691
from .export_pot import export_pot
6692
export_pot(self.outf, plugin, include_duplicates)
6695
class cmd_import(Command):
6696
__doc__ = """Import sources from a directory, tarball or zip file
6698
This command will import a directory, tarball or zip file into a bzr
6699
tree, replacing any versioned files already present. If a directory is
6700
specified, it is used as the target. If the directory does not exist, or
6701
is not versioned, it is created.
6703
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6705
If the tarball or zip has a single root directory, that directory is
6706
stripped when extracting the tarball. This is not done for directories.
6709
takes_args = ['source', 'tree?']
6711
def run(self, source, tree=None):
6712
from .upstream_import import do_import
6713
do_import(source, tree)
6716
class cmd_fetch_ghosts(Command):
6717
__doc__ = """Attempt to retrieve ghosts from another branch.
6719
If the other branch is not supplied, the last-pulled branch is used.
6723
aliases = ['fetch-missing']
6724
takes_args = ['branch?']
6725
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6727
def run(self, branch=None, no_fix=False):
6728
from .fetch_ghosts import GhostFetcher
6729
installed, failed = GhostFetcher.from_cmdline(branch).run()
6730
if len(installed) > 0:
6731
self.outf.write("Installed:\n")
6732
for rev in installed:
6733
self.outf.write(rev + "\n")
6735
self.outf.write("Still missing:\n")
6737
self.outf.write(rev + "\n")
6738
if not no_fix and len(installed) > 0:
6739
cmd_reconcile().run(".")
6742
def _register_lazy_builtins():
6743
# register lazy builtins from other modules; called at startup and should
6744
# be only called once.
6745
for (name, aliases, module_name) in [
6746
('cmd_bundle_info', [], 'breezy.bundle.commands'),
6747
('cmd_config', [], 'breezy.config'),
6748
('cmd_dpush', [], 'breezy.foreign'),
6749
('cmd_version_info', [], 'breezy.cmd_version_info'),
6750
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
6751
('cmd_conflicts', [], 'breezy.conflicts'),
6752
('cmd_ping', [], 'breezy.smart.ping'),
6753
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
6754
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
6755
('cmd_test_script', [], 'breezy.cmd_test_script'),
6757
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
