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
32
from . import lazy_import
33
lazy_import.lazy_import(globals(), """
38
branch as _mod_branch,
44
config as _mod_config,
51
mergeable as _mod_mergeable,
56
revision as _mod_revision,
65
from breezy.branch import Branch
66
from breezy.transport import memory
67
from breezy.smtp_connection import SMTPConnection
68
from breezy.workingtree import WorkingTree
69
from breezy.i18n import gettext, ngettext
72
from .commands import (
74
builtin_command_registry,
84
from .revisionspec import (
94
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
97
def _get_branch_location(control_dir, possible_transports=None):
98
"""Return location of branch for this control dir."""
100
target = control_dir.get_branch_reference()
101
except errors.NotBranchError:
102
return control_dir.root_transport.base
103
if target is not None:
105
this_branch = control_dir.open_branch(
106
possible_transports=possible_transports)
107
# This may be a heavy checkout, where we want the master branch
108
master_location = this_branch.get_bound_location()
109
if master_location is not None:
110
return master_location
111
# If not, use a local sibling
112
return this_branch.base
115
def _is_colocated(control_dir, possible_transports=None):
116
"""Check if the branch in control_dir is colocated.
118
:param control_dir: Control directory
119
:return: Tuple with boolean indicating whether the branch is colocated
120
and the full URL to the actual branch
122
# This path is meant to be relative to the existing branch
123
this_url = _get_branch_location(
124
control_dir, possible_transports=possible_transports)
125
# Perhaps the target control dir supports colocated branches?
127
root = controldir.ControlDir.open(
128
this_url, possible_transports=possible_transports)
129
except errors.NotBranchError:
130
return (False, this_url)
133
control_dir.open_workingtree()
134
except (errors.NoWorkingTree, errors.NotLocalUrl):
135
return (False, this_url)
138
root._format.colocated_branches and
139
control_dir.control_url == root.control_url,
143
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
144
"""Lookup the location for a new sibling branch.
146
:param control_dir: Control directory to find sibling branches from
147
:param location: Name of the new branch
148
:return: Full location to the new branch
150
location = directory_service.directories.dereference(location)
151
if '/' not in location and '\\' not in location:
152
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
155
return urlutils.join_segment_parameters(
156
this_url, {"branch": urlutils.escape(location)})
158
return urlutils.join(this_url, '..', urlutils.escape(location))
162
def open_sibling_branch(control_dir, location, possible_transports=None):
163
"""Open a branch, possibly a sibling of another.
165
:param control_dir: Control directory relative to which to lookup the
167
:param location: Location to look up
168
:return: branch to open
171
# Perhaps it's a colocated branch?
172
return control_dir.open_branch(
173
location, possible_transports=possible_transports)
174
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
175
this_url = _get_branch_location(control_dir)
178
this_url, '..', urlutils.escape(location)))
181
def open_nearby_branch(near=None, location=None, possible_transports=None):
182
"""Open a nearby branch.
184
:param near: Optional location of container from which to open branch
185
:param location: Location of the branch
186
:return: Branch instance
193
location, possible_transports=possible_transports)
194
except errors.NotBranchError:
196
cdir = controldir.ControlDir.open(
197
near, possible_transports=possible_transports)
198
return open_sibling_branch(
199
cdir, location, possible_transports=possible_transports)
202
def iter_sibling_branches(control_dir, possible_transports=None):
203
"""Iterate over the siblings of a branch.
205
:param control_dir: Control directory for which to look up the siblings
206
:return: Iterator over tuples with branch name and branch object
209
reference = control_dir.get_branch_reference()
210
except errors.NotBranchError:
212
if reference is not None:
214
ref_branch = Branch.open(
215
reference, possible_transports=possible_transports)
216
except errors.NotBranchError:
220
if ref_branch is None or ref_branch.name:
221
if ref_branch is not None:
222
control_dir = ref_branch.controldir
223
for name, branch in viewitems(control_dir.get_branches()):
226
repo = ref_branch.controldir.find_repository()
227
for branch in repo.find_branches(using=True):
228
name = urlutils.relative_url(
229
repo.user_url, branch.user_url).rstrip("/")
233
def tree_files_for_add(file_list):
235
Return a tree and list of absolute paths from a file list.
237
Similar to tree_files, but add handles files a bit differently, so it a
238
custom implementation. In particular, MutableTreeTree.smart_add expects
239
absolute paths, which it immediately converts to relative paths.
241
# FIXME Would be nice to just return the relative paths like
242
# internal_tree_files does, but there are a large number of unit tests
243
# that assume the current interface to mutabletree.smart_add
245
tree, relpath = WorkingTree.open_containing(file_list[0])
246
if tree.supports_views():
247
view_files = tree.views.lookup_view()
249
for filename in file_list:
250
if not osutils.is_inside_any(view_files, filename):
251
raise views.FileOutsideView(filename, view_files)
252
file_list = file_list[:]
253
file_list[0] = tree.abspath(relpath)
255
tree = WorkingTree.open_containing(u'.')[0]
256
if tree.supports_views():
257
view_files = tree.views.lookup_view()
259
file_list = view_files
260
view_str = views.view_display_str(view_files)
261
note(gettext("Ignoring files outside view. View is %s"),
263
return tree, file_list
266
def _get_one_revision(command_name, revisions):
267
if revisions is None:
269
if len(revisions) != 1:
270
raise errors.CommandError(gettext(
271
'brz %s --revision takes exactly one revision identifier') % (
276
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
277
"""Get a revision tree. Not suitable for commands that change the tree.
279
Specifically, the basis tree in dirstate trees is coupled to the dirstate
280
and doing a commit/uncommit/pull will at best fail due to changing the
283
If tree is passed in, it should be already locked, for lifetime management
284
of the trees internal cached state.
288
if revisions is None:
290
rev_tree = tree.basis_tree()
292
rev_tree = branch.basis_tree()
294
revision = _get_one_revision(command_name, revisions)
295
rev_tree = revision.as_tree(branch)
299
def _get_view_info_for_change_reporter(tree):
300
"""Get the view information from a tree for change reporting."""
303
current_view = tree.views.get_view_info()[0]
304
if current_view is not None:
305
view_info = (current_view, tree.views.lookup_view())
306
except views.ViewsNotSupported:
311
def _open_directory_or_containing_tree_or_branch(filename, directory):
312
"""Open the tree or branch containing the specified file, unless
313
the --directory option is used to specify a different branch."""
314
if directory is not None:
315
return (None, Branch.open(directory), filename)
316
return controldir.ControlDir.open_containing_tree_or_branch(filename)
319
# TODO: Make sure no commands unconditionally use the working directory as a
320
# branch. If a filename argument is used, the first of them should be used to
321
# specify the branch. (Perhaps this can be factored out into some kind of
322
# Argument class, representing a file in a branch, where the first occurrence
325
class cmd_status(Command):
326
__doc__ = """Display status summary.
328
This reports on versioned and unknown files, reporting them
329
grouped by state. Possible states are:
332
Versioned in the working copy but not in the previous revision.
335
Versioned in the previous revision but removed or deleted
339
Path of this file changed from the previous revision;
340
the text may also have changed. This includes files whose
341
parent directory was renamed.
344
Text has changed since the previous revision.
347
File kind has been changed (e.g. from file to directory).
350
Not versioned and not matching an ignore pattern.
352
Additionally for directories, symlinks and files with a changed
353
executable bit, Breezy indicates their type using a trailing
354
character: '/', '@' or '*' respectively. These decorations can be
355
disabled using the '--no-classify' option.
357
To see ignored files use 'brz ignored'. For details on the
358
changes to file texts, use 'brz diff'.
360
Note that --short or -S gives status flags for each item, similar
361
to Subversion's status command. To get output similar to svn -q,
364
If no arguments are specified, the status of the entire working
365
directory is shown. Otherwise, only the status of the specified
366
files or directories is reported. If a directory is given, status
367
is reported for everything inside that directory.
369
Before merges are committed, the pending merge tip revisions are
370
shown. To see all pending merge revisions, use the -v option.
371
To skip the display of pending merge information altogether, use
372
the no-pending option or specify a file/directory.
374
To compare the working directory to a specific revision, pass a
375
single revision to the revision argument.
377
To see which files have changed in a specific revision, or between
378
two revisions, pass a revision range to the revision argument.
379
This will produce the same results as calling 'brz diff --summarize'.
382
# TODO: --no-recurse/-N, --recurse options
384
takes_args = ['file*']
385
takes_options = ['show-ids', 'revision', 'change', 'verbose',
386
Option('short', help='Use short status indicators.',
388
Option('versioned', help='Only show versioned files.',
390
Option('no-pending', help='Don\'t show pending merges.'),
391
Option('no-classify',
392
help='Do not mark object type using indicator.'),
394
aliases = ['st', 'stat']
396
encoding_type = 'replace'
397
_see_also = ['diff', 'revert', 'status-flags']
400
def run(self, show_ids=False, file_list=None, revision=None, short=False,
401
versioned=False, no_pending=False, verbose=False,
403
from .status import show_tree_status
405
if revision and len(revision) > 2:
406
raise errors.CommandError(
407
gettext('brz status --revision takes exactly'
408
' one or two revision specifiers'))
410
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
411
# Avoid asking for specific files when that is not needed.
412
if relfile_list == ['']:
414
# Don't disable pending merges for full trees other than '.'.
415
if file_list == ['.']:
417
# A specific path within a tree was given.
418
elif relfile_list is not None:
420
show_tree_status(tree, show_ids=show_ids,
421
specific_files=relfile_list, revision=revision,
422
to_file=self.outf, short=short, versioned=versioned,
423
show_pending=(not no_pending), verbose=verbose,
424
classify=not no_classify)
427
class cmd_cat_revision(Command):
428
__doc__ = """Write out metadata for a revision.
430
The revision to print can either be specified by a specific
431
revision identifier, or you can use --revision.
435
takes_args = ['revision_id?']
436
takes_options = ['directory', 'revision']
437
# cat-revision is more for frontends so should be exact
440
def print_revision(self, revisions, revid):
441
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
442
record = next(stream)
443
if record.storage_kind == 'absent':
444
raise errors.NoSuchRevision(revisions, revid)
445
revtext = record.get_bytes_as('fulltext')
446
self.outf.write(revtext.decode('utf-8'))
449
def run(self, revision_id=None, revision=None, directory=u'.'):
450
if revision_id is not None and revision is not None:
451
raise errors.CommandError(gettext('You can only supply one of'
452
' revision_id or --revision'))
453
if revision_id is None and revision is None:
454
raise errors.CommandError(
455
gettext('You must supply either --revision or a revision_id'))
457
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
459
revisions = getattr(b.repository, "revisions", None)
460
if revisions is None:
461
raise errors.CommandError(
462
gettext('Repository %r does not support '
463
'access to raw revision texts') % b.repository)
465
with b.repository.lock_read():
466
# TODO: jam 20060112 should cat-revision always output utf-8?
467
if revision_id is not None:
468
revision_id = cache_utf8.encode(revision_id)
470
self.print_revision(revisions, revision_id)
471
except errors.NoSuchRevision:
473
"The repository {0} contains no revision {1}.").format(
474
b.repository.base, revision_id.decode('utf-8'))
475
raise errors.CommandError(msg)
476
elif revision is not None:
479
raise errors.CommandError(
480
gettext('You cannot specify a NULL revision.'))
481
rev_id = rev.as_revision_id(b)
482
self.print_revision(revisions, rev_id)
485
class cmd_remove_tree(Command):
486
__doc__ = """Remove the working tree from a given branch/checkout.
488
Since a lightweight checkout is little more than a working tree
489
this will refuse to run against one.
491
To re-create the working tree, use "brz checkout".
493
_see_also = ['checkout', 'working-trees']
494
takes_args = ['location*']
497
help='Remove the working tree even if it has '
498
'uncommitted or shelved changes.'),
501
def run(self, location_list, force=False):
502
if not location_list:
503
location_list = ['.']
505
for location in location_list:
506
d = controldir.ControlDir.open(location)
509
working = d.open_workingtree()
510
except errors.NoWorkingTree:
511
raise errors.CommandError(
512
gettext("No working tree to remove"))
513
except errors.NotLocalUrl:
514
raise errors.CommandError(
515
gettext("You cannot remove the working tree"
516
" of a remote path"))
518
if (working.has_changes()):
519
raise errors.UncommittedChanges(working)
520
if working.get_shelf_manager().last_shelf() is not None:
521
raise errors.ShelvedChanges(working)
523
if working.user_url != working.branch.user_url:
524
raise errors.CommandError(
525
gettext("You cannot remove the working tree"
526
" from a lightweight checkout"))
528
d.destroy_workingtree()
531
class cmd_repair_workingtree(Command):
532
__doc__ = """Reset the working tree state file.
534
This is not meant to be used normally, but more as a way to recover from
535
filesystem corruption, etc. This rebuilds the working inventory back to a
536
'known good' state. Any new modifications (adding a file, renaming, etc)
537
will be lost, though modified files will still be detected as such.
539
Most users will want something more like "brz revert" or "brz update"
540
unless the state file has become corrupted.
542
By default this attempts to recover the current state by looking at the
543
headers of the state file. If the state file is too corrupted to even do
544
that, you can supply --revision to force the state of the tree.
548
'revision', 'directory',
550
help='Reset the tree even if it doesn\'t appear to be'
555
def run(self, revision=None, directory='.', force=False):
556
tree, _ = WorkingTree.open_containing(directory)
557
self.enter_context(tree.lock_tree_write())
561
except errors.BzrError:
562
pass # There seems to be a real error here, so we'll reset
565
raise errors.CommandError(gettext(
566
'The tree does not appear to be corrupt. You probably'
567
' want "brz revert" instead. Use "--force" if you are'
568
' sure you want to reset the working tree.'))
572
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
574
tree.reset_state(revision_ids)
575
except errors.BzrError:
576
if revision_ids is None:
577
extra = gettext(', the header appears corrupt, try passing '
578
'-r -1 to set the state to the last commit')
581
raise errors.CommandError(
582
gettext('failed to reset the tree state{0}').format(extra))
585
class cmd_revno(Command):
586
__doc__ = """Show current revision number.
588
This is equal to the number of revisions on this branch.
592
takes_args = ['location?']
594
Option('tree', help='Show revno of working tree.'),
599
def run(self, tree=False, location=u'.', revision=None):
600
if revision is not None and tree:
601
raise errors.CommandError(
602
gettext("--tree and --revision can not be used together"))
606
wt = WorkingTree.open_containing(location)[0]
607
self.enter_context(wt.lock_read())
608
except (errors.NoWorkingTree, errors.NotLocalUrl):
609
raise errors.NoWorkingTree(location)
611
revid = wt.last_revision()
613
b = Branch.open_containing(location)[0]
614
self.enter_context(b.lock_read())
616
if len(revision) != 1:
617
raise errors.CommandError(gettext(
618
"Revision numbers only make sense for single "
619
"revisions, not ranges"))
620
revid = revision[0].as_revision_id(b)
622
revid = b.last_revision()
624
revno_t = b.revision_id_to_dotted_revno(revid)
625
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
627
revno = ".".join(str(n) for n in revno_t)
629
self.outf.write(revno + '\n')
632
class cmd_revision_info(Command):
633
__doc__ = """Show revision number and revision id for a given revision identifier.
636
takes_args = ['revision_info*']
639
custom_help('directory', help='Branch to examine, '
640
'rather than the one containing the working directory.'),
641
Option('tree', help='Show revno of working tree.'),
645
def run(self, revision=None, directory=u'.', tree=False,
646
revision_info_list=[]):
649
wt = WorkingTree.open_containing(directory)[0]
651
self.enter_context(wt.lock_read())
652
except (errors.NoWorkingTree, errors.NotLocalUrl):
654
b = Branch.open_containing(directory)[0]
655
self.enter_context(b.lock_read())
657
if revision is not None:
658
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
659
if revision_info_list is not None:
660
for rev_str in revision_info_list:
661
rev_spec = RevisionSpec.from_string(rev_str)
662
revision_ids.append(rev_spec.as_revision_id(b))
663
# No arguments supplied, default to the last revision
664
if len(revision_ids) == 0:
667
raise errors.NoWorkingTree(directory)
668
revision_ids.append(wt.last_revision())
670
revision_ids.append(b.last_revision())
674
for revision_id in revision_ids:
676
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
677
revno = '.'.join(str(i) for i in dotted_revno)
678
except errors.NoSuchRevision:
680
maxlen = max(maxlen, len(revno))
681
revinfos.append((revno, revision_id))
684
for revno, revid in revinfos:
686
'%*s %s\n' % (maxlen, revno, revid.decode('utf-8')))
689
class cmd_add(Command):
690
__doc__ = """Add specified files or directories.
692
In non-recursive mode, all the named items are added, regardless
693
of whether they were previously ignored. A warning is given if
694
any of the named files are already versioned.
696
In recursive mode (the default), files are treated the same way
697
but the behaviour for directories is different. Directories that
698
are already versioned do not give a warning. All directories,
699
whether already versioned or not, are searched for files or
700
subdirectories that are neither versioned or ignored, and these
701
are added. This search proceeds recursively into versioned
702
directories. If no names are given '.' is assumed.
704
A warning will be printed when nested trees are encountered,
705
unless they are explicitly ignored.
707
Therefore simply saying 'brz add' will version all files that
708
are currently unknown.
710
Adding a file whose parent directory is not versioned will
711
implicitly add the parent, and so on up to the root. This means
712
you should never need to explicitly add a directory, they'll just
713
get added when you add a file in the directory.
715
--dry-run will show which files would be added, but not actually
718
--file-ids-from will try to use the file ids from the supplied path.
719
It looks up ids trying to find a matching parent directory with the
720
same filename, and then by pure path. This option is rarely needed
721
but can be useful when adding the same logical file into two
722
branches that will be merged later (without showing the two different
723
adds as a conflict). It is also useful when merging another project
724
into a subdirectory of this one.
726
Any files matching patterns in the ignore list will not be added
727
unless they are explicitly mentioned.
729
In recursive mode, files larger than the configuration option
730
add.maximum_file_size will be skipped. Named items are never skipped due
733
takes_args = ['file*']
736
help="Don't recursively add the contents of directories.",
739
help="Show what would be done, but don't actually do "
742
Option('file-ids-from',
744
help='Lookup file ids from this tree.'),
746
encoding_type = 'replace'
747
_see_also = ['remove', 'ignore']
749
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
752
tree, file_list = tree_files_for_add(file_list)
754
if file_ids_from is not None and not tree.supports_setting_file_ids():
756
gettext('Ignoring --file-ids-from, since the tree does not '
757
'support setting file ids.'))
761
if file_ids_from is not None:
763
base_tree, base_path = WorkingTree.open_containing(
765
except errors.NoWorkingTree:
766
base_branch, base_path = Branch.open_containing(
768
base_tree = base_branch.basis_tree()
770
action = breezy.add.AddFromBaseAction(
771
base_tree, base_path, to_file=self.outf,
772
should_print=(not is_quiet()))
774
action = breezy.add.AddWithSkipLargeAction(
775
to_file=self.outf, should_print=(not is_quiet()))
778
self.enter_context(base_tree.lock_read())
779
added, ignored = tree.smart_add(
780
file_list, not no_recurse, action=action, save=not dry_run)
784
for glob in sorted(ignored):
785
for path in ignored[glob]:
787
gettext("ignored {0} matching \"{1}\"\n").format(
791
class cmd_mkdir(Command):
792
__doc__ = """Create a new versioned directory.
794
This is equivalent to creating the directory and then adding it.
797
takes_args = ['dir+']
801
help='No error if existing, make parent directories as needed.',
805
encoding_type = 'replace'
808
def add_file_with_parents(cls, wt, relpath):
809
if wt.is_versioned(relpath):
811
cls.add_file_with_parents(wt, osutils.dirname(relpath))
815
def add_file_single(cls, wt, relpath):
818
def run(self, dir_list, parents=False):
820
add_file = self.add_file_with_parents
822
add_file = self.add_file_single
824
wt, relpath = WorkingTree.open_containing(dir)
829
if e.errno != errno.EEXIST:
833
add_file(wt, relpath)
835
self.outf.write(gettext('added %s\n') % dir)
838
class cmd_relpath(Command):
839
__doc__ = """Show path of a file relative to root"""
841
takes_args = ['filename']
845
def run(self, filename):
846
# TODO: jam 20050106 Can relpath return a munged path if
847
# sys.stdout encoding cannot represent it?
848
tree, relpath = WorkingTree.open_containing(filename)
849
self.outf.write(relpath)
850
self.outf.write('\n')
853
class cmd_inventory(Command):
854
__doc__ = """Show inventory of the current working copy or a revision.
856
It is possible to limit the output to a particular entry
857
type using the --kind option. For example: --kind file.
859
It is also possible to restrict the list of files to a specific
860
set. For example: brz inventory --show-ids this/file
868
Option('include-root',
869
help='Include the entry for the root of the tree, if any.'),
871
help='List entries of a particular kind: file, directory, '
875
takes_args = ['file*']
878
def run(self, revision=None, show_ids=False, kind=None, include_root=False,
880
if kind and kind not in ['file', 'directory', 'symlink']:
881
raise errors.CommandError(
882
gettext('invalid kind %r specified') % (kind,))
884
revision = _get_one_revision('inventory', revision)
885
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
886
self.enter_context(work_tree.lock_read())
887
if revision is not None:
888
tree = revision.as_tree(work_tree.branch)
890
extra_trees = [work_tree]
891
self.enter_context(tree.lock_read())
896
self.enter_context(tree.lock_read())
897
if file_list is not None:
898
paths = tree.find_related_paths_across_trees(
899
file_list, extra_trees, require_versioned=True)
900
# find_ids_across_trees may include some paths that don't
902
entries = tree.iter_entries_by_dir(specific_files=paths)
904
entries = tree.iter_entries_by_dir()
906
for path, entry in sorted(entries):
907
if kind and kind != entry.kind:
909
if path == "" and not include_root:
912
self.outf.write('%-50s %s\n' % (
913
path, entry.file_id.decode('utf-8')))
915
self.outf.write(path)
916
self.outf.write('\n')
919
class cmd_cp(Command):
920
__doc__ = """Copy a file.
923
brz cp OLDNAME NEWNAME
925
brz cp SOURCE... DESTINATION
927
If the last argument is a versioned directory, all the other names
928
are copied into it. Otherwise, there must be exactly two arguments
929
and the file is copied to a new name.
931
Files cannot be copied between branches. Only files can be copied
935
takes_args = ['names*']
938
encoding_type = 'replace'
940
def run(self, names_list):
941
if names_list is None:
943
if len(names_list) < 2:
944
raise errors.CommandError(gettext("missing file argument"))
945
tree, rel_names = WorkingTree.open_containing_paths(
946
names_list, canonicalize=False)
947
for file_name in rel_names[0:-1]:
949
raise errors.CommandError(
950
gettext("can not copy root of branch"))
951
self.enter_context(tree.lock_tree_write())
952
into_existing = osutils.isdir(names_list[-1])
953
if not into_existing:
955
(src, dst) = rel_names
957
raise errors.CommandError(
958
gettext('to copy multiple files the'
959
' destination must be a versioned'
964
(n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
965
for n in rel_names[:-1]]
967
for src, dst in pairs:
969
src_kind = tree.stored_kind(src)
970
except errors.NoSuchFile:
971
raise errors.CommandError(
972
gettext('Could not copy %s => %s: %s is not versioned.')
975
raise errors.CommandError(
976
gettext('Could not copy %s => %s . %s is not versioned\\.'
978
if src_kind == 'directory':
979
raise errors.CommandError(
980
gettext('Could not copy %s => %s . %s is a directory.'
982
dst_parent = osutils.split(dst)[0]
985
dst_parent_kind = tree.stored_kind(dst_parent)
986
except errors.NoSuchFile:
987
raise errors.CommandError(
988
gettext('Could not copy %s => %s: %s is not versioned.')
989
% (src, dst, dst_parent))
990
if dst_parent_kind != 'directory':
991
raise errors.CommandError(
992
gettext('Could not copy to %s: %s is not a directory.')
993
% (dst_parent, dst_parent))
995
tree.copy_one(src, dst)
998
class cmd_mv(Command):
999
__doc__ = """Move or rename a file.
1002
brz mv OLDNAME NEWNAME
1004
brz mv SOURCE... DESTINATION
1006
If the last argument is a versioned directory, all the other names
1007
are moved into it. Otherwise, there must be exactly two arguments
1008
and the file is changed to a new name.
1010
If OLDNAME does not exist on the filesystem but is versioned and
1011
NEWNAME does exist on the filesystem but is not versioned, mv
1012
assumes that the file has been manually moved and only updates
1013
its internal inventory to reflect that change.
1014
The same is valid when moving many SOURCE files to a DESTINATION.
1016
Files cannot be moved between branches.
1019
takes_args = ['names*']
1020
takes_options = [Option("after", help="Move only the brz identifier"
1021
" of the file, because the file has already been moved."),
1022
Option('auto', help='Automatically guess renames.'),
1024
'dry-run', help='Avoid making changes when guessing renames.'),
1026
aliases = ['move', 'rename']
1027
encoding_type = 'replace'
1029
def run(self, names_list, after=False, auto=False, dry_run=False):
1031
return self.run_auto(names_list, after, dry_run)
1033
raise errors.CommandError(gettext('--dry-run requires --auto.'))
1034
if names_list is None:
1036
if len(names_list) < 2:
1037
raise errors.CommandError(gettext("missing file argument"))
1038
tree, rel_names = WorkingTree.open_containing_paths(
1039
names_list, canonicalize=False)
1040
for file_name in rel_names[0:-1]:
1042
raise errors.CommandError(
1043
gettext("can not move root of branch"))
1044
self.enter_context(tree.lock_tree_write())
1045
self._run(tree, names_list, rel_names, after)
1047
def run_auto(self, names_list, after, dry_run):
1048
if names_list is not None and len(names_list) > 1:
1049
raise errors.CommandError(
1050
gettext('Only one path may be specified to --auto.'))
1052
raise errors.CommandError(
1053
gettext('--after cannot be specified with --auto.'))
1054
work_tree, file_list = WorkingTree.open_containing_paths(
1055
names_list, default_directory='.')
1056
self.enter_context(work_tree.lock_tree_write())
1057
rename_map.RenameMap.guess_renames(
1058
work_tree.basis_tree(), work_tree, dry_run)
1060
def _run(self, tree, names_list, rel_names, after):
1061
into_existing = osutils.isdir(names_list[-1])
1062
if into_existing and len(names_list) == 2:
1064
# a. case-insensitive filesystem and change case of dir
1065
# b. move directory after the fact (if the source used to be
1066
# a directory, but now doesn't exist in the working tree
1067
# and the target is an existing directory, just rename it)
1068
if (not tree.case_sensitive
1069
and rel_names[0].lower() == rel_names[1].lower()):
1070
into_existing = False
1072
# 'fix' the case of a potential 'from'
1073
from_path = tree.get_canonical_path(rel_names[0])
1074
if (not osutils.lexists(names_list[0]) and
1075
tree.is_versioned(from_path) and
1076
tree.stored_kind(from_path) == "directory"):
1077
into_existing = False
1080
# move into existing directory
1081
# All entries reference existing inventory items, so fix them up
1082
# for cicp file-systems.
1083
rel_names = list(tree.get_canonical_paths(rel_names))
1084
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1086
self.outf.write("%s => %s\n" % (src, dest))
1088
if len(names_list) != 2:
1089
raise errors.CommandError(gettext('to mv multiple files the'
1090
' destination must be a versioned'
1093
# for cicp file-systems: the src references an existing inventory
1095
src = tree.get_canonical_path(rel_names[0])
1096
# Find the canonical version of the destination: In all cases, the
1097
# parent of the target must be in the inventory, so we fetch the
1098
# canonical version from there (we do not always *use* the
1099
# canonicalized tail portion - we may be attempting to rename the
1101
canon_dest = tree.get_canonical_path(rel_names[1])
1102
dest_parent = osutils.dirname(canon_dest)
1103
spec_tail = osutils.basename(rel_names[1])
1104
# For a CICP file-system, we need to avoid creating 2 inventory
1105
# entries that differ only by case. So regardless of the case
1106
# we *want* to use (ie, specified by the user or the file-system),
1107
# we must always choose to use the case of any existing inventory
1108
# items. The only exception to this is when we are attempting a
1109
# case-only rename (ie, canonical versions of src and dest are
1111
dest_id = tree.path2id(canon_dest)
1112
if dest_id is None or tree.path2id(src) == dest_id:
1113
# No existing item we care about, so work out what case we
1114
# are actually going to use.
1116
# If 'after' is specified, the tail must refer to a file on disk.
1118
dest_parent_fq = osutils.pathjoin(
1119
tree.basedir, dest_parent)
1121
# pathjoin with an empty tail adds a slash, which breaks
1123
dest_parent_fq = tree.basedir
1125
dest_tail = osutils.canonical_relpath(
1127
osutils.pathjoin(dest_parent_fq, spec_tail))
1129
# not 'after', so case as specified is used
1130
dest_tail = spec_tail
1132
# Use the existing item so 'mv' fails with AlreadyVersioned.
1133
dest_tail = os.path.basename(canon_dest)
1134
dest = osutils.pathjoin(dest_parent, dest_tail)
1135
mutter("attempting to move %s => %s", src, dest)
1136
tree.rename_one(src, dest, after=after)
1138
self.outf.write("%s => %s\n" % (src, dest))
1141
class cmd_pull(Command):
1142
__doc__ = """Turn this branch into a mirror of another branch.
1144
By default, this command only works on branches that have not diverged.
1145
Branches are considered diverged if the destination branch's most recent
1146
commit is one that has not been merged (directly or indirectly) into the
1149
If branches have diverged, you can use 'brz merge' to integrate the changes
1150
from one into the other. Once one branch has merged, the other should
1151
be able to pull it again.
1153
If you want to replace your local changes and just want your branch to
1154
match the remote one, use pull --overwrite. This will work even if the two
1155
branches have diverged.
1157
If there is no default location set, the first pull will set it (use
1158
--no-remember to avoid setting it). After that, you can omit the
1159
location to use the default. To change the default, use --remember. The
1160
value will only be saved if the remote location can be accessed.
1162
The --verbose option will display the revisions pulled using the log_format
1163
configuration option. You can use a different format by overriding it with
1164
-Olog_format=<other_format>.
1166
Note: The location can be specified either in the form of a branch,
1167
or in the form of a path to a file containing a merge directive generated
1171
_see_also = ['push', 'update', 'status-flags', 'send']
1172
takes_options = ['remember', 'overwrite', 'revision',
1173
custom_help('verbose',
1174
help='Show logs of pulled revisions.'),
1175
custom_help('directory',
1176
help='Branch to pull into, '
1177
'rather than the one containing the working directory.'),
1179
help="Perform a local pull in a bound "
1180
"branch. Local pulls are not applied to "
1181
"the master branch."
1184
help="Show base revision text in conflicts."),
1185
Option('overwrite-tags',
1186
help="Overwrite tags only."),
1188
takes_args = ['location?']
1189
encoding_type = 'replace'
1191
def run(self, location=None, remember=None, overwrite=False,
1192
revision=None, verbose=False,
1193
directory=None, local=False,
1194
show_base=False, overwrite_tags=False):
1197
overwrite = ["history", "tags"]
1198
elif overwrite_tags:
1199
overwrite = ["tags"]
1202
# FIXME: too much stuff is in the command class
1205
if directory is None:
1208
tree_to = WorkingTree.open_containing(directory)[0]
1209
branch_to = tree_to.branch
1210
self.enter_context(tree_to.lock_write())
1211
except errors.NoWorkingTree:
1213
branch_to = Branch.open_containing(directory)[0]
1214
self.enter_context(branch_to.lock_write())
1216
warning(gettext("No working tree, ignoring --show-base"))
1218
if local and not branch_to.get_bound_location():
1219
raise errors.LocalRequiresBoundBranch()
1221
possible_transports = []
1222
if location is not None:
1224
mergeable = _mod_mergeable.read_mergeable_from_url(
1225
location, possible_transports=possible_transports)
1226
except errors.NotABundle:
1229
stored_loc = branch_to.get_parent()
1230
if location is None:
1231
if stored_loc is None:
1232
raise errors.CommandError(gettext("No pull location known or"
1235
display_url = urlutils.unescape_for_display(stored_loc,
1239
gettext("Using saved parent location: %s\n") % display_url)
1240
location = stored_loc
1242
revision = _get_one_revision('pull', revision)
1243
if mergeable is not None:
1244
if revision is not None:
1245
raise errors.CommandError(gettext(
1246
'Cannot use -r with merge directives or bundles'))
1247
mergeable.install_revisions(branch_to.repository)
1248
base_revision_id, revision_id, verified = \
1249
mergeable.get_merge_request(branch_to.repository)
1250
branch_from = branch_to
1252
branch_from = Branch.open(location,
1253
possible_transports=possible_transports)
1254
self.enter_context(branch_from.lock_read())
1255
# Remembers if asked explicitly or no previous location is set
1257
or (remember is None and branch_to.get_parent() is None)):
1258
# FIXME: This shouldn't be done before the pull
1259
# succeeds... -- vila 2012-01-02
1260
branch_to.set_parent(branch_from.base)
1262
if revision is not None:
1263
revision_id = revision.as_revision_id(branch_from)
1265
if tree_to is not None:
1266
view_info = _get_view_info_for_change_reporter(tree_to)
1267
change_reporter = delta._ChangeReporter(
1268
unversioned_filter=tree_to.is_ignored,
1269
view_info=view_info)
1270
result = tree_to.pull(
1271
branch_from, overwrite, revision_id, change_reporter,
1272
local=local, show_base=show_base)
1274
result = branch_to.pull(
1275
branch_from, overwrite, revision_id, local=local)
1277
result.report(self.outf)
1278
if verbose and result.old_revid != result.new_revid:
1279
log.show_branch_change(
1280
branch_to, self.outf, result.old_revno,
1282
if getattr(result, 'tag_conflicts', None):
1288
class cmd_push(Command):
1289
__doc__ = """Update a mirror of this branch.
1291
The target branch will not have its working tree populated because this
1292
is both expensive, and is not supported on remote file systems.
1294
Some smart servers or protocols *may* put the working tree in place in
1297
This command only works on branches that have not diverged. Branches are
1298
considered diverged if the destination branch's most recent commit is one
1299
that has not been merged (directly or indirectly) by the source branch.
1301
If branches have diverged, you can use 'brz push --overwrite' to replace
1302
the other branch completely, discarding its unmerged changes.
1304
If you want to ensure you have the different changes in the other branch,
1305
do a merge (see brz help merge) from the other branch, and commit that.
1306
After that you will be able to do a push without '--overwrite'.
1308
If there is no default push location set, the first push will set it (use
1309
--no-remember to avoid setting it). After that, you can omit the
1310
location to use the default. To change the default, use --remember. The
1311
value will only be saved if the remote location can be accessed.
1313
The --verbose option will display the revisions pushed using the log_format
1314
configuration option. You can use a different format by overriding it with
1315
-Olog_format=<other_format>.
1318
_see_also = ['pull', 'update', 'working-trees']
1319
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1320
Option('create-prefix',
1321
help='Create the path leading up to the branch '
1322
'if it does not already exist.'),
1323
custom_help('directory',
1324
help='Branch to push from, '
1325
'rather than the one containing the working directory.'),
1326
Option('use-existing-dir',
1327
help='By default push will fail if the target'
1328
' directory exists, but does not already'
1329
' have a control directory. This flag will'
1330
' allow push to proceed.'),
1332
help='Create a stacked branch that references the public location '
1333
'of the parent branch.'),
1334
Option('stacked-on',
1335
help='Create a stacked branch that refers to another branch '
1336
'for the commit history. Only the work not present in the '
1337
'referenced branch is included in the branch created.',
1340
help='Refuse to push if there are uncommitted changes in'
1341
' the working tree, --no-strict disables the check.'),
1343
help="Don't populate the working tree, even for protocols"
1344
" that support it."),
1345
Option('overwrite-tags',
1346
help="Overwrite tags only."),
1347
Option('lossy', help="Allow lossy push, i.e. dropping metadata "
1348
"that can't be represented in the target.")
1350
takes_args = ['location?']
1351
encoding_type = 'replace'
1353
def run(self, location=None, remember=None, overwrite=False,
1354
create_prefix=False, verbose=False, revision=None,
1355
use_existing_dir=False, directory=None, stacked_on=None,
1356
stacked=False, strict=None, no_tree=False,
1357
overwrite_tags=False, lossy=False):
1358
from .location import location_to_url
1359
from .push import _show_push_branch
1362
overwrite = ["history", "tags"]
1363
elif overwrite_tags:
1364
overwrite = ["tags"]
1368
if directory is None:
1370
# Get the source branch
1372
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1373
# Get the tip's revision_id
1374
revision = _get_one_revision('push', revision)
1375
if revision is not None:
1376
revision_id = revision.in_history(br_from).rev_id
1379
if tree is not None and revision_id is None:
1380
tree.check_changed_or_out_of_date(
1381
strict, 'push_strict',
1382
more_error='Use --no-strict to force the push.',
1383
more_warning='Uncommitted changes will not be pushed.')
1384
# Get the stacked_on branch, if any
1385
if stacked_on is not None:
1386
stacked_on = location_to_url(stacked_on, 'read')
1387
stacked_on = urlutils.normalize_url(stacked_on)
1389
parent_url = br_from.get_parent()
1391
parent = Branch.open(parent_url)
1392
stacked_on = parent.get_public_branch()
1394
# I considered excluding non-http url's here, thus forcing
1395
# 'public' branches only, but that only works for some
1396
# users, so it's best to just depend on the user spotting an
1397
# error by the feedback given to them. RBC 20080227.
1398
stacked_on = parent_url
1400
raise errors.CommandError(gettext(
1401
"Could not determine branch to refer to."))
1403
# Get the destination location
1404
if location is None:
1405
stored_loc = br_from.get_push_location()
1406
if stored_loc is None:
1407
parent_loc = br_from.get_parent()
1409
raise errors.CommandError(gettext(
1410
"No push location known or specified. To push to the "
1411
"parent branch (at %s), use 'brz push :parent'." %
1412
urlutils.unescape_for_display(parent_loc,
1413
self.outf.encoding)))
1415
raise errors.CommandError(gettext(
1416
"No push location known or specified."))
1418
display_url = urlutils.unescape_for_display(stored_loc,
1420
note(gettext("Using saved push location: %s") % display_url)
1421
location = stored_loc
1423
_show_push_branch(br_from, revision_id, location, self.outf,
1424
verbose=verbose, overwrite=overwrite, remember=remember,
1425
stacked_on=stacked_on, create_prefix=create_prefix,
1426
use_existing_dir=use_existing_dir, no_tree=no_tree,
1430
class cmd_branch(Command):
1431
__doc__ = """Create a new branch that is a copy of an existing branch.
1433
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1434
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1435
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1436
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1437
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1440
To retrieve the branch as of a particular revision, supply the --revision
1441
parameter, as in "branch foo/bar -r 5".
1445
_see_also = ['checkout']
1446
takes_args = ['from_location', 'to_location?']
1447
takes_options = ['revision',
1449
'hardlink', help='Hard-link working tree files where possible.'),
1450
Option('files-from', type=text_type,
1451
help="Get file contents from this tree."),
1453
help="Create a branch without a working-tree."),
1455
help="Switch the checkout in the current directory "
1456
"to the new branch."),
1458
help='Create a stacked branch referring to the source branch. '
1459
'The new branch will depend on the availability of the source '
1460
'branch for all operations.'),
1461
Option('standalone',
1462
help='Do not use a shared repository, even if available.'),
1463
Option('use-existing-dir',
1464
help='By default branch will fail if the target'
1465
' directory exists, but does not already'
1466
' have a control directory. This flag will'
1467
' allow branch to proceed.'),
1469
help="Bind new branch to from location."),
1470
Option('no-recurse-nested',
1471
help='Do not recursively check out nested trees.'),
1472
Option('colocated-branch', short_name='b',
1473
type=str, help='Name of colocated branch to sprout.'),
1476
def run(self, from_location, to_location=None, revision=None,
1477
hardlink=False, stacked=False, standalone=False, no_tree=False,
1478
use_existing_dir=False, switch=False, bind=False,
1479
files_from=None, no_recurse_nested=False, colocated_branch=None):
1480
from breezy import switch as _mod_switch
1481
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1482
from_location, name=colocated_branch)
1483
if no_recurse_nested:
1487
if not (hardlink or files_from):
1488
# accelerator_tree is usually slower because you have to read N
1489
# files (no readahead, lots of seeks, etc), but allow the user to
1490
# explicitly request it
1491
accelerator_tree = None
1492
if files_from is not None and files_from != from_location:
1493
accelerator_tree = WorkingTree.open(files_from)
1494
revision = _get_one_revision('branch', revision)
1495
self.enter_context(br_from.lock_read())
1496
if revision is not None:
1497
revision_id = revision.as_revision_id(br_from)
1499
# FIXME - wt.last_revision, fallback to branch, fall back to
1500
# None or perhaps NULL_REVISION to mean copy nothing
1502
revision_id = br_from.last_revision()
1503
if to_location is None:
1504
to_location = urlutils.derive_to_location(from_location)
1505
to_transport = transport.get_transport(to_location, purpose='write')
1507
to_transport.mkdir('.')
1508
except errors.FileExists:
1510
to_dir = controldir.ControlDir.open_from_transport(
1512
except errors.NotBranchError:
1513
if not use_existing_dir:
1514
raise errors.CommandError(gettext('Target directory "%s" '
1515
'already exists.') % to_location)
1520
to_dir.open_branch()
1521
except errors.NotBranchError:
1524
raise errors.AlreadyBranchError(to_location)
1525
except errors.NoSuchFile:
1526
raise errors.CommandError(gettext('Parent of "%s" does not exist.')
1532
# preserve whatever source format we have.
1533
to_dir = br_from.controldir.sprout(
1534
to_transport.base, revision_id,
1535
possible_transports=[to_transport],
1536
accelerator_tree=accelerator_tree, hardlink=hardlink,
1537
stacked=stacked, force_new_repo=standalone,
1538
create_tree_if_local=not no_tree, source_branch=br_from,
1540
branch = to_dir.open_branch(
1541
possible_transports=[
1542
br_from.controldir.root_transport, to_transport])
1543
except errors.NoSuchRevision:
1544
to_transport.delete_tree('.')
1545
msg = gettext("The branch {0} has no revision {1}.").format(
1546
from_location, revision)
1547
raise errors.CommandError(msg)
1550
to_repo = to_dir.open_repository()
1551
except errors.NoRepositoryPresent:
1552
to_repo = to_dir.create_repository()
1553
to_repo.fetch(br_from.repository, revision_id=revision_id)
1554
branch = br_from.sprout(
1555
to_dir, revision_id=revision_id)
1556
br_from.tags.merge_to(branch.tags)
1558
# If the source branch is stacked, the new branch may
1559
# be stacked whether we asked for that explicitly or not.
1560
# We therefore need a try/except here and not just 'if stacked:'
1562
note(gettext('Created new stacked branch referring to %s.') %
1563
branch.get_stacked_on_url())
1564
except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
1565
errors.UnstackableRepositoryFormat) as e:
1566
revno = branch.revno()
1567
if revno is not None:
1568
note(ngettext('Branched %d revision.',
1569
'Branched %d revisions.',
1570
branch.revno()) % revno)
1572
note(gettext('Created new branch.'))
1574
# Bind to the parent
1575
parent_branch = Branch.open(from_location)
1576
branch.bind(parent_branch)
1577
note(gettext('New branch bound to %s') % from_location)
1579
# Switch to the new branch
1580
wt, _ = WorkingTree.open_containing('.')
1581
_mod_switch.switch(wt.controldir, branch)
1582
note(gettext('Switched to branch: %s'),
1583
urlutils.unescape_for_display(branch.base, 'utf-8'))
1586
class cmd_branches(Command):
1587
__doc__ = """List the branches available at the current location.
1589
This command will print the names of all the branches at the current
1593
takes_args = ['location?']
1595
Option('recursive', short_name='R',
1596
help='Recursively scan for branches rather than '
1597
'just looking in the specified location.')]
1599
def run(self, location=".", recursive=False):
1601
t = transport.get_transport(location, purpose='read')
1602
if not t.listable():
1603
raise errors.CommandError(
1604
"Can't scan this type of location.")
1605
for b in controldir.ControlDir.find_branches(t):
1606
self.outf.write("%s\n" % urlutils.unescape_for_display(
1607
urlutils.relative_url(t.base, b.base),
1608
self.outf.encoding).rstrip("/"))
1610
dir = controldir.ControlDir.open_containing(location)[0]
1612
active_branch = dir.open_branch(name="")
1613
except errors.NotBranchError:
1614
active_branch = None
1616
for name, branch in iter_sibling_branches(dir):
1619
active = (active_branch is not None and
1620
active_branch.user_url == branch.user_url)
1621
names[name] = active
1622
# Only mention the current branch explicitly if it's not
1623
# one of the colocated branches
1624
if not any(viewvalues(names)) and active_branch is not None:
1625
self.outf.write("* %s\n" % gettext("(default)"))
1626
for name in sorted(names):
1627
active = names[name]
1632
self.outf.write("%s %s\n" % (
1633
prefix, (name if PY3 else name.encode(self.outf.encoding))))
1636
class cmd_checkout(Command):
1637
__doc__ = """Create a new checkout of an existing branch.
1639
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree
1640
for the branch found in '.'. This is useful if you have removed the working
1641
tree or if it was never created - i.e. if you pushed the branch to its
1642
current location using SFTP.
1644
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION
1645
will be used. In other words, "checkout ../foo/bar" will attempt to create
1646
./bar. If the BRANCH_LOCATION has no / or path separator embedded, the
1647
TO_LOCATION is derived from the BRANCH_LOCATION by stripping a leading
1648
scheme or drive identifier, if any. For example, "checkout lp:foo-bar" will
1649
attempt to create ./foo-bar.
1651
To retrieve the branch as of a particular revision, supply the --revision
1652
parameter, as in "checkout foo/bar -r 5". Note that this will be
1653
immediately out of date [so you cannot commit] but it may be useful (i.e.
1654
to examine old code.)
1657
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1658
takes_args = ['branch_location?', 'to_location?']
1659
takes_options = ['revision',
1660
Option('lightweight',
1661
help="Perform a lightweight checkout. Lightweight "
1662
"checkouts depend on access to the branch for "
1663
"every operation. Normal checkouts can perform "
1664
"common operations like diff and status without "
1665
"such access, and also support local commits."
1667
Option('files-from', type=text_type,
1668
help="Get file contents from this tree."),
1670
help='Hard-link working tree files where possible.'
1675
def run(self, branch_location=None, to_location=None, revision=None,
1676
lightweight=False, files_from=None, hardlink=False):
1677
if branch_location is None:
1678
branch_location = osutils.getcwd()
1679
to_location = branch_location
1680
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1682
if not (hardlink or files_from):
1683
# accelerator_tree is usually slower because you have to read N
1684
# files (no readahead, lots of seeks, etc), but allow the user to
1685
# explicitly request it
1686
accelerator_tree = None
1687
revision = _get_one_revision('checkout', revision)
1688
if files_from is not None and files_from != branch_location:
1689
accelerator_tree = WorkingTree.open(files_from)
1690
if revision is not None:
1691
revision_id = revision.as_revision_id(source)
1694
if to_location is None:
1695
to_location = urlutils.derive_to_location(branch_location)
1696
# if the source and to_location are the same,
1697
# and there is no working tree,
1698
# then reconstitute a branch
1699
if osutils.abspath(to_location) == osutils.abspath(branch_location):
1701
source.controldir.open_workingtree()
1702
except errors.NoWorkingTree:
1703
source.controldir.create_workingtree(revision_id)
1705
source.create_checkout(to_location, revision_id, lightweight,
1706
accelerator_tree, hardlink)
1709
class cmd_clone(Command):
1710
__doc__ = """Clone a control directory.
1713
takes_args = ['from_location', 'to_location?']
1714
takes_options = ['revision',
1715
Option('no-recurse-nested',
1716
help='Do not recursively check out nested trees.'),
1719
def run(self, from_location, to_location=None, revision=None, no_recurse_nested=False):
1720
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1722
if no_recurse_nested:
1726
revision = _get_one_revision('branch', revision)
1727
self.enter_context(br_from.lock_read())
1728
if revision is not None:
1729
revision_id = revision.as_revision_id(br_from)
1731
# FIXME - wt.last_revision, fallback to branch, fall back to
1732
# None or perhaps NULL_REVISION to mean copy nothing
1734
revision_id = br_from.last_revision()
1735
if to_location is None:
1736
to_location = urlutils.derive_to_location(from_location)
1737
target_controldir = br_from.controldir.clone(to_location, revision_id=revision_id)
1738
note(gettext('Created new control directory.'))
1741
class cmd_renames(Command):
1742
__doc__ = """Show list of renamed files.
1744
# TODO: Option to show renames between two historical versions.
1746
# TODO: Only show renames under dir, rather than in the whole branch.
1747
_see_also = ['status']
1748
takes_args = ['dir?']
1751
def run(self, dir=u'.'):
1752
tree = WorkingTree.open_containing(dir)[0]
1753
self.enter_context(tree.lock_read())
1754
old_tree = tree.basis_tree()
1755
self.enter_context(old_tree.lock_read())
1757
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1758
for change in iterator:
1759
if change.path[0] == change.path[1]:
1761
if None in change.path:
1763
renames.append(change.path)
1765
for old_name, new_name in renames:
1766
self.outf.write("%s => %s\n" % (old_name, new_name))
1769
class cmd_update(Command):
1770
__doc__ = """Update a working tree to a new revision.
1772
This will perform a merge of the destination revision (the tip of the
1773
branch, or the specified revision) into the working tree, and then make
1774
that revision the basis revision for the working tree.
1776
You can use this to visit an older revision, or to update a working tree
1777
that is out of date from its branch.
1779
If there are any uncommitted changes in the tree, they will be carried
1780
across and remain as uncommitted changes after the update. To discard
1781
these changes, use 'brz revert'. The uncommitted changes may conflict
1782
with the changes brought in by the change in basis revision.
1784
If the tree's branch is bound to a master branch, brz will also update
1785
the branch from the master.
1787
You cannot update just a single file or directory, because each Breezy
1788
working tree has just a single basis revision. If you want to restore a
1789
file that has been removed locally, use 'brz revert' instead of 'brz
1790
update'. If you want to restore a file to its state in a previous
1791
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1792
out the old content of that file to a new location.
1794
The 'dir' argument, if given, must be the location of the root of a
1795
working tree to update. By default, the working tree that contains the
1796
current working directory is used.
1799
_see_also = ['pull', 'working-trees', 'status-flags']
1800
takes_args = ['dir?']
1801
takes_options = ['revision',
1803
help="Show base revision text in conflicts."),
1807
def run(self, dir=None, revision=None, show_base=None):
1808
if revision is not None and len(revision) != 1:
1809
raise errors.CommandError(gettext(
1810
"brz update --revision takes exactly one revision"))
1812
tree = WorkingTree.open_containing('.')[0]
1814
tree, relpath = WorkingTree.open_containing(dir)
1817
raise errors.CommandError(gettext(
1818
"brz update can only update a whole tree, "
1819
"not a file or subdirectory"))
1820
branch = tree.branch
1821
possible_transports = []
1822
master = branch.get_master_branch(
1823
possible_transports=possible_transports)
1824
if master is not None:
1825
branch_location = master.base
1826
self.enter_context(tree.lock_write())
1828
branch_location = tree.branch.base
1829
self.enter_context(tree.lock_tree_write())
1830
# get rid of the final '/' and be ready for display
1831
branch_location = urlutils.unescape_for_display(
1832
branch_location.rstrip('/'),
1834
existing_pending_merges = tree.get_parent_ids()[1:]
1838
# may need to fetch data into a heavyweight checkout
1839
# XXX: this may take some time, maybe we should display a
1841
old_tip = branch.update(possible_transports)
1842
if revision is not None:
1843
revision_id = revision[0].as_revision_id(branch)
1845
revision_id = branch.last_revision()
1846
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1847
revno = branch.revision_id_to_dotted_revno(revision_id)
1848
note(gettext("Tree is up to date at revision {0} of branch {1}"
1849
).format('.'.join(map(str, revno)), branch_location))
1851
view_info = _get_view_info_for_change_reporter(tree)
1852
change_reporter = delta._ChangeReporter(
1853
unversioned_filter=tree.is_ignored,
1854
view_info=view_info)
1856
conflicts = tree.update(
1858
possible_transports=possible_transports,
1859
revision=revision_id,
1861
show_base=show_base)
1862
except errors.NoSuchRevision as e:
1863
raise errors.CommandError(gettext(
1864
"branch has no revision %s\n"
1865
"brz update --revision only works"
1866
" for a revision in the branch history")
1868
revno = tree.branch.revision_id_to_dotted_revno(
1869
_mod_revision.ensure_null(tree.last_revision()))
1870
note(gettext('Updated to revision {0} of branch {1}').format(
1871
'.'.join(map(str, revno)), branch_location))
1872
parent_ids = tree.get_parent_ids()
1873
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1874
note(gettext('Your local commits will now show as pending merges with '
1875
"'brz status', and can be committed with 'brz commit'."))
1882
class cmd_info(Command):
1883
__doc__ = """Show information about a working tree, branch or repository.
1885
This command will show all known locations and formats associated to the
1886
tree, branch or repository.
1888
In verbose mode, statistical information is included with each report.
1889
To see extended statistic information, use a verbosity level of 2 or
1890
higher by specifying the verbose option multiple times, e.g. -vv.
1892
Branches and working trees will also report any missing revisions.
1896
Display information on the format and related locations:
1900
Display the above together with extended format information and
1901
basic statistics (like the number of files in the working tree and
1902
number of revisions in the branch and repository):
1906
Display the above together with number of committers to the branch:
1910
_see_also = ['revno', 'working-trees', 'repositories']
1911
takes_args = ['location?']
1912
takes_options = ['verbose']
1913
encoding_type = 'replace'
1916
def run(self, location=None, verbose=False):
1918
noise_level = get_verbosity_level()
1921
from .info import show_bzrdir_info
1922
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1923
verbose=noise_level, outfile=self.outf)
1926
class cmd_remove(Command):
1927
__doc__ = """Remove files or directories.
1929
This makes Breezy stop tracking changes to the specified files. Breezy will
1930
delete them if they can easily be recovered using revert otherwise they
1931
will be backed up (adding an extension of the form .~#~). If no options or
1932
parameters are given Breezy will scan for files that are being tracked by
1933
Breezy but missing in your tree and stop tracking them for you.
1935
takes_args = ['file*']
1936
takes_options = ['verbose',
1938
'new', help='Only remove files that have never been committed.'),
1939
RegistryOption.from_kwargs('file-deletion-strategy',
1940
'The file deletion mode to be used.',
1941
title='Deletion Strategy', value_switches=True, enum_switch=False,
1942
safe='Backup changed files (default).',
1943
keep='Delete from brz but leave the working copy.',
1944
no_backup='Don\'t backup changed files.'),
1946
aliases = ['rm', 'del']
1947
encoding_type = 'replace'
1949
def run(self, file_list, verbose=False, new=False,
1950
file_deletion_strategy='safe'):
1952
tree, file_list = WorkingTree.open_containing_paths(file_list)
1954
if file_list is not None:
1955
file_list = [f for f in file_list]
1957
self.enter_context(tree.lock_write())
1958
# Heuristics should probably all move into tree.remove_smart or
1961
added = tree.changes_from(tree.basis_tree(),
1962
specific_files=file_list).added
1963
file_list = sorted([f.path[1] for f in added], reverse=True)
1964
if len(file_list) == 0:
1965
raise errors.CommandError(gettext('No matching files.'))
1966
elif file_list is None:
1967
# missing files show up in iter_changes(basis) as
1968
# versioned-with-no-kind.
1970
for change in tree.iter_changes(tree.basis_tree()):
1971
# Find paths in the working tree that have no kind:
1972
if change.path[1] is not None and change.kind[1] is None:
1973
missing.append(change.path[1])
1974
file_list = sorted(missing, reverse=True)
1975
file_deletion_strategy = 'keep'
1976
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1977
keep_files=file_deletion_strategy == 'keep',
1978
force=(file_deletion_strategy == 'no-backup'))
1981
class cmd_reconcile(Command):
1982
__doc__ = """Reconcile brz metadata in a branch.
1984
This can correct data mismatches that may have been caused by
1985
previous ghost operations or brz upgrades. You should only
1986
need to run this command if 'brz check' or a brz developer
1987
advises you to run it.
1989
If a second branch is provided, cross-branch reconciliation is
1990
also attempted, which will check that data like the tree root
1991
id which was not present in very early brz versions is represented
1992
correctly in both branches.
1994
At the same time it is run it may recompress data resulting in
1995
a potential saving in disk space or performance gain.
1997
The branch *MUST* be on a listable system such as local disk or sftp.
2000
_see_also = ['check']
2001
takes_args = ['branch?']
2003
Option('canonicalize-chks',
2004
help='Make sure CHKs are in canonical form (repairs '
2009
def run(self, branch=".", canonicalize_chks=False):
2010
from .reconcile import reconcile
2011
dir = controldir.ControlDir.open(branch)
2012
reconcile(dir, canonicalize_chks=canonicalize_chks)
2015
class cmd_revision_history(Command):
2016
__doc__ = """Display the list of revision ids on a branch."""
2019
takes_args = ['location?']
2024
def run(self, location="."):
2025
branch = Branch.open_containing(location)[0]
2026
self.enter_context(branch.lock_read())
2027
graph = branch.repository.get_graph()
2028
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
2029
[_mod_revision.NULL_REVISION]))
2030
for revid in reversed(history):
2031
self.outf.write(revid)
2032
self.outf.write('\n')
2035
class cmd_ancestry(Command):
2036
__doc__ = """List all revisions merged into this branch."""
2038
_see_also = ['log', 'revision-history']
2039
takes_args = ['location?']
2044
def run(self, location="."):
2046
wt = WorkingTree.open_containing(location)[0]
2047
except errors.NoWorkingTree:
2048
b = Branch.open(location)
2049
last_revision = b.last_revision()
2052
last_revision = wt.last_revision()
2054
self.enter_context(b.repository.lock_read())
2055
graph = b.repository.get_graph()
2056
revisions = [revid for revid, parents in
2057
graph.iter_ancestry([last_revision])]
2058
for revision_id in reversed(revisions):
2059
if _mod_revision.is_null(revision_id):
2061
self.outf.write(revision_id.decode('utf-8') + '\n')
2064
class cmd_init(Command):
2065
__doc__ = """Make a directory into a versioned branch.
2067
Use this to create an empty branch, or before importing an
2070
If there is a repository in a parent directory of the location, then
2071
the history of the branch will be stored in the repository. Otherwise
2072
init creates a standalone branch which carries its own history
2073
in the .bzr directory.
2075
If there is already a branch at the location but it has no working tree,
2076
the tree can be populated with 'brz checkout'.
2078
Recipe for importing a tree of files::
2084
brz commit -m "imported project"
2087
_see_also = ['init-shared-repository', 'branch', 'checkout']
2088
takes_args = ['location?']
2090
Option('create-prefix',
2091
help='Create the path leading up to the branch '
2092
'if it does not already exist.'),
2093
RegistryOption('format',
2094
help='Specify a format for this branch. '
2095
'See "help formats" for a full list.',
2096
lazy_registry=('breezy.controldir', 'format_registry'),
2097
converter=lambda name: controldir.format_registry.make_controldir(
2099
value_switches=True,
2100
title="Branch format",
2102
Option('append-revisions-only',
2103
help='Never change revnos or the existing log.'
2104
' Append revisions to it only.'),
2106
'Create a branch without a working tree.')
2109
def run(self, location=None, format=None, append_revisions_only=False,
2110
create_prefix=False, no_tree=False):
2112
format = controldir.format_registry.make_controldir('default')
2113
if location is None:
2116
to_transport = transport.get_transport(location, purpose='write')
2118
# The path has to exist to initialize a
2119
# branch inside of it.
2120
# Just using os.mkdir, since I don't
2121
# believe that we want to create a bunch of
2122
# locations if the user supplies an extended path
2124
to_transport.ensure_base()
2125
except errors.NoSuchFile:
2126
if not create_prefix:
2127
raise errors.CommandError(gettext("Parent directory of %s"
2129
"\nYou may supply --create-prefix to create all"
2130
" leading parent directories.")
2132
to_transport.create_prefix()
2135
a_controldir = controldir.ControlDir.open_from_transport(
2137
except errors.NotBranchError:
2138
# really a NotBzrDir error...
2139
create_branch = controldir.ControlDir.create_branch_convenience
2141
force_new_tree = False
2143
force_new_tree = None
2144
branch = create_branch(to_transport.base, format=format,
2145
possible_transports=[to_transport],
2146
force_new_tree=force_new_tree)
2147
a_controldir = branch.controldir
2149
from .transport.local import LocalTransport
2150
if a_controldir.has_branch():
2151
if (isinstance(to_transport, LocalTransport)
2152
and not a_controldir.has_workingtree()):
2153
raise errors.BranchExistsWithoutWorkingTree(location)
2154
raise errors.AlreadyBranchError(location)
2155
branch = a_controldir.create_branch()
2156
if not no_tree and not a_controldir.has_workingtree():
2157
a_controldir.create_workingtree()
2158
if append_revisions_only:
2160
branch.set_append_revisions_only(True)
2161
except errors.UpgradeRequired:
2162
raise errors.CommandError(gettext('This branch format cannot be set'
2163
' to append-revisions-only. Try --default.'))
2165
from .info import describe_layout, describe_format
2167
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2168
except (errors.NoWorkingTree, errors.NotLocalUrl):
2170
repository = branch.repository
2171
layout = describe_layout(repository, branch, tree).lower()
2172
format = describe_format(a_controldir, repository, branch, tree)
2173
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2175
if repository.is_shared():
2176
# XXX: maybe this can be refactored into transport.path_or_url()
2177
url = repository.controldir.root_transport.external_url()
2179
url = urlutils.local_path_from_url(url)
2180
except urlutils.InvalidURL:
2182
self.outf.write(gettext("Using shared repository: %s\n") % url)
2185
class cmd_init_shared_repository(Command):
2186
__doc__ = """Create a shared repository for branches to share storage space.
2188
New branches created under the repository directory will store their
2189
revisions in the repository, not in the branch directory. For branches
2190
with shared history, this reduces the amount of storage needed and
2191
speeds up the creation of new branches.
2193
If the --no-trees option is given then the branches in the repository
2194
will not have working trees by default. They will still exist as
2195
directories on disk, but they will not have separate copies of the
2196
files at a certain revision. This can be useful for repositories that
2197
store branches which are interacted with through checkouts or remote
2198
branches, such as on a server.
2201
Create a shared repository holding just branches::
2203
brz init-shared-repo --no-trees repo
2206
Make a lightweight checkout elsewhere::
2208
brz checkout --lightweight repo/trunk trunk-checkout
2213
_see_also = ['init', 'branch', 'checkout', 'repositories']
2214
takes_args = ["location"]
2215
takes_options = [RegistryOption('format',
2216
help='Specify a format for this repository. See'
2217
' "brz help formats" for details.',
2219
'breezy.controldir', 'format_registry'),
2220
converter=lambda name: controldir.format_registry.make_controldir(
2222
value_switches=True, title='Repository format'),
2224
help='Branches in the repository will default to'
2225
' not having a working tree.'),
2227
aliases = ["init-shared-repo", "init-repo"]
2229
def run(self, location, format=None, no_trees=False):
2231
format = controldir.format_registry.make_controldir('default')
2233
if location is None:
2236
to_transport = transport.get_transport(location, purpose='write')
2238
if format.fixed_components:
2239
repo_format_name = None
2241
repo_format_name = format.repository_format.get_format_string()
2243
(repo, newdir, require_stacking, repository_policy) = (
2244
format.initialize_on_transport_ex(to_transport,
2245
create_prefix=True, make_working_trees=not no_trees,
2246
shared_repo=True, force_new_repo=True,
2247
use_existing_dir=True,
2248
repo_format_name=repo_format_name))
2250
from .info import show_bzrdir_info
2251
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2254
class cmd_diff(Command):
2255
__doc__ = """Show differences in the working tree, between revisions or branches.
2257
If no arguments are given, all changes for the current tree are listed.
2258
If files are given, only the changes in those files are listed.
2259
Remote and multiple branches can be compared by using the --old and
2260
--new options. If not provided, the default for both is derived from
2261
the first argument, if any, or the current tree if no arguments are
2264
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2265
produces patches suitable for "patch -p1".
2267
Note that when using the -r argument with a range of revisions, the
2268
differences are computed between the two specified revisions. That
2269
is, the command does not show the changes introduced by the first
2270
revision in the range. This differs from the interpretation of
2271
revision ranges used by "brz log" which includes the first revision
2276
2 - unrepresentable changes
2281
Shows the difference in the working tree versus the last commit::
2285
Difference between the working tree and revision 1::
2289
Difference between revision 3 and revision 1::
2293
Difference between revision 3 and revision 1 for branch xxx::
2297
The changes introduced by revision 2 (equivalent to -r1..2)::
2301
To see the changes introduced by revision X::
2305
Note that in the case of a merge, the -c option shows the changes
2306
compared to the left hand parent. To see the changes against
2307
another parent, use::
2309
brz diff -r<chosen_parent>..X
2311
The changes between the current revision and the previous revision
2312
(equivalent to -c-1 and -r-2..-1)
2316
Show just the differences for file NEWS::
2320
Show the differences in working tree xxx for file NEWS::
2324
Show the differences from branch xxx to this working tree:
2328
Show the differences between two branches for file NEWS::
2330
brz diff --old xxx --new yyy NEWS
2332
Same as 'brz diff' but prefix paths with old/ and new/::
2334
brz diff --prefix old/:new/
2336
Show the differences using a custom diff program with options::
2338
brz diff --using /usr/bin/diff --diff-options -wu
2340
_see_also = ['status']
2341
takes_args = ['file*']
2343
Option('diff-options', type=text_type,
2344
help='Pass these options to the external diff program.'),
2345
Option('prefix', type=text_type,
2347
help='Set prefixes added to old and new filenames, as '
2348
'two values separated by a colon. (eg "old/:new/").'),
2350
help='Branch/tree to compare from.',
2354
help='Branch/tree to compare to.',
2360
help='Use this command to compare files.',
2363
RegistryOption('format',
2365
help='Diff format to use.',
2366
lazy_registry=('breezy.diff', 'format_registry'),
2367
title='Diff format'),
2369
help='How many lines of context to show.',
2372
RegistryOption.from_kwargs(
2374
help='Color mode to use.',
2375
title='Color Mode', value_switches=False, enum_switch=True,
2376
never='Never colorize output.',
2377
auto='Only colorize output if terminal supports it and STDOUT is a'
2379
always='Always colorize output (default).'),
2382
help=('Warn if trailing whitespace or spurious changes have been'
2386
aliases = ['di', 'dif']
2387
encoding_type = 'exact'
2390
def run(self, revision=None, file_list=None, diff_options=None,
2391
prefix=None, old=None, new=None, using=None, format=None,
2392
context=None, color='never'):
2393
from .diff import (get_trees_and_branches_to_diff_locked,
2400
elif prefix == u'1' or prefix is None:
2403
elif u':' in prefix:
2404
old_label, new_label = prefix.split(u":")
2406
raise errors.CommandError(gettext(
2407
'--prefix expects two values separated by a colon'
2408
' (eg "old/:new/")'))
2410
if revision and len(revision) > 2:
2411
raise errors.CommandError(gettext('brz diff --revision takes exactly'
2412
' one or two revision specifiers'))
2414
if using is not None and format is not None:
2415
raise errors.CommandError(gettext(
2416
'{0} and {1} are mutually exclusive').format(
2417
'--using', '--format'))
2419
(old_tree, new_tree,
2420
old_branch, new_branch,
2421
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2422
file_list, revision, old, new, self._exit_stack, apply_view=True)
2423
# GNU diff on Windows uses ANSI encoding for filenames
2424
path_encoding = osutils.get_diff_header_encoding()
2427
from .terminal import has_ansi_colors
2428
if has_ansi_colors():
2432
if 'always' == color:
2433
from .colordiff import DiffWriter
2434
outf = DiffWriter(outf)
2435
return show_diff_trees(old_tree, new_tree, outf,
2436
specific_files=specific_files,
2437
external_diff_options=diff_options,
2438
old_label=old_label, new_label=new_label,
2439
extra_trees=extra_trees,
2440
path_encoding=path_encoding,
2441
using=using, context=context,
2445
class cmd_deleted(Command):
2446
__doc__ = """List files deleted in the working tree.
2448
# TODO: Show files deleted since a previous revision, or
2449
# between two revisions.
2450
# TODO: Much more efficient way to do this: read in new
2451
# directories with readdir, rather than stating each one. Same
2452
# level of effort but possibly much less IO. (Or possibly not,
2453
# if the directories are very large...)
2454
_see_also = ['status', 'ls']
2455
takes_options = ['directory', 'show-ids']
2458
def run(self, show_ids=False, directory=u'.'):
2459
tree = WorkingTree.open_containing(directory)[0]
2460
self.enter_context(tree.lock_read())
2461
old = tree.basis_tree()
2462
self.enter_context(old.lock_read())
2463
delta = tree.changes_from(old)
2464
for change in delta.removed:
2465
self.outf.write(change.path[0])
2467
self.outf.write(' ')
2468
self.outf.write(change.file_id)
2469
self.outf.write('\n')
2472
class cmd_modified(Command):
2473
__doc__ = """List files modified in working tree.
2477
_see_also = ['status', 'ls']
2478
takes_options = ['directory', 'null']
2481
def run(self, null=False, directory=u'.'):
2482
tree = WorkingTree.open_containing(directory)[0]
2483
self.enter_context(tree.lock_read())
2484
td = tree.changes_from(tree.basis_tree())
2486
for change in td.modified:
2488
self.outf.write(change.path[1] + '\0')
2490
self.outf.write(osutils.quotefn(change.path[1]) + '\n')
2493
class cmd_added(Command):
2494
__doc__ = """List files added in working tree.
2498
_see_also = ['status', 'ls']
2499
takes_options = ['directory', 'null']
2502
def run(self, null=False, directory=u'.'):
2503
wt = WorkingTree.open_containing(directory)[0]
2504
self.enter_context(wt.lock_read())
2505
basis = wt.basis_tree()
2506
self.enter_context(basis.lock_read())
2507
for path in wt.all_versioned_paths():
2508
if basis.has_filename(path):
2512
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2515
self.outf.write(path + '\0')
2517
self.outf.write(osutils.quotefn(path) + '\n')
2520
class cmd_root(Command):
2521
__doc__ = """Show the tree root directory.
2523
The root is the nearest enclosing directory with a control
2526
takes_args = ['filename?']
2529
def run(self, filename=None):
2530
"""Print the branch root."""
2531
tree = WorkingTree.open_containing(filename)[0]
2532
self.outf.write(tree.basedir + '\n')
2535
def _parse_limit(limitstring):
2537
return int(limitstring)
2539
msg = gettext("The limit argument must be an integer.")
2540
raise errors.CommandError(msg)
2543
def _parse_levels(s):
2547
msg = gettext("The levels argument must be an integer.")
2548
raise errors.CommandError(msg)
2551
class cmd_log(Command):
2552
__doc__ = """Show historical log for a branch or subset of a branch.
2554
log is brz's default tool for exploring the history of a branch.
2555
The branch to use is taken from the first parameter. If no parameters
2556
are given, the branch containing the working directory is logged.
2557
Here are some simple examples::
2559
brz log log the current branch
2560
brz log foo.py log a file in its branch
2561
brz log http://server/branch log a branch on a server
2563
The filtering, ordering and information shown for each revision can
2564
be controlled as explained below. By default, all revisions are
2565
shown sorted (topologically) so that newer revisions appear before
2566
older ones and descendants always appear before ancestors. If displayed,
2567
merged revisions are shown indented under the revision in which they
2572
The log format controls how information about each revision is
2573
displayed. The standard log formats are called ``long``, ``short``
2574
and ``line``. The default is long. See ``brz help log-formats``
2575
for more details on log formats.
2577
The following options can be used to control what information is
2580
-l N display a maximum of N revisions
2581
-n N display N levels of revisions (0 for all, 1 for collapsed)
2582
-v display a status summary (delta) for each revision
2583
-p display a diff (patch) for each revision
2584
--show-ids display revision-ids (and file-ids), not just revnos
2586
Note that the default number of levels to display is a function of the
2587
log format. If the -n option is not used, the standard log formats show
2588
just the top level (mainline).
2590
Status summaries are shown using status flags like A, M, etc. To see
2591
the changes explained using words like ``added`` and ``modified``
2592
instead, use the -vv option.
2596
To display revisions from oldest to newest, use the --forward option.
2597
In most cases, using this option will have little impact on the total
2598
time taken to produce a log, though --forward does not incrementally
2599
display revisions like --reverse does when it can.
2601
:Revision filtering:
2603
The -r option can be used to specify what revision or range of revisions
2604
to filter against. The various forms are shown below::
2606
-rX display revision X
2607
-rX.. display revision X and later
2608
-r..Y display up to and including revision Y
2609
-rX..Y display from X to Y inclusive
2611
See ``brz help revisionspec`` for details on how to specify X and Y.
2612
Some common examples are given below::
2614
-r-1 show just the tip
2615
-r-10.. show the last 10 mainline revisions
2616
-rsubmit:.. show what's new on this branch
2617
-rancestor:path.. show changes since the common ancestor of this
2618
branch and the one at location path
2619
-rdate:yesterday.. show changes since yesterday
2621
When logging a range of revisions using -rX..Y, log starts at
2622
revision Y and searches back in history through the primary
2623
("left-hand") parents until it finds X. When logging just the
2624
top level (using -n1), an error is reported if X is not found
2625
along the way. If multi-level logging is used (-n0), X may be
2626
a nested merge revision and the log will be truncated accordingly.
2630
If parameters are given and the first one is not a branch, the log
2631
will be filtered to show only those revisions that changed the
2632
nominated files or directories.
2634
Filenames are interpreted within their historical context. To log a
2635
deleted file, specify a revision range so that the file existed at
2636
the end or start of the range.
2638
Historical context is also important when interpreting pathnames of
2639
renamed files/directories. Consider the following example:
2641
* revision 1: add tutorial.txt
2642
* revision 2: modify tutorial.txt
2643
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2647
* ``brz log guide.txt`` will log the file added in revision 1
2649
* ``brz log tutorial.txt`` will log the new file added in revision 3
2651
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2652
the original file in revision 2.
2654
* ``brz log -r2 -p guide.txt`` will display an error message as there
2655
was no file called guide.txt in revision 2.
2657
Renames are always followed by log. By design, there is no need to
2658
explicitly ask for this (and no way to stop logging a file back
2659
until it was last renamed).
2663
The --match option can be used for finding revisions that match a
2664
regular expression in a commit message, committer, author or bug.
2665
Specifying the option several times will match any of the supplied
2666
expressions. --match-author, --match-bugs, --match-committer and
2667
--match-message can be used to only match a specific field.
2671
GUI tools and IDEs are often better at exploring history than command
2672
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2673
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2674
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2675
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2677
You may find it useful to add the aliases below to ``breezy.conf``::
2681
top = log -l10 --line
2684
``brz tip`` will then show the latest revision while ``brz top``
2685
will show the last 10 mainline revisions. To see the details of a
2686
particular revision X, ``brz show -rX``.
2688
If you are interested in looking deeper into a particular merge X,
2689
use ``brz log -n0 -rX``.
2691
``brz log -v`` on a branch with lots of history is currently
2692
very slow. A fix for this issue is currently under development.
2693
With or without that fix, it is recommended that a revision range
2694
be given when using the -v option.
2696
brz has a generic full-text matching plugin, brz-search, that can be
2697
used to find revisions matching user names, commit messages, etc.
2698
Among other features, this plugin can find all revisions containing
2699
a list of words but not others.
2701
When exploring non-mainline history on large projects with deep
2702
history, the performance of log can be greatly improved by installing
2703
the historycache plugin. This plugin buffers historical information
2704
trading disk space for faster speed.
2706
takes_args = ['file*']
2707
_see_also = ['log-formats', 'revisionspec']
2710
help='Show from oldest to newest.'),
2712
custom_help('verbose',
2713
help='Show files changed in each revision.'),
2717
type=breezy.option._parse_revision_str,
2719
help='Show just the specified revision.'
2720
' See also "help revisionspec".'),
2722
RegistryOption('authors',
2723
'What names to list as authors - first, all or committer.',
2726
'breezy.log', 'author_list_registry'),
2730
help='Number of levels to display - 0 for all, 1 for flat.',
2732
type=_parse_levels),
2734
help='Show revisions whose message matches this '
2735
'regular expression.',
2740
help='Limit the output to the first N revisions.',
2745
help='Show changes made in each revision as a patch.'),
2746
Option('include-merged',
2747
help='Show merged revisions like --levels 0 does.'),
2748
Option('include-merges', hidden=True,
2749
help='Historical alias for --include-merged.'),
2750
Option('omit-merges',
2751
help='Do not report commits with more than one parent.'),
2752
Option('exclude-common-ancestry',
2753
help='Display only the revisions that are not part'
2754
' of both ancestries (require -rX..Y).'
2756
Option('signatures',
2757
help='Show digital signature validity.'),
2760
help='Show revisions whose properties match this '
2763
ListOption('match-message',
2764
help='Show revisions whose message matches this '
2767
ListOption('match-committer',
2768
help='Show revisions whose committer matches this '
2771
ListOption('match-author',
2772
help='Show revisions whose authors match this '
2775
ListOption('match-bugs',
2776
help='Show revisions whose bugs match this '
2780
encoding_type = 'replace'
2783
def run(self, file_list=None, timezone='original',
2794
include_merged=None,
2796
exclude_common_ancestry=False,
2800
match_committer=None,
2807
make_log_request_dict,
2808
_get_info_for_log_files,
2810
direction = (forward and 'forward') or 'reverse'
2811
if include_merged is None:
2812
include_merged = False
2813
if (exclude_common_ancestry
2814
and (revision is None or len(revision) != 2)):
2815
raise errors.CommandError(gettext(
2816
'--exclude-common-ancestry requires -r with two revisions'))
2821
raise errors.CommandError(gettext(
2822
'{0} and {1} are mutually exclusive').format(
2823
'--levels', '--include-merged'))
2825
if change is not None:
2827
raise errors.RangeInChangeOption()
2828
if revision is not None:
2829
raise errors.CommandError(gettext(
2830
'{0} and {1} are mutually exclusive').format(
2831
'--revision', '--change'))
2836
filter_by_dir = False
2838
# find the file ids to log and check for directory filtering
2839
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2840
revision, file_list, self._exit_stack)
2841
for relpath, kind in file_info_list:
2843
raise errors.CommandError(gettext(
2844
"Path unknown at end or start of revision range: %s") %
2846
# If the relpath is the top of the tree, we log everything
2851
files.append(relpath)
2852
filter_by_dir = filter_by_dir or (
2853
kind in ['directory', 'tree-reference'])
2856
# FIXME ? log the current subdir only RBC 20060203
2857
if revision is not None \
2858
and len(revision) > 0 and revision[0].get_branch():
2859
location = revision[0].get_branch()
2862
dir, relpath = controldir.ControlDir.open_containing(location)
2863
b = dir.open_branch()
2864
self.enter_context(b.lock_read())
2865
rev1, rev2 = _get_revision_range(revision, b, self.name())
2867
if b.get_config_stack().get('validate_signatures_in_log'):
2871
if not gpg.GPGStrategy.verify_signatures_available():
2872
raise errors.GpgmeNotInstalled(None)
2874
# Decide on the type of delta & diff filtering to use
2875
# TODO: add an --all-files option to make this configurable & consistent
2883
diff_type = 'partial'
2887
# Build the log formatter
2888
if log_format is None:
2889
log_format = log.log_formatter_registry.get_default(b)
2890
# Make a non-encoding output to include the diffs - bug 328007
2891
unencoded_output = ui.ui_factory.make_output_stream(
2892
encoding_type='exact')
2893
lf = log_format(show_ids=show_ids, to_file=self.outf,
2894
to_exact_file=unencoded_output,
2895
show_timezone=timezone,
2896
delta_format=get_verbosity_level(),
2898
show_advice=levels is None,
2899
author_list_handler=authors)
2901
# Choose the algorithm for doing the logging. It's annoying
2902
# having multiple code paths like this but necessary until
2903
# the underlying repository format is faster at generating
2904
# deltas or can provide everything we need from the indices.
2905
# The default algorithm - match-using-deltas - works for
2906
# multiple files and directories and is faster for small
2907
# amounts of history (200 revisions say). However, it's too
2908
# slow for logging a single file in a repository with deep
2909
# history, i.e. > 10K revisions. In the spirit of "do no
2910
# evil when adding features", we continue to use the
2911
# original algorithm - per-file-graph - for the "single
2912
# file that isn't a directory without showing a delta" case.
2913
partial_history = revision and b.repository._format.supports_chks
2914
match_using_deltas = (len(files) != 1 or filter_by_dir
2915
or delta_type or partial_history)
2919
match_dict[''] = match
2921
match_dict['message'] = match_message
2923
match_dict['committer'] = match_committer
2925
match_dict['author'] = match_author
2927
match_dict['bugs'] = match_bugs
2929
# Build the LogRequest and execute it
2932
rqst = make_log_request_dict(
2933
direction=direction, specific_files=files,
2934
start_revision=rev1, end_revision=rev2, limit=limit,
2935
message_search=message, delta_type=delta_type,
2936
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2937
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2938
signature=signatures, omit_merges=omit_merges,
2940
Logger(b, rqst).show(lf)
2943
def _get_revision_range(revisionspec_list, branch, command_name):
2944
"""Take the input of a revision option and turn it into a revision range.
2946
It returns RevisionInfo objects which can be used to obtain the rev_id's
2947
of the desired revisions. It does some user input validations.
2949
if revisionspec_list is None:
2952
elif len(revisionspec_list) == 1:
2953
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2954
elif len(revisionspec_list) == 2:
2955
start_spec = revisionspec_list[0]
2956
end_spec = revisionspec_list[1]
2957
if end_spec.get_branch() != start_spec.get_branch():
2958
# b is taken from revision[0].get_branch(), and
2959
# show_log will use its revision_history. Having
2960
# different branches will lead to weird behaviors.
2961
raise errors.CommandError(gettext(
2962
"brz %s doesn't accept two revisions in different"
2963
" branches.") % command_name)
2964
if start_spec.spec is None:
2965
# Avoid loading all the history.
2966
rev1 = RevisionInfo(branch, None, None)
2968
rev1 = start_spec.in_history(branch)
2969
# Avoid loading all of history when we know a missing
2970
# end of range means the last revision ...
2971
if end_spec.spec is None:
2972
last_revno, last_revision_id = branch.last_revision_info()
2973
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2975
rev2 = end_spec.in_history(branch)
2977
raise errors.CommandError(gettext(
2978
'brz %s --revision takes one or two values.') % command_name)
2982
def _revision_range_to_revid_range(revision_range):
2985
if revision_range[0] is not None:
2986
rev_id1 = revision_range[0].rev_id
2987
if revision_range[1] is not None:
2988
rev_id2 = revision_range[1].rev_id
2989
return rev_id1, rev_id2
2992
def get_log_format(long=False, short=False, line=False, default='long'):
2993
log_format = default
2997
log_format = 'short'
3003
class cmd_touching_revisions(Command):
3004
__doc__ = """Return revision-ids which affected a particular file.
3006
A more user-friendly interface is "brz log FILE".
3010
takes_args = ["filename"]
3013
def run(self, filename):
3014
tree, relpath = WorkingTree.open_containing(filename)
3015
with tree.lock_read():
3016
touching_revs = log.find_touching_revisions(
3017
tree.branch.repository, tree.branch.last_revision(), tree, relpath)
3018
for revno, revision_id, what in reversed(list(touching_revs)):
3019
self.outf.write("%6d %s\n" % (revno, what))
3022
class cmd_ls(Command):
3023
__doc__ = """List files in a tree.
3026
_see_also = ['status', 'cat']
3027
takes_args = ['path?']
3031
Option('recursive', short_name='R',
3032
help='Recurse into subdirectories.'),
3034
help='Print paths relative to the root of the branch.'),
3035
Option('unknown', short_name='u',
3036
help='Print unknown files.'),
3037
Option('versioned', help='Print versioned files.',
3039
Option('ignored', short_name='i',
3040
help='Print ignored files.'),
3041
Option('kind', short_name='k',
3042
help=('List entries of a particular kind: file, '
3043
'directory, symlink, tree-reference.'),
3051
def run(self, revision=None, verbose=False,
3052
recursive=False, from_root=False,
3053
unknown=False, versioned=False, ignored=False,
3054
null=False, kind=None, show_ids=False, path=None, directory=None):
3056
if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
3057
raise errors.CommandError(gettext('invalid kind specified'))
3059
if verbose and null:
3060
raise errors.CommandError(
3061
gettext('Cannot set both --verbose and --null'))
3062
all = not (unknown or versioned or ignored)
3064
selection = {'I': ignored, '?': unknown, 'V': versioned}
3070
raise errors.CommandError(gettext('cannot specify both --from-root'
3073
tree, branch, relpath = \
3074
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3076
# Calculate the prefix to use
3080
prefix = relpath + '/'
3081
elif fs_path != '.' and not fs_path.endswith('/'):
3082
prefix = fs_path + '/'
3084
if revision is not None or tree is None:
3085
tree = _get_one_revision_tree('ls', revision, branch=branch)
3088
if isinstance(tree, WorkingTree) and tree.supports_views():
3089
view_files = tree.views.lookup_view()
3092
view_str = views.view_display_str(view_files)
3093
note(gettext("Ignoring files outside view. View is %s") % view_str)
3095
self.enter_context(tree.lock_read())
3096
for fp, fc, fkind, entry in tree.list_files(
3097
include_root=False, from_dir=relpath, recursive=recursive):
3098
# Apply additional masking
3099
if not all and not selection[fc]:
3101
if kind is not None and fkind != kind:
3106
fullpath = osutils.pathjoin(relpath, fp)
3109
views.check_path_in_view(tree, fullpath)
3110
except views.FileOutsideView:
3115
fp = osutils.pathjoin(prefix, fp)
3116
kindch = entry.kind_character()
3117
outstring = fp + kindch
3118
ui.ui_factory.clear_term()
3120
outstring = '%-8s %s' % (fc, outstring)
3121
if show_ids and getattr(entry, 'file_id', None) is not None:
3122
outstring = "%-50s %s" % (outstring, entry.file_id.decode('utf-8'))
3123
self.outf.write(outstring + '\n')
3125
self.outf.write(fp + '\0')
3127
if getattr(entry, 'file_id', None) is not None:
3128
self.outf.write(entry.file_id.decode('utf-8'))
3129
self.outf.write('\0')
3133
if getattr(entry, 'file_id', None) is not None:
3134
my_id = entry.file_id.decode('utf-8')
3137
self.outf.write('%-50s %s\n' % (outstring, my_id))
3139
self.outf.write(outstring + '\n')
3142
class cmd_unknowns(Command):
3143
__doc__ = """List unknown files.
3148
takes_options = ['directory']
3151
def run(self, directory=u'.'):
3152
for f in WorkingTree.open_containing(directory)[0].unknowns():
3153
self.outf.write(osutils.quotefn(f) + '\n')
3156
class cmd_ignore(Command):
3157
__doc__ = """Ignore specified files or patterns.
3159
See ``brz help patterns`` for details on the syntax of patterns.
3161
If a .bzrignore file does not exist, the ignore command
3162
will create one and add the specified files or patterns to the newly
3163
created file. The ignore command will also automatically add the
3164
.bzrignore file to be versioned. Creating a .bzrignore file without
3165
the use of the ignore command will require an explicit add command.
3167
To remove patterns from the ignore list, edit the .bzrignore file.
3168
After adding, editing or deleting that file either indirectly by
3169
using this command or directly by using an editor, be sure to commit
3172
Breezy also supports a global ignore file ~/.config/breezy/ignore. On
3173
Windows the global ignore file can be found in the application data
3175
C:\\Documents and Settings\\<user>\\Application Data\\Breezy\\3.0\\ignore.
3176
Global ignores are not touched by this command. The global ignore file
3177
can be edited directly using an editor.
3179
Patterns prefixed with '!' are exceptions to ignore patterns and take
3180
precedence over regular ignores. Such exceptions are used to specify
3181
files that should be versioned which would otherwise be ignored.
3183
Patterns prefixed with '!!' act as regular ignore patterns, but have
3184
precedence over the '!' exception patterns.
3188
* Ignore patterns containing shell wildcards must be quoted from
3191
* Ignore patterns starting with "#" act as comments in the ignore file.
3192
To ignore patterns that begin with that character, use the "RE:" prefix.
3195
Ignore the top level Makefile::
3197
brz ignore ./Makefile
3199
Ignore .class files in all directories...::
3201
brz ignore "*.class"
3203
...but do not ignore "special.class"::
3205
brz ignore "!special.class"
3207
Ignore files whose name begins with the "#" character::
3211
Ignore .o files under the lib directory::
3213
brz ignore "lib/**/*.o"
3215
Ignore .o files under the lib directory::
3217
brz ignore "RE:lib/.*\\.o"
3219
Ignore everything but the "debian" toplevel directory::
3221
brz ignore "RE:(?!debian/).*"
3223
Ignore everything except the "local" toplevel directory,
3224
but always ignore autosave files ending in ~, even under local/::
3227
brz ignore "!./local"
3231
_see_also = ['status', 'ignored', 'patterns']
3232
takes_args = ['name_pattern*']
3233
takes_options = ['directory',
3234
Option('default-rules',
3235
help='Display the default ignore rules that brz uses.')
3238
def run(self, name_pattern_list=None, default_rules=None,
3240
from breezy import ignores
3241
if default_rules is not None:
3242
# dump the default rules and exit
3243
for pattern in ignores.USER_DEFAULTS:
3244
self.outf.write("%s\n" % pattern)
3246
if not name_pattern_list:
3247
raise errors.CommandError(gettext("ignore requires at least one "
3248
"NAME_PATTERN or --default-rules."))
3249
name_pattern_list = [globbing.normalize_pattern(p)
3250
for p in name_pattern_list]
3252
bad_patterns_count = 0
3253
for p in name_pattern_list:
3254
if not globbing.Globster.is_pattern_valid(p):
3255
bad_patterns_count += 1
3256
bad_patterns += ('\n %s' % p)
3258
msg = (ngettext('Invalid ignore pattern found. %s',
3259
'Invalid ignore patterns found. %s',
3260
bad_patterns_count) % bad_patterns)
3261
ui.ui_factory.show_error(msg)
3262
raise lazy_regex.InvalidPattern('')
3263
for name_pattern in name_pattern_list:
3264
if (name_pattern[0] == '/' or
3265
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3266
raise errors.CommandError(gettext(
3267
"NAME_PATTERN should not be an absolute path"))
3268
tree, relpath = WorkingTree.open_containing(directory)
3269
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3270
ignored = globbing.Globster(name_pattern_list)
3272
self.enter_context(tree.lock_read())
3273
for filename, fc, fkind, entry in tree.list_files():
3274
id = getattr(entry, 'file_id', None)
3276
if ignored.match(filename):
3277
matches.append(filename)
3278
if len(matches) > 0:
3279
self.outf.write(gettext("Warning: the following files are version "
3280
"controlled and match your ignore pattern:\n%s"
3281
"\nThese files will continue to be version controlled"
3282
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3285
class cmd_ignored(Command):
3286
__doc__ = """List ignored files and the patterns that matched them.
3288
List all the ignored files and the ignore pattern that caused the file to
3291
Alternatively, to list just the files::
3296
encoding_type = 'replace'
3297
_see_also = ['ignore', 'ls']
3298
takes_options = ['directory']
3301
def run(self, directory=u'.'):
3302
tree = WorkingTree.open_containing(directory)[0]
3303
self.enter_context(tree.lock_read())
3304
for path, file_class, kind, entry in tree.list_files():
3305
if file_class != 'I':
3307
# XXX: Slightly inefficient since this was already calculated
3308
pat = tree.is_ignored(path)
3309
self.outf.write('%-50s %s\n' % (path, pat))
3312
class cmd_lookup_revision(Command):
3313
__doc__ = """Lookup the revision-id from a revision-number
3316
brz lookup-revision 33
3319
takes_args = ['revno']
3320
takes_options = ['directory']
3323
def run(self, revno, directory=u'.'):
3327
raise errors.CommandError(gettext("not a valid revision-number: %r")
3329
revid = WorkingTree.open_containing(
3330
directory)[0].branch.get_rev_id(revno)
3331
self.outf.write("%s\n" % revid.decode('utf-8'))
3334
class cmd_export(Command):
3335
__doc__ = """Export current or past revision to a destination directory or archive.
3337
If no revision is specified this exports the last committed revision.
3339
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3340
given, try to find the format with the extension. If no extension
3341
is found exports to a directory (equivalent to --format=dir).
3343
If root is supplied, it will be used as the root directory inside
3344
container formats (tar, zip, etc). If it is not supplied it will default
3345
to the exported filename. The root option has no effect for 'dir' format.
3347
If branch is omitted then the branch containing the current working
3348
directory will be used.
3350
Note: Export of tree with non-ASCII filenames to zip is not supported.
3352
================= =========================
3353
Supported formats Autodetected by extension
3354
================= =========================
3357
tbz2 .tar.bz2, .tbz2
3360
================= =========================
3363
encoding_type = 'exact'
3364
takes_args = ['dest', 'branch_or_subdir?']
3365
takes_options = ['directory',
3367
help="Type of file to export to.",
3370
Option('filters', help='Apply content filters to export the '
3371
'convenient form.'),
3374
help="Name of the root directory inside the exported file."),
3375
Option('per-file-timestamps',
3376
help='Set modification time of files to that of the last '
3377
'revision in which it was changed.'),
3378
Option('uncommitted',
3379
help='Export the working tree contents rather than that of the '
3383
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3384
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3386
from .export import export, guess_format, get_root_name
3388
if branch_or_subdir is None:
3389
branch_or_subdir = directory
3391
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3393
if tree is not None:
3394
self.enter_context(tree.lock_read())
3398
raise errors.CommandError(
3399
gettext("--uncommitted requires a working tree"))
3402
export_tree = _get_one_revision_tree(
3403
'export', revision, branch=b,
3407
format = guess_format(dest)
3410
root = get_root_name(dest)
3412
if not per_file_timestamps:
3413
force_mtime = time.time()
3418
from breezy.filter_tree import ContentFilterTree
3419
export_tree = ContentFilterTree(
3420
export_tree, export_tree._content_filter_stack)
3423
export(export_tree, dest, format, root, subdir,
3424
per_file_timestamps=per_file_timestamps)
3425
except errors.NoSuchExportFormat as e:
3426
raise errors.CommandError(
3427
gettext('Unsupported export format: %s') % e.format)
3430
class cmd_cat(Command):
3431
__doc__ = """Write the contents of a file as of a given revision to standard output.
3433
If no revision is nominated, the last revision is used.
3435
Note: Take care to redirect standard output when using this command on a
3440
takes_options = ['directory',
3441
Option('name-from-revision',
3442
help='The path name in the old tree.'),
3443
Option('filters', help='Apply content filters to display the '
3444
'convenience form.'),
3447
takes_args = ['filename']
3448
encoding_type = 'exact'
3451
def run(self, filename, revision=None, name_from_revision=False,
3452
filters=False, directory=None):
3453
if revision is not None and len(revision) != 1:
3454
raise errors.CommandError(gettext("brz cat --revision takes exactly"
3455
" one revision specifier"))
3456
tree, branch, relpath = \
3457
_open_directory_or_containing_tree_or_branch(filename, directory)
3458
self.enter_context(branch.lock_read())
3459
return self._run(tree, branch, relpath, filename, revision,
3460
name_from_revision, filters)
3462
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3466
tree = b.basis_tree()
3467
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3468
self.enter_context(rev_tree.lock_read())
3470
if name_from_revision:
3471
# Try in revision if requested
3472
if not rev_tree.is_versioned(relpath):
3473
raise errors.CommandError(gettext(
3474
"{0!r} is not present in revision {1}").format(
3475
filename, rev_tree.get_revision_id()))
3476
rev_tree_path = relpath
3479
rev_tree_path = _mod_tree.find_previous_path(
3480
tree, rev_tree, relpath)
3481
except errors.NoSuchFile:
3482
rev_tree_path = None
3484
if rev_tree_path is None:
3485
# Path didn't exist in working tree
3486
if not rev_tree.is_versioned(relpath):
3487
raise errors.CommandError(gettext(
3488
"{0!r} is not present in revision {1}").format(
3489
filename, rev_tree.get_revision_id()))
3491
# Fall back to the same path in the basis tree, if present.
3492
rev_tree_path = relpath
3495
from .filter_tree import ContentFilterTree
3496
filter_tree = ContentFilterTree(
3497
rev_tree, rev_tree._content_filter_stack)
3498
fileobj = filter_tree.get_file(rev_tree_path)
3500
fileobj = rev_tree.get_file(rev_tree_path)
3501
shutil.copyfileobj(fileobj, self.outf)
3505
class cmd_local_time_offset(Command):
3506
__doc__ = """Show the offset in seconds from GMT to local time."""
3511
self.outf.write("%s\n" % osutils.local_time_offset())
3514
class cmd_commit(Command):
3515
__doc__ = """Commit changes into a new revision.
3517
An explanatory message needs to be given for each commit. This is
3518
often done by using the --message option (getting the message from the
3519
command line) or by using the --file option (getting the message from
3520
a file). If neither of these options is given, an editor is opened for
3521
the user to enter the message. To see the changed files in the
3522
boilerplate text loaded into the editor, use the --show-diff option.
3524
By default, the entire tree is committed and the person doing the
3525
commit is assumed to be the author. These defaults can be overridden
3530
If selected files are specified, only changes to those files are
3531
committed. If a directory is specified then the directory and
3532
everything within it is committed.
3534
When excludes are given, they take precedence over selected files.
3535
For example, to commit only changes within foo, but not changes
3538
brz commit foo -x foo/bar
3540
A selective commit after a merge is not yet supported.
3544
If the author of the change is not the same person as the committer,
3545
you can specify the author's name using the --author option. The
3546
name should be in the same format as a committer-id, e.g.
3547
"John Doe <jdoe@example.com>". If there is more than one author of
3548
the change you can specify the option multiple times, once for each
3553
A common mistake is to forget to add a new file or directory before
3554
running the commit command. The --strict option checks for unknown
3555
files and aborts the commit if any are found. More advanced pre-commit
3556
checks can be implemented by defining hooks. See ``brz help hooks``
3561
If you accidentally commit the wrong changes or make a spelling
3562
mistake in the commit message say, you can use the uncommit command
3563
to undo it. See ``brz help uncommit`` for details.
3565
Hooks can also be configured to run after a commit. This allows you
3566
to trigger updates to external systems like bug trackers. The --fixes
3567
option can be used to record the association between a revision and
3568
one or more bugs. See ``brz help bugs`` for details.
3571
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3572
takes_args = ['selected*']
3575
'exclude', type=text_type, short_name='x',
3576
help="Do not consider changes made to a given path."),
3577
Option('message', type=text_type,
3579
help="Description of the new revision."),
3582
help='Commit even if nothing has changed.'),
3583
Option('file', type=text_type,
3586
help='Take commit message from this file.'),
3588
help="Refuse to commit if there are unknown "
3589
"files in the working tree."),
3590
Option('commit-time', type=text_type,
3591
help="Manually set a commit time using commit date "
3592
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3594
'bugs', type=text_type,
3595
help="Link to a related bug. (see \"brz help bugs\")."),
3597
'fixes', type=text_type,
3598
help="Mark a bug as being fixed by this revision "
3599
"(see \"brz help bugs\")."),
3601
'author', type=text_type,
3602
help="Set the author's name, if it's different "
3603
"from the committer."),
3605
help="Perform a local commit in a bound "
3606
"branch. Local commits are not pushed to "
3607
"the master branch until a normal commit "
3610
Option('show-diff', short_name='p',
3611
help='When no message is supplied, show the diff along'
3612
' with the status summary in the message editor.'),
3614
help='When committing to a foreign version control '
3615
'system do not push data that can not be natively '
3617
aliases = ['ci', 'checkin']
3619
def _iter_bug_urls(self, bugs, branch, status):
3620
default_bugtracker = None
3621
# Configure the properties for bug fixing attributes.
3623
tokens = bug.split(':')
3624
if len(tokens) == 1:
3625
if default_bugtracker is None:
3626
branch_config = branch.get_config_stack()
3627
default_bugtracker = branch_config.get(
3629
if default_bugtracker is None:
3630
raise errors.CommandError(gettext(
3631
"No tracker specified for bug %s. Use the form "
3632
"'tracker:id' or specify a default bug tracker "
3633
"using the `bugtracker` option.\nSee "
3634
"\"brz help bugs\" for more information on this "
3635
"feature. Commit refused.") % bug)
3636
tag = default_bugtracker
3638
elif len(tokens) != 2:
3639
raise errors.CommandError(gettext(
3640
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3641
"See \"brz help bugs\" for more information on this "
3642
"feature.\nCommit refused.") % bug)
3644
tag, bug_id = tokens
3646
yield bugtracker.get_bug_url(tag, branch, bug_id), status
3647
except bugtracker.UnknownBugTrackerAbbreviation:
3648
raise errors.CommandError(gettext(
3649
'Unrecognized bug %s. Commit refused.') % bug)
3650
except bugtracker.MalformedBugIdentifier as e:
3651
raise errors.CommandError(gettext(
3652
u"%s\nCommit refused.") % (e,))
3654
def run(self, message=None, file=None, verbose=False, selected_list=None,
3655
unchanged=False, strict=False, local=False, fixes=None, bugs=None,
3656
author=None, show_diff=False, exclude=None, commit_time=None,
3659
from .commit import (
3662
from .errors import (
3666
from .msgeditor import (
3667
edit_commit_message_encoded,
3668
generate_commit_message_template,
3669
make_commit_message_template_encoded,
3673
commit_stamp = offset = None
3674
if commit_time is not None:
3676
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3677
except ValueError as e:
3678
raise errors.CommandError(gettext(
3679
"Could not parse --commit-time: " + str(e)))
3683
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3684
if selected_list == ['']:
3685
# workaround - commit of root of tree should be exactly the same
3686
# as just default commit in that tree, and succeed even though
3687
# selected-file merge commit is not done yet
3694
bug_property = bugtracker.encode_fixes_bug_urls(
3696
self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
3697
self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
3699
properties[u'bugs'] = bug_property
3701
if local and not tree.branch.get_bound_location():
3702
raise errors.LocalRequiresBoundBranch()
3704
if message is not None:
3706
file_exists = osutils.lexists(message)
3707
except UnicodeError:
3708
# The commit message contains unicode characters that can't be
3709
# represented in the filesystem encoding, so that can't be a
3714
'The commit message is a file name: "%(f)s".\n'
3715
'(use --file "%(f)s" to take commit message from that file)'
3717
ui.ui_factory.show_warning(warning_msg)
3719
message = message.replace('\r\n', '\n')
3720
message = message.replace('\r', '\n')
3722
raise errors.CommandError(gettext(
3723
"please specify either --message or --file"))
3725
def get_message(commit_obj):
3726
"""Callback to get commit message"""
3728
with open(file, 'rb') as f:
3729
my_message = f.read().decode(osutils.get_user_encoding())
3730
elif message is not None:
3731
my_message = message
3733
# No message supplied: make one up.
3734
# text is the status of the tree
3735
text = make_commit_message_template_encoded(tree,
3736
selected_list, diff=show_diff,
3737
output_encoding=osutils.get_user_encoding())
3738
# start_message is the template generated from hooks
3739
# XXX: Warning - looks like hooks return unicode,
3740
# make_commit_message_template_encoded returns user encoding.
3741
# We probably want to be using edit_commit_message instead to
3743
my_message = set_commit_message(commit_obj)
3744
if my_message is None:
3745
start_message = generate_commit_message_template(
3747
if start_message is not None:
3748
start_message = start_message.encode(
3749
osutils.get_user_encoding())
3750
my_message = edit_commit_message_encoded(text,
3751
start_message=start_message)
3752
if my_message is None:
3753
raise errors.CommandError(gettext("please specify a commit"
3754
" message with either --message or --file"))
3755
if my_message == "":
3756
raise errors.CommandError(gettext("Empty commit message specified."
3757
" Please specify a commit message with either"
3758
" --message or --file or leave a blank message"
3759
" with --message \"\"."))
3762
# The API permits a commit with a filter of [] to mean 'select nothing'
3763
# but the command line should not do that.
3764
if not selected_list:
3765
selected_list = None
3767
tree.commit(message_callback=get_message,
3768
specific_files=selected_list,
3769
allow_pointless=unchanged, strict=strict, local=local,
3770
reporter=None, verbose=verbose, revprops=properties,
3771
authors=author, timestamp=commit_stamp,
3773
exclude=tree.safe_relpath_files(exclude),
3775
except PointlessCommit:
3776
raise errors.CommandError(gettext("No changes to commit."
3777
" Please 'brz add' the files you want to commit, or use"
3778
" --unchanged to force an empty commit."))
3779
except ConflictsInTree:
3780
raise errors.CommandError(gettext('Conflicts detected in working '
3781
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3783
except StrictCommitFailed:
3784
raise errors.CommandError(gettext("Commit refused because there are"
3785
" unknown files in the working tree."))
3786
except errors.BoundBranchOutOfDate as e:
3787
e.extra_help = (gettext("\n"
3788
'To commit to master branch, run update and then commit.\n'
3789
'You can also pass --local to commit to continue working '
3794
class cmd_check(Command):
3795
__doc__ = """Validate working tree structure, branch consistency and repository history.
3797
This command checks various invariants about branch and repository storage
3798
to detect data corruption or brz bugs.
3800
The working tree and branch checks will only give output if a problem is
3801
detected. The output fields of the repository check are:
3804
This is just the number of revisions checked. It doesn't
3808
This is just the number of versionedfiles checked. It
3809
doesn't indicate a problem.
3811
unreferenced ancestors
3812
Texts that are ancestors of other texts, but
3813
are not properly referenced by the revision ancestry. This is a
3814
subtle problem that Breezy can work around.
3817
This is the total number of unique file contents
3818
seen in the checked revisions. It does not indicate a problem.
3821
This is the total number of repeated texts seen
3822
in the checked revisions. Texts can be repeated when their file
3823
entries are modified, but the file contents are not. It does not
3826
If no restrictions are specified, all data that is found at the given
3827
location will be checked.
3831
Check the tree and branch at 'foo'::
3833
brz check --tree --branch foo
3835
Check only the repository at 'bar'::
3837
brz check --repo bar
3839
Check everything at 'baz'::
3844
_see_also = ['reconcile']
3845
takes_args = ['path?']
3846
takes_options = ['verbose',
3847
Option('branch', help="Check the branch related to the"
3848
" current directory."),
3849
Option('repo', help="Check the repository related to the"
3850
" current directory."),
3851
Option('tree', help="Check the working tree related to"
3852
" the current directory.")]
3854
def run(self, path=None, verbose=False, branch=False, repo=False,
3856
from .check import check_dwim
3859
if not branch and not repo and not tree:
3860
branch = repo = tree = True
3861
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3864
class cmd_upgrade(Command):
3865
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3867
When the default format has changed after a major new release of
3868
Bazaar/Breezy, you may be informed during certain operations that you
3869
should upgrade. Upgrading to a newer format may improve performance
3870
or make new features available. It may however limit interoperability
3871
with older repositories or with older versions of Bazaar or Breezy.
3873
If you wish to upgrade to a particular format rather than the
3874
current default, that can be specified using the --format option.
3875
As a consequence, you can use the upgrade command this way to
3876
"downgrade" to an earlier format, though some conversions are
3877
a one way process (e.g. changing from the 1.x default to the
3878
2.x default) so downgrading is not always possible.
3880
A backup.bzr.~#~ directory is created at the start of the conversion
3881
process (where # is a number). By default, this is left there on
3882
completion. If the conversion fails, delete the new .bzr directory
3883
and rename this one back in its place. Use the --clean option to ask
3884
for the backup.bzr directory to be removed on successful conversion.
3885
Alternatively, you can delete it by hand if everything looks good
3888
If the location given is a shared repository, dependent branches
3889
are also converted provided the repository converts successfully.
3890
If the conversion of a branch fails, remaining branches are still
3893
For more information on upgrades, see the Breezy Upgrade Guide,
3894
https://www.breezy-vcs.org/doc/en/upgrade-guide/.
3897
_see_also = ['check', 'reconcile', 'formats']
3898
takes_args = ['url?']
3900
RegistryOption('format',
3901
help='Upgrade to a specific format. See "brz help'
3902
' formats" for details.',
3903
lazy_registry=('breezy.controldir', 'format_registry'),
3904
converter=lambda name: controldir.format_registry.make_controldir(
3906
value_switches=True, title='Branch format'),
3908
help='Remove the backup.bzr directory if successful.'),
3910
help="Show what would be done, but don't actually do anything."),
3913
def run(self, url='.', format=None, clean=False, dry_run=False):
3914
from .upgrade import upgrade
3915
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3917
if len(exceptions) == 1:
3918
# Compatibility with historical behavior
3924
class cmd_whoami(Command):
3925
__doc__ = """Show or set brz user id.
3928
Show the email of the current user::
3932
Set the current user::
3934
brz whoami "Frank Chu <fchu@example.com>"
3936
takes_options = ['directory',
3938
help='Display email address only.'),
3940
help='Set identity for the current branch instead of '
3943
takes_args = ['name?']
3944
encoding_type = 'replace'
3947
def run(self, email=False, branch=False, name=None, directory=None):
3949
if directory is None:
3950
# use branch if we're inside one; otherwise global config
3952
c = Branch.open_containing(u'.')[0].get_config_stack()
3953
except errors.NotBranchError:
3954
c = _mod_config.GlobalStack()
3956
c = Branch.open(directory).get_config_stack()
3957
identity = c.get('email')
3959
self.outf.write(_mod_config.extract_email_address(identity)
3962
self.outf.write(identity + '\n')
3966
raise errors.CommandError(gettext("--email can only be used to display existing "
3969
# display a warning if an email address isn't included in the given name.
3971
_mod_config.extract_email_address(name)
3972
except _mod_config.NoEmailInUsername:
3973
warning('"%s" does not seem to contain an email address. '
3974
'This is allowed, but not recommended.', name)
3976
# use global config unless --branch given
3978
if directory is None:
3979
c = Branch.open_containing(u'.')[0].get_config_stack()
3981
b = Branch.open(directory)
3982
self.enter_context(b.lock_write())
3983
c = b.get_config_stack()
3985
c = _mod_config.GlobalStack()
3986
c.set('email', name)
3989
class cmd_nick(Command):
3990
__doc__ = """Print or set the branch nickname.
3992
If unset, the colocated branch name is used for colocated branches, and
3993
the branch directory name is used for other branches. To print the
3994
current nickname, execute with no argument.
3996
Bound branches use the nickname of its master branch unless it is set
4000
_see_also = ['info']
4001
takes_args = ['nickname?']
4002
takes_options = ['directory']
4004
def run(self, nickname=None, directory=u'.'):
4005
branch = Branch.open_containing(directory)[0]
4006
if nickname is None:
4007
self.printme(branch)
4009
branch.nick = nickname
4012
def printme(self, branch):
4013
self.outf.write('%s\n' % branch.nick)
4016
class cmd_alias(Command):
4017
__doc__ = """Set/unset and display aliases.
4020
Show the current aliases::
4024
Show the alias specified for 'll'::
4028
Set an alias for 'll'::
4030
brz alias ll="log --line -r-10..-1"
4032
To remove an alias for 'll'::
4034
brz alias --remove ll
4037
takes_args = ['name?']
4039
Option('remove', help='Remove the alias.'),
4042
def run(self, name=None, remove=False):
4044
self.remove_alias(name)
4046
self.print_aliases()
4048
equal_pos = name.find('=')
4050
self.print_alias(name)
4052
self.set_alias(name[:equal_pos], name[equal_pos + 1:])
4054
def remove_alias(self, alias_name):
4055
if alias_name is None:
4056
raise errors.CommandError(gettext(
4057
'brz alias --remove expects an alias to remove.'))
4058
# If alias is not found, print something like:
4059
# unalias: foo: not found
4060
c = _mod_config.GlobalConfig()
4061
c.unset_alias(alias_name)
4064
def print_aliases(self):
4065
"""Print out the defined aliases in a similar format to bash."""
4066
aliases = _mod_config.GlobalConfig().get_aliases()
4067
for key, value in sorted(viewitems(aliases)):
4068
self.outf.write('brz alias %s="%s"\n' % (key, value))
4071
def print_alias(self, alias_name):
4072
from .commands import get_alias
4073
alias = get_alias(alias_name)
4075
self.outf.write("brz alias: %s: not found\n" % alias_name)
4078
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
4080
def set_alias(self, alias_name, alias_command):
4081
"""Save the alias in the global config."""
4082
c = _mod_config.GlobalConfig()
4083
c.set_alias(alias_name, alias_command)
4086
class cmd_selftest(Command):
4087
__doc__ = """Run internal test suite.
4089
If arguments are given, they are regular expressions that say which tests
4090
should run. Tests matching any expression are run, and other tests are
4093
Alternatively if --first is given, matching tests are run first and then
4094
all other tests are run. This is useful if you have been working in a
4095
particular area, but want to make sure nothing else was broken.
4097
If --exclude is given, tests that match that regular expression are
4098
excluded, regardless of whether they match --first or not.
4100
To help catch accidential dependencies between tests, the --randomize
4101
option is useful. In most cases, the argument used is the word 'now'.
4102
Note that the seed used for the random number generator is displayed
4103
when this option is used. The seed can be explicitly passed as the
4104
argument to this option if required. This enables reproduction of the
4105
actual ordering used if and when an order sensitive problem is encountered.
4107
If --list-only is given, the tests that would be run are listed. This is
4108
useful when combined with --first, --exclude and/or --randomize to
4109
understand their impact. The test harness reports "Listed nn tests in ..."
4110
instead of "Ran nn tests in ..." when list mode is enabled.
4112
If the global option '--no-plugins' is given, plugins are not loaded
4113
before running the selftests. This has two effects: features provided or
4114
modified by plugins will not be tested, and tests provided by plugins will
4117
Tests that need working space on disk use a common temporary directory,
4118
typically inside $TMPDIR or /tmp.
4120
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4121
into a pdb postmortem session.
4123
The --coverage=DIRNAME global option produces a report with covered code
4127
Run only tests relating to 'ignore'::
4131
Disable plugins and list tests as they're run::
4133
brz --no-plugins selftest -v
4135
# NB: this is used from the class without creating an instance, which is
4136
# why it does not have a self parameter.
4138
def get_transport_type(typestring):
4139
"""Parse and return a transport specifier."""
4140
if typestring == "sftp":
4141
from .tests import stub_sftp
4142
return stub_sftp.SFTPAbsoluteServer
4143
elif typestring == "memory":
4144
from .tests import test_server
4145
return memory.MemoryServer
4146
elif typestring == "fakenfs":
4147
from .tests import test_server
4148
return test_server.FakeNFSServer
4149
msg = "No known transport type %s. Supported types are: sftp\n" %\
4151
raise errors.CommandError(msg)
4154
takes_args = ['testspecs*']
4155
takes_options = ['verbose',
4157
help='Stop when one test fails.',
4161
help='Use a different transport by default '
4162
'throughout the test suite.',
4163
type=get_transport_type),
4165
help='Run the benchmarks rather than selftests.',
4167
Option('lsprof-timed',
4168
help='Generate lsprof output for benchmarked'
4169
' sections of code.'),
4170
Option('lsprof-tests',
4171
help='Generate lsprof output for each test.'),
4173
help='Run all tests, but run specified tests first.',
4177
help='List the tests instead of running them.'),
4178
RegistryOption('parallel',
4179
help="Run the test suite in parallel.",
4181
'breezy.tests', 'parallel_registry'),
4182
value_switches=False,
4184
Option('randomize', type=text_type, argname="SEED",
4185
help='Randomize the order of tests using the given'
4186
' seed or "now" for the current time.'),
4187
ListOption('exclude', type=text_type, argname="PATTERN",
4189
help='Exclude tests that match this regular'
4192
help='Output test progress via subunit v1.'),
4194
help='Output test progress via subunit v2.'),
4195
Option('strict', help='Fail on missing dependencies or '
4197
Option('load-list', type=text_type, argname='TESTLISTFILE',
4198
help='Load a test id list from a text file.'),
4199
ListOption('debugflag', type=text_type, short_name='E',
4200
help='Turn on a selftest debug flag.'),
4201
ListOption('starting-with', type=text_type, argname='TESTID',
4202
param_name='starting_with', short_name='s',
4203
help='Load only the tests starting with TESTID.'),
4205
help="By default we disable fsync and fdatasync"
4206
" while running the test suite.")
4208
encoding_type = 'replace'
4211
Command.__init__(self)
4212
self.additional_selftest_args = {}
4214
def run(self, testspecs_list=None, verbose=False, one=False,
4215
transport=None, benchmark=None,
4217
first=False, list_only=False,
4218
randomize=None, exclude=None, strict=False,
4219
load_list=None, debugflag=None, starting_with=None, subunit1=False,
4220
subunit2=False, parallel=None, lsprof_tests=False, sync=False):
4222
# During selftest, disallow proxying, as it can cause severe
4223
# performance penalties and is only needed for thread
4224
# safety. The selftest command is assumed to not use threads
4225
# too heavily. The call should be as early as possible, as
4226
# error reporting for past duplicate imports won't have useful
4228
if sys.version_info[0] < 3:
4229
# TODO(pad.lv/1696545): Allow proxying on Python 3, since
4230
# disallowing it currently leads to failures in many places.
4231
lazy_import.disallow_proxying()
4235
except ImportError as e:
4236
raise errors.CommandError("tests not available. Install the "
4237
"breezy tests to run the breezy testsuite.")
4239
if testspecs_list is not None:
4240
pattern = '|'.join(testspecs_list)
4245
from .tests import SubUnitBzrRunnerv1
4247
raise errors.CommandError(gettext(
4248
"subunit not available. subunit needs to be installed "
4249
"to use --subunit."))
4250
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
4251
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4252
# stdout, which would corrupt the subunit stream.
4253
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4254
# following code can be deleted when it's sufficiently deployed
4255
# -- vila/mgz 20100514
4256
if (sys.platform == "win32"
4257
and getattr(sys.stdout, 'fileno', None) is not None):
4259
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4262
from .tests import SubUnitBzrRunnerv2
4264
raise errors.CommandError(gettext(
4265
"subunit not available. subunit "
4266
"needs to be installed to use --subunit2."))
4267
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
4270
self.additional_selftest_args.setdefault(
4271
'suite_decorators', []).append(parallel)
4273
raise errors.CommandError(gettext(
4274
"--benchmark is no longer supported from brz 2.2; "
4275
"use bzr-usertest instead"))
4276
test_suite_factory = None
4278
exclude_pattern = None
4280
exclude_pattern = '(' + '|'.join(exclude) + ')'
4282
self._disable_fsync()
4283
selftest_kwargs = {"verbose": verbose,
4285
"stop_on_failure": one,
4286
"transport": transport,
4287
"test_suite_factory": test_suite_factory,
4288
"lsprof_timed": lsprof_timed,
4289
"lsprof_tests": lsprof_tests,
4290
"matching_tests_first": first,
4291
"list_only": list_only,
4292
"random_seed": randomize,
4293
"exclude_pattern": exclude_pattern,
4295
"load_list": load_list,
4296
"debug_flags": debugflag,
4297
"starting_with": starting_with
4299
selftest_kwargs.update(self.additional_selftest_args)
4301
# Make deprecation warnings visible, unless -Werror is set
4302
cleanup = symbol_versioning.activate_deprecation_warnings(
4305
result = tests.selftest(**selftest_kwargs)
4308
return int(not result)
4310
def _disable_fsync(self):
4311
"""Change the 'os' functionality to not synchronize."""
4312
self._orig_fsync = getattr(os, 'fsync', None)
4313
if self._orig_fsync is not None:
4314
os.fsync = lambda filedes: None
4315
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4316
if self._orig_fdatasync is not None:
4317
os.fdatasync = lambda filedes: None
4320
class cmd_version(Command):
4321
__doc__ = """Show version of brz."""
4323
encoding_type = 'replace'
4325
Option("short", help="Print just the version number."),
4329
def run(self, short=False):
4330
from .version import show_version
4332
self.outf.write(breezy.version_string + '\n')
4334
show_version(to_file=self.outf)
4337
class cmd_rocks(Command):
4338
__doc__ = """Statement of optimism."""
4344
self.outf.write(gettext("It sure does!\n"))
4347
class cmd_find_merge_base(Command):
4348
__doc__ = """Find and print a base revision for merging two branches."""
4349
# TODO: Options to specify revisions on either side, as if
4350
# merging only part of the history.
4351
takes_args = ['branch', 'other']
4355
def run(self, branch, other):
4356
from .revision import ensure_null
4358
branch1 = Branch.open_containing(branch)[0]
4359
branch2 = Branch.open_containing(other)[0]
4360
self.enter_context(branch1.lock_read())
4361
self.enter_context(branch2.lock_read())
4362
last1 = ensure_null(branch1.last_revision())
4363
last2 = ensure_null(branch2.last_revision())
4365
graph = branch1.repository.get_graph(branch2.repository)
4366
base_rev_id = graph.find_unique_lca(last1, last2)
4368
self.outf.write(gettext('merge base is revision %s\n') %
4369
base_rev_id.decode('utf-8'))
4372
class cmd_merge(Command):
4373
__doc__ = """Perform a three-way merge.
4375
The source of the merge can be specified either in the form of a branch,
4376
or in the form of a path to a file containing a merge directive generated
4377
with brz send. If neither is specified, the default is the upstream branch
4378
or the branch most recently merged using --remember. The source of the
4379
merge may also be specified in the form of a path to a file in another
4380
branch: in this case, only the modifications to that file are merged into
4381
the current working tree.
4383
When merging from a branch, by default brz will try to merge in all new
4384
work from the other branch, automatically determining an appropriate base
4385
revision. If this fails, you may need to give an explicit base.
4387
To pick a different ending revision, pass "--revision OTHER". brz will
4388
try to merge in all new work up to and including revision OTHER.
4390
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4391
through OTHER, excluding BASE but including OTHER, will be merged. If this
4392
causes some revisions to be skipped, i.e. if the destination branch does
4393
not already contain revision BASE, such a merge is commonly referred to as
4394
a "cherrypick". Unlike a normal merge, Breezy does not currently track
4395
cherrypicks. The changes look like a normal commit, and the history of the
4396
changes from the other branch is not stored in the commit.
4398
Revision numbers are always relative to the source branch.
4400
Merge will do its best to combine the changes in two branches, but there
4401
are some kinds of problems only a human can fix. When it encounters those,
4402
it will mark a conflict. A conflict means that you need to fix something,
4403
before you can commit.
4405
Use brz resolve when you have fixed a problem. See also brz conflicts.
4407
If there is no default branch set, the first merge will set it (use
4408
--no-remember to avoid setting it). After that, you can omit the branch
4409
to use the default. To change the default, use --remember. The value will
4410
only be saved if the remote location can be accessed.
4412
The results of the merge are placed into the destination working
4413
directory, where they can be reviewed (with brz diff), tested, and then
4414
committed to record the result of the merge.
4416
merge refuses to run if there are any uncommitted changes, unless
4417
--force is given. If --force is given, then the changes from the source
4418
will be merged with the current working tree, including any uncommitted
4419
changes in the tree. The --force option can also be used to create a
4420
merge revision which has more than two parents.
4422
If one would like to merge changes from the working tree of the other
4423
branch without merging any committed revisions, the --uncommitted option
4426
To select only some changes to merge, use "merge -i", which will prompt
4427
you to apply each diff hunk and file change, similar to "shelve".
4430
To merge all new revisions from brz.dev::
4432
brz merge ../brz.dev
4434
To merge changes up to and including revision 82 from brz.dev::
4436
brz merge -r 82 ../brz.dev
4438
To merge the changes introduced by 82, without previous changes::
4440
brz merge -r 81..82 ../brz.dev
4442
To apply a merge directive contained in /tmp/merge::
4444
brz merge /tmp/merge
4446
To create a merge revision with three parents from two branches
4447
feature1a and feature1b:
4449
brz merge ../feature1a
4450
brz merge ../feature1b --force
4451
brz commit -m 'revision with three parents'
4454
encoding_type = 'exact'
4455
_see_also = ['update', 'remerge', 'status-flags', 'send']
4456
takes_args = ['location?']
4461
help='Merge even if the destination tree has uncommitted changes.'),
4465
Option('show-base', help="Show base revision text in "
4467
Option('uncommitted', help='Apply uncommitted changes'
4468
' from a working copy, instead of branch changes.'),
4469
Option('pull', help='If the destination is already'
4470
' completely merged into the source, pull from the'
4471
' source rather than merging. When this happens,'
4472
' you do not need to commit the result.'),
4473
custom_help('directory',
4474
help='Branch to merge into, '
4475
'rather than the one containing the working directory.'),
4476
Option('preview', help='Instead of merging, show a diff of the'
4478
Option('interactive', help='Select changes interactively.',
4482
def run(self, location=None, revision=None, force=False,
4483
merge_type=None, show_base=False, reprocess=None, remember=None,
4484
uncommitted=False, pull=False,
4489
if merge_type is None:
4490
merge_type = _mod_merge.Merge3Merger
4492
if directory is None:
4494
possible_transports = []
4496
allow_pending = True
4497
verified = 'inapplicable'
4499
tree = WorkingTree.open_containing(directory)[0]
4500
if tree.branch.last_revision() == _mod_revision.NULL_REVISION:
4501
raise errors.CommandError(gettext('Merging into empty branches not currently supported, '
4502
'https://bugs.launchpad.net/bzr/+bug/308562'))
4504
# die as quickly as possible if there are uncommitted changes
4506
if tree.has_changes():
4507
raise errors.UncommittedChanges(tree)
4509
view_info = _get_view_info_for_change_reporter(tree)
4510
change_reporter = delta._ChangeReporter(
4511
unversioned_filter=tree.is_ignored, view_info=view_info)
4512
pb = ui.ui_factory.nested_progress_bar()
4513
self.enter_context(pb)
4514
self.enter_context(tree.lock_write())
4515
if location is not None:
4517
mergeable = _mod_mergeable.read_mergeable_from_url(
4518
location, possible_transports=possible_transports)
4519
except errors.NotABundle:
4523
raise errors.CommandError(gettext('Cannot use --uncommitted'
4524
' with bundles or merge directives.'))
4526
if revision is not None:
4527
raise errors.CommandError(gettext(
4528
'Cannot use -r with merge directives or bundles'))
4529
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4532
if merger is None and uncommitted:
4533
if revision is not None and len(revision) > 0:
4534
raise errors.CommandError(gettext('Cannot use --uncommitted and'
4535
' --revision at the same time.'))
4536
merger = self.get_merger_from_uncommitted(tree, location, None)
4537
allow_pending = False
4540
merger, allow_pending = self._get_merger_from_branch(tree,
4541
location, revision, remember, possible_transports, None)
4543
merger.merge_type = merge_type
4544
merger.reprocess = reprocess
4545
merger.show_base = show_base
4546
self.sanity_check_merger(merger)
4547
if (merger.base_rev_id == merger.other_rev_id and
4548
merger.other_rev_id is not None):
4549
# check if location is a nonexistent file (and not a branch) to
4550
# disambiguate the 'Nothing to do'
4551
if merger.interesting_files:
4552
if not merger.other_tree.has_filename(
4553
merger.interesting_files[0]):
4554
note(gettext("merger: ") + str(merger))
4555
raise errors.PathsDoNotExist([location])
4556
note(gettext('Nothing to do.'))
4558
if pull and not preview:
4559
if merger.interesting_files is not None:
4560
raise errors.CommandError(
4561
gettext('Cannot pull individual files'))
4562
if (merger.base_rev_id == tree.last_revision()):
4563
result = tree.pull(merger.other_branch, False,
4564
merger.other_rev_id)
4565
result.report(self.outf)
4567
if merger.this_basis is None:
4568
raise errors.CommandError(gettext(
4569
"This branch has no commits."
4570
" (perhaps you would prefer 'brz pull')"))
4572
return self._do_preview(merger)
4574
return self._do_interactive(merger)
4576
return self._do_merge(merger, change_reporter, allow_pending,
4579
def _get_preview(self, merger):
4580
tree_merger = merger.make_merger()
4581
tt = tree_merger.make_preview_transform()
4582
self.enter_context(tt)
4583
result_tree = tt.get_preview_tree()
4586
def _do_preview(self, merger):
4587
from .diff import show_diff_trees
4588
result_tree = self._get_preview(merger)
4589
path_encoding = osutils.get_diff_header_encoding()
4590
show_diff_trees(merger.this_tree, result_tree, self.outf,
4591
old_label='', new_label='',
4592
path_encoding=path_encoding)
4594
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4595
merger.change_reporter = change_reporter
4596
conflict_count = merger.do_merge()
4598
merger.set_pending()
4599
if verified == 'failed':
4600
warning('Preview patch does not match changes')
4601
if conflict_count != 0:
4606
def _do_interactive(self, merger):
4607
"""Perform an interactive merge.
4609
This works by generating a preview tree of the merge, then using
4610
Shelver to selectively remove the differences between the working tree
4611
and the preview tree.
4613
from . import shelf_ui
4614
result_tree = self._get_preview(merger)
4615
writer = breezy.option.diff_writer_registry.get()
4616
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4617
reporter=shelf_ui.ApplyReporter(),
4618
diff_writer=writer(self.outf))
4624
def sanity_check_merger(self, merger):
4625
if (merger.show_base and
4626
merger.merge_type is not _mod_merge.Merge3Merger):
4627
raise errors.CommandError(gettext("Show-base is not supported for this"
4628
" merge type. %s") % merger.merge_type)
4629
if merger.reprocess is None:
4630
if merger.show_base:
4631
merger.reprocess = False
4633
# Use reprocess if the merger supports it
4634
merger.reprocess = merger.merge_type.supports_reprocess
4635
if merger.reprocess and not merger.merge_type.supports_reprocess:
4636
raise errors.CommandError(gettext("Conflict reduction is not supported"
4637
" for merge type %s.") %
4639
if merger.reprocess and merger.show_base:
4640
raise errors.CommandError(gettext("Cannot do conflict reduction and"
4643
if (merger.merge_type.requires_file_merge_plan and
4644
(not getattr(merger.this_tree, 'plan_file_merge', None) or
4645
not getattr(merger.other_tree, 'plan_file_merge', None) or
4646
(merger.base_tree is not None and
4647
not getattr(merger.base_tree, 'plan_file_merge', None)))):
4648
raise errors.CommandError(
4649
gettext('Plan file merge unsupported: '
4650
'Merge type incompatible with tree formats.'))
4652
def _get_merger_from_branch(self, tree, location, revision, remember,
4653
possible_transports, pb):
4654
"""Produce a merger from a location, assuming it refers to a branch."""
4655
# find the branch locations
4656
other_loc, user_location = self._select_branch_location(tree, location,
4658
if revision is not None and len(revision) == 2:
4659
base_loc, _unused = self._select_branch_location(tree,
4660
location, revision, 0)
4662
base_loc = other_loc
4664
other_branch, other_path = Branch.open_containing(other_loc,
4665
possible_transports)
4666
if base_loc == other_loc:
4667
base_branch = other_branch
4669
base_branch, base_path = Branch.open_containing(base_loc,
4670
possible_transports)
4671
# Find the revision ids
4672
other_revision_id = None
4673
base_revision_id = None
4674
if revision is not None:
4675
if len(revision) >= 1:
4676
other_revision_id = revision[-1].as_revision_id(other_branch)
4677
if len(revision) == 2:
4678
base_revision_id = revision[0].as_revision_id(base_branch)
4679
if other_revision_id is None:
4680
other_revision_id = _mod_revision.ensure_null(
4681
other_branch.last_revision())
4682
# Remember where we merge from. We need to remember if:
4683
# - user specify a location (and we don't merge from the parent
4685
# - user ask to remember or there is no previous location set to merge
4686
# from and user didn't ask to *not* remember
4687
if (user_location is not None
4689
(remember is None and
4690
tree.branch.get_submit_branch() is None)))):
4691
tree.branch.set_submit_branch(other_branch.base)
4692
# Merge tags (but don't set them in the master branch yet, the user
4693
# might revert this merge). Commit will propagate them.
4694
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4695
merger = _mod_merge.Merger.from_revision_ids(tree,
4696
other_revision_id, base_revision_id, other_branch, base_branch)
4697
if other_path != '':
4698
allow_pending = False
4699
merger.interesting_files = [other_path]
4701
allow_pending = True
4702
return merger, allow_pending
4704
def get_merger_from_uncommitted(self, tree, location, pb):
4705
"""Get a merger for uncommitted changes.
4707
:param tree: The tree the merger should apply to.
4708
:param location: The location containing uncommitted changes.
4709
:param pb: The progress bar to use for showing progress.
4711
location = self._select_branch_location(tree, location)[0]
4712
other_tree, other_path = WorkingTree.open_containing(location)
4713
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4714
if other_path != '':
4715
merger.interesting_files = [other_path]
4718
def _select_branch_location(self, tree, user_location, revision=None,
4720
"""Select a branch location, according to possible inputs.
4722
If provided, branches from ``revision`` are preferred. (Both
4723
``revision`` and ``index`` must be supplied.)
4725
Otherwise, the ``location`` parameter is used. If it is None, then the
4726
``submit`` or ``parent`` location is used, and a note is printed.
4728
:param tree: The working tree to select a branch for merging into
4729
:param location: The location entered by the user
4730
:param revision: The revision parameter to the command
4731
:param index: The index to use for the revision parameter. Negative
4732
indices are permitted.
4733
:return: (selected_location, user_location). The default location
4734
will be the user-entered location.
4736
if (revision is not None and index is not None
4737
and revision[index] is not None):
4738
branch = revision[index].get_branch()
4739
if branch is not None:
4740
return branch, branch
4741
if user_location is None:
4742
location = self._get_remembered(tree, 'Merging from')
4744
location = user_location
4745
return location, user_location
4747
def _get_remembered(self, tree, verb_string):
4748
"""Use tree.branch's parent if none was supplied.
4750
Report if the remembered location was used.
4752
stored_location = tree.branch.get_submit_branch()
4753
stored_location_type = "submit"
4754
if stored_location is None:
4755
stored_location = tree.branch.get_parent()
4756
stored_location_type = "parent"
4757
mutter("%s", stored_location)
4758
if stored_location is None:
4759
raise errors.CommandError(
4760
gettext("No location specified or remembered"))
4761
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4762
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4763
stored_location_type, display_url))
4764
return stored_location
4767
class cmd_remerge(Command):
4768
__doc__ = """Redo a merge.
4770
Use this if you want to try a different merge technique while resolving
4771
conflicts. Some merge techniques are better than others, and remerge
4772
lets you try different ones on different files.
4774
The options for remerge have the same meaning and defaults as the ones for
4775
merge. The difference is that remerge can (only) be run when there is a
4776
pending merge, and it lets you specify particular files.
4779
Re-do the merge of all conflicted files, and show the base text in
4780
conflict regions, in addition to the usual THIS and OTHER texts::
4782
brz remerge --show-base
4784
Re-do the merge of "foobar", using the weave merge algorithm, with
4785
additional processing to reduce the size of conflict regions::
4787
brz remerge --merge-type weave --reprocess foobar
4789
takes_args = ['file*']
4794
help="Show base revision text in conflicts."),
4797
def run(self, file_list=None, merge_type=None, show_base=False,
4799
from .conflicts import restore
4800
if merge_type is None:
4801
merge_type = _mod_merge.Merge3Merger
4802
tree, file_list = WorkingTree.open_containing_paths(file_list)
4803
self.enter_context(tree.lock_write())
4804
parents = tree.get_parent_ids()
4805
if len(parents) != 2:
4806
raise errors.CommandError(
4807
gettext("Sorry, remerge only works after normal"
4808
" merges. Not cherrypicking or multi-merges."))
4809
interesting_files = None
4811
conflicts = tree.conflicts()
4812
if file_list is not None:
4813
interesting_files = set()
4814
for filename in file_list:
4815
if not tree.is_versioned(filename):
4816
raise errors.NotVersionedError(filename)
4817
interesting_files.add(filename)
4818
if tree.kind(filename) != "directory":
4821
for path, ie in tree.iter_entries_by_dir(
4822
specific_files=[filename]):
4823
interesting_files.add(path)
4824
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4826
# Remerge only supports resolving contents conflicts
4827
allowed_conflicts = ('text conflict', 'contents conflict')
4828
restore_files = [c.path for c in conflicts
4829
if c.typestring in allowed_conflicts]
4830
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
4831
tree.set_conflicts(new_conflicts)
4832
if file_list is not None:
4833
restore_files = file_list
4834
for filename in restore_files:
4836
restore(tree.abspath(filename))
4837
except errors.NotConflicted:
4839
# Disable pending merges, because the file texts we are remerging
4840
# have not had those merges performed. If we use the wrong parents
4841
# list, we imply that the working tree text has seen and rejected
4842
# all the changes from the other tree, when in fact those changes
4843
# have not yet been seen.
4844
tree.set_parent_ids(parents[:1])
4846
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4847
merger.interesting_files = interesting_files
4848
merger.merge_type = merge_type
4849
merger.show_base = show_base
4850
merger.reprocess = reprocess
4851
conflicts = merger.do_merge()
4853
tree.set_parent_ids(parents)
4860
class cmd_revert(Command):
4862
Set files in the working tree back to the contents of a previous revision.
4864
Giving a list of files will revert only those files. Otherwise, all files
4865
will be reverted. If the revision is not specified with '--revision', the
4866
working tree basis revision is used. A revert operation affects only the
4867
working tree, not any revision history like the branch and repository or
4868
the working tree basis revision.
4870
To remove only some changes, without reverting to a prior version, use
4871
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4872
will remove the changes introduced by the second last commit (-2), without
4873
affecting the changes introduced by the last commit (-1). To remove
4874
certain changes on a hunk-by-hunk basis, see the shelve command.
4875
To update the branch to a specific revision or the latest revision and
4876
update the working tree accordingly while preserving local changes, see the
4879
Uncommitted changes to files that are reverted will be discarded.
4880
However, by default, any files that have been manually changed will be
4881
backed up first. (Files changed only by merge are not backed up.) Backup
4882
files have '.~#~' appended to their name, where # is a number.
4884
When you provide files, you can use their current pathname or the pathname
4885
from the target revision. So you can use revert to "undelete" a file by
4886
name. If you name a directory, all the contents of that directory will be
4889
If you have newly added files since the target revision, they will be
4890
removed. If the files to be removed have been changed, backups will be
4891
created as above. Directories containing unknown files will not be
4894
The working tree contains a list of revisions that have been merged but
4895
not yet committed. These revisions will be included as additional parents
4896
of the next commit. Normally, using revert clears that list as well as
4897
reverting the files. If any files are specified, revert leaves the list
4898
of uncommitted merges alone and reverts only the files. Use ``brz revert
4899
.`` in the tree root to revert all files but keep the recorded merges,
4900
and ``brz revert --forget-merges`` to clear the pending merge list without
4901
reverting any files.
4903
Using "brz revert --forget-merges", it is possible to apply all of the
4904
changes from a branch in a single revision. To do this, perform the merge
4905
as desired. Then doing revert with the "--forget-merges" option will keep
4906
the content of the tree as it was, but it will clear the list of pending
4907
merges. The next commit will then contain all of the changes that are
4908
present in the other branch, but without any other parent revisions.
4909
Because this technique forgets where these changes originated, it may
4910
cause additional conflicts on later merges involving the same source and
4914
_see_also = ['cat', 'export', 'merge', 'shelve']
4917
Option('no-backup', "Do not save backups of reverted files."),
4918
Option('forget-merges',
4919
'Remove pending merge marker, without changing any files.'),
4921
takes_args = ['file*']
4923
def run(self, revision=None, no_backup=False, file_list=None,
4924
forget_merges=None):
4925
tree, file_list = WorkingTree.open_containing_paths(file_list)
4926
self.enter_context(tree.lock_tree_write())
4928
tree.set_parent_ids(tree.get_parent_ids()[:1])
4930
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4933
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4934
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4935
tree.revert(file_list, rev_tree, not no_backup, None,
4936
report_changes=True)
4939
class cmd_assert_fail(Command):
4940
__doc__ = """Test reporting of assertion failures"""
4941
# intended just for use in testing
4946
raise AssertionError("always fails")
4949
class cmd_help(Command):
4950
__doc__ = """Show help on a command or other topic.
4953
_see_also = ['topics']
4955
Option('long', 'Show help on all commands.'),
4957
takes_args = ['topic?']
4958
aliases = ['?', '--help', '-?', '-h']
4961
def run(self, topic=None, long=False):
4963
if topic is None and long:
4965
breezy.help.help(topic)
4968
class cmd_shell_complete(Command):
4969
__doc__ = """Show appropriate completions for context.
4971
For a list of all available commands, say 'brz shell-complete'.
4973
takes_args = ['context?']
4978
def run(self, context=None):
4979
from . import shellcomplete
4980
shellcomplete.shellcomplete(context)
4983
class cmd_missing(Command):
4984
__doc__ = """Show unmerged/unpulled revisions between two branches.
4986
OTHER_BRANCH may be local or remote.
4988
To filter on a range of revisions, you can use the command -r begin..end
4989
-r revision requests a specific revision, -r ..end or -r begin.. are
4993
1 - some missing revisions
4994
0 - no missing revisions
4998
Determine the missing revisions between this and the branch at the
4999
remembered pull location::
5003
Determine the missing revisions between this and another branch::
5005
brz missing http://server/branch
5007
Determine the missing revisions up to a specific revision on the other
5010
brz missing -r ..-10
5012
Determine the missing revisions up to a specific revision on this
5015
brz missing --my-revision ..-10
5018
_see_also = ['merge', 'pull']
5019
takes_args = ['other_branch?']
5022
Option('reverse', 'Reverse the order of revisions.'),
5024
'Display changes in the local branch only.'),
5025
Option('this', 'Same as --mine-only.'),
5026
Option('theirs-only',
5027
'Display changes in the remote branch only.'),
5028
Option('other', 'Same as --theirs-only.'),
5032
custom_help('revision',
5033
help='Filter on other branch revisions (inclusive). '
5034
'See "help revisionspec" for details.'),
5035
Option('my-revision',
5036
type=_parse_revision_str,
5037
help='Filter on local branch revisions (inclusive). '
5038
'See "help revisionspec" for details.'),
5039
Option('include-merged',
5040
'Show all revisions in addition to the mainline ones.'),
5041
Option('include-merges', hidden=True,
5042
help='Historical alias for --include-merged.'),
5044
encoding_type = 'replace'
5047
def run(self, other_branch=None, reverse=False, mine_only=False,
5049
log_format=None, long=False, short=False, line=False,
5050
show_ids=False, verbose=False, this=False, other=False,
5051
include_merged=None, revision=None, my_revision=None,
5053
from breezy.missing import find_unmerged, iter_log_revisions
5059
if include_merged is None:
5060
include_merged = False
5065
# TODO: We should probably check that we don't have mine-only and
5066
# theirs-only set, but it gets complicated because we also have
5067
# this and other which could be used.
5074
local_branch = Branch.open_containing(directory)[0]
5075
self.enter_context(local_branch.lock_read())
5077
parent = local_branch.get_parent()
5078
if other_branch is None:
5079
other_branch = parent
5080
if other_branch is None:
5081
raise errors.CommandError(gettext("No peer location known"
5083
display_url = urlutils.unescape_for_display(parent,
5085
message(gettext("Using saved parent location: {0}\n").format(
5088
remote_branch = Branch.open(other_branch)
5089
if remote_branch.base == local_branch.base:
5090
remote_branch = local_branch
5092
self.enter_context(remote_branch.lock_read())
5094
local_revid_range = _revision_range_to_revid_range(
5095
_get_revision_range(my_revision, local_branch,
5098
remote_revid_range = _revision_range_to_revid_range(
5099
_get_revision_range(revision,
5100
remote_branch, self.name()))
5102
local_extra, remote_extra = find_unmerged(
5103
local_branch, remote_branch, restrict,
5104
backward=not reverse,
5105
include_merged=include_merged,
5106
local_revid_range=local_revid_range,
5107
remote_revid_range=remote_revid_range)
5109
if log_format is None:
5110
registry = log.log_formatter_registry
5111
log_format = registry.get_default(local_branch)
5112
lf = log_format(to_file=self.outf,
5114
show_timezone='original')
5117
if local_extra and not theirs_only:
5118
message(ngettext("You have %d extra revision:\n",
5119
"You have %d extra revisions:\n",
5123
if local_branch.supports_tags():
5124
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5125
for revision in iter_log_revisions(local_extra,
5126
local_branch.repository,
5129
lf.log_revision(revision)
5130
printed_local = True
5133
printed_local = False
5135
if remote_extra and not mine_only:
5136
if printed_local is True:
5138
message(ngettext("You are missing %d revision:\n",
5139
"You are missing %d revisions:\n",
5140
len(remote_extra)) %
5142
if remote_branch.supports_tags():
5143
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5144
for revision in iter_log_revisions(remote_extra,
5145
remote_branch.repository,
5148
lf.log_revision(revision)
5151
if mine_only and not local_extra:
5152
# We checked local, and found nothing extra
5153
message(gettext('This branch has no new revisions.\n'))
5154
elif theirs_only and not remote_extra:
5155
# We checked remote, and found nothing extra
5156
message(gettext('Other branch has no new revisions.\n'))
5157
elif not (mine_only or theirs_only or local_extra or
5159
# We checked both branches, and neither one had extra
5161
message(gettext("Branches are up to date.\n"))
5163
if not status_code and parent is None and other_branch is not None:
5164
self.enter_context(local_branch.lock_write())
5165
# handle race conditions - a parent might be set while we run.
5166
if local_branch.get_parent() is None:
5167
local_branch.set_parent(remote_branch.base)
5171
class cmd_pack(Command):
5172
__doc__ = """Compress the data within a repository.
5174
This operation compresses the data within a bazaar repository. As
5175
bazaar supports automatic packing of repository, this operation is
5176
normally not required to be done manually.
5178
During the pack operation, bazaar takes a backup of existing repository
5179
data, i.e. pack files. This backup is eventually removed by bazaar
5180
automatically when it is safe to do so. To save disk space by removing
5181
the backed up pack files, the --clean-obsolete-packs option may be
5184
Warning: If you use --clean-obsolete-packs and your machine crashes
5185
during or immediately after repacking, you may be left with a state
5186
where the deletion has been written to disk but the new packs have not
5187
been. In this case the repository may be unusable.
5190
_see_also = ['repositories']
5191
takes_args = ['branch_or_repo?']
5193
Option('clean-obsolete-packs',
5194
'Delete obsolete packs to save disk space.'),
5197
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5198
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5200
branch = dir.open_branch()
5201
repository = branch.repository
5202
except errors.NotBranchError:
5203
repository = dir.open_repository()
5204
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5207
class cmd_plugins(Command):
5208
__doc__ = """List the installed plugins.
5210
This command displays the list of installed plugins including
5211
version of plugin and a short description of each.
5213
--verbose shows the path where each plugin is located.
5215
A plugin is an external component for Breezy that extends the
5216
revision control system, by adding or replacing code in Breezy.
5217
Plugins can do a variety of things, including overriding commands,
5218
adding new commands, providing additional network transports and
5219
customizing log output.
5221
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5222
for further information on plugins including where to find them and how to
5223
install them. Instructions are also provided there on how to write new
5224
plugins using the Python programming language.
5226
takes_options = ['verbose']
5229
def run(self, verbose=False):
5230
from . import plugin
5231
# Don't give writelines a generator as some codecs don't like that
5232
self.outf.writelines(
5233
list(plugin.describe_plugins(show_paths=verbose)))
5236
class cmd_testament(Command):
5237
__doc__ = """Show testament (signing-form) of a revision."""
5240
Option('long', help='Produce long-format testament.'),
5242
help='Produce a strict-format testament.')]
5243
takes_args = ['branch?']
5244
encoding_type = 'exact'
5247
def run(self, branch=u'.', revision=None, long=False, strict=False):
5248
from .bzr.testament import Testament, StrictTestament
5250
testament_class = StrictTestament
5252
testament_class = Testament
5254
b = Branch.open_containing(branch)[0]
5256
b = Branch.open(branch)
5257
self.enter_context(b.lock_read())
5258
if revision is None:
5259
rev_id = b.last_revision()
5261
rev_id = revision[0].as_revision_id(b)
5262
t = testament_class.from_revision(b.repository, rev_id)
5264
self.outf.writelines(t.as_text_lines())
5266
self.outf.write(t.as_short_text())
5269
class cmd_annotate(Command):
5270
__doc__ = """Show the origin of each line in a file.
5272
This prints out the given file with an annotation on the left side
5273
indicating which revision, author and date introduced the change.
5275
If the origin is the same for a run of consecutive lines, it is
5276
shown only at the top, unless the --all option is given.
5278
# TODO: annotate directories; showing when each file was last changed
5279
# TODO: if the working copy is modified, show annotations on that
5280
# with new uncommitted lines marked
5281
aliases = ['ann', 'blame', 'praise']
5282
takes_args = ['filename']
5283
takes_options = [Option('all', help='Show annotations on all lines.'),
5284
Option('long', help='Show commit date in annotations.'),
5289
encoding_type = 'exact'
5292
def run(self, filename, all=False, long=False, revision=None,
5293
show_ids=False, directory=None):
5294
from .annotate import (
5297
wt, branch, relpath = \
5298
_open_directory_or_containing_tree_or_branch(filename, directory)
5300
self.enter_context(wt.lock_read())
5302
self.enter_context(branch.lock_read())
5303
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5304
self.enter_context(tree.lock_read())
5305
if wt is not None and revision is None:
5306
if not wt.is_versioned(relpath):
5307
raise errors.NotVersionedError(relpath)
5308
# If there is a tree and we're not annotating historical
5309
# versions, annotate the working tree's content.
5310
annotate_file_tree(wt, relpath, self.outf, long, all,
5313
if not tree.is_versioned(relpath):
5314
raise errors.NotVersionedError(relpath)
5315
annotate_file_tree(tree, relpath, self.outf, long, all,
5316
show_ids=show_ids, branch=branch)
5319
class cmd_re_sign(Command):
5320
__doc__ = """Create a digital signature for an existing revision."""
5321
# TODO be able to replace existing ones.
5323
hidden = True # is this right ?
5324
takes_args = ['revision_id*']
5325
takes_options = ['directory', 'revision']
5327
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5328
if revision_id_list is not None and revision is not None:
5329
raise errors.CommandError(
5330
gettext('You can only supply one of revision_id or --revision'))
5331
if revision_id_list is None and revision is None:
5332
raise errors.CommandError(
5333
gettext('You must supply either --revision or a revision_id'))
5334
b = WorkingTree.open_containing(directory)[0].branch
5335
self.enter_context(b.lock_write())
5336
return self._run(b, revision_id_list, revision)
5338
def _run(self, b, revision_id_list, revision):
5339
from .repository import WriteGroup
5340
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5341
if revision_id_list is not None:
5342
with WriteGroup(b.repository):
5343
for revision_id in revision_id_list:
5344
revision_id = cache_utf8.encode(revision_id)
5345
b.repository.sign_revision(revision_id, gpg_strategy)
5346
elif revision is not None:
5347
if len(revision) == 1:
5348
revno, rev_id = revision[0].in_history(b)
5349
with WriteGroup(b.repository):
5350
b.repository.sign_revision(rev_id, gpg_strategy)
5351
elif len(revision) == 2:
5352
# are they both on rh- if so we can walk between them
5353
# might be nice to have a range helper for arbitrary
5354
# revision paths. hmm.
5355
from_revno, from_revid = revision[0].in_history(b)
5356
to_revno, to_revid = revision[1].in_history(b)
5357
if to_revid is None:
5358
to_revno = b.revno()
5359
if from_revno is None or to_revno is None:
5360
raise errors.CommandError(
5361
gettext('Cannot sign a range of non-revision-history revisions'))
5362
with WriteGroup(b.repository):
5363
for revno in range(from_revno, to_revno + 1):
5364
b.repository.sign_revision(b.get_rev_id(revno),
5367
raise errors.CommandError(
5368
gettext('Please supply either one revision, or a range.'))
5371
class cmd_bind(Command):
5372
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5373
If no branch is supplied, rebind to the last bound location.
5375
Once converted into a checkout, commits must succeed on the master branch
5376
before they will be applied to the local branch.
5378
Bound branches use the nickname of its master branch unless it is set
5379
locally, in which case binding will update the local nickname to be
5383
_see_also = ['checkouts', 'unbind']
5384
takes_args = ['location?']
5385
takes_options = ['directory']
5387
def run(self, location=None, directory=u'.'):
5388
b, relpath = Branch.open_containing(directory)
5389
if location is None:
5391
location = b.get_old_bound_location()
5392
except errors.UpgradeRequired:
5393
raise errors.CommandError(
5394
gettext('No location supplied. '
5395
'This format does not remember old locations.'))
5397
if location is None:
5398
if b.get_bound_location() is not None:
5399
raise errors.CommandError(
5400
gettext('Branch is already bound'))
5402
raise errors.CommandError(
5403
gettext('No location supplied'
5404
' and no previous location known'))
5405
b_other = Branch.open(location)
5408
except errors.DivergedBranches:
5409
raise errors.CommandError(
5410
gettext('These branches have diverged.'
5411
' Try merging, and then bind again.'))
5412
if b.get_config().has_explicit_nickname():
5413
b.nick = b_other.nick
5416
class cmd_unbind(Command):
5417
__doc__ = """Convert the current checkout into a regular branch.
5419
After unbinding, the local branch is considered independent and subsequent
5420
commits will be local only.
5423
_see_also = ['checkouts', 'bind']
5425
takes_options = ['directory']
5427
def run(self, directory=u'.'):
5428
b, relpath = Branch.open_containing(directory)
5430
raise errors.CommandError(gettext('Local branch is not bound'))
5433
class cmd_uncommit(Command):
5434
__doc__ = """Remove the last committed revision.
5436
--verbose will print out what is being removed.
5437
--dry-run will go through all the motions, but not actually
5440
If --revision is specified, uncommit revisions to leave the branch at the
5441
specified revision. For example, "brz uncommit -r 15" will leave the
5442
branch at revision 15.
5444
Uncommit leaves the working tree ready for a new commit. The only change
5445
it may make is to restore any pending merges that were present before
5449
# TODO: jam 20060108 Add an option to allow uncommit to remove
5450
# unreferenced information in 'branch-as-repository' branches.
5451
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5452
# information in shared branches as well.
5453
_see_also = ['commit']
5454
takes_options = ['verbose', 'revision',
5455
Option('dry-run', help='Don\'t actually make changes.'),
5456
Option('force', help='Say yes to all questions.'),
5458
help='Keep tags that point to removed revisions.'),
5460
help="Only remove the commits from the local "
5461
"branch when in a checkout."
5464
takes_args = ['location?']
5466
encoding_type = 'replace'
5468
def run(self, location=None, dry_run=False, verbose=False,
5469
revision=None, force=False, local=False, keep_tags=False):
5470
if location is None:
5472
control, relpath = controldir.ControlDir.open_containing(location)
5474
tree = control.open_workingtree()
5476
except (errors.NoWorkingTree, errors.NotLocalUrl):
5478
b = control.open_branch()
5480
if tree is not None:
5481
self.enter_context(tree.lock_write())
5483
self.enter_context(b.lock_write())
5484
return self._run(b, tree, dry_run, verbose, revision, force,
5485
local, keep_tags, location)
5487
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5488
keep_tags, location):
5489
from .log import log_formatter, show_log
5490
from .uncommit import uncommit
5492
last_revno, last_rev_id = b.last_revision_info()
5495
if revision is None:
5497
rev_id = last_rev_id
5499
# 'brz uncommit -r 10' actually means uncommit
5500
# so that the final tree is at revno 10.
5501
# but breezy.uncommit.uncommit() actually uncommits
5502
# the revisions that are supplied.
5503
# So we need to offset it by one
5504
revno = revision[0].in_history(b).revno + 1
5505
if revno <= last_revno:
5506
rev_id = b.get_rev_id(revno)
5508
if rev_id is None or _mod_revision.is_null(rev_id):
5509
self.outf.write(gettext('No revisions to uncommit.\n'))
5512
lf = log_formatter('short',
5514
show_timezone='original')
5519
direction='forward',
5520
start_revision=revno,
5521
end_revision=last_revno)
5524
self.outf.write(gettext('Dry-run, pretending to remove'
5525
' the above revisions.\n'))
5528
gettext('The above revision(s) will be removed.\n'))
5531
if not ui.ui_factory.confirm_action(
5532
gettext(u'Uncommit these revisions'),
5533
'breezy.builtins.uncommit',
5535
self.outf.write(gettext('Canceled\n'))
5538
mutter('Uncommitting from {%s} to {%s}',
5539
last_rev_id, rev_id)
5540
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5541
revno=revno, local=local, keep_tags=keep_tags)
5544
gettext('You can restore the old tip by running:\n'
5545
' brz pull -d %s %s -r revid:%s\n')
5546
% (location, location, last_rev_id.decode('utf-8')))
5549
gettext('You can restore the old tip by running:\n'
5550
' brz pull . -r revid:%s\n')
5551
% last_rev_id.decode('utf-8'))
5554
class cmd_break_lock(Command):
5555
__doc__ = """Break a dead lock.
5557
This command breaks a lock on a repository, branch, working directory or
5560
CAUTION: Locks should only be broken when you are sure that the process
5561
holding the lock has been stopped.
5563
You can get information on what locks are open via the 'brz info
5564
[location]' command.
5568
brz break-lock brz+ssh://example.com/brz/foo
5569
brz break-lock --conf ~/.config/breezy
5572
takes_args = ['location?']
5575
help='LOCATION is the directory where the config lock is.'),
5577
help='Do not ask for confirmation before breaking the lock.'),
5580
def run(self, location=None, config=False, force=False):
5581
if location is None:
5584
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5586
{'breezy.lockdir.break': True})
5588
conf = _mod_config.LockableConfig(file_name=location)
5591
control, relpath = controldir.ControlDir.open_containing(location)
5593
control.break_lock()
5594
except NotImplementedError:
5598
class cmd_wait_until_signalled(Command):
5599
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5601
This just prints a line to signal when it is ready, then blocks on stdin.
5607
self.outf.write("running\n")
5609
sys.stdin.readline()
5612
class cmd_serve(Command):
5613
__doc__ = """Run the brz server."""
5615
aliases = ['server']
5619
help='Serve on stdin/out for use from inetd or sshd.'),
5620
RegistryOption('protocol',
5621
help="Protocol to serve.",
5622
lazy_registry=('breezy.transport',
5623
'transport_server_registry'),
5624
value_switches=True),
5626
help='Listen for connections on nominated address.',
5629
help='Listen for connections on nominated port. Passing 0 as '
5630
'the port number will result in a dynamically allocated '
5631
'port. The default port depends on the protocol.',
5633
custom_help('directory',
5634
help='Serve contents of this directory.'),
5635
Option('allow-writes',
5636
help='By default the server is a readonly server. Supplying '
5637
'--allow-writes enables write access to the contents of '
5638
'the served directory and below. Note that ``brz serve`` '
5639
'does not perform authentication, so unless some form of '
5640
'external authentication is arranged supplying this '
5641
'option leads to global uncontrolled write access to your '
5644
Option('client-timeout', type=float,
5645
help='Override the default idle client timeout (5min).'),
5648
def run(self, listen=None, port=None, inet=False, directory=None,
5649
allow_writes=False, protocol=None, client_timeout=None):
5650
from . import location, transport
5651
if directory is None:
5652
directory = osutils.getcwd()
5653
if protocol is None:
5654
protocol = transport.transport_server_registry.get()
5655
url = location.location_to_url(directory)
5656
if not allow_writes:
5657
url = 'readonly+' + url
5658
t = transport.get_transport_from_url(url)
5659
protocol(t, listen, port, inet, client_timeout)
5662
class cmd_join(Command):
5663
__doc__ = """Combine a tree into its containing tree.
5665
This command requires the target tree to be in a rich-root format.
5667
The TREE argument should be an independent tree, inside another tree, but
5668
not part of it. (Such trees can be produced by "brz split", but also by
5669
running "brz branch" with the target inside a tree.)
5671
The result is a combined tree, with the subtree no longer an independent
5672
part. This is marked as a merge of the subtree into the containing tree,
5673
and all history is preserved.
5676
_see_also = ['split']
5677
takes_args = ['tree']
5679
Option('reference', help='Join by reference.', hidden=True),
5682
def run(self, tree, reference=False):
5683
from breezy.mutabletree import BadReferenceTarget
5684
sub_tree = WorkingTree.open(tree)
5685
parent_dir = osutils.dirname(sub_tree.basedir)
5686
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5687
repo = containing_tree.branch.repository
5688
if not repo.supports_rich_root():
5689
raise errors.CommandError(gettext(
5690
"Can't join trees because %s doesn't support rich root data.\n"
5691
"You can use brz upgrade on the repository.")
5695
containing_tree.add_reference(sub_tree)
5696
except BadReferenceTarget as e:
5697
# XXX: Would be better to just raise a nicely printable
5698
# exception from the real origin. Also below. mbp 20070306
5699
raise errors.CommandError(
5700
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5703
containing_tree.subsume(sub_tree)
5704
except errors.BadSubsumeSource as e:
5705
raise errors.CommandError(
5706
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5709
class cmd_split(Command):
5710
__doc__ = """Split a subdirectory of a tree into a separate tree.
5712
This command will produce a target tree in a format that supports
5713
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5714
converted into earlier formats like 'dirstate-tags'.
5716
The TREE argument should be a subdirectory of a working tree. That
5717
subdirectory will be converted into an independent tree, with its own
5718
branch. Commits in the top-level tree will not apply to the new subtree.
5721
_see_also = ['join']
5722
takes_args = ['tree']
5724
def run(self, tree):
5725
containing_tree, subdir = WorkingTree.open_containing(tree)
5726
if not containing_tree.is_versioned(subdir):
5727
raise errors.NotVersionedError(subdir)
5729
containing_tree.extract(subdir)
5730
except errors.RootNotRich:
5731
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5734
class cmd_merge_directive(Command):
5735
__doc__ = """Generate a merge directive for auto-merge tools.
5737
A directive requests a merge to be performed, and also provides all the
5738
information necessary to do so. This means it must either include a
5739
revision bundle, or the location of a branch containing the desired
5742
A submit branch (the location to merge into) must be supplied the first
5743
time the command is issued. After it has been supplied once, it will
5744
be remembered as the default.
5746
A public branch is optional if a revision bundle is supplied, but required
5747
if --diff or --plain is specified. It will be remembered as the default
5748
after the first use.
5751
takes_args = ['submit_branch?', 'public_branch?']
5755
_see_also = ['send']
5759
RegistryOption.from_kwargs(
5761
'The type of patch to include in the directive.',
5763
value_switches=True,
5765
bundle='Bazaar revision bundle (default).',
5766
diff='Normal unified diff.',
5767
plain='No patch, just directive.'),
5768
Option('sign', help='GPG-sign the directive.'), 'revision',
5769
Option('mail-to', type=text_type,
5770
help='Instead of printing the directive, email to this '
5772
Option('message', type=text_type, short_name='m',
5773
help='Message to use when committing this merge.')
5776
encoding_type = 'exact'
5778
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5779
sign=False, revision=None, mail_to=None, message=None,
5781
from .revision import ensure_null, NULL_REVISION
5782
include_patch, include_bundle = {
5783
'plain': (False, False),
5784
'diff': (True, False),
5785
'bundle': (True, True),
5787
branch = Branch.open(directory)
5788
stored_submit_branch = branch.get_submit_branch()
5789
if submit_branch is None:
5790
submit_branch = stored_submit_branch
5792
if stored_submit_branch is None:
5793
branch.set_submit_branch(submit_branch)
5794
if submit_branch is None:
5795
submit_branch = branch.get_parent()
5796
if submit_branch is None:
5797
raise errors.CommandError(
5798
gettext('No submit branch specified or known'))
5800
stored_public_branch = branch.get_public_branch()
5801
if public_branch is None:
5802
public_branch = stored_public_branch
5803
elif stored_public_branch is None:
5804
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5805
branch.set_public_branch(public_branch)
5806
if not include_bundle and public_branch is None:
5807
raise errors.CommandError(
5808
gettext('No public branch specified or known'))
5809
base_revision_id = None
5810
if revision is not None:
5811
if len(revision) > 2:
5812
raise errors.CommandError(
5813
gettext('brz merge-directive takes '
5814
'at most two one revision identifiers'))
5815
revision_id = revision[-1].as_revision_id(branch)
5816
if len(revision) == 2:
5817
base_revision_id = revision[0].as_revision_id(branch)
5819
revision_id = branch.last_revision()
5820
revision_id = ensure_null(revision_id)
5821
if revision_id == NULL_REVISION:
5822
raise errors.CommandError(gettext('No revisions to bundle.'))
5823
directive = merge_directive.MergeDirective2.from_objects(
5824
branch.repository, revision_id, time.time(),
5825
osutils.local_time_offset(), submit_branch,
5826
public_branch=public_branch, include_patch=include_patch,
5827
include_bundle=include_bundle, message=message,
5828
base_revision_id=base_revision_id)
5831
self.outf.write(directive.to_signed(branch))
5833
self.outf.writelines(directive.to_lines())
5835
message = directive.to_email(mail_to, branch, sign)
5836
s = SMTPConnection(branch.get_config_stack())
5837
s.send_email(message)
5840
class cmd_send(Command):
5841
__doc__ = """Mail or create a merge-directive for submitting changes.
5843
A merge directive provides many things needed for requesting merges:
5845
* A machine-readable description of the merge to perform
5847
* An optional patch that is a preview of the changes requested
5849
* An optional bundle of revision data, so that the changes can be applied
5850
directly from the merge directive, without retrieving data from a
5853
`brz send` creates a compact data set that, when applied using brz
5854
merge, has the same effect as merging from the source branch.
5856
By default the merge directive is self-contained and can be applied to any
5857
branch containing submit_branch in its ancestory without needing access to
5860
If --no-bundle is specified, then Breezy doesn't send the contents of the
5861
revisions, but only a structured request to merge from the
5862
public_location. In that case the public_branch is needed and it must be
5863
up-to-date and accessible to the recipient. The public_branch is always
5864
included if known, so that people can check it later.
5866
The submit branch defaults to the parent of the source branch, but can be
5867
overridden. Both submit branch and public branch will be remembered in
5868
branch.conf the first time they are used for a particular branch. The
5869
source branch defaults to that containing the working directory, but can
5870
be changed using --from.
5872
Both the submit branch and the public branch follow the usual behavior with
5873
respect to --remember: If there is no default location set, the first send
5874
will set it (use --no-remember to avoid setting it). After that, you can
5875
omit the location to use the default. To change the default, use
5876
--remember. The value will only be saved if the location can be accessed.
5878
In order to calculate those changes, brz must analyse the submit branch.
5879
Therefore it is most efficient for the submit branch to be a local mirror.
5880
If a public location is known for the submit_branch, that location is used
5881
in the merge directive.
5883
The default behaviour is to send the merge directive by mail, unless -o is
5884
given, in which case it is sent to a file.
5886
Mail is sent using your preferred mail program. This should be transparent
5887
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5888
If the preferred client can't be found (or used), your editor will be used.
5890
To use a specific mail program, set the mail_client configuration option.
5891
Supported values for specific clients are "claws", "evolution", "kmail",
5892
"mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options
5893
are "default", "editor", "emacsclient", "mapi", and "xdg-email". Plugins
5894
may also add supported clients.
5896
If mail is being sent, a to address is required. This can be supplied
5897
either on the commandline, by setting the submit_to configuration
5898
option in the branch itself or the child_submit_to configuration option
5899
in the submit branch.
5901
The merge directives created by brz send may be applied using brz merge or
5902
brz pull by specifying a file containing a merge directive as the location.
5904
brz send makes extensive use of public locations to map local locations into
5905
URLs that can be used by other people. See `brz help configuration` to
5906
set them, and use `brz info` to display them.
5909
encoding_type = 'exact'
5911
_see_also = ['merge', 'pull']
5913
takes_args = ['submit_branch?', 'public_branch?']
5917
help='Do not include a bundle in the merge directive.'),
5918
Option('no-patch', help='Do not include a preview patch in the merge'
5921
help='Remember submit and public branch.'),
5923
help='Branch to generate the submission from, '
5924
'rather than the one containing the working directory.',
5927
Option('output', short_name='o',
5928
help='Write merge directive to this file or directory; '
5929
'use - for stdout.',
5932
help='Refuse to send if there are uncommitted changes in'
5933
' the working tree, --no-strict disables the check.'),
5934
Option('mail-to', help='Mail the request to this address.',
5938
Option('body', help='Body for the email.', type=text_type),
5939
RegistryOption('format',
5940
help='Use the specified output format.',
5941
lazy_registry=('breezy.send', 'format_registry')),
5944
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5945
no_patch=False, revision=None, remember=None, output=None,
5946
format=None, mail_to=None, message=None, body=None,
5947
strict=None, **kwargs):
5948
from .send import send
5949
return send(submit_branch, revision, public_branch, remember,
5950
format, no_bundle, no_patch, output,
5951
kwargs.get('from', '.'), mail_to, message, body,
5956
class cmd_bundle_revisions(cmd_send):
5957
__doc__ = """Create a merge-directive for submitting changes.
5959
A merge directive provides many things needed for requesting merges:
5961
* A machine-readable description of the merge to perform
5963
* An optional patch that is a preview of the changes requested
5965
* An optional bundle of revision data, so that the changes can be applied
5966
directly from the merge directive, without retrieving data from a
5969
If --no-bundle is specified, then public_branch is needed (and must be
5970
up-to-date), so that the receiver can perform the merge using the
5971
public_branch. The public_branch is always included if known, so that
5972
people can check it later.
5974
The submit branch defaults to the parent, but can be overridden. Both
5975
submit branch and public branch will be remembered if supplied.
5977
If a public_branch is known for the submit_branch, that public submit
5978
branch is used in the merge instructions. This means that a local mirror
5979
can be used as your actual submit branch, once you have set public_branch
5985
help='Do not include a bundle in the merge directive.'),
5986
Option('no-patch', help='Do not include a preview patch in the merge'
5989
help='Remember submit and public branch.'),
5991
help='Branch to generate the submission from, '
5992
'rather than the one containing the working directory.',
5995
Option('output', short_name='o', help='Write directive to this file.',
5998
help='Refuse to bundle revisions if there are uncommitted'
5999
' changes in the working tree, --no-strict disables the check.'),
6001
RegistryOption('format',
6002
help='Use the specified output format.',
6003
lazy_registry=('breezy.send', 'format_registry')),
6005
aliases = ['bundle']
6007
_see_also = ['send', 'merge']
6011
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
6012
no_patch=False, revision=None, remember=False, output=None,
6013
format=None, strict=None, **kwargs):
6016
from .send import send
6017
return send(submit_branch, revision, public_branch, remember,
6018
format, no_bundle, no_patch, output,
6019
kwargs.get('from', '.'), None, None, None,
6020
self.outf, strict=strict)
6023
class cmd_tag(Command):
6024
__doc__ = """Create, remove or modify a tag naming a revision.
6026
Tags give human-meaningful names to revisions. Commands that take a -r
6027
(--revision) option can be given -rtag:X, where X is any previously
6030
Tags are stored in the branch. Tags are copied from one branch to another
6031
along when you branch, push, pull or merge.
6033
It is an error to give a tag name that already exists unless you pass
6034
--force, in which case the tag is moved to point to the new revision.
6036
To rename a tag (change the name but keep it on the same revsion), run ``brz
6037
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
6039
If no tag name is specified it will be determined through the
6040
'automatic_tag_name' hook. This can e.g. be used to automatically tag
6041
upstream releases by reading configure.ac. See ``brz help hooks`` for
6045
_see_also = ['commit', 'tags']
6046
takes_args = ['tag_name?']
6049
help='Delete this tag rather than placing it.',
6051
custom_help('directory',
6052
help='Branch in which to place the tag.'),
6054
help='Replace existing tags.',
6059
def run(self, tag_name=None,
6065
branch, relpath = Branch.open_containing(directory)
6066
self.enter_context(branch.lock_write())
6068
if tag_name is None:
6069
raise errors.CommandError(
6070
gettext("No tag specified to delete."))
6071
branch.tags.delete_tag(tag_name)
6072
note(gettext('Deleted tag %s.') % tag_name)
6075
if len(revision) != 1:
6076
raise errors.CommandError(gettext(
6077
"Tags can only be placed on a single revision, "
6079
revision_id = revision[0].as_revision_id(branch)
6081
revision_id = branch.last_revision()
6082
if tag_name is None:
6083
tag_name = branch.automatic_tag_name(revision_id)
6084
if tag_name is None:
6085
raise errors.CommandError(gettext(
6086
"Please specify a tag name."))
6088
existing_target = branch.tags.lookup_tag(tag_name)
6089
except errors.NoSuchTag:
6090
existing_target = None
6091
if not force and existing_target not in (None, revision_id):
6092
raise errors.TagAlreadyExists(tag_name)
6093
if existing_target == revision_id:
6094
note(gettext('Tag %s already exists for that revision.') % tag_name)
6096
branch.tags.set_tag(tag_name, revision_id)
6097
if existing_target is None:
6098
note(gettext('Created tag %s.') % tag_name)
6100
note(gettext('Updated tag %s.') % tag_name)
6103
class cmd_tags(Command):
6104
__doc__ = """List tags.
6106
This command shows a table of tag names and the revisions they reference.
6111
custom_help('directory',
6112
help='Branch whose tags should be displayed.'),
6113
RegistryOption('sort',
6114
'Sort tags by different criteria.', title='Sorting',
6115
lazy_registry=('breezy.tag', 'tag_sort_methods')
6122
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6123
from .tag import tag_sort_methods
6124
branch, relpath = Branch.open_containing(directory)
6126
tags = list(viewitems(branch.tags.get_tag_dict()))
6130
self.enter_context(branch.lock_read())
6132
# Restrict to the specified range
6133
tags = self._tags_for_range(branch, revision)
6135
sort = tag_sort_methods.get()
6138
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6139
for index, (tag, revid) in enumerate(tags):
6141
revno = branch.revision_id_to_dotted_revno(revid)
6142
if isinstance(revno, tuple):
6143
revno = '.'.join(map(str, revno))
6144
except (errors.NoSuchRevision,
6145
errors.GhostRevisionsHaveNoRevno,
6146
errors.UnsupportedOperation):
6147
# Bad tag data/merges can lead to tagged revisions
6148
# which are not in this branch. Fail gracefully ...
6150
tags[index] = (tag, revno)
6152
tags = [(tag, revid.decode('utf-8')) for (tag, revid) in tags]
6154
for tag, revspec in tags:
6155
self.outf.write('%-20s %s\n' % (tag, revspec))
6157
def _tags_for_range(self, branch, revision):
6158
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6159
revid1, revid2 = rev1.rev_id, rev2.rev_id
6160
# _get_revision_range will always set revid2 if it's not specified.
6161
# If revid1 is None, it means we want to start from the branch
6162
# origin which is always a valid ancestor. If revid1 == revid2, the
6163
# ancestry check is useless.
6164
if revid1 and revid1 != revid2:
6165
# FIXME: We really want to use the same graph than
6166
# branch.iter_merge_sorted_revisions below, but this is not
6167
# easily available -- vila 2011-09-23
6168
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6169
# We don't want to output anything in this case...
6171
# only show revisions between revid1 and revid2 (inclusive)
6172
tagged_revids = branch.tags.get_reverse_tag_dict()
6174
for r in branch.iter_merge_sorted_revisions(
6175
start_revision_id=revid2, stop_revision_id=revid1,
6176
stop_rule='include'):
6177
revid_tags = tagged_revids.get(r[0], None)
6179
found.extend([(tag, r[0]) for tag in revid_tags])
6183
class cmd_reconfigure(Command):
6184
__doc__ = """Reconfigure the type of a brz directory.
6186
A target configuration must be specified.
6188
For checkouts, the bind-to location will be auto-detected if not specified.
6189
The order of preference is
6190
1. For a lightweight checkout, the current bound location.
6191
2. For branches that used to be checkouts, the previously-bound location.
6192
3. The push location.
6193
4. The parent location.
6194
If none of these is available, --bind-to must be specified.
6197
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6198
takes_args = ['location?']
6200
RegistryOption.from_kwargs(
6203
help='The relation between branch and tree.',
6204
value_switches=True, enum_switch=False,
6205
branch='Reconfigure to be an unbound branch with no working tree.',
6206
tree='Reconfigure to be an unbound branch with a working tree.',
6207
checkout='Reconfigure to be a bound branch with a working tree.',
6208
lightweight_checkout='Reconfigure to be a lightweight'
6209
' checkout (with no local history).',
6211
RegistryOption.from_kwargs(
6213
title='Repository type',
6214
help='Location fo the repository.',
6215
value_switches=True, enum_switch=False,
6216
standalone='Reconfigure to be a standalone branch '
6217
'(i.e. stop using shared repository).',
6218
use_shared='Reconfigure to use a shared repository.',
6220
RegistryOption.from_kwargs(
6222
title='Trees in Repository',
6223
help='Whether new branches in the repository have trees.',
6224
value_switches=True, enum_switch=False,
6225
with_trees='Reconfigure repository to create '
6226
'working trees on branches by default.',
6227
with_no_trees='Reconfigure repository to not create '
6228
'working trees on branches by default.'
6230
Option('bind-to', help='Branch to bind checkout to.', type=text_type),
6232
help='Perform reconfiguration even if local changes'
6234
Option('stacked-on',
6235
help='Reconfigure a branch to be stacked on another branch.',
6239
help='Reconfigure a branch to be unstacked. This '
6240
'may require copying substantial data into it.',
6244
def run(self, location=None, bind_to=None, force=False,
6245
tree_type=None, repository_type=None, repository_trees=None,
6246
stacked_on=None, unstacked=None):
6247
directory = controldir.ControlDir.open(location)
6248
if stacked_on and unstacked:
6249
raise errors.CommandError(
6250
gettext("Can't use both --stacked-on and --unstacked"))
6251
elif stacked_on is not None:
6252
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6254
reconfigure.ReconfigureUnstacked().apply(directory)
6255
# At the moment you can use --stacked-on and a different
6256
# reconfiguration shape at the same time; there seems no good reason
6258
if (tree_type is None and
6259
repository_type is None and
6260
repository_trees is None):
6261
if stacked_on or unstacked:
6264
raise errors.CommandError(gettext('No target configuration '
6266
reconfiguration = None
6267
if tree_type == 'branch':
6268
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6269
elif tree_type == 'tree':
6270
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6271
elif tree_type == 'checkout':
6272
reconfiguration = reconfigure.Reconfigure.to_checkout(
6274
elif tree_type == 'lightweight-checkout':
6275
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6278
reconfiguration.apply(force)
6279
reconfiguration = None
6280
if repository_type == 'use-shared':
6281
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6282
elif repository_type == 'standalone':
6283
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6285
reconfiguration.apply(force)
6286
reconfiguration = None
6287
if repository_trees == 'with-trees':
6288
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6290
elif repository_trees == 'with-no-trees':
6291
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6294
reconfiguration.apply(force)
6295
reconfiguration = None
6298
class cmd_switch(Command):
6299
__doc__ = """Set the branch of a checkout and update.
6301
For lightweight checkouts, this changes the branch being referenced.
6302
For heavyweight checkouts, this checks that there are no local commits
6303
versus the current bound branch, then it makes the local branch a mirror
6304
of the new location and binds to it.
6306
In both cases, the working tree is updated and uncommitted changes
6307
are merged. The user can commit or revert these as they desire.
6309
Pending merges need to be committed or reverted before using switch.
6311
The path to the branch to switch to can be specified relative to the parent
6312
directory of the current branch. For example, if you are currently in a
6313
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6316
Bound branches use the nickname of its master branch unless it is set
6317
locally, in which case switching will update the local nickname to be
6321
takes_args = ['to_location?']
6322
takes_options = ['directory',
6324
help='Switch even if local commits will be lost.'),
6326
Option('create-branch', short_name='b',
6327
help='Create the target branch from this one before'
6328
' switching to it.'),
6330
help='Store and restore uncommitted changes in the'
6334
def run(self, to_location=None, force=False, create_branch=False,
6335
revision=None, directory=u'.', store=False):
6336
from . import switch
6337
tree_location = directory
6338
revision = _get_one_revision('switch', revision)
6339
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6340
possible_transports = [control_dir.root_transport]
6341
if to_location is None:
6342
if revision is None:
6343
raise errors.CommandError(gettext('You must supply either a'
6344
' revision or a location'))
6345
to_location = tree_location
6347
branch = control_dir.open_branch(
6348
possible_transports=possible_transports)
6349
had_explicit_nick = branch.get_config().has_explicit_nickname()
6350
except errors.NotBranchError:
6352
had_explicit_nick = False
6354
possible_transports.append(branch.user_transport)
6357
raise errors.CommandError(
6358
gettext('cannot create branch without source branch'))
6359
to_location = lookup_new_sibling_branch(
6360
control_dir, to_location,
6361
possible_transports=possible_transports)
6362
if revision is not None:
6363
revision = revision.as_revision_id(branch)
6364
to_branch = branch.controldir.sprout(
6366
possible_transports=possible_transports,
6367
revision_id=revision,
6368
source_branch=branch).open_branch()
6371
to_branch = Branch.open(
6372
to_location, possible_transports=possible_transports)
6373
except errors.NotBranchError:
6374
to_branch = open_sibling_branch(
6375
control_dir, to_location,
6376
possible_transports=possible_transports)
6377
if revision is not None:
6378
revision = revision.as_revision_id(to_branch)
6379
possible_transports.append(to_branch.user_transport)
6381
switch.switch(control_dir, to_branch, force, revision_id=revision,
6382
store_uncommitted=store,
6383
possible_transports=possible_transports)
6384
except controldir.BranchReferenceLoop:
6385
raise errors.CommandError(
6386
gettext('switching would create a branch reference loop. '
6387
'Use the "bzr up" command to switch to a '
6388
'different revision.'))
6389
if had_explicit_nick:
6390
branch = control_dir.open_branch() # get the new branch!
6391
branch.nick = to_branch.nick
6393
if to_branch.controldir.control_url != control_dir.control_url:
6394
note(gettext('Switched to branch %s at %s'),
6395
to_branch.name, urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6397
note(gettext('Switched to branch %s'), to_branch.name)
6399
note(gettext('Switched to branch at %s'),
6400
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6403
class cmd_view(Command):
6404
__doc__ = """Manage filtered views.
6406
Views provide a mask over the tree so that users can focus on
6407
a subset of a tree when doing their work. After creating a view,
6408
commands that support a list of files - status, diff, commit, etc -
6409
effectively have that list of files implicitly given each time.
6410
An explicit list of files can still be given but those files
6411
must be within the current view.
6413
In most cases, a view has a short life-span: it is created to make
6414
a selected change and is deleted once that change is committed.
6415
At other times, you may wish to create one or more named views
6416
and switch between them.
6418
To disable the current view without deleting it, you can switch to
6419
the pseudo view called ``off``. This can be useful when you need
6420
to see the whole tree for an operation or two (e.g. merge) but
6421
want to switch back to your view after that.
6424
To define the current view::
6426
brz view file1 dir1 ...
6428
To list the current view::
6432
To delete the current view::
6436
To disable the current view without deleting it::
6438
brz view --switch off
6440
To define a named view and switch to it::
6442
brz view --name view-name file1 dir1 ...
6444
To list a named view::
6446
brz view --name view-name
6448
To delete a named view::
6450
brz view --name view-name --delete
6452
To switch to a named view::
6454
brz view --switch view-name
6456
To list all views defined::
6460
To delete all views::
6462
brz view --delete --all
6466
takes_args = ['file*']
6469
help='Apply list or delete action to all views.',
6472
help='Delete the view.',
6475
help='Name of the view to define, list or delete.',
6479
help='Name of the view to switch to.',
6484
def run(self, file_list,
6490
tree, file_list = WorkingTree.open_containing_paths(file_list,
6492
current_view, view_dict = tree.views.get_view_info()
6497
raise errors.CommandError(gettext(
6498
"Both --delete and a file list specified"))
6500
raise errors.CommandError(gettext(
6501
"Both --delete and --switch specified"))
6503
tree.views.set_view_info(None, {})
6504
self.outf.write(gettext("Deleted all views.\n"))
6506
raise errors.CommandError(
6507
gettext("No current view to delete"))
6509
tree.views.delete_view(name)
6510
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6513
raise errors.CommandError(gettext(
6514
"Both --switch and a file list specified"))
6516
raise errors.CommandError(gettext(
6517
"Both --switch and --all specified"))
6518
elif switch == 'off':
6519
if current_view is None:
6520
raise errors.CommandError(
6521
gettext("No current view to disable"))
6522
tree.views.set_view_info(None, view_dict)
6523
self.outf.write(gettext("Disabled '%s' view.\n") %
6526
tree.views.set_view_info(switch, view_dict)
6527
view_str = views.view_display_str(tree.views.lookup_view())
6529
gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6532
self.outf.write(gettext('Views defined:\n'))
6533
for view in sorted(view_dict):
6534
if view == current_view:
6538
view_str = views.view_display_str(view_dict[view])
6539
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6541
self.outf.write(gettext('No views defined.\n'))
6544
# No name given and no current view set
6547
raise errors.CommandError(gettext(
6548
"Cannot change the 'off' pseudo view"))
6549
tree.views.set_view(name, sorted(file_list))
6550
view_str = views.view_display_str(tree.views.lookup_view())
6552
gettext("Using '{0}' view: {1}\n").format(name, view_str))
6556
# No name given and no current view set
6557
self.outf.write(gettext('No current view.\n'))
6559
view_str = views.view_display_str(tree.views.lookup_view(name))
6561
gettext("'{0}' view is: {1}\n").format(name, view_str))
6564
class cmd_hooks(Command):
6565
__doc__ = """Show hooks."""
6570
for hook_key in sorted(hooks.known_hooks.keys()):
6571
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6572
self.outf.write("%s:\n" % type(some_hooks).__name__)
6573
for hook_name, hook_point in sorted(some_hooks.items()):
6574
self.outf.write(" %s:\n" % (hook_name,))
6575
found_hooks = list(hook_point)
6577
for hook in found_hooks:
6578
self.outf.write(" %s\n" %
6579
(some_hooks.get_hook_name(hook),))
6581
self.outf.write(gettext(" <no hooks installed>\n"))
6584
class cmd_remove_branch(Command):
6585
__doc__ = """Remove a branch.
6587
This will remove the branch from the specified location but
6588
will keep any working tree or repository in place.
6592
Remove the branch at repo/trunk::
6594
brz remove-branch repo/trunk
6598
takes_args = ["location?"]
6600
takes_options = ['directory',
6601
Option('force', help='Remove branch even if it is the active branch.')]
6603
aliases = ["rmbranch"]
6605
def run(self, directory=None, location=None, force=False):
6606
br = open_nearby_branch(near=directory, location=location)
6607
if not force and br.controldir.has_workingtree():
6609
active_branch = br.controldir.open_branch(name="")
6610
except errors.NotBranchError:
6611
active_branch = None
6612
if (active_branch is not None and
6613
br.control_url == active_branch.control_url):
6614
raise errors.CommandError(
6615
gettext("Branch is active. Use --force to remove it."))
6616
br.controldir.destroy_branch(br.name)
6619
class cmd_shelve(Command):
6620
__doc__ = """Temporarily set aside some changes from the current tree.
6622
Shelve allows you to temporarily put changes you've made "on the shelf",
6623
ie. out of the way, until a later time when you can bring them back from
6624
the shelf with the 'unshelve' command. The changes are stored alongside
6625
your working tree, and so they aren't propagated along with your branch nor
6626
will they survive its deletion.
6628
If shelve --list is specified, previously-shelved changes are listed.
6630
Shelve is intended to help separate several sets of changes that have
6631
been inappropriately mingled. If you just want to get rid of all changes
6632
and you don't need to restore them later, use revert. If you want to
6633
shelve all text changes at once, use shelve --all.
6635
If filenames are specified, only the changes to those files will be
6636
shelved. Other files will be left untouched.
6638
If a revision is specified, changes since that revision will be shelved.
6640
You can put multiple items on the shelf, and by default, 'unshelve' will
6641
restore the most recently shelved changes.
6643
For complicated changes, it is possible to edit the changes in a separate
6644
editor program to decide what the file remaining in the working copy
6645
should look like. To do this, add the configuration option
6647
change_editor = PROGRAM {new_path} {old_path}
6649
where {new_path} is replaced with the path of the new version of the
6650
file and {old_path} is replaced with the path of the old version of
6651
the file. The PROGRAM should save the new file with the desired
6652
contents of the file in the working tree.
6656
takes_args = ['file*']
6661
Option('all', help='Shelve all changes.'),
6663
RegistryOption('writer', 'Method to use for writing diffs.',
6664
breezy.option.diff_writer_registry,
6665
value_switches=True, enum_switch=False),
6667
Option('list', help='List shelved changes.'),
6669
help='Destroy removed changes instead of shelving them.'),
6671
_see_also = ['unshelve', 'configuration']
6673
def run(self, revision=None, all=False, file_list=None, message=None,
6674
writer=None, list=False, destroy=False, directory=None):
6676
return self.run_for_list(directory=directory)
6677
from .shelf_ui import Shelver
6679
writer = breezy.option.diff_writer_registry.get()
6681
shelver = Shelver.from_args(writer(self.outf), revision, all,
6682
file_list, message, destroy=destroy, directory=directory)
6687
except errors.UserAbort:
6690
def run_for_list(self, directory=None):
6691
if directory is None:
6693
tree = WorkingTree.open_containing(directory)[0]
6694
self.enter_context(tree.lock_read())
6695
manager = tree.get_shelf_manager()
6696
shelves = manager.active_shelves()
6697
if len(shelves) == 0:
6698
note(gettext('No shelved changes.'))
6700
for shelf_id in reversed(shelves):
6701
message = manager.get_metadata(shelf_id).get(b'message')
6703
message = '<no message>'
6704
self.outf.write('%3d: %s\n' % (shelf_id, message))
6708
class cmd_unshelve(Command):
6709
__doc__ = """Restore shelved changes.
6711
By default, the most recently shelved changes are restored. However if you
6712
specify a shelf by id those changes will be restored instead. This works
6713
best when the changes don't depend on each other.
6716
takes_args = ['shelf_id?']
6719
RegistryOption.from_kwargs(
6720
'action', help="The action to perform.",
6721
enum_switch=False, value_switches=True,
6722
apply="Apply changes and remove from the shelf.",
6723
dry_run="Show changes, but do not apply or remove them.",
6724
preview="Instead of unshelving the changes, show the diff that "
6725
"would result from unshelving.",
6726
delete_only="Delete changes without applying them.",
6727
keep="Apply changes but don't delete them.",
6730
_see_also = ['shelve']
6732
def run(self, shelf_id=None, action='apply', directory=u'.'):
6733
from .shelf_ui import Unshelver
6734
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6738
unshelver.tree.unlock()
6741
class cmd_clean_tree(Command):
6742
__doc__ = """Remove unwanted files from working tree.
6744
By default, only unknown files, not ignored files, are deleted. Versioned
6745
files are never deleted.
6747
Another class is 'detritus', which includes files emitted by brz during
6748
normal operations and selftests. (The value of these files decreases with
6751
If no options are specified, unknown files are deleted. Otherwise, option
6752
flags are respected, and may be combined.
6754
To check what clean-tree will do, use --dry-run.
6756
takes_options = ['directory',
6757
Option('ignored', help='Delete all ignored files.'),
6758
Option('detritus', help='Delete conflict files, merge and revert'
6759
' backups, and failed selftest dirs.'),
6761
help='Delete files unknown to brz (default).'),
6762
Option('dry-run', help='Show files to delete instead of'
6764
Option('force', help='Do not prompt before deleting.')]
6766
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6767
force=False, directory=u'.'):
6768
from .clean_tree import clean_tree
6769
if not (unknown or ignored or detritus):
6773
clean_tree(directory, unknown=unknown, ignored=ignored,
6774
detritus=detritus, dry_run=dry_run, no_prompt=force)
6777
class cmd_reference(Command):
6778
__doc__ = """list, view and set branch locations for nested trees.
6780
If no arguments are provided, lists the branch locations for nested trees.
6781
If one argument is provided, display the branch location for that tree.
6782
If two arguments are provided, set the branch location for that tree.
6787
takes_args = ['path?', 'location?']
6790
Option('force-unversioned',
6791
help='Set reference even if path is not versioned.'),
6794
def run(self, path=None, directory='.', location=None, force_unversioned=False):
6795
tree, branch, relpath = (
6796
controldir.ControlDir.open_containing_tree_or_branch(directory))
6798
tree = branch.basis_tree()
6800
with tree.lock_read():
6802
(path, tree.get_reference_info(path, branch))
6803
for path in tree.iter_references()]
6804
self._display_reference_info(tree, branch, info)
6806
if not tree.is_versioned(path) and not force_unversioned:
6807
raise errors.NotVersionedError(path)
6808
if location is None:
6809
info = [(path, tree.get_reference_info(path, branch))]
6810
self._display_reference_info(tree, branch, info)
6812
tree.set_reference_info(path, location)
6814
def _display_reference_info(self, tree, branch, info):
6816
for path, location in info:
6817
ref_list.append((path, location))
6818
for path, location in sorted(ref_list):
6819
self.outf.write('%s %s\n' % (path, location))
6822
class cmd_export_pot(Command):
6823
__doc__ = """Export command helps and error messages in po format."""
6826
takes_options = [Option('plugin',
6827
help='Export help text from named command '
6828
'(defaults to all built in commands).',
6830
Option('include-duplicates',
6831
help='Output multiple copies of the same msgid '
6832
'string if it appears more than once.'),
6835
def run(self, plugin=None, include_duplicates=False):
6836
from .export_pot import export_pot
6837
export_pot(self.outf, plugin, include_duplicates)
6840
class cmd_import(Command):
6841
__doc__ = """Import sources from a directory, tarball or zip file
6843
This command will import a directory, tarball or zip file into a bzr
6844
tree, replacing any versioned files already present. If a directory is
6845
specified, it is used as the target. If the directory does not exist, or
6846
is not versioned, it is created.
6848
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6850
If the tarball or zip has a single root directory, that directory is
6851
stripped when extracting the tarball. This is not done for directories.
6854
takes_args = ['source', 'tree?']
6856
def run(self, source, tree=None):
6857
from .upstream_import import do_import
6858
do_import(source, tree)
6861
class cmd_link_tree(Command):
6862
__doc__ = """Hardlink matching files to another tree.
6864
Only files with identical content and execute bit will be linked.
6867
takes_args = ['location']
6869
def run(self, location):
6870
from .transform import link_tree
6871
target_tree = WorkingTree.open_containing(".")[0]
6872
source_tree = WorkingTree.open(location)
6873
with target_tree.lock_write(), source_tree.lock_read():
6874
link_tree(target_tree, source_tree)
6877
class cmd_fetch_ghosts(Command):
6878
__doc__ = """Attempt to retrieve ghosts from another branch.
6880
If the other branch is not supplied, the last-pulled branch is used.
6884
aliases = ['fetch-missing']
6885
takes_args = ['branch?']
6886
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6888
def run(self, branch=None, no_fix=False):
6889
from .fetch_ghosts import GhostFetcher
6890
installed, failed = GhostFetcher.from_cmdline(branch).run()
6891
if len(installed) > 0:
6892
self.outf.write("Installed:\n")
6893
for rev in installed:
6894
self.outf.write(rev.decode('utf-8') + "\n")
6896
self.outf.write("Still missing:\n")
6898
self.outf.write(rev.decode('utf-8') + "\n")
6899
if not no_fix and len(installed) > 0:
6900
cmd_reconcile().run(".")
6903
class cmd_grep(Command):
6904
"""Print lines matching PATTERN for specified files and revisions.
6906
This command searches the specified files and revisions for a given
6907
pattern. The pattern is specified as a Python regular expressions[1].
6909
If the file name is not specified, the revisions starting with the
6910
current directory are searched recursively. If the revision number is
6911
not specified, the working copy is searched. To search the last committed
6912
revision, use the '-r -1' or '-r last:1' option.
6914
Unversioned files are not searched unless explicitly specified on the
6915
command line. Unversioned directores are not searched.
6917
When searching a pattern, the output is shown in the 'filepath:string'
6918
format. If a revision is explicitly searched, the output is shown as
6919
'filepath~N:string', where N is the revision number.
6921
--include and --exclude options can be used to search only (or exclude
6922
from search) files with base name matches the specified Unix style GLOB
6923
pattern. The GLOB pattern an use *, ?, and [...] as wildcards, and \\
6924
to quote wildcard or backslash character literally. Note that the glob
6925
pattern is not a regular expression.
6927
[1] http://docs.python.org/library/re.html#regular-expression-syntax
6930
encoding_type = 'replace'
6931
takes_args = ['pattern', 'path*']
6935
Option('color', type=text_type, argname='when',
6936
help='Show match in color. WHEN is never, always or auto.'),
6937
Option('diff', short_name='p',
6938
help='Grep for pattern in changeset for each revision.'),
6939
ListOption('exclude', type=text_type, argname='glob', short_name='X',
6940
help="Skip files whose base name matches GLOB."),
6941
ListOption('include', type=text_type, argname='glob', short_name='I',
6942
help="Search only files whose base name matches GLOB."),
6943
Option('files-with-matches', short_name='l',
6944
help='Print only the name of each input file in '
6945
'which PATTERN is found.'),
6946
Option('files-without-match', short_name='L',
6947
help='Print only the name of each input file in '
6948
'which PATTERN is not found.'),
6949
Option('fixed-string', short_name='F',
6950
help='Interpret PATTERN is a single fixed string (not regex).'),
6952
help='Search for pattern starting from the root of the branch. '
6953
'(implies --recursive)'),
6954
Option('ignore-case', short_name='i',
6955
help='Ignore case distinctions while matching.'),
6957
help='Number of levels to display - 0 for all, 1 for collapsed '
6960
type=_parse_levels),
6961
Option('line-number', short_name='n',
6962
help='Show 1-based line number.'),
6963
Option('no-recursive',
6964
help="Don't recurse into subdirectories. (default is --recursive)"),
6965
Option('null', short_name='Z',
6966
help='Write an ASCII NUL (\\0) separator '
6967
'between output lines rather than a newline.'),
6971
def run(self, verbose=False, ignore_case=False, no_recursive=False,
6972
from_root=False, null=False, levels=None, line_number=False,
6973
path_list=None, revision=None, pattern=None, include=None,
6974
exclude=None, fixed_string=False, files_with_matches=False,
6975
files_without_match=False, color=None, diff=False):
6976
from breezy import _termcolor
6979
if path_list is None:
6983
raise errors.CommandError(
6984
'cannot specify both --from-root and PATH.')
6986
if files_with_matches and files_without_match:
6987
raise errors.CommandError(
6988
'cannot specify both '
6989
'-l/--files-with-matches and -L/--files-without-matches.')
6991
global_config = _mod_config.GlobalConfig()
6994
color = global_config.get_user_option('grep_color')
6999
if color not in ['always', 'never', 'auto']:
7000
raise errors.CommandError('Valid values for --color are '
7001
'"always", "never" or "auto".')
7007
if revision is not None or levels == 0:
7008
# print revision numbers as we may be showing multiple revisions
7015
if not ignore_case and grep.is_fixed_string(pattern):
7016
# if the pattern isalnum, implicitly use to -F for faster grep
7018
elif ignore_case and fixed_string:
7019
# GZ 2010-06-02: Fall back to regexp rather than lowercasing
7020
# pattern and text which will cause pain later
7021
fixed_string = False
7022
pattern = re.escape(pattern)
7025
re_flags = re.MULTILINE
7027
re_flags |= re.IGNORECASE
7029
if not fixed_string:
7030
patternc = grep.compile_pattern(
7031
pattern.encode(grep._user_encoding), re_flags)
7033
if color == 'always':
7035
elif color == 'never':
7037
elif color == 'auto':
7038
show_color = _termcolor.allow_color()
7040
opts = grep.GrepOptions()
7042
opts.verbose = verbose
7043
opts.ignore_case = ignore_case
7044
opts.no_recursive = no_recursive
7045
opts.from_root = from_root
7047
opts.levels = levels
7048
opts.line_number = line_number
7049
opts.path_list = path_list
7050
opts.revision = revision
7051
opts.pattern = pattern
7052
opts.include = include
7053
opts.exclude = exclude
7054
opts.fixed_string = fixed_string
7055
opts.files_with_matches = files_with_matches
7056
opts.files_without_match = files_without_match
7060
opts.eol_marker = eol_marker
7061
opts.print_revno = print_revno
7062
opts.patternc = patternc
7063
opts.recursive = not no_recursive
7064
opts.fixed_string = fixed_string
7065
opts.outf = self.outf
7066
opts.show_color = show_color
7070
# files_with_matches, files_without_match
7071
# levels(?), line_number, from_root
7073
# These are silently ignored.
7074
grep.grep_diff(opts)
7075
elif revision is None:
7076
grep.workingtree_grep(opts)
7078
grep.versioned_grep(opts)
7081
class cmd_patch(Command):
7082
"""Apply a named patch to the current tree.
7086
takes_args = ['filename?']
7087
takes_options = [Option('strip', type=int, short_name='p',
7088
help=("Strip the smallest prefix containing num "
7089
"leading slashes from filenames.")),
7090
Option('silent', help='Suppress chatter.')]
7092
def run(self, filename=None, strip=None, silent=False):
7093
from .patch import patch_tree
7094
wt = WorkingTree.open_containing('.')[0]
7098
if filename is None:
7099
my_file = getattr(sys.stdin, 'buffer', sys.stdin)
7101
my_file = open(filename, 'rb')
7102
patches = [my_file.read()]
7103
return patch_tree(wt, patches, strip, quiet=is_quiet(), out=self.outf)
7106
class cmd_resolve_location(Command):
7107
__doc__ = """Expand a location to a full URL.
7110
Look up a Launchpad URL.
7112
brz resolve-location lp:brz
7114
takes_args = ['location']
7117
def run(self, location):
7118
from .location import location_to_url
7119
url = location_to_url(location)
7120
display_url = urlutils.unescape_for_display(url, self.outf.encoding)
7121
self.outf.write('%s\n' % display_url)
7124
def _register_lazy_builtins():
7125
# register lazy builtins from other modules; called at startup and should
7126
# be only called once.
7127
for (name, aliases, module_name) in [
7128
('cmd_bisect', [], 'breezy.bisect'),
7129
('cmd_bundle_info', [], 'breezy.bzr.bundle.commands'),
7130
('cmd_config', [], 'breezy.config'),
7131
('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
7132
('cmd_file_id', [], 'breezy.bzr.debug_commands'),
7133
('cmd_file_path', [], 'breezy.bzr.debug_commands'),
7134
('cmd_version_info', [], 'breezy.cmd_version_info'),
7135
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
7136
('cmd_conflicts', [], 'breezy.conflicts'),
7137
('cmd_ping', [], 'breezy.bzr.smart.ping'),
7138
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
7139
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
7140
('cmd_test_script', [], 'breezy.cmd_test_script'),
7142
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
