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
28
from . import lazy_import
29
lazy_import.lazy_import(globals(), """
34
branch as _mod_branch,
40
config as _mod_config,
48
mergeable as _mod_mergeable,
53
revision as _mod_revision,
62
from breezy.branch import Branch
63
from breezy.conflicts import ConflictList
64
from breezy.transport import memory
65
from breezy.smtp_connection import SMTPConnection
66
from breezy.workingtree import WorkingTree
67
from breezy.i18n import gettext, ngettext
70
from .commands import (
72
builtin_command_registry,
82
from .revisionspec import (
92
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
95
def _get_branch_location(control_dir, possible_transports=None):
96
"""Return location of branch for this control dir."""
98
target = control_dir.get_branch_reference()
99
except errors.NotBranchError:
100
return control_dir.root_transport.base
101
if target is not None:
103
this_branch = control_dir.open_branch(
104
possible_transports=possible_transports)
105
# This may be a heavy checkout, where we want the master branch
106
master_location = this_branch.get_bound_location()
107
if master_location is not None:
108
return master_location
109
# If not, use a local sibling
110
return this_branch.base
113
def _is_colocated(control_dir, possible_transports=None):
114
"""Check if the branch in control_dir is colocated.
116
:param control_dir: Control directory
117
:return: Tuple with boolean indicating whether the branch is colocated
118
and the full URL to the actual branch
120
# This path is meant to be relative to the existing branch
121
this_url = _get_branch_location(
122
control_dir, possible_transports=possible_transports)
123
# Perhaps the target control dir supports colocated branches?
125
root = controldir.ControlDir.open(
126
this_url, possible_transports=possible_transports)
127
except errors.NotBranchError:
128
return (False, this_url)
131
control_dir.open_workingtree()
132
except (errors.NoWorkingTree, errors.NotLocalUrl):
133
return (False, this_url)
136
root._format.colocated_branches and
137
control_dir.control_url == root.control_url,
141
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
142
"""Lookup the location for a new sibling branch.
144
:param control_dir: Control directory to find sibling branches from
145
:param location: Name of the new branch
146
:return: Full location to the new branch
148
location = directory_service.directories.dereference(location)
149
if '/' not in location and '\\' not in location:
150
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
153
return urlutils.join_segment_parameters(
154
this_url, {"branch": urlutils.escape(location)})
156
return urlutils.join(this_url, '..', urlutils.escape(location))
160
def open_sibling_branch(control_dir, location, possible_transports=None):
161
"""Open a branch, possibly a sibling of another.
163
:param control_dir: Control directory relative to which to lookup the
165
:param location: Location to look up
166
:return: branch to open
169
# Perhaps it's a colocated branch?
170
return control_dir.open_branch(
171
location, possible_transports=possible_transports)
172
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
173
this_url = _get_branch_location(control_dir)
176
this_url, '..', urlutils.escape(location)))
179
def open_nearby_branch(near=None, location=None, possible_transports=None):
180
"""Open a nearby branch.
182
:param near: Optional location of container from which to open branch
183
:param location: Location of the branch
184
:return: Branch instance
191
location, possible_transports=possible_transports)
192
except errors.NotBranchError:
194
cdir = controldir.ControlDir.open(
195
near, possible_transports=possible_transports)
196
return open_sibling_branch(
197
cdir, location, possible_transports=possible_transports)
200
def iter_sibling_branches(control_dir, possible_transports=None):
201
"""Iterate over the siblings of a branch.
203
:param control_dir: Control directory for which to look up the siblings
204
:return: Iterator over tuples with branch name and branch object
207
reference = control_dir.get_branch_reference()
208
except errors.NotBranchError:
210
if reference is not None:
212
ref_branch = Branch.open(
213
reference, possible_transports=possible_transports)
214
except errors.NotBranchError:
218
if ref_branch is None or ref_branch.name:
219
if ref_branch is not None:
220
control_dir = ref_branch.controldir
221
for name, branch in viewitems(control_dir.get_branches()):
224
repo = ref_branch.controldir.find_repository()
225
for branch in repo.find_branches(using=True):
226
name = urlutils.relative_url(
227
repo.user_url, branch.user_url).rstrip("/")
231
def tree_files_for_add(file_list):
233
Return a tree and list of absolute paths from a file list.
235
Similar to tree_files, but add handles files a bit differently, so it a
236
custom implementation. In particular, MutableTreeTree.smart_add expects
237
absolute paths, which it immediately converts to relative paths.
239
# FIXME Would be nice to just return the relative paths like
240
# internal_tree_files does, but there are a large number of unit tests
241
# that assume the current interface to mutabletree.smart_add
243
tree, relpath = WorkingTree.open_containing(file_list[0])
244
if tree.supports_views():
245
view_files = tree.views.lookup_view()
247
for filename in file_list:
248
if not osutils.is_inside_any(view_files, filename):
249
raise views.FileOutsideView(filename, view_files)
250
file_list = file_list[:]
251
file_list[0] = tree.abspath(relpath)
253
tree = WorkingTree.open_containing(u'.')[0]
254
if tree.supports_views():
255
view_files = tree.views.lookup_view()
257
file_list = view_files
258
view_str = views.view_display_str(view_files)
259
note(gettext("Ignoring files outside view. View is %s"),
261
return tree, file_list
264
def _get_one_revision(command_name, revisions):
265
if revisions is None:
267
if len(revisions) != 1:
268
raise errors.BzrCommandError(gettext(
269
'brz %s --revision takes exactly one revision identifier') % (
274
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
275
"""Get a revision tree. Not suitable for commands that change the tree.
277
Specifically, the basis tree in dirstate trees is coupled to the dirstate
278
and doing a commit/uncommit/pull will at best fail due to changing the
281
If tree is passed in, it should be already locked, for lifetime management
282
of the trees internal cached state.
286
if revisions is None:
288
rev_tree = tree.basis_tree()
290
rev_tree = branch.basis_tree()
292
revision = _get_one_revision(command_name, revisions)
293
rev_tree = revision.as_tree(branch)
297
def _get_view_info_for_change_reporter(tree):
298
"""Get the view information from a tree for change reporting."""
301
current_view = tree.views.get_view_info()[0]
302
if current_view is not None:
303
view_info = (current_view, tree.views.lookup_view())
304
except views.ViewsNotSupported:
309
def _open_directory_or_containing_tree_or_branch(filename, directory):
310
"""Open the tree or branch containing the specified file, unless
311
the --directory option is used to specify a different branch."""
312
if directory is not None:
313
return (None, Branch.open(directory), filename)
314
return controldir.ControlDir.open_containing_tree_or_branch(filename)
317
# TODO: Make sure no commands unconditionally use the working directory as a
318
# branch. If a filename argument is used, the first of them should be used to
319
# specify the branch. (Perhaps this can be factored out into some kind of
320
# Argument class, representing a file in a branch, where the first occurrence
323
class cmd_status(Command):
324
__doc__ = """Display status summary.
326
This reports on versioned and unknown files, reporting them
327
grouped by state. Possible states are:
330
Versioned in the working copy but not in the previous revision.
333
Versioned in the previous revision but removed or deleted
337
Path of this file changed from the previous revision;
338
the text may also have changed. This includes files whose
339
parent directory was renamed.
342
Text has changed since the previous revision.
345
File kind has been changed (e.g. from file to directory).
348
Not versioned and not matching an ignore pattern.
350
Additionally for directories, symlinks and files with a changed
351
executable bit, Breezy indicates their type using a trailing
352
character: '/', '@' or '*' respectively. These decorations can be
353
disabled using the '--no-classify' option.
355
To see ignored files use 'brz ignored'. For details on the
356
changes to file texts, use 'brz diff'.
358
Note that --short or -S gives status flags for each item, similar
359
to Subversion's status command. To get output similar to svn -q,
362
If no arguments are specified, the status of the entire working
363
directory is shown. Otherwise, only the status of the specified
364
files or directories is reported. If a directory is given, status
365
is reported for everything inside that directory.
367
Before merges are committed, the pending merge tip revisions are
368
shown. To see all pending merge revisions, use the -v option.
369
To skip the display of pending merge information altogether, use
370
the no-pending option or specify a file/directory.
372
To compare the working directory to a specific revision, pass a
373
single revision to the revision argument.
375
To see which files have changed in a specific revision, or between
376
two revisions, pass a revision range to the revision argument.
377
This will produce the same results as calling 'brz diff --summarize'.
380
# TODO: --no-recurse/-N, --recurse options
382
takes_args = ['file*']
383
takes_options = ['show-ids', 'revision', 'change', 'verbose',
384
Option('short', help='Use short status indicators.',
386
Option('versioned', help='Only show versioned files.',
388
Option('no-pending', help='Don\'t show pending merges.'),
389
Option('no-classify',
390
help='Do not mark object type using indicator.'),
392
aliases = ['st', 'stat']
394
encoding_type = 'replace'
395
_see_also = ['diff', 'revert', 'status-flags']
398
def run(self, show_ids=False, file_list=None, revision=None, short=False,
399
versioned=False, no_pending=False, verbose=False,
401
from .status import show_tree_status
403
if revision and len(revision) > 2:
404
raise errors.BzrCommandError(
405
gettext('brz status --revision takes exactly'
406
' one or two revision specifiers'))
408
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
409
# Avoid asking for specific files when that is not needed.
410
if relfile_list == ['']:
412
# Don't disable pending merges for full trees other than '.'.
413
if file_list == ['.']:
415
# A specific path within a tree was given.
416
elif relfile_list is not None:
418
show_tree_status(tree, show_ids=show_ids,
419
specific_files=relfile_list, revision=revision,
420
to_file=self.outf, short=short, versioned=versioned,
421
show_pending=(not no_pending), verbose=verbose,
422
classify=not no_classify)
425
class cmd_cat_revision(Command):
426
__doc__ = """Write out metadata for a revision.
428
The revision to print can either be specified by a specific
429
revision identifier, or you can use --revision.
433
takes_args = ['revision_id?']
434
takes_options = ['directory', 'revision']
435
# cat-revision is more for frontends so should be exact
438
def print_revision(self, revisions, revid):
439
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
440
record = next(stream)
441
if record.storage_kind == 'absent':
442
raise errors.NoSuchRevision(revisions, revid)
443
revtext = record.get_bytes_as('fulltext')
444
self.outf.write(revtext.decode('utf-8'))
447
def run(self, revision_id=None, revision=None, directory=u'.'):
448
if revision_id is not None and revision is not None:
449
raise errors.BzrCommandError(gettext('You can only supply one of'
450
' revision_id or --revision'))
451
if revision_id is None and revision is None:
452
raise errors.BzrCommandError(
453
gettext('You must supply either --revision or a revision_id'))
455
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
457
revisions = getattr(b.repository, "revisions", None)
458
if revisions is None:
459
raise errors.BzrCommandError(
460
gettext('Repository %r does not support '
461
'access to raw revision texts') % b.repository)
463
with b.repository.lock_read():
464
# TODO: jam 20060112 should cat-revision always output utf-8?
465
if revision_id is not None:
466
revision_id = cache_utf8.encode(revision_id)
468
self.print_revision(revisions, revision_id)
469
except errors.NoSuchRevision:
471
"The repository {0} contains no revision {1}.").format(
472
b.repository.base, revision_id.decode('utf-8'))
473
raise errors.BzrCommandError(msg)
474
elif revision is not None:
477
raise errors.BzrCommandError(
478
gettext('You cannot specify a NULL revision.'))
479
rev_id = rev.as_revision_id(b)
480
self.print_revision(revisions, rev_id)
483
class cmd_remove_tree(Command):
484
__doc__ = """Remove the working tree from a given branch/checkout.
486
Since a lightweight checkout is little more than a working tree
487
this will refuse to run against one.
489
To re-create the working tree, use "brz checkout".
491
_see_also = ['checkout', 'working-trees']
492
takes_args = ['location*']
495
help='Remove the working tree even if it has '
496
'uncommitted or shelved changes.'),
499
def run(self, location_list, force=False):
500
if not location_list:
501
location_list = ['.']
503
for location in location_list:
504
d = controldir.ControlDir.open(location)
507
working = d.open_workingtree()
508
except errors.NoWorkingTree:
509
raise errors.BzrCommandError(
510
gettext("No working tree to remove"))
511
except errors.NotLocalUrl:
512
raise errors.BzrCommandError(
513
gettext("You cannot remove the working tree"
514
" of a remote path"))
516
if (working.has_changes()):
517
raise errors.UncommittedChanges(working)
518
if working.get_shelf_manager().last_shelf() is not None:
519
raise errors.ShelvedChanges(working)
521
if working.user_url != working.branch.user_url:
522
raise errors.BzrCommandError(
523
gettext("You cannot remove the working tree"
524
" from a lightweight checkout"))
526
d.destroy_workingtree()
529
class cmd_repair_workingtree(Command):
530
__doc__ = """Reset the working tree state file.
532
This is not meant to be used normally, but more as a way to recover from
533
filesystem corruption, etc. This rebuilds the working inventory back to a
534
'known good' state. Any new modifications (adding a file, renaming, etc)
535
will be lost, though modified files will still be detected as such.
537
Most users will want something more like "brz revert" or "brz update"
538
unless the state file has become corrupted.
540
By default this attempts to recover the current state by looking at the
541
headers of the state file. If the state file is too corrupted to even do
542
that, you can supply --revision to force the state of the tree.
546
'revision', 'directory',
548
help='Reset the tree even if it doesn\'t appear to be'
553
def run(self, revision=None, directory='.', force=False):
554
tree, _ = WorkingTree.open_containing(directory)
555
self.enter_context(tree.lock_tree_write())
559
except errors.BzrError:
560
pass # There seems to be a real error here, so we'll reset
563
raise errors.BzrCommandError(gettext(
564
'The tree does not appear to be corrupt. You probably'
565
' want "brz revert" instead. Use "--force" if you are'
566
' sure you want to reset the working tree.'))
570
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
572
tree.reset_state(revision_ids)
573
except errors.BzrError:
574
if revision_ids is None:
575
extra = gettext(', the header appears corrupt, try passing '
576
'-r -1 to set the state to the last commit')
579
raise errors.BzrCommandError(
580
gettext('failed to reset the tree state{0}').format(extra))
583
class cmd_revno(Command):
584
__doc__ = """Show current revision number.
586
This is equal to the number of revisions on this branch.
590
takes_args = ['location?']
592
Option('tree', help='Show revno of working tree.'),
597
def run(self, tree=False, location=u'.', revision=None):
598
if revision is not None and tree:
599
raise errors.BzrCommandError(
600
gettext("--tree and --revision can not be used together"))
604
wt = WorkingTree.open_containing(location)[0]
605
self.enter_context(wt.lock_read())
606
except (errors.NoWorkingTree, errors.NotLocalUrl):
607
raise errors.NoWorkingTree(location)
609
revid = wt.last_revision()
611
b = Branch.open_containing(location)[0]
612
self.enter_context(b.lock_read())
614
if len(revision) != 1:
615
raise errors.BzrCommandError(gettext(
616
"Revision numbers only make sense for single "
617
"revisions, not ranges"))
618
revid = revision[0].as_revision_id(b)
620
revid = b.last_revision()
622
revno_t = b.revision_id_to_dotted_revno(revid)
623
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
625
revno = ".".join(str(n) for n in revno_t)
627
self.outf.write(revno + '\n')
630
class cmd_revision_info(Command):
631
__doc__ = """Show revision number and revision id for a given revision identifier.
634
takes_args = ['revision_info*']
637
custom_help('directory', help='Branch to examine, '
638
'rather than the one containing the working directory.'),
639
Option('tree', help='Show revno of working tree.'),
643
def run(self, revision=None, directory=u'.', tree=False,
644
revision_info_list=[]):
647
wt = WorkingTree.open_containing(directory)[0]
649
self.enter_context(wt.lock_read())
650
except (errors.NoWorkingTree, errors.NotLocalUrl):
652
b = Branch.open_containing(directory)[0]
653
self.enter_context(b.lock_read())
655
if revision is not None:
656
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
657
if revision_info_list is not None:
658
for rev_str in revision_info_list:
659
rev_spec = RevisionSpec.from_string(rev_str)
660
revision_ids.append(rev_spec.as_revision_id(b))
661
# No arguments supplied, default to the last revision
662
if len(revision_ids) == 0:
665
raise errors.NoWorkingTree(directory)
666
revision_ids.append(wt.last_revision())
668
revision_ids.append(b.last_revision())
672
for revision_id in revision_ids:
674
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
675
revno = '.'.join(str(i) for i in dotted_revno)
676
except errors.NoSuchRevision:
678
maxlen = max(maxlen, len(revno))
679
revinfos.append((revno, revision_id))
682
for revno, revid in revinfos:
684
'%*s %s\n' % (maxlen, revno, revid.decode('utf-8')))
687
class cmd_add(Command):
688
__doc__ = """Add specified files or directories.
690
In non-recursive mode, all the named items are added, regardless
691
of whether they were previously ignored. A warning is given if
692
any of the named files are already versioned.
694
In recursive mode (the default), files are treated the same way
695
but the behaviour for directories is different. Directories that
696
are already versioned do not give a warning. All directories,
697
whether already versioned or not, are searched for files or
698
subdirectories that are neither versioned or ignored, and these
699
are added. This search proceeds recursively into versioned
700
directories. If no names are given '.' is assumed.
702
A warning will be printed when nested trees are encountered,
703
unless they are explicitly ignored.
705
Therefore simply saying 'brz add' will version all files that
706
are currently unknown.
708
Adding a file whose parent directory is not versioned will
709
implicitly add the parent, and so on up to the root. This means
710
you should never need to explicitly add a directory, they'll just
711
get added when you add a file in the directory.
713
--dry-run will show which files would be added, but not actually
716
--file-ids-from will try to use the file ids from the supplied path.
717
It looks up ids trying to find a matching parent directory with the
718
same filename, and then by pure path. This option is rarely needed
719
but can be useful when adding the same logical file into two
720
branches that will be merged later (without showing the two different
721
adds as a conflict). It is also useful when merging another project
722
into a subdirectory of this one.
724
Any files matching patterns in the ignore list will not be added
725
unless they are explicitly mentioned.
727
In recursive mode, files larger than the configuration option
728
add.maximum_file_size will be skipped. Named items are never skipped due
731
takes_args = ['file*']
734
help="Don't recursively add the contents of directories.",
737
help="Show what would be done, but don't actually do "
740
Option('file-ids-from',
742
help='Lookup file ids from this tree.'),
744
encoding_type = 'replace'
745
_see_also = ['remove', 'ignore']
747
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
752
if file_ids_from is not None:
754
base_tree, base_path = WorkingTree.open_containing(
756
except errors.NoWorkingTree:
757
base_branch, base_path = Branch.open_containing(
759
base_tree = base_branch.basis_tree()
761
action = breezy.add.AddFromBaseAction(
762
base_tree, base_path, to_file=self.outf,
763
should_print=(not is_quiet()))
765
action = breezy.add.AddWithSkipLargeAction(
766
to_file=self.outf, should_print=(not is_quiet()))
769
self.enter_context(base_tree.lock_read())
770
tree, file_list = tree_files_for_add(file_list)
771
added, ignored = tree.smart_add(
772
file_list, not no_recurse, action=action, save=not dry_run)
776
for glob in sorted(ignored):
777
for path in ignored[glob]:
779
gettext("ignored {0} matching \"{1}\"\n").format(
783
class cmd_mkdir(Command):
784
__doc__ = """Create a new versioned directory.
786
This is equivalent to creating the directory and then adding it.
789
takes_args = ['dir+']
793
help='No error if existing, make parent directories as needed.',
797
encoding_type = 'replace'
800
def add_file_with_parents(cls, wt, relpath):
801
if wt.is_versioned(relpath):
803
cls.add_file_with_parents(wt, osutils.dirname(relpath))
807
def add_file_single(cls, wt, relpath):
810
def run(self, dir_list, parents=False):
812
add_file = self.add_file_with_parents
814
add_file = self.add_file_single
816
wt, relpath = WorkingTree.open_containing(dir)
821
if e.errno != errno.EEXIST:
825
add_file(wt, relpath)
827
self.outf.write(gettext('added %s\n') % dir)
830
class cmd_relpath(Command):
831
__doc__ = """Show path of a file relative to root"""
833
takes_args = ['filename']
837
def run(self, filename):
838
# TODO: jam 20050106 Can relpath return a munged path if
839
# sys.stdout encoding cannot represent it?
840
tree, relpath = WorkingTree.open_containing(filename)
841
self.outf.write(relpath)
842
self.outf.write('\n')
845
class cmd_inventory(Command):
846
__doc__ = """Show inventory of the current working copy or a revision.
848
It is possible to limit the output to a particular entry
849
type using the --kind option. For example: --kind file.
851
It is also possible to restrict the list of files to a specific
852
set. For example: brz inventory --show-ids this/file
860
Option('include-root',
861
help='Include the entry for the root of the tree, if any.'),
863
help='List entries of a particular kind: file, directory, '
867
takes_args = ['file*']
870
def run(self, revision=None, show_ids=False, kind=None, include_root=False,
872
if kind and kind not in ['file', 'directory', 'symlink']:
873
raise errors.BzrCommandError(
874
gettext('invalid kind %r specified') % (kind,))
876
revision = _get_one_revision('inventory', revision)
877
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
878
self.enter_context(work_tree.lock_read())
879
if revision is not None:
880
tree = revision.as_tree(work_tree.branch)
882
extra_trees = [work_tree]
883
self.enter_context(tree.lock_read())
888
self.enter_context(tree.lock_read())
889
if file_list is not None:
890
paths = tree.find_related_paths_across_trees(
891
file_list, extra_trees, require_versioned=True)
892
# find_ids_across_trees may include some paths that don't
894
entries = tree.iter_entries_by_dir(specific_files=paths)
896
entries = tree.iter_entries_by_dir()
898
for path, entry in sorted(entries):
899
if kind and kind != entry.kind:
901
if path == "" and not include_root:
904
self.outf.write('%-50s %s\n' % (
905
path, entry.file_id.decode('utf-8')))
907
self.outf.write(path)
908
self.outf.write('\n')
911
class cmd_cp(Command):
912
__doc__ = """Copy a file.
915
brz cp OLDNAME NEWNAME
917
brz cp SOURCE... DESTINATION
919
If the last argument is a versioned directory, all the other names
920
are copied into it. Otherwise, there must be exactly two arguments
921
and the file is copied to a new name.
923
Files cannot be copied between branches. Only files can be copied
927
takes_args = ['names*']
930
encoding_type = 'replace'
932
def run(self, names_list):
933
if names_list is None:
935
if len(names_list) < 2:
936
raise errors.BzrCommandError(gettext("missing file argument"))
937
tree, rel_names = WorkingTree.open_containing_paths(
938
names_list, canonicalize=False)
939
for file_name in rel_names[0:-1]:
941
raise errors.BzrCommandError(
942
gettext("can not copy root of branch"))
943
self.enter_context(tree.lock_tree_write())
944
into_existing = osutils.isdir(names_list[-1])
945
if not into_existing:
947
(src, dst) = rel_names
949
raise errors.BzrCommandError(
950
gettext('to copy multiple files the'
951
' destination must be a versioned'
956
(n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
957
for n in rel_names[:-1]]
959
for src, dst in pairs:
961
src_kind = tree.stored_kind(src)
962
except errors.NoSuchFile:
963
raise errors.BzrCommandError(
964
gettext('Could not copy %s => %s: %s is not versioned.')
967
raise errors.BzrCommandError(
968
gettext('Could not copy %s => %s . %s is not versioned\\.'
970
if src_kind == 'directory':
971
raise errors.BzrCommandError(
972
gettext('Could not copy %s => %s . %s is a directory.'
974
dst_parent = osutils.split(dst)[0]
977
dst_parent_kind = tree.stored_kind(dst_parent)
978
except errors.NoSuchFile:
979
raise errors.BzrCommandError(
980
gettext('Could not copy %s => %s: %s is not versioned.')
981
% (src, dst, dst_parent))
982
if dst_parent_kind != 'directory':
983
raise errors.BzrCommandError(
984
gettext('Could not copy to %s: %s is not a directory.')
985
% (dst_parent, dst_parent))
987
tree.copy_one(src, dst)
990
class cmd_mv(Command):
991
__doc__ = """Move or rename a file.
994
brz mv OLDNAME NEWNAME
996
brz mv SOURCE... DESTINATION
998
If the last argument is a versioned directory, all the other names
999
are moved into it. Otherwise, there must be exactly two arguments
1000
and the file is changed to a new name.
1002
If OLDNAME does not exist on the filesystem but is versioned and
1003
NEWNAME does exist on the filesystem but is not versioned, mv
1004
assumes that the file has been manually moved and only updates
1005
its internal inventory to reflect that change.
1006
The same is valid when moving many SOURCE files to a DESTINATION.
1008
Files cannot be moved between branches.
1011
takes_args = ['names*']
1012
takes_options = [Option("after", help="Move only the brz identifier"
1013
" of the file, because the file has already been moved."),
1014
Option('auto', help='Automatically guess renames.'),
1016
'dry-run', help='Avoid making changes when guessing renames.'),
1018
aliases = ['move', 'rename']
1019
encoding_type = 'replace'
1021
def run(self, names_list, after=False, auto=False, dry_run=False):
1023
return self.run_auto(names_list, after, dry_run)
1025
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1026
if names_list is None:
1028
if len(names_list) < 2:
1029
raise errors.BzrCommandError(gettext("missing file argument"))
1030
tree, rel_names = WorkingTree.open_containing_paths(
1031
names_list, canonicalize=False)
1032
for file_name in rel_names[0:-1]:
1034
raise errors.BzrCommandError(
1035
gettext("can not move root of branch"))
1036
self.enter_context(tree.lock_tree_write())
1037
self._run(tree, names_list, rel_names, after)
1039
def run_auto(self, names_list, after, dry_run):
1040
if names_list is not None and len(names_list) > 1:
1041
raise errors.BzrCommandError(
1042
gettext('Only one path may be specified to --auto.'))
1044
raise errors.BzrCommandError(
1045
gettext('--after cannot be specified with --auto.'))
1046
work_tree, file_list = WorkingTree.open_containing_paths(
1047
names_list, default_directory='.')
1048
self.enter_context(work_tree.lock_tree_write())
1049
rename_map.RenameMap.guess_renames(
1050
work_tree.basis_tree(), work_tree, dry_run)
1052
def _run(self, tree, names_list, rel_names, after):
1053
into_existing = osutils.isdir(names_list[-1])
1054
if into_existing and len(names_list) == 2:
1056
# a. case-insensitive filesystem and change case of dir
1057
# b. move directory after the fact (if the source used to be
1058
# a directory, but now doesn't exist in the working tree
1059
# and the target is an existing directory, just rename it)
1060
if (not tree.case_sensitive
1061
and rel_names[0].lower() == rel_names[1].lower()):
1062
into_existing = False
1064
# 'fix' the case of a potential 'from'
1065
from_path = tree.get_canonical_path(rel_names[0])
1066
if (not osutils.lexists(names_list[0]) and
1067
tree.is_versioned(from_path) and
1068
tree.stored_kind(from_path) == "directory"):
1069
into_existing = False
1072
# move into existing directory
1073
# All entries reference existing inventory items, so fix them up
1074
# for cicp file-systems.
1075
rel_names = list(tree.get_canonical_paths(rel_names))
1076
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1078
self.outf.write("%s => %s\n" % (src, dest))
1080
if len(names_list) != 2:
1081
raise errors.BzrCommandError(gettext('to mv multiple files the'
1082
' destination must be a versioned'
1085
# for cicp file-systems: the src references an existing inventory
1087
src = tree.get_canonical_path(rel_names[0])
1088
# Find the canonical version of the destination: In all cases, the
1089
# parent of the target must be in the inventory, so we fetch the
1090
# canonical version from there (we do not always *use* the
1091
# canonicalized tail portion - we may be attempting to rename the
1093
canon_dest = tree.get_canonical_path(rel_names[1])
1094
dest_parent = osutils.dirname(canon_dest)
1095
spec_tail = osutils.basename(rel_names[1])
1096
# For a CICP file-system, we need to avoid creating 2 inventory
1097
# entries that differ only by case. So regardless of the case
1098
# we *want* to use (ie, specified by the user or the file-system),
1099
# we must always choose to use the case of any existing inventory
1100
# items. The only exception to this is when we are attempting a
1101
# case-only rename (ie, canonical versions of src and dest are
1103
dest_id = tree.path2id(canon_dest)
1104
if dest_id is None or tree.path2id(src) == dest_id:
1105
# No existing item we care about, so work out what case we
1106
# are actually going to use.
1108
# If 'after' is specified, the tail must refer to a file on disk.
1110
dest_parent_fq = osutils.pathjoin(
1111
tree.basedir, dest_parent)
1113
# pathjoin with an empty tail adds a slash, which breaks
1115
dest_parent_fq = tree.basedir
1117
dest_tail = osutils.canonical_relpath(
1119
osutils.pathjoin(dest_parent_fq, spec_tail))
1121
# not 'after', so case as specified is used
1122
dest_tail = spec_tail
1124
# Use the existing item so 'mv' fails with AlreadyVersioned.
1125
dest_tail = os.path.basename(canon_dest)
1126
dest = osutils.pathjoin(dest_parent, dest_tail)
1127
mutter("attempting to move %s => %s", src, dest)
1128
tree.rename_one(src, dest, after=after)
1130
self.outf.write("%s => %s\n" % (src, dest))
1133
class cmd_pull(Command):
1134
__doc__ = """Turn this branch into a mirror of another branch.
1136
By default, this command only works on branches that have not diverged.
1137
Branches are considered diverged if the destination branch's most recent
1138
commit is one that has not been merged (directly or indirectly) into the
1141
If branches have diverged, you can use 'brz merge' to integrate the changes
1142
from one into the other. Once one branch has merged, the other should
1143
be able to pull it again.
1145
If you want to replace your local changes and just want your branch to
1146
match the remote one, use pull --overwrite. This will work even if the two
1147
branches have diverged.
1149
If there is no default location set, the first pull will set it (use
1150
--no-remember to avoid setting it). After that, you can omit the
1151
location to use the default. To change the default, use --remember. The
1152
value will only be saved if the remote location can be accessed.
1154
The --verbose option will display the revisions pulled using the log_format
1155
configuration option. You can use a different format by overriding it with
1156
-Olog_format=<other_format>.
1158
Note: The location can be specified either in the form of a branch,
1159
or in the form of a path to a file containing a merge directive generated
1163
_see_also = ['push', 'update', 'status-flags', 'send']
1164
takes_options = ['remember', 'overwrite', 'revision',
1165
custom_help('verbose',
1166
help='Show logs of pulled revisions.'),
1167
custom_help('directory',
1168
help='Branch to pull into, '
1169
'rather than the one containing the working directory.'),
1171
help="Perform a local pull in a bound "
1172
"branch. Local pulls are not applied to "
1173
"the master branch."
1176
help="Show base revision text in conflicts."),
1177
Option('overwrite-tags',
1178
help="Overwrite tags only."),
1180
takes_args = ['location?']
1181
encoding_type = 'replace'
1183
def run(self, location=None, remember=None, overwrite=False,
1184
revision=None, verbose=False,
1185
directory=None, local=False,
1186
show_base=False, overwrite_tags=False):
1189
overwrite = ["history", "tags"]
1190
elif overwrite_tags:
1191
overwrite = ["tags"]
1194
# FIXME: too much stuff is in the command class
1197
if directory is None:
1200
tree_to = WorkingTree.open_containing(directory)[0]
1201
branch_to = tree_to.branch
1202
self.enter_context(tree_to.lock_write())
1203
except errors.NoWorkingTree:
1205
branch_to = Branch.open_containing(directory)[0]
1206
self.enter_context(branch_to.lock_write())
1208
warning(gettext("No working tree, ignoring --show-base"))
1210
if local and not branch_to.get_bound_location():
1211
raise errors.LocalRequiresBoundBranch()
1213
possible_transports = []
1214
if location is not None:
1216
mergeable = _mod_mergeable.read_mergeable_from_url(
1217
location, possible_transports=possible_transports)
1218
except errors.NotABundle:
1221
stored_loc = branch_to.get_parent()
1222
if location is None:
1223
if stored_loc is None:
1224
raise errors.BzrCommandError(gettext("No pull location known or"
1227
display_url = urlutils.unescape_for_display(stored_loc,
1231
gettext("Using saved parent location: %s\n") % display_url)
1232
location = stored_loc
1234
revision = _get_one_revision('pull', revision)
1235
if mergeable is not None:
1236
if revision is not None:
1237
raise errors.BzrCommandError(gettext(
1238
'Cannot use -r with merge directives or bundles'))
1239
mergeable.install_revisions(branch_to.repository)
1240
base_revision_id, revision_id, verified = \
1241
mergeable.get_merge_request(branch_to.repository)
1242
branch_from = branch_to
1244
branch_from = Branch.open(location,
1245
possible_transports=possible_transports)
1246
self.enter_context(branch_from.lock_read())
1247
# Remembers if asked explicitly or no previous location is set
1249
or (remember is None and branch_to.get_parent() is None)):
1250
# FIXME: This shouldn't be done before the pull
1251
# succeeds... -- vila 2012-01-02
1252
branch_to.set_parent(branch_from.base)
1254
if revision is not None:
1255
revision_id = revision.as_revision_id(branch_from)
1257
if tree_to is not None:
1258
view_info = _get_view_info_for_change_reporter(tree_to)
1259
change_reporter = delta._ChangeReporter(
1260
unversioned_filter=tree_to.is_ignored,
1261
view_info=view_info)
1262
result = tree_to.pull(
1263
branch_from, overwrite, revision_id, change_reporter,
1264
local=local, show_base=show_base)
1266
result = branch_to.pull(
1267
branch_from, overwrite, revision_id, local=local)
1269
result.report(self.outf)
1270
if verbose and result.old_revid != result.new_revid:
1271
log.show_branch_change(
1272
branch_to, self.outf, result.old_revno,
1274
if getattr(result, 'tag_conflicts', None):
1280
class cmd_push(Command):
1281
__doc__ = """Update a mirror of this branch.
1283
The target branch will not have its working tree populated because this
1284
is both expensive, and is not supported on remote file systems.
1286
Some smart servers or protocols *may* put the working tree in place in
1289
This command only works on branches that have not diverged. Branches are
1290
considered diverged if the destination branch's most recent commit is one
1291
that has not been merged (directly or indirectly) by the source branch.
1293
If branches have diverged, you can use 'brz push --overwrite' to replace
1294
the other branch completely, discarding its unmerged changes.
1296
If you want to ensure you have the different changes in the other branch,
1297
do a merge (see brz help merge) from the other branch, and commit that.
1298
After that you will be able to do a push without '--overwrite'.
1300
If there is no default push location set, the first push will set it (use
1301
--no-remember to avoid setting it). After that, you can omit the
1302
location to use the default. To change the default, use --remember. The
1303
value will only be saved if the remote location can be accessed.
1305
The --verbose option will display the revisions pushed using the log_format
1306
configuration option. You can use a different format by overriding it with
1307
-Olog_format=<other_format>.
1310
_see_also = ['pull', 'update', 'working-trees']
1311
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1312
Option('create-prefix',
1313
help='Create the path leading up to the branch '
1314
'if it does not already exist.'),
1315
custom_help('directory',
1316
help='Branch to push from, '
1317
'rather than the one containing the working directory.'),
1318
Option('use-existing-dir',
1319
help='By default push will fail if the target'
1320
' directory exists, but does not already'
1321
' have a control directory. This flag will'
1322
' allow push to proceed.'),
1324
help='Create a stacked branch that references the public location '
1325
'of the parent branch.'),
1326
Option('stacked-on',
1327
help='Create a stacked branch that refers to another branch '
1328
'for the commit history. Only the work not present in the '
1329
'referenced branch is included in the branch created.',
1332
help='Refuse to push if there are uncommitted changes in'
1333
' the working tree, --no-strict disables the check.'),
1335
help="Don't populate the working tree, even for protocols"
1336
" that support it."),
1337
Option('overwrite-tags',
1338
help="Overwrite tags only."),
1339
Option('lossy', help="Allow lossy push, i.e. dropping metadata "
1340
"that can't be represented in the target.")
1342
takes_args = ['location?']
1343
encoding_type = 'replace'
1345
def run(self, location=None, remember=None, overwrite=False,
1346
create_prefix=False, verbose=False, revision=None,
1347
use_existing_dir=False, directory=None, stacked_on=None,
1348
stacked=False, strict=None, no_tree=False,
1349
overwrite_tags=False, lossy=False):
1350
from .location import location_to_url
1351
from .push import _show_push_branch
1354
overwrite = ["history", "tags"]
1355
elif overwrite_tags:
1356
overwrite = ["tags"]
1360
if directory is None:
1362
# Get the source branch
1364
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1365
# Get the tip's revision_id
1366
revision = _get_one_revision('push', revision)
1367
if revision is not None:
1368
revision_id = revision.in_history(br_from).rev_id
1371
if tree is not None and revision_id is None:
1372
tree.check_changed_or_out_of_date(
1373
strict, 'push_strict',
1374
more_error='Use --no-strict to force the push.',
1375
more_warning='Uncommitted changes will not be pushed.')
1376
# Get the stacked_on branch, if any
1377
if stacked_on is not None:
1378
stacked_on = location_to_url(stacked_on, 'read')
1379
stacked_on = urlutils.normalize_url(stacked_on)
1381
parent_url = br_from.get_parent()
1383
parent = Branch.open(parent_url)
1384
stacked_on = parent.get_public_branch()
1386
# I considered excluding non-http url's here, thus forcing
1387
# 'public' branches only, but that only works for some
1388
# users, so it's best to just depend on the user spotting an
1389
# error by the feedback given to them. RBC 20080227.
1390
stacked_on = parent_url
1392
raise errors.BzrCommandError(gettext(
1393
"Could not determine branch to refer to."))
1395
# Get the destination location
1396
if location is None:
1397
stored_loc = br_from.get_push_location()
1398
if stored_loc is None:
1399
parent_loc = br_from.get_parent()
1401
raise errors.BzrCommandError(gettext(
1402
"No push location known or specified. To push to the "
1403
"parent branch (at %s), use 'brz push :parent'." %
1404
urlutils.unescape_for_display(parent_loc,
1405
self.outf.encoding)))
1407
raise errors.BzrCommandError(gettext(
1408
"No push location known or specified."))
1410
display_url = urlutils.unescape_for_display(stored_loc,
1412
note(gettext("Using saved push location: %s") % display_url)
1413
location = stored_loc
1415
_show_push_branch(br_from, revision_id, location, self.outf,
1416
verbose=verbose, overwrite=overwrite, remember=remember,
1417
stacked_on=stacked_on, create_prefix=create_prefix,
1418
use_existing_dir=use_existing_dir, no_tree=no_tree,
1422
class cmd_branch(Command):
1423
__doc__ = """Create a new branch that is a copy of an existing branch.
1425
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1426
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1427
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1428
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1429
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1432
To retrieve the branch as of a particular revision, supply the --revision
1433
parameter, as in "branch foo/bar -r 5".
1436
_see_also = ['checkout']
1437
takes_args = ['from_location', 'to_location?']
1438
takes_options = ['revision',
1440
'hardlink', help='Hard-link working tree files where possible.'),
1441
Option('files-from', type=text_type,
1442
help="Get file contents from this tree."),
1444
help="Create a branch without a working-tree."),
1446
help="Switch the checkout in the current directory "
1447
"to the new branch."),
1449
help='Create a stacked branch referring to the source branch. '
1450
'The new branch will depend on the availability of the source '
1451
'branch for all operations.'),
1452
Option('standalone',
1453
help='Do not use a shared repository, even if available.'),
1454
Option('use-existing-dir',
1455
help='By default branch will fail if the target'
1456
' directory exists, but does not already'
1457
' have a control directory. This flag will'
1458
' allow branch to proceed.'),
1460
help="Bind new branch to from location."),
1463
def run(self, from_location, to_location=None, revision=None,
1464
hardlink=False, stacked=False, standalone=False, no_tree=False,
1465
use_existing_dir=False, switch=False, bind=False,
1467
from breezy import switch as _mod_switch
1468
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1470
if not (hardlink or files_from):
1471
# accelerator_tree is usually slower because you have to read N
1472
# files (no readahead, lots of seeks, etc), but allow the user to
1473
# explicitly request it
1474
accelerator_tree = None
1475
if files_from is not None and files_from != from_location:
1476
accelerator_tree = WorkingTree.open(files_from)
1477
revision = _get_one_revision('branch', revision)
1478
self.enter_context(br_from.lock_read())
1479
if revision is not None:
1480
revision_id = revision.as_revision_id(br_from)
1482
# FIXME - wt.last_revision, fallback to branch, fall back to
1483
# None or perhaps NULL_REVISION to mean copy nothing
1485
revision_id = br_from.last_revision()
1486
if to_location is None:
1487
to_location = urlutils.derive_to_location(from_location)
1488
to_transport = transport.get_transport(to_location, purpose='write')
1490
to_transport.mkdir('.')
1491
except errors.FileExists:
1493
to_dir = controldir.ControlDir.open_from_transport(
1495
except errors.NotBranchError:
1496
if not use_existing_dir:
1497
raise errors.BzrCommandError(gettext('Target directory "%s" '
1498
'already exists.') % to_location)
1503
to_dir.open_branch()
1504
except errors.NotBranchError:
1507
raise errors.AlreadyBranchError(to_location)
1508
except errors.NoSuchFile:
1509
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1515
# preserve whatever source format we have.
1516
to_dir = br_from.controldir.sprout(
1517
to_transport.base, revision_id,
1518
possible_transports=[to_transport],
1519
accelerator_tree=accelerator_tree, hardlink=hardlink,
1520
stacked=stacked, force_new_repo=standalone,
1521
create_tree_if_local=not no_tree, source_branch=br_from)
1522
branch = to_dir.open_branch(
1523
possible_transports=[
1524
br_from.controldir.root_transport, to_transport])
1525
except errors.NoSuchRevision:
1526
to_transport.delete_tree('.')
1527
msg = gettext("The branch {0} has no revision {1}.").format(
1528
from_location, revision)
1529
raise errors.BzrCommandError(msg)
1532
to_repo = to_dir.open_repository()
1533
except errors.NoRepositoryPresent:
1534
to_repo = to_dir.create_repository()
1535
to_repo.fetch(br_from.repository, revision_id=revision_id)
1536
branch = br_from.sprout(to_dir, revision_id=revision_id)
1537
br_from.tags.merge_to(branch.tags)
1539
# If the source branch is stacked, the new branch may
1540
# be stacked whether we asked for that explicitly or not.
1541
# We therefore need a try/except here and not just 'if stacked:'
1543
note(gettext('Created new stacked branch referring to %s.') %
1544
branch.get_stacked_on_url())
1545
except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
1546
errors.UnstackableRepositoryFormat) as e:
1547
revno = branch.revno()
1548
if revno is not None:
1549
note(ngettext('Branched %d revision.',
1550
'Branched %d revisions.',
1551
branch.revno()) % revno)
1553
note(gettext('Created new branch.'))
1555
# Bind to the parent
1556
parent_branch = Branch.open(from_location)
1557
branch.bind(parent_branch)
1558
note(gettext('New branch bound to %s') % from_location)
1560
# Switch to the new branch
1561
wt, _ = WorkingTree.open_containing('.')
1562
_mod_switch.switch(wt.controldir, branch)
1563
note(gettext('Switched to branch: %s'),
1564
urlutils.unescape_for_display(branch.base, 'utf-8'))
1567
class cmd_branches(Command):
1568
__doc__ = """List the branches available at the current location.
1570
This command will print the names of all the branches at the current
1574
takes_args = ['location?']
1576
Option('recursive', short_name='R',
1577
help='Recursively scan for branches rather than '
1578
'just looking in the specified location.')]
1580
def run(self, location=".", recursive=False):
1582
t = transport.get_transport(location, purpose='read')
1583
if not t.listable():
1584
raise errors.BzrCommandError(
1585
"Can't scan this type of location.")
1586
for b in controldir.ControlDir.find_branches(t):
1587
self.outf.write("%s\n" % urlutils.unescape_for_display(
1588
urlutils.relative_url(t.base, b.base),
1589
self.outf.encoding).rstrip("/"))
1591
dir = controldir.ControlDir.open_containing(location)[0]
1593
active_branch = dir.open_branch(name="")
1594
except errors.NotBranchError:
1595
active_branch = None
1597
for name, branch in iter_sibling_branches(dir):
1600
active = (active_branch is not None and
1601
active_branch.user_url == branch.user_url)
1602
names[name] = active
1603
# Only mention the current branch explicitly if it's not
1604
# one of the colocated branches
1605
if not any(viewvalues(names)) and active_branch is not None:
1606
self.outf.write("* %s\n" % gettext("(default)"))
1607
for name in sorted(names):
1608
active = names[name]
1613
self.outf.write("%s %s\n" % (
1614
prefix, (name if PY3 else name.encode(self.outf.encoding))))
1617
class cmd_checkout(Command):
1618
__doc__ = """Create a new checkout of an existing branch.
1620
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree
1621
for the branch found in '.'. This is useful if you have removed the working
1622
tree or if it was never created - i.e. if you pushed the branch to its
1623
current location using SFTP.
1625
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION
1626
will be used. In other words, "checkout ../foo/bar" will attempt to create
1627
./bar. If the BRANCH_LOCATION has no / or path separator embedded, the
1628
TO_LOCATION is derived from the BRANCH_LOCATION by stripping a leading
1629
scheme or drive identifier, if any. For example, "checkout lp:foo-bar" will
1630
attempt to create ./foo-bar.
1632
To retrieve the branch as of a particular revision, supply the --revision
1633
parameter, as in "checkout foo/bar -r 5". Note that this will be
1634
immediately out of date [so you cannot commit] but it may be useful (i.e.
1635
to examine old code.)
1638
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1639
takes_args = ['branch_location?', 'to_location?']
1640
takes_options = ['revision',
1641
Option('lightweight',
1642
help="Perform a lightweight checkout. Lightweight "
1643
"checkouts depend on access to the branch for "
1644
"every operation. Normal checkouts can perform "
1645
"common operations like diff and status without "
1646
"such access, and also support local commits."
1648
Option('files-from', type=text_type,
1649
help="Get file contents from this tree."),
1651
help='Hard-link working tree files where possible.'
1656
def run(self, branch_location=None, to_location=None, revision=None,
1657
lightweight=False, files_from=None, hardlink=False):
1658
if branch_location is None:
1659
branch_location = osutils.getcwd()
1660
to_location = branch_location
1661
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1663
if not (hardlink or files_from):
1664
# accelerator_tree is usually slower because you have to read N
1665
# files (no readahead, lots of seeks, etc), but allow the user to
1666
# explicitly request it
1667
accelerator_tree = None
1668
revision = _get_one_revision('checkout', revision)
1669
if files_from is not None and files_from != branch_location:
1670
accelerator_tree = WorkingTree.open(files_from)
1671
if revision is not None:
1672
revision_id = revision.as_revision_id(source)
1675
if to_location is None:
1676
to_location = urlutils.derive_to_location(branch_location)
1677
# if the source and to_location are the same,
1678
# and there is no working tree,
1679
# then reconstitute a branch
1680
if osutils.abspath(to_location) == osutils.abspath(branch_location):
1682
source.controldir.open_workingtree()
1683
except errors.NoWorkingTree:
1684
source.controldir.create_workingtree(revision_id)
1686
source.create_checkout(to_location, revision_id, lightweight,
1687
accelerator_tree, hardlink)
1690
class cmd_renames(Command):
1691
__doc__ = """Show list of renamed files.
1693
# TODO: Option to show renames between two historical versions.
1695
# TODO: Only show renames under dir, rather than in the whole branch.
1696
_see_also = ['status']
1697
takes_args = ['dir?']
1700
def run(self, dir=u'.'):
1701
tree = WorkingTree.open_containing(dir)[0]
1702
self.enter_context(tree.lock_read())
1703
old_tree = tree.basis_tree()
1704
self.enter_context(old_tree.lock_read())
1706
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1707
for change in iterator:
1708
if change.path[0] == change.path[1]:
1710
if None in change.path:
1712
renames.append(change.path)
1714
for old_name, new_name in renames:
1715
self.outf.write("%s => %s\n" % (old_name, new_name))
1718
class cmd_update(Command):
1719
__doc__ = """Update a working tree to a new revision.
1721
This will perform a merge of the destination revision (the tip of the
1722
branch, or the specified revision) into the working tree, and then make
1723
that revision the basis revision for the working tree.
1725
You can use this to visit an older revision, or to update a working tree
1726
that is out of date from its branch.
1728
If there are any uncommitted changes in the tree, they will be carried
1729
across and remain as uncommitted changes after the update. To discard
1730
these changes, use 'brz revert'. The uncommitted changes may conflict
1731
with the changes brought in by the change in basis revision.
1733
If the tree's branch is bound to a master branch, brz will also update
1734
the branch from the master.
1736
You cannot update just a single file or directory, because each Breezy
1737
working tree has just a single basis revision. If you want to restore a
1738
file that has been removed locally, use 'brz revert' instead of 'brz
1739
update'. If you want to restore a file to its state in a previous
1740
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1741
out the old content of that file to a new location.
1743
The 'dir' argument, if given, must be the location of the root of a
1744
working tree to update. By default, the working tree that contains the
1745
current working directory is used.
1748
_see_also = ['pull', 'working-trees', 'status-flags']
1749
takes_args = ['dir?']
1750
takes_options = ['revision',
1752
help="Show base revision text in conflicts."),
1756
def run(self, dir=None, revision=None, show_base=None):
1757
if revision is not None and len(revision) != 1:
1758
raise errors.BzrCommandError(gettext(
1759
"brz update --revision takes exactly one revision"))
1761
tree = WorkingTree.open_containing('.')[0]
1763
tree, relpath = WorkingTree.open_containing(dir)
1766
raise errors.BzrCommandError(gettext(
1767
"brz update can only update a whole tree, "
1768
"not a file or subdirectory"))
1769
branch = tree.branch
1770
possible_transports = []
1771
master = branch.get_master_branch(
1772
possible_transports=possible_transports)
1773
if master is not None:
1774
branch_location = master.base
1775
self.enter_context(tree.lock_write())
1777
branch_location = tree.branch.base
1778
self.enter_context(tree.lock_tree_write())
1779
# get rid of the final '/' and be ready for display
1780
branch_location = urlutils.unescape_for_display(
1781
branch_location.rstrip('/'),
1783
existing_pending_merges = tree.get_parent_ids()[1:]
1787
# may need to fetch data into a heavyweight checkout
1788
# XXX: this may take some time, maybe we should display a
1790
old_tip = branch.update(possible_transports)
1791
if revision is not None:
1792
revision_id = revision[0].as_revision_id(branch)
1794
revision_id = branch.last_revision()
1795
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1796
revno = branch.revision_id_to_dotted_revno(revision_id)
1797
note(gettext("Tree is up to date at revision {0} of branch {1}"
1798
).format('.'.join(map(str, revno)), branch_location))
1800
view_info = _get_view_info_for_change_reporter(tree)
1801
change_reporter = delta._ChangeReporter(
1802
unversioned_filter=tree.is_ignored,
1803
view_info=view_info)
1805
conflicts = tree.update(
1807
possible_transports=possible_transports,
1808
revision=revision_id,
1810
show_base=show_base)
1811
except errors.NoSuchRevision as e:
1812
raise errors.BzrCommandError(gettext(
1813
"branch has no revision %s\n"
1814
"brz update --revision only works"
1815
" for a revision in the branch history")
1817
revno = tree.branch.revision_id_to_dotted_revno(
1818
_mod_revision.ensure_null(tree.last_revision()))
1819
note(gettext('Updated to revision {0} of branch {1}').format(
1820
'.'.join(map(str, revno)), branch_location))
1821
parent_ids = tree.get_parent_ids()
1822
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1823
note(gettext('Your local commits will now show as pending merges with '
1824
"'brz status', and can be committed with 'brz commit'."))
1831
class cmd_info(Command):
1832
__doc__ = """Show information about a working tree, branch or repository.
1834
This command will show all known locations and formats associated to the
1835
tree, branch or repository.
1837
In verbose mode, statistical information is included with each report.
1838
To see extended statistic information, use a verbosity level of 2 or
1839
higher by specifying the verbose option multiple times, e.g. -vv.
1841
Branches and working trees will also report any missing revisions.
1845
Display information on the format and related locations:
1849
Display the above together with extended format information and
1850
basic statistics (like the number of files in the working tree and
1851
number of revisions in the branch and repository):
1855
Display the above together with number of committers to the branch:
1859
_see_also = ['revno', 'working-trees', 'repositories']
1860
takes_args = ['location?']
1861
takes_options = ['verbose']
1862
encoding_type = 'replace'
1865
def run(self, location=None, verbose=False):
1867
noise_level = get_verbosity_level()
1870
from .info import show_bzrdir_info
1871
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1872
verbose=noise_level, outfile=self.outf)
1875
class cmd_remove(Command):
1876
__doc__ = """Remove files or directories.
1878
This makes Breezy stop tracking changes to the specified files. Breezy will
1879
delete them if they can easily be recovered using revert otherwise they
1880
will be backed up (adding an extension of the form .~#~). If no options or
1881
parameters are given Breezy will scan for files that are being tracked by
1882
Breezy but missing in your tree and stop tracking them for you.
1884
takes_args = ['file*']
1885
takes_options = ['verbose',
1887
'new', help='Only remove files that have never been committed.'),
1888
RegistryOption.from_kwargs('file-deletion-strategy',
1889
'The file deletion mode to be used.',
1890
title='Deletion Strategy', value_switches=True, enum_switch=False,
1891
safe='Backup changed files (default).',
1892
keep='Delete from brz but leave the working copy.',
1893
no_backup='Don\'t backup changed files.'),
1895
aliases = ['rm', 'del']
1896
encoding_type = 'replace'
1898
def run(self, file_list, verbose=False, new=False,
1899
file_deletion_strategy='safe'):
1901
tree, file_list = WorkingTree.open_containing_paths(file_list)
1903
if file_list is not None:
1904
file_list = [f for f in file_list]
1906
self.enter_context(tree.lock_write())
1907
# Heuristics should probably all move into tree.remove_smart or
1910
added = tree.changes_from(tree.basis_tree(),
1911
specific_files=file_list).added
1912
file_list = sorted([f.path[1] for f in added], reverse=True)
1913
if len(file_list) == 0:
1914
raise errors.BzrCommandError(gettext('No matching files.'))
1915
elif file_list is None:
1916
# missing files show up in iter_changes(basis) as
1917
# versioned-with-no-kind.
1919
for change in tree.iter_changes(tree.basis_tree()):
1920
# Find paths in the working tree that have no kind:
1921
if change.path[1] is not None and change.kind[1] is None:
1922
missing.append(change.path[1])
1923
file_list = sorted(missing, reverse=True)
1924
file_deletion_strategy = 'keep'
1925
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1926
keep_files=file_deletion_strategy == 'keep',
1927
force=(file_deletion_strategy == 'no-backup'))
1930
class cmd_reconcile(Command):
1931
__doc__ = """Reconcile brz metadata in a branch.
1933
This can correct data mismatches that may have been caused by
1934
previous ghost operations or brz upgrades. You should only
1935
need to run this command if 'brz check' or a brz developer
1936
advises you to run it.
1938
If a second branch is provided, cross-branch reconciliation is
1939
also attempted, which will check that data like the tree root
1940
id which was not present in very early brz versions is represented
1941
correctly in both branches.
1943
At the same time it is run it may recompress data resulting in
1944
a potential saving in disk space or performance gain.
1946
The branch *MUST* be on a listable system such as local disk or sftp.
1949
_see_also = ['check']
1950
takes_args = ['branch?']
1952
Option('canonicalize-chks',
1953
help='Make sure CHKs are in canonical form (repairs '
1958
def run(self, branch=".", canonicalize_chks=False):
1959
from .reconcile import reconcile
1960
dir = controldir.ControlDir.open(branch)
1961
reconcile(dir, canonicalize_chks=canonicalize_chks)
1964
class cmd_revision_history(Command):
1965
__doc__ = """Display the list of revision ids on a branch."""
1968
takes_args = ['location?']
1973
def run(self, location="."):
1974
branch = Branch.open_containing(location)[0]
1975
self.enter_context(branch.lock_read())
1976
graph = branch.repository.get_graph()
1977
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1978
[_mod_revision.NULL_REVISION]))
1979
for revid in reversed(history):
1980
self.outf.write(revid)
1981
self.outf.write('\n')
1984
class cmd_ancestry(Command):
1985
__doc__ = """List all revisions merged into this branch."""
1987
_see_also = ['log', 'revision-history']
1988
takes_args = ['location?']
1993
def run(self, location="."):
1995
wt = WorkingTree.open_containing(location)[0]
1996
except errors.NoWorkingTree:
1997
b = Branch.open(location)
1998
last_revision = b.last_revision()
2001
last_revision = wt.last_revision()
2003
self.enter_context(b.repository.lock_read())
2004
graph = b.repository.get_graph()
2005
revisions = [revid for revid, parents in
2006
graph.iter_ancestry([last_revision])]
2007
for revision_id in reversed(revisions):
2008
if _mod_revision.is_null(revision_id):
2010
self.outf.write(revision_id.decode('utf-8') + '\n')
2013
class cmd_init(Command):
2014
__doc__ = """Make a directory into a versioned branch.
2016
Use this to create an empty branch, or before importing an
2019
If there is a repository in a parent directory of the location, then
2020
the history of the branch will be stored in the repository. Otherwise
2021
init creates a standalone branch which carries its own history
2022
in the .bzr directory.
2024
If there is already a branch at the location but it has no working tree,
2025
the tree can be populated with 'brz checkout'.
2027
Recipe for importing a tree of files::
2033
brz commit -m "imported project"
2036
_see_also = ['init-shared-repository', 'branch', 'checkout']
2037
takes_args = ['location?']
2039
Option('create-prefix',
2040
help='Create the path leading up to the branch '
2041
'if it does not already exist.'),
2042
RegistryOption('format',
2043
help='Specify a format for this branch. '
2044
'See "help formats" for a full list.',
2045
lazy_registry=('breezy.controldir', 'format_registry'),
2046
converter=lambda name: controldir.format_registry.make_controldir(
2048
value_switches=True,
2049
title="Branch format",
2051
Option('append-revisions-only',
2052
help='Never change revnos or the existing log.'
2053
' Append revisions to it only.'),
2055
'Create a branch without a working tree.')
2058
def run(self, location=None, format=None, append_revisions_only=False,
2059
create_prefix=False, no_tree=False):
2061
format = controldir.format_registry.make_controldir('default')
2062
if location is None:
2065
to_transport = transport.get_transport(location, purpose='write')
2067
# The path has to exist to initialize a
2068
# branch inside of it.
2069
# Just using os.mkdir, since I don't
2070
# believe that we want to create a bunch of
2071
# locations if the user supplies an extended path
2073
to_transport.ensure_base()
2074
except errors.NoSuchFile:
2075
if not create_prefix:
2076
raise errors.BzrCommandError(gettext("Parent directory of %s"
2078
"\nYou may supply --create-prefix to create all"
2079
" leading parent directories.")
2081
to_transport.create_prefix()
2084
a_controldir = controldir.ControlDir.open_from_transport(
2086
except errors.NotBranchError:
2087
# really a NotBzrDir error...
2088
create_branch = controldir.ControlDir.create_branch_convenience
2090
force_new_tree = False
2092
force_new_tree = None
2093
branch = create_branch(to_transport.base, format=format,
2094
possible_transports=[to_transport],
2095
force_new_tree=force_new_tree)
2096
a_controldir = branch.controldir
2098
from .transport.local import LocalTransport
2099
if a_controldir.has_branch():
2100
if (isinstance(to_transport, LocalTransport)
2101
and not a_controldir.has_workingtree()):
2102
raise errors.BranchExistsWithoutWorkingTree(location)
2103
raise errors.AlreadyBranchError(location)
2104
branch = a_controldir.create_branch()
2105
if not no_tree and not a_controldir.has_workingtree():
2106
a_controldir.create_workingtree()
2107
if append_revisions_only:
2109
branch.set_append_revisions_only(True)
2110
except errors.UpgradeRequired:
2111
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2112
' to append-revisions-only. Try --default.'))
2114
from .info import describe_layout, describe_format
2116
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2117
except (errors.NoWorkingTree, errors.NotLocalUrl):
2119
repository = branch.repository
2120
layout = describe_layout(repository, branch, tree).lower()
2121
format = describe_format(a_controldir, repository, branch, tree)
2122
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2124
if repository.is_shared():
2125
# XXX: maybe this can be refactored into transport.path_or_url()
2126
url = repository.controldir.root_transport.external_url()
2128
url = urlutils.local_path_from_url(url)
2129
except urlutils.InvalidURL:
2131
self.outf.write(gettext("Using shared repository: %s\n") % url)
2134
class cmd_init_shared_repository(Command):
2135
__doc__ = """Create a shared repository for branches to share storage space.
2137
New branches created under the repository directory will store their
2138
revisions in the repository, not in the branch directory. For branches
2139
with shared history, this reduces the amount of storage needed and
2140
speeds up the creation of new branches.
2142
If the --no-trees option is given then the branches in the repository
2143
will not have working trees by default. They will still exist as
2144
directories on disk, but they will not have separate copies of the
2145
files at a certain revision. This can be useful for repositories that
2146
store branches which are interacted with through checkouts or remote
2147
branches, such as on a server.
2150
Create a shared repository holding just branches::
2152
brz init-shared-repo --no-trees repo
2155
Make a lightweight checkout elsewhere::
2157
brz checkout --lightweight repo/trunk trunk-checkout
2162
_see_also = ['init', 'branch', 'checkout', 'repositories']
2163
takes_args = ["location"]
2164
takes_options = [RegistryOption('format',
2165
help='Specify a format for this repository. See'
2166
' "brz help formats" for details.',
2168
'breezy.controldir', 'format_registry'),
2169
converter=lambda name: controldir.format_registry.make_controldir(
2171
value_switches=True, title='Repository format'),
2173
help='Branches in the repository will default to'
2174
' not having a working tree.'),
2176
aliases = ["init-shared-repo", "init-repo"]
2178
def run(self, location, format=None, no_trees=False):
2180
format = controldir.format_registry.make_controldir('default')
2182
if location is None:
2185
to_transport = transport.get_transport(location, purpose='write')
2187
if format.fixed_components:
2188
repo_format_name = None
2190
repo_format_name = format.repository_format.get_format_string()
2192
(repo, newdir, require_stacking, repository_policy) = (
2193
format.initialize_on_transport_ex(to_transport,
2194
create_prefix=True, make_working_trees=not no_trees,
2195
shared_repo=True, force_new_repo=True,
2196
use_existing_dir=True,
2197
repo_format_name=repo_format_name))
2199
from .info import show_bzrdir_info
2200
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2203
class cmd_diff(Command):
2204
__doc__ = """Show differences in the working tree, between revisions or branches.
2206
If no arguments are given, all changes for the current tree are listed.
2207
If files are given, only the changes in those files are listed.
2208
Remote and multiple branches can be compared by using the --old and
2209
--new options. If not provided, the default for both is derived from
2210
the first argument, if any, or the current tree if no arguments are
2213
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2214
produces patches suitable for "patch -p1".
2216
Note that when using the -r argument with a range of revisions, the
2217
differences are computed between the two specified revisions. That
2218
is, the command does not show the changes introduced by the first
2219
revision in the range. This differs from the interpretation of
2220
revision ranges used by "brz log" which includes the first revision
2225
2 - unrepresentable changes
2230
Shows the difference in the working tree versus the last commit::
2234
Difference between the working tree and revision 1::
2238
Difference between revision 3 and revision 1::
2242
Difference between revision 3 and revision 1 for branch xxx::
2246
The changes introduced by revision 2 (equivalent to -r1..2)::
2250
To see the changes introduced by revision X::
2254
Note that in the case of a merge, the -c option shows the changes
2255
compared to the left hand parent. To see the changes against
2256
another parent, use::
2258
brz diff -r<chosen_parent>..X
2260
The changes between the current revision and the previous revision
2261
(equivalent to -c-1 and -r-2..-1)
2265
Show just the differences for file NEWS::
2269
Show the differences in working tree xxx for file NEWS::
2273
Show the differences from branch xxx to this working tree:
2277
Show the differences between two branches for file NEWS::
2279
brz diff --old xxx --new yyy NEWS
2281
Same as 'brz diff' but prefix paths with old/ and new/::
2283
brz diff --prefix old/:new/
2285
Show the differences using a custom diff program with options::
2287
brz diff --using /usr/bin/diff --diff-options -wu
2289
_see_also = ['status']
2290
takes_args = ['file*']
2292
Option('diff-options', type=text_type,
2293
help='Pass these options to the external diff program.'),
2294
Option('prefix', type=text_type,
2296
help='Set prefixes added to old and new filenames, as '
2297
'two values separated by a colon. (eg "old/:new/").'),
2299
help='Branch/tree to compare from.',
2303
help='Branch/tree to compare to.',
2309
help='Use this command to compare files.',
2312
RegistryOption('format',
2314
help='Diff format to use.',
2315
lazy_registry=('breezy.diff', 'format_registry'),
2316
title='Diff format'),
2318
help='How many lines of context to show.',
2322
aliases = ['di', 'dif']
2323
encoding_type = 'exact'
2326
def run(self, revision=None, file_list=None, diff_options=None,
2327
prefix=None, old=None, new=None, using=None, format=None,
2329
from .diff import (get_trees_and_branches_to_diff_locked,
2336
elif prefix == u'1' or prefix is None:
2339
elif u':' in prefix:
2340
old_label, new_label = prefix.split(u":")
2342
raise errors.BzrCommandError(gettext(
2343
'--prefix expects two values separated by a colon'
2344
' (eg "old/:new/")'))
2346
if revision and len(revision) > 2:
2347
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2348
' one or two revision specifiers'))
2350
if using is not None and format is not None:
2351
raise errors.BzrCommandError(gettext(
2352
'{0} and {1} are mutually exclusive').format(
2353
'--using', '--format'))
2355
(old_tree, new_tree,
2356
old_branch, new_branch,
2357
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2358
file_list, revision, old, new, self._exit_stack, apply_view=True)
2359
# GNU diff on Windows uses ANSI encoding for filenames
2360
path_encoding = osutils.get_diff_header_encoding()
2361
return show_diff_trees(old_tree, new_tree, self.outf,
2362
specific_files=specific_files,
2363
external_diff_options=diff_options,
2364
old_label=old_label, new_label=new_label,
2365
extra_trees=extra_trees,
2366
path_encoding=path_encoding,
2367
using=using, context=context,
2371
class cmd_deleted(Command):
2372
__doc__ = """List files deleted in the working tree.
2374
# TODO: Show files deleted since a previous revision, or
2375
# between two revisions.
2376
# TODO: Much more efficient way to do this: read in new
2377
# directories with readdir, rather than stating each one. Same
2378
# level of effort but possibly much less IO. (Or possibly not,
2379
# if the directories are very large...)
2380
_see_also = ['status', 'ls']
2381
takes_options = ['directory', 'show-ids']
2384
def run(self, show_ids=False, directory=u'.'):
2385
tree = WorkingTree.open_containing(directory)[0]
2386
self.enter_context(tree.lock_read())
2387
old = tree.basis_tree()
2388
self.enter_context(old.lock_read())
2389
delta = tree.changes_from(old)
2390
for change in delta.removed:
2391
self.outf.write(change.path[0])
2393
self.outf.write(' ')
2394
self.outf.write(change.file_id)
2395
self.outf.write('\n')
2398
class cmd_modified(Command):
2399
__doc__ = """List files modified in working tree.
2403
_see_also = ['status', 'ls']
2404
takes_options = ['directory', 'null']
2407
def run(self, null=False, directory=u'.'):
2408
tree = WorkingTree.open_containing(directory)[0]
2409
self.enter_context(tree.lock_read())
2410
td = tree.changes_from(tree.basis_tree())
2412
for change in td.modified:
2414
self.outf.write(change.path[1] + '\0')
2416
self.outf.write(osutils.quotefn(change.path[1]) + '\n')
2419
class cmd_added(Command):
2420
__doc__ = """List files added in working tree.
2424
_see_also = ['status', 'ls']
2425
takes_options = ['directory', 'null']
2428
def run(self, null=False, directory=u'.'):
2429
wt = WorkingTree.open_containing(directory)[0]
2430
self.enter_context(wt.lock_read())
2431
basis = wt.basis_tree()
2432
self.enter_context(basis.lock_read())
2433
for path in wt.all_versioned_paths():
2434
if basis.has_filename(path):
2438
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2441
self.outf.write(path + '\0')
2443
self.outf.write(osutils.quotefn(path) + '\n')
2446
class cmd_root(Command):
2447
__doc__ = """Show the tree root directory.
2449
The root is the nearest enclosing directory with a control
2452
takes_args = ['filename?']
2455
def run(self, filename=None):
2456
"""Print the branch root."""
2457
tree = WorkingTree.open_containing(filename)[0]
2458
self.outf.write(tree.basedir + '\n')
2461
def _parse_limit(limitstring):
2463
return int(limitstring)
2465
msg = gettext("The limit argument must be an integer.")
2466
raise errors.BzrCommandError(msg)
2469
def _parse_levels(s):
2473
msg = gettext("The levels argument must be an integer.")
2474
raise errors.BzrCommandError(msg)
2477
class cmd_log(Command):
2478
__doc__ = """Show historical log for a branch or subset of a branch.
2480
log is brz's default tool for exploring the history of a branch.
2481
The branch to use is taken from the first parameter. If no parameters
2482
are given, the branch containing the working directory is logged.
2483
Here are some simple examples::
2485
brz log log the current branch
2486
brz log foo.py log a file in its branch
2487
brz log http://server/branch log a branch on a server
2489
The filtering, ordering and information shown for each revision can
2490
be controlled as explained below. By default, all revisions are
2491
shown sorted (topologically) so that newer revisions appear before
2492
older ones and descendants always appear before ancestors. If displayed,
2493
merged revisions are shown indented under the revision in which they
2498
The log format controls how information about each revision is
2499
displayed. The standard log formats are called ``long``, ``short``
2500
and ``line``. The default is long. See ``brz help log-formats``
2501
for more details on log formats.
2503
The following options can be used to control what information is
2506
-l N display a maximum of N revisions
2507
-n N display N levels of revisions (0 for all, 1 for collapsed)
2508
-v display a status summary (delta) for each revision
2509
-p display a diff (patch) for each revision
2510
--show-ids display revision-ids (and file-ids), not just revnos
2512
Note that the default number of levels to display is a function of the
2513
log format. If the -n option is not used, the standard log formats show
2514
just the top level (mainline).
2516
Status summaries are shown using status flags like A, M, etc. To see
2517
the changes explained using words like ``added`` and ``modified``
2518
instead, use the -vv option.
2522
To display revisions from oldest to newest, use the --forward option.
2523
In most cases, using this option will have little impact on the total
2524
time taken to produce a log, though --forward does not incrementally
2525
display revisions like --reverse does when it can.
2527
:Revision filtering:
2529
The -r option can be used to specify what revision or range of revisions
2530
to filter against. The various forms are shown below::
2532
-rX display revision X
2533
-rX.. display revision X and later
2534
-r..Y display up to and including revision Y
2535
-rX..Y display from X to Y inclusive
2537
See ``brz help revisionspec`` for details on how to specify X and Y.
2538
Some common examples are given below::
2540
-r-1 show just the tip
2541
-r-10.. show the last 10 mainline revisions
2542
-rsubmit:.. show what's new on this branch
2543
-rancestor:path.. show changes since the common ancestor of this
2544
branch and the one at location path
2545
-rdate:yesterday.. show changes since yesterday
2547
When logging a range of revisions using -rX..Y, log starts at
2548
revision Y and searches back in history through the primary
2549
("left-hand") parents until it finds X. When logging just the
2550
top level (using -n1), an error is reported if X is not found
2551
along the way. If multi-level logging is used (-n0), X may be
2552
a nested merge revision and the log will be truncated accordingly.
2556
If parameters are given and the first one is not a branch, the log
2557
will be filtered to show only those revisions that changed the
2558
nominated files or directories.
2560
Filenames are interpreted within their historical context. To log a
2561
deleted file, specify a revision range so that the file existed at
2562
the end or start of the range.
2564
Historical context is also important when interpreting pathnames of
2565
renamed files/directories. Consider the following example:
2567
* revision 1: add tutorial.txt
2568
* revision 2: modify tutorial.txt
2569
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2573
* ``brz log guide.txt`` will log the file added in revision 1
2575
* ``brz log tutorial.txt`` will log the new file added in revision 3
2577
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2578
the original file in revision 2.
2580
* ``brz log -r2 -p guide.txt`` will display an error message as there
2581
was no file called guide.txt in revision 2.
2583
Renames are always followed by log. By design, there is no need to
2584
explicitly ask for this (and no way to stop logging a file back
2585
until it was last renamed).
2589
The --match option can be used for finding revisions that match a
2590
regular expression in a commit message, committer, author or bug.
2591
Specifying the option several times will match any of the supplied
2592
expressions. --match-author, --match-bugs, --match-committer and
2593
--match-message can be used to only match a specific field.
2597
GUI tools and IDEs are often better at exploring history than command
2598
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2599
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2600
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2601
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2603
You may find it useful to add the aliases below to ``breezy.conf``::
2607
top = log -l10 --line
2610
``brz tip`` will then show the latest revision while ``brz top``
2611
will show the last 10 mainline revisions. To see the details of a
2612
particular revision X, ``brz show -rX``.
2614
If you are interested in looking deeper into a particular merge X,
2615
use ``brz log -n0 -rX``.
2617
``brz log -v`` on a branch with lots of history is currently
2618
very slow. A fix for this issue is currently under development.
2619
With or without that fix, it is recommended that a revision range
2620
be given when using the -v option.
2622
brz has a generic full-text matching plugin, brz-search, that can be
2623
used to find revisions matching user names, commit messages, etc.
2624
Among other features, this plugin can find all revisions containing
2625
a list of words but not others.
2627
When exploring non-mainline history on large projects with deep
2628
history, the performance of log can be greatly improved by installing
2629
the historycache plugin. This plugin buffers historical information
2630
trading disk space for faster speed.
2632
takes_args = ['file*']
2633
_see_also = ['log-formats', 'revisionspec']
2636
help='Show from oldest to newest.'),
2638
custom_help('verbose',
2639
help='Show files changed in each revision.'),
2643
type=breezy.option._parse_revision_str,
2645
help='Show just the specified revision.'
2646
' See also "help revisionspec".'),
2648
RegistryOption('authors',
2649
'What names to list as authors - first, all or committer.',
2652
'breezy.log', 'author_list_registry'),
2656
help='Number of levels to display - 0 for all, 1 for flat.',
2658
type=_parse_levels),
2660
help='Show revisions whose message matches this '
2661
'regular expression.',
2666
help='Limit the output to the first N revisions.',
2671
help='Show changes made in each revision as a patch.'),
2672
Option('include-merged',
2673
help='Show merged revisions like --levels 0 does.'),
2674
Option('include-merges', hidden=True,
2675
help='Historical alias for --include-merged.'),
2676
Option('omit-merges',
2677
help='Do not report commits with more than one parent.'),
2678
Option('exclude-common-ancestry',
2679
help='Display only the revisions that are not part'
2680
' of both ancestries (require -rX..Y).'
2682
Option('signatures',
2683
help='Show digital signature validity.'),
2686
help='Show revisions whose properties match this '
2689
ListOption('match-message',
2690
help='Show revisions whose message matches this '
2693
ListOption('match-committer',
2694
help='Show revisions whose committer matches this '
2697
ListOption('match-author',
2698
help='Show revisions whose authors match this '
2701
ListOption('match-bugs',
2702
help='Show revisions whose bugs match this '
2706
encoding_type = 'replace'
2709
def run(self, file_list=None, timezone='original',
2720
include_merged=None,
2722
exclude_common_ancestry=False,
2726
match_committer=None,
2733
make_log_request_dict,
2734
_get_info_for_log_files,
2736
direction = (forward and 'forward') or 'reverse'
2737
if include_merged is None:
2738
include_merged = False
2739
if (exclude_common_ancestry
2740
and (revision is None or len(revision) != 2)):
2741
raise errors.BzrCommandError(gettext(
2742
'--exclude-common-ancestry requires -r with two revisions'))
2747
raise errors.BzrCommandError(gettext(
2748
'{0} and {1} are mutually exclusive').format(
2749
'--levels', '--include-merged'))
2751
if change is not None:
2753
raise errors.RangeInChangeOption()
2754
if revision is not None:
2755
raise errors.BzrCommandError(gettext(
2756
'{0} and {1} are mutually exclusive').format(
2757
'--revision', '--change'))
2762
filter_by_dir = False
2764
# find the file ids to log and check for directory filtering
2765
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2766
revision, file_list, self._exit_stack)
2767
for relpath, file_id, kind in file_info_list:
2769
raise errors.BzrCommandError(gettext(
2770
"Path unknown at end or start of revision range: %s") %
2772
# If the relpath is the top of the tree, we log everything
2777
file_ids.append(file_id)
2778
filter_by_dir = filter_by_dir or (
2779
kind in ['directory', 'tree-reference'])
2782
# FIXME ? log the current subdir only RBC 20060203
2783
if revision is not None \
2784
and len(revision) > 0 and revision[0].get_branch():
2785
location = revision[0].get_branch()
2788
dir, relpath = controldir.ControlDir.open_containing(location)
2789
b = dir.open_branch()
2790
self.enter_context(b.lock_read())
2791
rev1, rev2 = _get_revision_range(revision, b, self.name())
2793
if b.get_config_stack().get('validate_signatures_in_log'):
2797
if not gpg.GPGStrategy.verify_signatures_available():
2798
raise errors.GpgmeNotInstalled(None)
2800
# Decide on the type of delta & diff filtering to use
2801
# TODO: add an --all-files option to make this configurable & consistent
2809
diff_type = 'partial'
2813
# Build the log formatter
2814
if log_format is None:
2815
log_format = log.log_formatter_registry.get_default(b)
2816
# Make a non-encoding output to include the diffs - bug 328007
2817
unencoded_output = ui.ui_factory.make_output_stream(
2818
encoding_type='exact')
2819
lf = log_format(show_ids=show_ids, to_file=self.outf,
2820
to_exact_file=unencoded_output,
2821
show_timezone=timezone,
2822
delta_format=get_verbosity_level(),
2824
show_advice=levels is None,
2825
author_list_handler=authors)
2827
# Choose the algorithm for doing the logging. It's annoying
2828
# having multiple code paths like this but necessary until
2829
# the underlying repository format is faster at generating
2830
# deltas or can provide everything we need from the indices.
2831
# The default algorithm - match-using-deltas - works for
2832
# multiple files and directories and is faster for small
2833
# amounts of history (200 revisions say). However, it's too
2834
# slow for logging a single file in a repository with deep
2835
# history, i.e. > 10K revisions. In the spirit of "do no
2836
# evil when adding features", we continue to use the
2837
# original algorithm - per-file-graph - for the "single
2838
# file that isn't a directory without showing a delta" case.
2839
partial_history = revision and b.repository._format.supports_chks
2840
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2841
or delta_type or partial_history)
2845
match_dict[''] = match
2847
match_dict['message'] = match_message
2849
match_dict['committer'] = match_committer
2851
match_dict['author'] = match_author
2853
match_dict['bugs'] = match_bugs
2855
# Build the LogRequest and execute it
2856
if len(file_ids) == 0:
2858
rqst = make_log_request_dict(
2859
direction=direction, specific_fileids=file_ids,
2860
start_revision=rev1, end_revision=rev2, limit=limit,
2861
message_search=message, delta_type=delta_type,
2862
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2863
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2864
signature=signatures, omit_merges=omit_merges,
2866
Logger(b, rqst).show(lf)
2869
def _get_revision_range(revisionspec_list, branch, command_name):
2870
"""Take the input of a revision option and turn it into a revision range.
2872
It returns RevisionInfo objects which can be used to obtain the rev_id's
2873
of the desired revisions. It does some user input validations.
2875
if revisionspec_list is None:
2878
elif len(revisionspec_list) == 1:
2879
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2880
elif len(revisionspec_list) == 2:
2881
start_spec = revisionspec_list[0]
2882
end_spec = revisionspec_list[1]
2883
if end_spec.get_branch() != start_spec.get_branch():
2884
# b is taken from revision[0].get_branch(), and
2885
# show_log will use its revision_history. Having
2886
# different branches will lead to weird behaviors.
2887
raise errors.BzrCommandError(gettext(
2888
"brz %s doesn't accept two revisions in different"
2889
" branches.") % command_name)
2890
if start_spec.spec is None:
2891
# Avoid loading all the history.
2892
rev1 = RevisionInfo(branch, None, None)
2894
rev1 = start_spec.in_history(branch)
2895
# Avoid loading all of history when we know a missing
2896
# end of range means the last revision ...
2897
if end_spec.spec is None:
2898
last_revno, last_revision_id = branch.last_revision_info()
2899
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2901
rev2 = end_spec.in_history(branch)
2903
raise errors.BzrCommandError(gettext(
2904
'brz %s --revision takes one or two values.') % command_name)
2908
def _revision_range_to_revid_range(revision_range):
2911
if revision_range[0] is not None:
2912
rev_id1 = revision_range[0].rev_id
2913
if revision_range[1] is not None:
2914
rev_id2 = revision_range[1].rev_id
2915
return rev_id1, rev_id2
2918
def get_log_format(long=False, short=False, line=False, default='long'):
2919
log_format = default
2923
log_format = 'short'
2929
class cmd_touching_revisions(Command):
2930
__doc__ = """Return revision-ids which affected a particular file.
2932
A more user-friendly interface is "brz log FILE".
2936
takes_args = ["filename"]
2939
def run(self, filename):
2940
tree, relpath = WorkingTree.open_containing(filename)
2941
with tree.lock_read():
2942
touching_revs = log.find_touching_revisions(
2943
tree.branch.repository, tree.branch.last_revision(), tree, relpath)
2944
for revno, revision_id, what in reversed(list(touching_revs)):
2945
self.outf.write("%6d %s\n" % (revno, what))
2948
class cmd_ls(Command):
2949
__doc__ = """List files in a tree.
2952
_see_also = ['status', 'cat']
2953
takes_args = ['path?']
2957
Option('recursive', short_name='R',
2958
help='Recurse into subdirectories.'),
2960
help='Print paths relative to the root of the branch.'),
2961
Option('unknown', short_name='u',
2962
help='Print unknown files.'),
2963
Option('versioned', help='Print versioned files.',
2965
Option('ignored', short_name='i',
2966
help='Print ignored files.'),
2967
Option('kind', short_name='k',
2968
help=('List entries of a particular kind: file, '
2969
'directory, symlink, tree-reference.'),
2977
def run(self, revision=None, verbose=False,
2978
recursive=False, from_root=False,
2979
unknown=False, versioned=False, ignored=False,
2980
null=False, kind=None, show_ids=False, path=None, directory=None):
2982
if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
2983
raise errors.BzrCommandError(gettext('invalid kind specified'))
2985
if verbose and null:
2986
raise errors.BzrCommandError(
2987
gettext('Cannot set both --verbose and --null'))
2988
all = not (unknown or versioned or ignored)
2990
selection = {'I': ignored, '?': unknown, 'V': versioned}
2996
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2999
tree, branch, relpath = \
3000
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3002
# Calculate the prefix to use
3006
prefix = relpath + '/'
3007
elif fs_path != '.' and not fs_path.endswith('/'):
3008
prefix = fs_path + '/'
3010
if revision is not None or tree is None:
3011
tree = _get_one_revision_tree('ls', revision, branch=branch)
3014
if isinstance(tree, WorkingTree) and tree.supports_views():
3015
view_files = tree.views.lookup_view()
3018
view_str = views.view_display_str(view_files)
3019
note(gettext("Ignoring files outside view. View is %s") % view_str)
3021
self.enter_context(tree.lock_read())
3022
for fp, fc, fkind, entry in tree.list_files(
3023
include_root=False, from_dir=relpath, recursive=recursive):
3024
# Apply additional masking
3025
if not all and not selection[fc]:
3027
if kind is not None and fkind != kind:
3032
fullpath = osutils.pathjoin(relpath, fp)
3035
views.check_path_in_view(tree, fullpath)
3036
except views.FileOutsideView:
3041
fp = osutils.pathjoin(prefix, fp)
3042
kindch = entry.kind_character()
3043
outstring = fp + kindch
3044
ui.ui_factory.clear_term()
3046
outstring = '%-8s %s' % (fc, outstring)
3047
if show_ids and getattr(entry, 'file_id', None) is not None:
3048
outstring = "%-50s %s" % (outstring, entry.file_id.decode('utf-8'))
3049
self.outf.write(outstring + '\n')
3051
self.outf.write(fp + '\0')
3053
if getattr(entry, 'file_id', None) is not None:
3054
self.outf.write(entry.file_id.decode('utf-8'))
3055
self.outf.write('\0')
3059
if getattr(entry, 'file_id', None) is not None:
3060
my_id = entry.file_id.decode('utf-8')
3063
self.outf.write('%-50s %s\n' % (outstring, my_id))
3065
self.outf.write(outstring + '\n')
3068
class cmd_unknowns(Command):
3069
__doc__ = """List unknown files.
3074
takes_options = ['directory']
3077
def run(self, directory=u'.'):
3078
for f in WorkingTree.open_containing(directory)[0].unknowns():
3079
self.outf.write(osutils.quotefn(f) + '\n')
3082
class cmd_ignore(Command):
3083
__doc__ = """Ignore specified files or patterns.
3085
See ``brz help patterns`` for details on the syntax of patterns.
3087
If a .bzrignore file does not exist, the ignore command
3088
will create one and add the specified files or patterns to the newly
3089
created file. The ignore command will also automatically add the
3090
.bzrignore file to be versioned. Creating a .bzrignore file without
3091
the use of the ignore command will require an explicit add command.
3093
To remove patterns from the ignore list, edit the .bzrignore file.
3094
After adding, editing or deleting that file either indirectly by
3095
using this command or directly by using an editor, be sure to commit
3098
Breezy also supports a global ignore file ~/.config/breezy/ignore. On
3099
Windows the global ignore file can be found in the application data
3101
C:\\Documents and Settings\\<user>\\Application Data\\Breezy\\3.0\\ignore.
3102
Global ignores are not touched by this command. The global ignore file
3103
can be edited directly using an editor.
3105
Patterns prefixed with '!' are exceptions to ignore patterns and take
3106
precedence over regular ignores. Such exceptions are used to specify
3107
files that should be versioned which would otherwise be ignored.
3109
Patterns prefixed with '!!' act as regular ignore patterns, but have
3110
precedence over the '!' exception patterns.
3114
* Ignore patterns containing shell wildcards must be quoted from
3117
* Ignore patterns starting with "#" act as comments in the ignore file.
3118
To ignore patterns that begin with that character, use the "RE:" prefix.
3121
Ignore the top level Makefile::
3123
brz ignore ./Makefile
3125
Ignore .class files in all directories...::
3127
brz ignore "*.class"
3129
...but do not ignore "special.class"::
3131
brz ignore "!special.class"
3133
Ignore files whose name begins with the "#" character::
3137
Ignore .o files under the lib directory::
3139
brz ignore "lib/**/*.o"
3141
Ignore .o files under the lib directory::
3143
brz ignore "RE:lib/.*\\.o"
3145
Ignore everything but the "debian" toplevel directory::
3147
brz ignore "RE:(?!debian/).*"
3149
Ignore everything except the "local" toplevel directory,
3150
but always ignore autosave files ending in ~, even under local/::
3153
brz ignore "!./local"
3157
_see_also = ['status', 'ignored', 'patterns']
3158
takes_args = ['name_pattern*']
3159
takes_options = ['directory',
3160
Option('default-rules',
3161
help='Display the default ignore rules that brz uses.')
3164
def run(self, name_pattern_list=None, default_rules=None,
3166
from breezy import ignores
3167
if default_rules is not None:
3168
# dump the default rules and exit
3169
for pattern in ignores.USER_DEFAULTS:
3170
self.outf.write("%s\n" % pattern)
3172
if not name_pattern_list:
3173
raise errors.BzrCommandError(gettext("ignore requires at least one "
3174
"NAME_PATTERN or --default-rules."))
3175
name_pattern_list = [globbing.normalize_pattern(p)
3176
for p in name_pattern_list]
3178
bad_patterns_count = 0
3179
for p in name_pattern_list:
3180
if not globbing.Globster.is_pattern_valid(p):
3181
bad_patterns_count += 1
3182
bad_patterns += ('\n %s' % p)
3184
msg = (ngettext('Invalid ignore pattern found. %s',
3185
'Invalid ignore patterns found. %s',
3186
bad_patterns_count) % bad_patterns)
3187
ui.ui_factory.show_error(msg)
3188
raise lazy_regex.InvalidPattern('')
3189
for name_pattern in name_pattern_list:
3190
if (name_pattern[0] == '/' or
3191
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3192
raise errors.BzrCommandError(gettext(
3193
"NAME_PATTERN should not be an absolute path"))
3194
tree, relpath = WorkingTree.open_containing(directory)
3195
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3196
ignored = globbing.Globster(name_pattern_list)
3198
self.enter_context(tree.lock_read())
3199
for filename, fc, fkind, entry in tree.list_files():
3200
id = getattr(entry, 'file_id', None)
3202
if ignored.match(filename):
3203
matches.append(filename)
3204
if len(matches) > 0:
3205
self.outf.write(gettext("Warning: the following files are version "
3206
"controlled and match your ignore pattern:\n%s"
3207
"\nThese files will continue to be version controlled"
3208
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3211
class cmd_ignored(Command):
3212
__doc__ = """List ignored files and the patterns that matched them.
3214
List all the ignored files and the ignore pattern that caused the file to
3217
Alternatively, to list just the files::
3222
encoding_type = 'replace'
3223
_see_also = ['ignore', 'ls']
3224
takes_options = ['directory']
3227
def run(self, directory=u'.'):
3228
tree = WorkingTree.open_containing(directory)[0]
3229
self.enter_context(tree.lock_read())
3230
for path, file_class, kind, entry in tree.list_files():
3231
if file_class != 'I':
3233
# XXX: Slightly inefficient since this was already calculated
3234
pat = tree.is_ignored(path)
3235
self.outf.write('%-50s %s\n' % (path, pat))
3238
class cmd_lookup_revision(Command):
3239
__doc__ = """Lookup the revision-id from a revision-number
3242
brz lookup-revision 33
3245
takes_args = ['revno']
3246
takes_options = ['directory']
3249
def run(self, revno, directory=u'.'):
3253
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3255
revid = WorkingTree.open_containing(
3256
directory)[0].branch.get_rev_id(revno)
3257
self.outf.write("%s\n" % revid.decode('utf-8'))
3260
class cmd_export(Command):
3261
__doc__ = """Export current or past revision to a destination directory or archive.
3263
If no revision is specified this exports the last committed revision.
3265
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3266
given, try to find the format with the extension. If no extension
3267
is found exports to a directory (equivalent to --format=dir).
3269
If root is supplied, it will be used as the root directory inside
3270
container formats (tar, zip, etc). If it is not supplied it will default
3271
to the exported filename. The root option has no effect for 'dir' format.
3273
If branch is omitted then the branch containing the current working
3274
directory will be used.
3276
Note: Export of tree with non-ASCII filenames to zip is not supported.
3278
================= =========================
3279
Supported formats Autodetected by extension
3280
================= =========================
3283
tbz2 .tar.bz2, .tbz2
3286
================= =========================
3289
encoding_type = 'exact'
3290
takes_args = ['dest', 'branch_or_subdir?']
3291
takes_options = ['directory',
3293
help="Type of file to export to.",
3296
Option('filters', help='Apply content filters to export the '
3297
'convenient form.'),
3300
help="Name of the root directory inside the exported file."),
3301
Option('per-file-timestamps',
3302
help='Set modification time of files to that of the last '
3303
'revision in which it was changed.'),
3304
Option('uncommitted',
3305
help='Export the working tree contents rather than that of the '
3309
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3310
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3312
from .export import export, guess_format, get_root_name
3314
if branch_or_subdir is None:
3315
branch_or_subdir = directory
3317
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3319
if tree is not None:
3320
self.enter_context(tree.lock_read())
3324
raise errors.BzrCommandError(
3325
gettext("--uncommitted requires a working tree"))
3328
export_tree = _get_one_revision_tree(
3329
'export', revision, branch=b,
3333
format = guess_format(dest)
3336
root = get_root_name(dest)
3338
if not per_file_timestamps:
3339
force_mtime = time.time()
3344
from breezy.filter_tree import ContentFilterTree
3345
export_tree = ContentFilterTree(
3346
export_tree, export_tree._content_filter_stack)
3349
export(export_tree, dest, format, root, subdir,
3350
per_file_timestamps=per_file_timestamps)
3351
except errors.NoSuchExportFormat as e:
3352
raise errors.BzrCommandError(
3353
gettext('Unsupported export format: %s') % e.format)
3356
class cmd_cat(Command):
3357
__doc__ = """Write the contents of a file as of a given revision to standard output.
3359
If no revision is nominated, the last revision is used.
3361
Note: Take care to redirect standard output when using this command on a
3366
takes_options = ['directory',
3367
Option('name-from-revision',
3368
help='The path name in the old tree.'),
3369
Option('filters', help='Apply content filters to display the '
3370
'convenience form.'),
3373
takes_args = ['filename']
3374
encoding_type = 'exact'
3377
def run(self, filename, revision=None, name_from_revision=False,
3378
filters=False, directory=None):
3379
if revision is not None and len(revision) != 1:
3380
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3381
" one revision specifier"))
3382
tree, branch, relpath = \
3383
_open_directory_or_containing_tree_or_branch(filename, directory)
3384
self.enter_context(branch.lock_read())
3385
return self._run(tree, branch, relpath, filename, revision,
3386
name_from_revision, filters)
3388
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3392
tree = b.basis_tree()
3393
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3394
self.enter_context(rev_tree.lock_read())
3396
if name_from_revision:
3397
# Try in revision if requested
3398
if not rev_tree.is_versioned(relpath):
3399
raise errors.BzrCommandError(gettext(
3400
"{0!r} is not present in revision {1}").format(
3401
filename, rev_tree.get_revision_id()))
3402
rev_tree_path = relpath
3405
rev_tree_path = _mod_tree.find_previous_path(
3406
tree, rev_tree, relpath)
3407
except errors.NoSuchFile:
3408
rev_tree_path = None
3410
if rev_tree_path is None:
3411
# Path didn't exist in working tree
3412
if not rev_tree.is_versioned(relpath):
3413
raise errors.BzrCommandError(gettext(
3414
"{0!r} is not present in revision {1}").format(
3415
filename, rev_tree.get_revision_id()))
3417
# Fall back to the same path in the basis tree, if present.
3418
rev_tree_path = relpath
3421
from .filter_tree import ContentFilterTree
3422
filter_tree = ContentFilterTree(
3423
rev_tree, rev_tree._content_filter_stack)
3424
fileobj = filter_tree.get_file(rev_tree_path)
3426
fileobj = rev_tree.get_file(rev_tree_path)
3427
shutil.copyfileobj(fileobj, self.outf)
3431
class cmd_local_time_offset(Command):
3432
__doc__ = """Show the offset in seconds from GMT to local time."""
3437
self.outf.write("%s\n" % osutils.local_time_offset())
3440
class cmd_commit(Command):
3441
__doc__ = """Commit changes into a new revision.
3443
An explanatory message needs to be given for each commit. This is
3444
often done by using the --message option (getting the message from the
3445
command line) or by using the --file option (getting the message from
3446
a file). If neither of these options is given, an editor is opened for
3447
the user to enter the message. To see the changed files in the
3448
boilerplate text loaded into the editor, use the --show-diff option.
3450
By default, the entire tree is committed and the person doing the
3451
commit is assumed to be the author. These defaults can be overridden
3456
If selected files are specified, only changes to those files are
3457
committed. If a directory is specified then the directory and
3458
everything within it is committed.
3460
When excludes are given, they take precedence over selected files.
3461
For example, to commit only changes within foo, but not changes
3464
brz commit foo -x foo/bar
3466
A selective commit after a merge is not yet supported.
3470
If the author of the change is not the same person as the committer,
3471
you can specify the author's name using the --author option. The
3472
name should be in the same format as a committer-id, e.g.
3473
"John Doe <jdoe@example.com>". If there is more than one author of
3474
the change you can specify the option multiple times, once for each
3479
A common mistake is to forget to add a new file or directory before
3480
running the commit command. The --strict option checks for unknown
3481
files and aborts the commit if any are found. More advanced pre-commit
3482
checks can be implemented by defining hooks. See ``brz help hooks``
3487
If you accidentally commit the wrong changes or make a spelling
3488
mistake in the commit message say, you can use the uncommit command
3489
to undo it. See ``brz help uncommit`` for details.
3491
Hooks can also be configured to run after a commit. This allows you
3492
to trigger updates to external systems like bug trackers. The --fixes
3493
option can be used to record the association between a revision and
3494
one or more bugs. See ``brz help bugs`` for details.
3497
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3498
takes_args = ['selected*']
3501
'exclude', type=text_type, short_name='x',
3502
help="Do not consider changes made to a given path."),
3503
Option('message', type=text_type,
3505
help="Description of the new revision."),
3508
help='Commit even if nothing has changed.'),
3509
Option('file', type=text_type,
3512
help='Take commit message from this file.'),
3514
help="Refuse to commit if there are unknown "
3515
"files in the working tree."),
3516
Option('commit-time', type=text_type,
3517
help="Manually set a commit time using commit date "
3518
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3520
'bugs', type=text_type,
3521
help="Link to a related bug. (see \"brz help bugs\")."),
3523
'fixes', type=text_type,
3524
help="Mark a bug as being fixed by this revision "
3525
"(see \"brz help bugs\")."),
3527
'author', type=text_type,
3528
help="Set the author's name, if it's different "
3529
"from the committer."),
3531
help="Perform a local commit in a bound "
3532
"branch. Local commits are not pushed to "
3533
"the master branch until a normal commit "
3536
Option('show-diff', short_name='p',
3537
help='When no message is supplied, show the diff along'
3538
' with the status summary in the message editor.'),
3540
help='When committing to a foreign version control '
3541
'system do not push data that can not be natively '
3543
aliases = ['ci', 'checkin']
3545
def _iter_bug_urls(self, bugs, branch, status):
3546
default_bugtracker = None
3547
# Configure the properties for bug fixing attributes.
3549
tokens = bug.split(':')
3550
if len(tokens) == 1:
3551
if default_bugtracker is None:
3552
branch_config = branch.get_config_stack()
3553
default_bugtracker = branch_config.get(
3555
if default_bugtracker is None:
3556
raise errors.BzrCommandError(gettext(
3557
"No tracker specified for bug %s. Use the form "
3558
"'tracker:id' or specify a default bug tracker "
3559
"using the `bugtracker` option.\nSee "
3560
"\"brz help bugs\" for more information on this "
3561
"feature. Commit refused.") % bug)
3562
tag = default_bugtracker
3564
elif len(tokens) != 2:
3565
raise errors.BzrCommandError(gettext(
3566
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3567
"See \"brz help bugs\" for more information on this "
3568
"feature.\nCommit refused.") % bug)
3570
tag, bug_id = tokens
3572
yield bugtracker.get_bug_url(tag, branch, bug_id), status
3573
except bugtracker.UnknownBugTrackerAbbreviation:
3574
raise errors.BzrCommandError(gettext(
3575
'Unrecognized bug %s. Commit refused.') % bug)
3576
except bugtracker.MalformedBugIdentifier as e:
3577
raise errors.BzrCommandError(gettext(
3578
u"%s\nCommit refused.") % (e,))
3580
def run(self, message=None, file=None, verbose=False, selected_list=None,
3581
unchanged=False, strict=False, local=False, fixes=None, bugs=None,
3582
author=None, show_diff=False, exclude=None, commit_time=None,
3585
from .commit import (
3588
from .errors import (
3592
from .msgeditor import (
3593
edit_commit_message_encoded,
3594
generate_commit_message_template,
3595
make_commit_message_template_encoded,
3599
commit_stamp = offset = None
3600
if commit_time is not None:
3602
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3603
except ValueError as e:
3604
raise errors.BzrCommandError(gettext(
3605
"Could not parse --commit-time: " + str(e)))
3609
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3610
if selected_list == ['']:
3611
# workaround - commit of root of tree should be exactly the same
3612
# as just default commit in that tree, and succeed even though
3613
# selected-file merge commit is not done yet
3620
bug_property = bugtracker.encode_fixes_bug_urls(
3622
self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
3623
self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
3625
properties[u'bugs'] = bug_property
3627
if local and not tree.branch.get_bound_location():
3628
raise errors.LocalRequiresBoundBranch()
3630
if message is not None:
3632
file_exists = osutils.lexists(message)
3633
except UnicodeError:
3634
# The commit message contains unicode characters that can't be
3635
# represented in the filesystem encoding, so that can't be a
3640
'The commit message is a file name: "%(f)s".\n'
3641
'(use --file "%(f)s" to take commit message from that file)'
3643
ui.ui_factory.show_warning(warning_msg)
3645
message = message.replace('\r\n', '\n')
3646
message = message.replace('\r', '\n')
3648
raise errors.BzrCommandError(gettext(
3649
"please specify either --message or --file"))
3651
def get_message(commit_obj):
3652
"""Callback to get commit message"""
3654
with open(file, 'rb') as f:
3655
my_message = f.read().decode(osutils.get_user_encoding())
3656
elif message is not None:
3657
my_message = message
3659
# No message supplied: make one up.
3660
# text is the status of the tree
3661
text = make_commit_message_template_encoded(tree,
3662
selected_list, diff=show_diff,
3663
output_encoding=osutils.get_user_encoding())
3664
# start_message is the template generated from hooks
3665
# XXX: Warning - looks like hooks return unicode,
3666
# make_commit_message_template_encoded returns user encoding.
3667
# We probably want to be using edit_commit_message instead to
3669
my_message = set_commit_message(commit_obj)
3670
if my_message is None:
3671
start_message = generate_commit_message_template(
3673
if start_message is not None:
3674
start_message = start_message.encode(
3675
osutils.get_user_encoding())
3676
my_message = edit_commit_message_encoded(text,
3677
start_message=start_message)
3678
if my_message is None:
3679
raise errors.BzrCommandError(gettext("please specify a commit"
3680
" message with either --message or --file"))
3681
if my_message == "":
3682
raise errors.BzrCommandError(gettext("Empty commit message specified."
3683
" Please specify a commit message with either"
3684
" --message or --file or leave a blank message"
3685
" with --message \"\"."))
3688
# The API permits a commit with a filter of [] to mean 'select nothing'
3689
# but the command line should not do that.
3690
if not selected_list:
3691
selected_list = None
3693
tree.commit(message_callback=get_message,
3694
specific_files=selected_list,
3695
allow_pointless=unchanged, strict=strict, local=local,
3696
reporter=None, verbose=verbose, revprops=properties,
3697
authors=author, timestamp=commit_stamp,
3699
exclude=tree.safe_relpath_files(exclude),
3701
except PointlessCommit:
3702
raise errors.BzrCommandError(gettext("No changes to commit."
3703
" Please 'brz add' the files you want to commit, or use"
3704
" --unchanged to force an empty commit."))
3705
except ConflictsInTree:
3706
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3707
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3709
except StrictCommitFailed:
3710
raise errors.BzrCommandError(gettext("Commit refused because there are"
3711
" unknown files in the working tree."))
3712
except errors.BoundBranchOutOfDate as e:
3713
e.extra_help = (gettext("\n"
3714
'To commit to master branch, run update and then commit.\n'
3715
'You can also pass --local to commit to continue working '
3720
class cmd_check(Command):
3721
__doc__ = """Validate working tree structure, branch consistency and repository history.
3723
This command checks various invariants about branch and repository storage
3724
to detect data corruption or brz bugs.
3726
The working tree and branch checks will only give output if a problem is
3727
detected. The output fields of the repository check are:
3730
This is just the number of revisions checked. It doesn't
3734
This is just the number of versionedfiles checked. It
3735
doesn't indicate a problem.
3737
unreferenced ancestors
3738
Texts that are ancestors of other texts, but
3739
are not properly referenced by the revision ancestry. This is a
3740
subtle problem that Breezy can work around.
3743
This is the total number of unique file contents
3744
seen in the checked revisions. It does not indicate a problem.
3747
This is the total number of repeated texts seen
3748
in the checked revisions. Texts can be repeated when their file
3749
entries are modified, but the file contents are not. It does not
3752
If no restrictions are specified, all data that is found at the given
3753
location will be checked.
3757
Check the tree and branch at 'foo'::
3759
brz check --tree --branch foo
3761
Check only the repository at 'bar'::
3763
brz check --repo bar
3765
Check everything at 'baz'::
3770
_see_also = ['reconcile']
3771
takes_args = ['path?']
3772
takes_options = ['verbose',
3773
Option('branch', help="Check the branch related to the"
3774
" current directory."),
3775
Option('repo', help="Check the repository related to the"
3776
" current directory."),
3777
Option('tree', help="Check the working tree related to"
3778
" the current directory.")]
3780
def run(self, path=None, verbose=False, branch=False, repo=False,
3782
from .check import check_dwim
3785
if not branch and not repo and not tree:
3786
branch = repo = tree = True
3787
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3790
class cmd_upgrade(Command):
3791
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3793
When the default format has changed after a major new release of
3794
Bazaar/Breezy, you may be informed during certain operations that you
3795
should upgrade. Upgrading to a newer format may improve performance
3796
or make new features available. It may however limit interoperability
3797
with older repositories or with older versions of Bazaar or Breezy.
3799
If you wish to upgrade to a particular format rather than the
3800
current default, that can be specified using the --format option.
3801
As a consequence, you can use the upgrade command this way to
3802
"downgrade" to an earlier format, though some conversions are
3803
a one way process (e.g. changing from the 1.x default to the
3804
2.x default) so downgrading is not always possible.
3806
A backup.bzr.~#~ directory is created at the start of the conversion
3807
process (where # is a number). By default, this is left there on
3808
completion. If the conversion fails, delete the new .bzr directory
3809
and rename this one back in its place. Use the --clean option to ask
3810
for the backup.bzr directory to be removed on successful conversion.
3811
Alternatively, you can delete it by hand if everything looks good
3814
If the location given is a shared repository, dependent branches
3815
are also converted provided the repository converts successfully.
3816
If the conversion of a branch fails, remaining branches are still
3819
For more information on upgrades, see the Breezy Upgrade Guide,
3820
https://www.breezy-vcs.org/doc/en/upgrade-guide/.
3823
_see_also = ['check', 'reconcile', 'formats']
3824
takes_args = ['url?']
3826
RegistryOption('format',
3827
help='Upgrade to a specific format. See "brz help'
3828
' formats" for details.',
3829
lazy_registry=('breezy.controldir', 'format_registry'),
3830
converter=lambda name: controldir.format_registry.make_controldir(
3832
value_switches=True, title='Branch format'),
3834
help='Remove the backup.bzr directory if successful.'),
3836
help="Show what would be done, but don't actually do anything."),
3839
def run(self, url='.', format=None, clean=False, dry_run=False):
3840
from .upgrade import upgrade
3841
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3843
if len(exceptions) == 1:
3844
# Compatibility with historical behavior
3850
class cmd_whoami(Command):
3851
__doc__ = """Show or set brz user id.
3854
Show the email of the current user::
3858
Set the current user::
3860
brz whoami "Frank Chu <fchu@example.com>"
3862
takes_options = ['directory',
3864
help='Display email address only.'),
3866
help='Set identity for the current branch instead of '
3869
takes_args = ['name?']
3870
encoding_type = 'replace'
3873
def run(self, email=False, branch=False, name=None, directory=None):
3875
if directory is None:
3876
# use branch if we're inside one; otherwise global config
3878
c = Branch.open_containing(u'.')[0].get_config_stack()
3879
except errors.NotBranchError:
3880
c = _mod_config.GlobalStack()
3882
c = Branch.open(directory).get_config_stack()
3883
identity = c.get('email')
3885
self.outf.write(_mod_config.extract_email_address(identity)
3888
self.outf.write(identity + '\n')
3892
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3895
# display a warning if an email address isn't included in the given name.
3897
_mod_config.extract_email_address(name)
3898
except _mod_config.NoEmailInUsername:
3899
warning('"%s" does not seem to contain an email address. '
3900
'This is allowed, but not recommended.', name)
3902
# use global config unless --branch given
3904
if directory is None:
3905
c = Branch.open_containing(u'.')[0].get_config_stack()
3907
b = Branch.open(directory)
3908
self.enter_context(b.lock_write())
3909
c = b.get_config_stack()
3911
c = _mod_config.GlobalStack()
3912
c.set('email', name)
3915
class cmd_nick(Command):
3916
__doc__ = """Print or set the branch nickname.
3918
If unset, the colocated branch name is used for colocated branches, and
3919
the branch directory name is used for other branches. To print the
3920
current nickname, execute with no argument.
3922
Bound branches use the nickname of its master branch unless it is set
3926
_see_also = ['info']
3927
takes_args = ['nickname?']
3928
takes_options = ['directory']
3930
def run(self, nickname=None, directory=u'.'):
3931
branch = Branch.open_containing(directory)[0]
3932
if nickname is None:
3933
self.printme(branch)
3935
branch.nick = nickname
3938
def printme(self, branch):
3939
self.outf.write('%s\n' % branch.nick)
3942
class cmd_alias(Command):
3943
__doc__ = """Set/unset and display aliases.
3946
Show the current aliases::
3950
Show the alias specified for 'll'::
3954
Set an alias for 'll'::
3956
brz alias ll="log --line -r-10..-1"
3958
To remove an alias for 'll'::
3960
brz alias --remove ll
3963
takes_args = ['name?']
3965
Option('remove', help='Remove the alias.'),
3968
def run(self, name=None, remove=False):
3970
self.remove_alias(name)
3972
self.print_aliases()
3974
equal_pos = name.find('=')
3976
self.print_alias(name)
3978
self.set_alias(name[:equal_pos], name[equal_pos + 1:])
3980
def remove_alias(self, alias_name):
3981
if alias_name is None:
3982
raise errors.BzrCommandError(gettext(
3983
'brz alias --remove expects an alias to remove.'))
3984
# If alias is not found, print something like:
3985
# unalias: foo: not found
3986
c = _mod_config.GlobalConfig()
3987
c.unset_alias(alias_name)
3990
def print_aliases(self):
3991
"""Print out the defined aliases in a similar format to bash."""
3992
aliases = _mod_config.GlobalConfig().get_aliases()
3993
for key, value in sorted(viewitems(aliases)):
3994
self.outf.write('brz alias %s="%s"\n' % (key, value))
3997
def print_alias(self, alias_name):
3998
from .commands import get_alias
3999
alias = get_alias(alias_name)
4001
self.outf.write("brz alias: %s: not found\n" % alias_name)
4004
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
4006
def set_alias(self, alias_name, alias_command):
4007
"""Save the alias in the global config."""
4008
c = _mod_config.GlobalConfig()
4009
c.set_alias(alias_name, alias_command)
4012
class cmd_selftest(Command):
4013
__doc__ = """Run internal test suite.
4015
If arguments are given, they are regular expressions that say which tests
4016
should run. Tests matching any expression are run, and other tests are
4019
Alternatively if --first is given, matching tests are run first and then
4020
all other tests are run. This is useful if you have been working in a
4021
particular area, but want to make sure nothing else was broken.
4023
If --exclude is given, tests that match that regular expression are
4024
excluded, regardless of whether they match --first or not.
4026
To help catch accidential dependencies between tests, the --randomize
4027
option is useful. In most cases, the argument used is the word 'now'.
4028
Note that the seed used for the random number generator is displayed
4029
when this option is used. The seed can be explicitly passed as the
4030
argument to this option if required. This enables reproduction of the
4031
actual ordering used if and when an order sensitive problem is encountered.
4033
If --list-only is given, the tests that would be run are listed. This is
4034
useful when combined with --first, --exclude and/or --randomize to
4035
understand their impact. The test harness reports "Listed nn tests in ..."
4036
instead of "Ran nn tests in ..." when list mode is enabled.
4038
If the global option '--no-plugins' is given, plugins are not loaded
4039
before running the selftests. This has two effects: features provided or
4040
modified by plugins will not be tested, and tests provided by plugins will
4043
Tests that need working space on disk use a common temporary directory,
4044
typically inside $TMPDIR or /tmp.
4046
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4047
into a pdb postmortem session.
4049
The --coverage=DIRNAME global option produces a report with covered code
4053
Run only tests relating to 'ignore'::
4057
Disable plugins and list tests as they're run::
4059
brz --no-plugins selftest -v
4061
# NB: this is used from the class without creating an instance, which is
4062
# why it does not have a self parameter.
4064
def get_transport_type(typestring):
4065
"""Parse and return a transport specifier."""
4066
if typestring == "sftp":
4067
from .tests import stub_sftp
4068
return stub_sftp.SFTPAbsoluteServer
4069
elif typestring == "memory":
4070
from .tests import test_server
4071
return memory.MemoryServer
4072
elif typestring == "fakenfs":
4073
from .tests import test_server
4074
return test_server.FakeNFSServer
4075
msg = "No known transport type %s. Supported types are: sftp\n" %\
4077
raise errors.BzrCommandError(msg)
4080
takes_args = ['testspecs*']
4081
takes_options = ['verbose',
4083
help='Stop when one test fails.',
4087
help='Use a different transport by default '
4088
'throughout the test suite.',
4089
type=get_transport_type),
4091
help='Run the benchmarks rather than selftests.',
4093
Option('lsprof-timed',
4094
help='Generate lsprof output for benchmarked'
4095
' sections of code.'),
4096
Option('lsprof-tests',
4097
help='Generate lsprof output for each test.'),
4099
help='Run all tests, but run specified tests first.',
4103
help='List the tests instead of running them.'),
4104
RegistryOption('parallel',
4105
help="Run the test suite in parallel.",
4107
'breezy.tests', 'parallel_registry'),
4108
value_switches=False,
4110
Option('randomize', type=text_type, argname="SEED",
4111
help='Randomize the order of tests using the given'
4112
' seed or "now" for the current time.'),
4113
ListOption('exclude', type=text_type, argname="PATTERN",
4115
help='Exclude tests that match this regular'
4118
help='Output test progress via subunit v1.'),
4120
help='Output test progress via subunit v2.'),
4121
Option('strict', help='Fail on missing dependencies or '
4123
Option('load-list', type=text_type, argname='TESTLISTFILE',
4124
help='Load a test id list from a text file.'),
4125
ListOption('debugflag', type=text_type, short_name='E',
4126
help='Turn on a selftest debug flag.'),
4127
ListOption('starting-with', type=text_type, argname='TESTID',
4128
param_name='starting_with', short_name='s',
4129
help='Load only the tests starting with TESTID.'),
4131
help="By default we disable fsync and fdatasync"
4132
" while running the test suite.")
4134
encoding_type = 'replace'
4137
Command.__init__(self)
4138
self.additional_selftest_args = {}
4140
def run(self, testspecs_list=None, verbose=False, one=False,
4141
transport=None, benchmark=None,
4143
first=False, list_only=False,
4144
randomize=None, exclude=None, strict=False,
4145
load_list=None, debugflag=None, starting_with=None, subunit1=False,
4146
subunit2=False, parallel=None, lsprof_tests=False, sync=False):
4148
# During selftest, disallow proxying, as it can cause severe
4149
# performance penalties and is only needed for thread
4150
# safety. The selftest command is assumed to not use threads
4151
# too heavily. The call should be as early as possible, as
4152
# error reporting for past duplicate imports won't have useful
4154
if sys.version_info[0] < 3:
4155
# TODO(pad.lv/1696545): Allow proxying on Python 3, since
4156
# disallowing it currently leads to failures in many places.
4157
lazy_import.disallow_proxying()
4162
raise errors.BzrCommandError("tests not available. Install the "
4163
"breezy tests to run the breezy testsuite.")
4165
if testspecs_list is not None:
4166
pattern = '|'.join(testspecs_list)
4171
from .tests import SubUnitBzrRunnerv1
4173
raise errors.BzrCommandError(gettext(
4174
"subunit not available. subunit needs to be installed "
4175
"to use --subunit."))
4176
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
4177
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4178
# stdout, which would corrupt the subunit stream.
4179
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4180
# following code can be deleted when it's sufficiently deployed
4181
# -- vila/mgz 20100514
4182
if (sys.platform == "win32"
4183
and getattr(sys.stdout, 'fileno', None) is not None):
4185
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4188
from .tests import SubUnitBzrRunnerv2
4190
raise errors.BzrCommandError(gettext(
4191
"subunit not available. subunit "
4192
"needs to be installed to use --subunit2."))
4193
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
4196
self.additional_selftest_args.setdefault(
4197
'suite_decorators', []).append(parallel)
4199
raise errors.BzrCommandError(gettext(
4200
"--benchmark is no longer supported from brz 2.2; "
4201
"use bzr-usertest instead"))
4202
test_suite_factory = None
4204
exclude_pattern = None
4206
exclude_pattern = '(' + '|'.join(exclude) + ')'
4208
self._disable_fsync()
4209
selftest_kwargs = {"verbose": verbose,
4211
"stop_on_failure": one,
4212
"transport": transport,
4213
"test_suite_factory": test_suite_factory,
4214
"lsprof_timed": lsprof_timed,
4215
"lsprof_tests": lsprof_tests,
4216
"matching_tests_first": first,
4217
"list_only": list_only,
4218
"random_seed": randomize,
4219
"exclude_pattern": exclude_pattern,
4221
"load_list": load_list,
4222
"debug_flags": debugflag,
4223
"starting_with": starting_with
4225
selftest_kwargs.update(self.additional_selftest_args)
4227
# Make deprecation warnings visible, unless -Werror is set
4228
cleanup = symbol_versioning.activate_deprecation_warnings(
4231
result = tests.selftest(**selftest_kwargs)
4234
return int(not result)
4236
def _disable_fsync(self):
4237
"""Change the 'os' functionality to not synchronize."""
4238
self._orig_fsync = getattr(os, 'fsync', None)
4239
if self._orig_fsync is not None:
4240
os.fsync = lambda filedes: None
4241
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4242
if self._orig_fdatasync is not None:
4243
os.fdatasync = lambda filedes: None
4246
class cmd_version(Command):
4247
__doc__ = """Show version of brz."""
4249
encoding_type = 'replace'
4251
Option("short", help="Print just the version number."),
4255
def run(self, short=False):
4256
from .version import show_version
4258
self.outf.write(breezy.version_string + '\n')
4260
show_version(to_file=self.outf)
4263
class cmd_rocks(Command):
4264
__doc__ = """Statement of optimism."""
4270
self.outf.write(gettext("It sure does!\n"))
4273
class cmd_find_merge_base(Command):
4274
__doc__ = """Find and print a base revision for merging two branches."""
4275
# TODO: Options to specify revisions on either side, as if
4276
# merging only part of the history.
4277
takes_args = ['branch', 'other']
4281
def run(self, branch, other):
4282
from .revision import ensure_null
4284
branch1 = Branch.open_containing(branch)[0]
4285
branch2 = Branch.open_containing(other)[0]
4286
self.enter_context(branch1.lock_read())
4287
self.enter_context(branch2.lock_read())
4288
last1 = ensure_null(branch1.last_revision())
4289
last2 = ensure_null(branch2.last_revision())
4291
graph = branch1.repository.get_graph(branch2.repository)
4292
base_rev_id = graph.find_unique_lca(last1, last2)
4294
self.outf.write(gettext('merge base is revision %s\n') %
4295
base_rev_id.decode('utf-8'))
4298
class cmd_merge(Command):
4299
__doc__ = """Perform a three-way merge.
4301
The source of the merge can be specified either in the form of a branch,
4302
or in the form of a path to a file containing a merge directive generated
4303
with brz send. If neither is specified, the default is the upstream branch
4304
or the branch most recently merged using --remember. The source of the
4305
merge may also be specified in the form of a path to a file in another
4306
branch: in this case, only the modifications to that file are merged into
4307
the current working tree.
4309
When merging from a branch, by default brz will try to merge in all new
4310
work from the other branch, automatically determining an appropriate base
4311
revision. If this fails, you may need to give an explicit base.
4313
To pick a different ending revision, pass "--revision OTHER". brz will
4314
try to merge in all new work up to and including revision OTHER.
4316
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4317
through OTHER, excluding BASE but including OTHER, will be merged. If this
4318
causes some revisions to be skipped, i.e. if the destination branch does
4319
not already contain revision BASE, such a merge is commonly referred to as
4320
a "cherrypick". Unlike a normal merge, Breezy does not currently track
4321
cherrypicks. The changes look like a normal commit, and the history of the
4322
changes from the other branch is not stored in the commit.
4324
Revision numbers are always relative to the source branch.
4326
Merge will do its best to combine the changes in two branches, but there
4327
are some kinds of problems only a human can fix. When it encounters those,
4328
it will mark a conflict. A conflict means that you need to fix something,
4329
before you can commit.
4331
Use brz resolve when you have fixed a problem. See also brz conflicts.
4333
If there is no default branch set, the first merge will set it (use
4334
--no-remember to avoid setting it). After that, you can omit the branch
4335
to use the default. To change the default, use --remember. The value will
4336
only be saved if the remote location can be accessed.
4338
The results of the merge are placed into the destination working
4339
directory, where they can be reviewed (with brz diff), tested, and then
4340
committed to record the result of the merge.
4342
merge refuses to run if there are any uncommitted changes, unless
4343
--force is given. If --force is given, then the changes from the source
4344
will be merged with the current working tree, including any uncommitted
4345
changes in the tree. The --force option can also be used to create a
4346
merge revision which has more than two parents.
4348
If one would like to merge changes from the working tree of the other
4349
branch without merging any committed revisions, the --uncommitted option
4352
To select only some changes to merge, use "merge -i", which will prompt
4353
you to apply each diff hunk and file change, similar to "shelve".
4356
To merge all new revisions from brz.dev::
4358
brz merge ../brz.dev
4360
To merge changes up to and including revision 82 from brz.dev::
4362
brz merge -r 82 ../brz.dev
4364
To merge the changes introduced by 82, without previous changes::
4366
brz merge -r 81..82 ../brz.dev
4368
To apply a merge directive contained in /tmp/merge::
4370
brz merge /tmp/merge
4372
To create a merge revision with three parents from two branches
4373
feature1a and feature1b:
4375
brz merge ../feature1a
4376
brz merge ../feature1b --force
4377
brz commit -m 'revision with three parents'
4380
encoding_type = 'exact'
4381
_see_also = ['update', 'remerge', 'status-flags', 'send']
4382
takes_args = ['location?']
4387
help='Merge even if the destination tree has uncommitted changes.'),
4391
Option('show-base', help="Show base revision text in "
4393
Option('uncommitted', help='Apply uncommitted changes'
4394
' from a working copy, instead of branch changes.'),
4395
Option('pull', help='If the destination is already'
4396
' completely merged into the source, pull from the'
4397
' source rather than merging. When this happens,'
4398
' you do not need to commit the result.'),
4399
custom_help('directory',
4400
help='Branch to merge into, '
4401
'rather than the one containing the working directory.'),
4402
Option('preview', help='Instead of merging, show a diff of the'
4404
Option('interactive', help='Select changes interactively.',
4408
def run(self, location=None, revision=None, force=False,
4409
merge_type=None, show_base=False, reprocess=None, remember=None,
4410
uncommitted=False, pull=False,
4415
if merge_type is None:
4416
merge_type = _mod_merge.Merge3Merger
4418
if directory is None:
4420
possible_transports = []
4422
allow_pending = True
4423
verified = 'inapplicable'
4425
tree = WorkingTree.open_containing(directory)[0]
4426
if tree.branch.last_revision() == _mod_revision.NULL_REVISION:
4427
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4428
'https://bugs.launchpad.net/bzr/+bug/308562'))
4430
# die as quickly as possible if there are uncommitted changes
4432
if tree.has_changes():
4433
raise errors.UncommittedChanges(tree)
4435
view_info = _get_view_info_for_change_reporter(tree)
4436
change_reporter = delta._ChangeReporter(
4437
unversioned_filter=tree.is_ignored, view_info=view_info)
4438
pb = ui.ui_factory.nested_progress_bar()
4439
self.enter_context(pb)
4440
self.enter_context(tree.lock_write())
4441
if location is not None:
4443
mergeable = _mod_mergeable.read_mergeable_from_url(
4444
location, possible_transports=possible_transports)
4445
except errors.NotABundle:
4449
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4450
' with bundles or merge directives.'))
4452
if revision is not None:
4453
raise errors.BzrCommandError(gettext(
4454
'Cannot use -r with merge directives or bundles'))
4455
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4458
if merger is None and uncommitted:
4459
if revision is not None and len(revision) > 0:
4460
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4461
' --revision at the same time.'))
4462
merger = self.get_merger_from_uncommitted(tree, location, None)
4463
allow_pending = False
4466
merger, allow_pending = self._get_merger_from_branch(tree,
4467
location, revision, remember, possible_transports, None)
4469
merger.merge_type = merge_type
4470
merger.reprocess = reprocess
4471
merger.show_base = show_base
4472
self.sanity_check_merger(merger)
4473
if (merger.base_rev_id == merger.other_rev_id and
4474
merger.other_rev_id is not None):
4475
# check if location is a nonexistent file (and not a branch) to
4476
# disambiguate the 'Nothing to do'
4477
if merger.interesting_files:
4478
if not merger.other_tree.has_filename(
4479
merger.interesting_files[0]):
4480
note(gettext("merger: ") + str(merger))
4481
raise errors.PathsDoNotExist([location])
4482
note(gettext('Nothing to do.'))
4484
if pull and not preview:
4485
if merger.interesting_files is not None:
4486
raise errors.BzrCommandError(
4487
gettext('Cannot pull individual files'))
4488
if (merger.base_rev_id == tree.last_revision()):
4489
result = tree.pull(merger.other_branch, False,
4490
merger.other_rev_id)
4491
result.report(self.outf)
4493
if merger.this_basis is None:
4494
raise errors.BzrCommandError(gettext(
4495
"This branch has no commits."
4496
" (perhaps you would prefer 'brz pull')"))
4498
return self._do_preview(merger)
4500
return self._do_interactive(merger)
4502
return self._do_merge(merger, change_reporter, allow_pending,
4505
def _get_preview(self, merger):
4506
tree_merger = merger.make_merger()
4507
tt = tree_merger.make_preview_transform()
4508
self.enter_context(tt)
4509
result_tree = tt.get_preview_tree()
4512
def _do_preview(self, merger):
4513
from .diff import show_diff_trees
4514
result_tree = self._get_preview(merger)
4515
path_encoding = osutils.get_diff_header_encoding()
4516
show_diff_trees(merger.this_tree, result_tree, self.outf,
4517
old_label='', new_label='',
4518
path_encoding=path_encoding)
4520
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4521
merger.change_reporter = change_reporter
4522
conflict_count = merger.do_merge()
4524
merger.set_pending()
4525
if verified == 'failed':
4526
warning('Preview patch does not match changes')
4527
if conflict_count != 0:
4532
def _do_interactive(self, merger):
4533
"""Perform an interactive merge.
4535
This works by generating a preview tree of the merge, then using
4536
Shelver to selectively remove the differences between the working tree
4537
and the preview tree.
4539
from . import shelf_ui
4540
result_tree = self._get_preview(merger)
4541
writer = breezy.option.diff_writer_registry.get()
4542
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4543
reporter=shelf_ui.ApplyReporter(),
4544
diff_writer=writer(self.outf))
4550
def sanity_check_merger(self, merger):
4551
if (merger.show_base and
4552
merger.merge_type is not _mod_merge.Merge3Merger):
4553
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4554
" merge type. %s") % merger.merge_type)
4555
if merger.reprocess is None:
4556
if merger.show_base:
4557
merger.reprocess = False
4559
# Use reprocess if the merger supports it
4560
merger.reprocess = merger.merge_type.supports_reprocess
4561
if merger.reprocess and not merger.merge_type.supports_reprocess:
4562
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4563
" for merge type %s.") %
4565
if merger.reprocess and merger.show_base:
4566
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4569
if (merger.merge_type.requires_file_merge_plan and
4570
(not getattr(merger.this_tree, 'plan_file_merge', None) or
4571
not getattr(merger.other_tree, 'plan_file_merge', None) or
4572
(merger.base_tree is not None and
4573
not getattr(merger.base_tree, 'plan_file_merge', None)))):
4574
raise errors.BzrCommandError(
4575
gettext('Plan file merge unsupported: '
4576
'Merge type incompatible with tree formats.'))
4578
def _get_merger_from_branch(self, tree, location, revision, remember,
4579
possible_transports, pb):
4580
"""Produce a merger from a location, assuming it refers to a branch."""
4581
# find the branch locations
4582
other_loc, user_location = self._select_branch_location(tree, location,
4584
if revision is not None and len(revision) == 2:
4585
base_loc, _unused = self._select_branch_location(tree,
4586
location, revision, 0)
4588
base_loc = other_loc
4590
other_branch, other_path = Branch.open_containing(other_loc,
4591
possible_transports)
4592
if base_loc == other_loc:
4593
base_branch = other_branch
4595
base_branch, base_path = Branch.open_containing(base_loc,
4596
possible_transports)
4597
# Find the revision ids
4598
other_revision_id = None
4599
base_revision_id = None
4600
if revision is not None:
4601
if len(revision) >= 1:
4602
other_revision_id = revision[-1].as_revision_id(other_branch)
4603
if len(revision) == 2:
4604
base_revision_id = revision[0].as_revision_id(base_branch)
4605
if other_revision_id is None:
4606
other_revision_id = _mod_revision.ensure_null(
4607
other_branch.last_revision())
4608
# Remember where we merge from. We need to remember if:
4609
# - user specify a location (and we don't merge from the parent
4611
# - user ask to remember or there is no previous location set to merge
4612
# from and user didn't ask to *not* remember
4613
if (user_location is not None
4615
(remember is None and
4616
tree.branch.get_submit_branch() is None)))):
4617
tree.branch.set_submit_branch(other_branch.base)
4618
# Merge tags (but don't set them in the master branch yet, the user
4619
# might revert this merge). Commit will propagate them.
4620
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4621
merger = _mod_merge.Merger.from_revision_ids(tree,
4622
other_revision_id, base_revision_id, other_branch, base_branch)
4623
if other_path != '':
4624
allow_pending = False
4625
merger.interesting_files = [other_path]
4627
allow_pending = True
4628
return merger, allow_pending
4630
def get_merger_from_uncommitted(self, tree, location, pb):
4631
"""Get a merger for uncommitted changes.
4633
:param tree: The tree the merger should apply to.
4634
:param location: The location containing uncommitted changes.
4635
:param pb: The progress bar to use for showing progress.
4637
location = self._select_branch_location(tree, location)[0]
4638
other_tree, other_path = WorkingTree.open_containing(location)
4639
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4640
if other_path != '':
4641
merger.interesting_files = [other_path]
4644
def _select_branch_location(self, tree, user_location, revision=None,
4646
"""Select a branch location, according to possible inputs.
4648
If provided, branches from ``revision`` are preferred. (Both
4649
``revision`` and ``index`` must be supplied.)
4651
Otherwise, the ``location`` parameter is used. If it is None, then the
4652
``submit`` or ``parent`` location is used, and a note is printed.
4654
:param tree: The working tree to select a branch for merging into
4655
:param location: The location entered by the user
4656
:param revision: The revision parameter to the command
4657
:param index: The index to use for the revision parameter. Negative
4658
indices are permitted.
4659
:return: (selected_location, user_location). The default location
4660
will be the user-entered location.
4662
if (revision is not None and index is not None
4663
and revision[index] is not None):
4664
branch = revision[index].get_branch()
4665
if branch is not None:
4666
return branch, branch
4667
if user_location is None:
4668
location = self._get_remembered(tree, 'Merging from')
4670
location = user_location
4671
return location, user_location
4673
def _get_remembered(self, tree, verb_string):
4674
"""Use tree.branch's parent if none was supplied.
4676
Report if the remembered location was used.
4678
stored_location = tree.branch.get_submit_branch()
4679
stored_location_type = "submit"
4680
if stored_location is None:
4681
stored_location = tree.branch.get_parent()
4682
stored_location_type = "parent"
4683
mutter("%s", stored_location)
4684
if stored_location is None:
4685
raise errors.BzrCommandError(
4686
gettext("No location specified or remembered"))
4687
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4688
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4689
stored_location_type, display_url))
4690
return stored_location
4693
class cmd_remerge(Command):
4694
__doc__ = """Redo a merge.
4696
Use this if you want to try a different merge technique while resolving
4697
conflicts. Some merge techniques are better than others, and remerge
4698
lets you try different ones on different files.
4700
The options for remerge have the same meaning and defaults as the ones for
4701
merge. The difference is that remerge can (only) be run when there is a
4702
pending merge, and it lets you specify particular files.
4705
Re-do the merge of all conflicted files, and show the base text in
4706
conflict regions, in addition to the usual THIS and OTHER texts::
4708
brz remerge --show-base
4710
Re-do the merge of "foobar", using the weave merge algorithm, with
4711
additional processing to reduce the size of conflict regions::
4713
brz remerge --merge-type weave --reprocess foobar
4715
takes_args = ['file*']
4720
help="Show base revision text in conflicts."),
4723
def run(self, file_list=None, merge_type=None, show_base=False,
4725
from .conflicts import restore
4726
if merge_type is None:
4727
merge_type = _mod_merge.Merge3Merger
4728
tree, file_list = WorkingTree.open_containing_paths(file_list)
4729
self.enter_context(tree.lock_write())
4730
parents = tree.get_parent_ids()
4731
if len(parents) != 2:
4732
raise errors.BzrCommandError(
4733
gettext("Sorry, remerge only works after normal"
4734
" merges. Not cherrypicking or multi-merges."))
4735
interesting_files = None
4737
conflicts = tree.conflicts()
4738
if file_list is not None:
4739
interesting_files = set()
4740
for filename in file_list:
4741
if not tree.is_versioned(filename):
4742
raise errors.NotVersionedError(filename)
4743
interesting_files.add(filename)
4744
if tree.kind(filename) != "directory":
4747
for path, ie in tree.iter_entries_by_dir(
4748
specific_files=[filename]):
4749
interesting_files.add(path)
4750
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4752
# Remerge only supports resolving contents conflicts
4753
allowed_conflicts = ('text conflict', 'contents conflict')
4754
restore_files = [c.path for c in conflicts
4755
if c.typestring in allowed_conflicts]
4756
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
4757
tree.set_conflicts(ConflictList(new_conflicts))
4758
if file_list is not None:
4759
restore_files = file_list
4760
for filename in restore_files:
4762
restore(tree.abspath(filename))
4763
except errors.NotConflicted:
4765
# Disable pending merges, because the file texts we are remerging
4766
# have not had those merges performed. If we use the wrong parents
4767
# list, we imply that the working tree text has seen and rejected
4768
# all the changes from the other tree, when in fact those changes
4769
# have not yet been seen.
4770
tree.set_parent_ids(parents[:1])
4772
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4773
merger.interesting_files = interesting_files
4774
merger.merge_type = merge_type
4775
merger.show_base = show_base
4776
merger.reprocess = reprocess
4777
conflicts = merger.do_merge()
4779
tree.set_parent_ids(parents)
4786
class cmd_revert(Command):
4788
Set files in the working tree back to the contents of a previous revision.
4790
Giving a list of files will revert only those files. Otherwise, all files
4791
will be reverted. If the revision is not specified with '--revision', the
4792
working tree basis revision is used. A revert operation affects only the
4793
working tree, not any revision history like the branch and repository or
4794
the working tree basis revision.
4796
To remove only some changes, without reverting to a prior version, use
4797
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4798
will remove the changes introduced by the second last commit (-2), without
4799
affecting the changes introduced by the last commit (-1). To remove
4800
certain changes on a hunk-by-hunk basis, see the shelve command.
4801
To update the branch to a specific revision or the latest revision and
4802
update the working tree accordingly while preserving local changes, see the
4805
Uncommitted changes to files that are reverted will be discarded.
4806
However, by default, any files that have been manually changed will be
4807
backed up first. (Files changed only by merge are not backed up.) Backup
4808
files have '.~#~' appended to their name, where # is a number.
4810
When you provide files, you can use their current pathname or the pathname
4811
from the target revision. So you can use revert to "undelete" a file by
4812
name. If you name a directory, all the contents of that directory will be
4815
If you have newly added files since the target revision, they will be
4816
removed. If the files to be removed have been changed, backups will be
4817
created as above. Directories containing unknown files will not be
4820
The working tree contains a list of revisions that have been merged but
4821
not yet committed. These revisions will be included as additional parents
4822
of the next commit. Normally, using revert clears that list as well as
4823
reverting the files. If any files are specified, revert leaves the list
4824
of uncommitted merges alone and reverts only the files. Use ``brz revert
4825
.`` in the tree root to revert all files but keep the recorded merges,
4826
and ``brz revert --forget-merges`` to clear the pending merge list without
4827
reverting any files.
4829
Using "brz revert --forget-merges", it is possible to apply all of the
4830
changes from a branch in a single revision. To do this, perform the merge
4831
as desired. Then doing revert with the "--forget-merges" option will keep
4832
the content of the tree as it was, but it will clear the list of pending
4833
merges. The next commit will then contain all of the changes that are
4834
present in the other branch, but without any other parent revisions.
4835
Because this technique forgets where these changes originated, it may
4836
cause additional conflicts on later merges involving the same source and
4840
_see_also = ['cat', 'export', 'merge', 'shelve']
4843
Option('no-backup', "Do not save backups of reverted files."),
4844
Option('forget-merges',
4845
'Remove pending merge marker, without changing any files.'),
4847
takes_args = ['file*']
4849
def run(self, revision=None, no_backup=False, file_list=None,
4850
forget_merges=None):
4851
tree, file_list = WorkingTree.open_containing_paths(file_list)
4852
self.enter_context(tree.lock_tree_write())
4854
tree.set_parent_ids(tree.get_parent_ids()[:1])
4856
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4859
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4860
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4861
tree.revert(file_list, rev_tree, not no_backup, None,
4862
report_changes=True)
4865
class cmd_assert_fail(Command):
4866
__doc__ = """Test reporting of assertion failures"""
4867
# intended just for use in testing
4872
raise AssertionError("always fails")
4875
class cmd_help(Command):
4876
__doc__ = """Show help on a command or other topic.
4879
_see_also = ['topics']
4881
Option('long', 'Show help on all commands.'),
4883
takes_args = ['topic?']
4884
aliases = ['?', '--help', '-?', '-h']
4887
def run(self, topic=None, long=False):
4889
if topic is None and long:
4891
breezy.help.help(topic)
4894
class cmd_shell_complete(Command):
4895
__doc__ = """Show appropriate completions for context.
4897
For a list of all available commands, say 'brz shell-complete'.
4899
takes_args = ['context?']
4904
def run(self, context=None):
4905
from . import shellcomplete
4906
shellcomplete.shellcomplete(context)
4909
class cmd_missing(Command):
4910
__doc__ = """Show unmerged/unpulled revisions between two branches.
4912
OTHER_BRANCH may be local or remote.
4914
To filter on a range of revisions, you can use the command -r begin..end
4915
-r revision requests a specific revision, -r ..end or -r begin.. are
4919
1 - some missing revisions
4920
0 - no missing revisions
4924
Determine the missing revisions between this and the branch at the
4925
remembered pull location::
4929
Determine the missing revisions between this and another branch::
4931
brz missing http://server/branch
4933
Determine the missing revisions up to a specific revision on the other
4936
brz missing -r ..-10
4938
Determine the missing revisions up to a specific revision on this
4941
brz missing --my-revision ..-10
4944
_see_also = ['merge', 'pull']
4945
takes_args = ['other_branch?']
4948
Option('reverse', 'Reverse the order of revisions.'),
4950
'Display changes in the local branch only.'),
4951
Option('this', 'Same as --mine-only.'),
4952
Option('theirs-only',
4953
'Display changes in the remote branch only.'),
4954
Option('other', 'Same as --theirs-only.'),
4958
custom_help('revision',
4959
help='Filter on other branch revisions (inclusive). '
4960
'See "help revisionspec" for details.'),
4961
Option('my-revision',
4962
type=_parse_revision_str,
4963
help='Filter on local branch revisions (inclusive). '
4964
'See "help revisionspec" for details.'),
4965
Option('include-merged',
4966
'Show all revisions in addition to the mainline ones.'),
4967
Option('include-merges', hidden=True,
4968
help='Historical alias for --include-merged.'),
4970
encoding_type = 'replace'
4973
def run(self, other_branch=None, reverse=False, mine_only=False,
4975
log_format=None, long=False, short=False, line=False,
4976
show_ids=False, verbose=False, this=False, other=False,
4977
include_merged=None, revision=None, my_revision=None,
4979
from breezy.missing import find_unmerged, iter_log_revisions
4985
if include_merged is None:
4986
include_merged = False
4991
# TODO: We should probably check that we don't have mine-only and
4992
# theirs-only set, but it gets complicated because we also have
4993
# this and other which could be used.
5000
local_branch = Branch.open_containing(directory)[0]
5001
self.enter_context(local_branch.lock_read())
5003
parent = local_branch.get_parent()
5004
if other_branch is None:
5005
other_branch = parent
5006
if other_branch is None:
5007
raise errors.BzrCommandError(gettext("No peer location known"
5009
display_url = urlutils.unescape_for_display(parent,
5011
message(gettext("Using saved parent location: {0}\n").format(
5014
remote_branch = Branch.open(other_branch)
5015
if remote_branch.base == local_branch.base:
5016
remote_branch = local_branch
5018
self.enter_context(remote_branch.lock_read())
5020
local_revid_range = _revision_range_to_revid_range(
5021
_get_revision_range(my_revision, local_branch,
5024
remote_revid_range = _revision_range_to_revid_range(
5025
_get_revision_range(revision,
5026
remote_branch, self.name()))
5028
local_extra, remote_extra = find_unmerged(
5029
local_branch, remote_branch, restrict,
5030
backward=not reverse,
5031
include_merged=include_merged,
5032
local_revid_range=local_revid_range,
5033
remote_revid_range=remote_revid_range)
5035
if log_format is None:
5036
registry = log.log_formatter_registry
5037
log_format = registry.get_default(local_branch)
5038
lf = log_format(to_file=self.outf,
5040
show_timezone='original')
5043
if local_extra and not theirs_only:
5044
message(ngettext("You have %d extra revision:\n",
5045
"You have %d extra revisions:\n",
5049
if local_branch.supports_tags():
5050
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5051
for revision in iter_log_revisions(local_extra,
5052
local_branch.repository,
5055
lf.log_revision(revision)
5056
printed_local = True
5059
printed_local = False
5061
if remote_extra and not mine_only:
5062
if printed_local is True:
5064
message(ngettext("You are missing %d revision:\n",
5065
"You are missing %d revisions:\n",
5066
len(remote_extra)) %
5068
if remote_branch.supports_tags():
5069
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5070
for revision in iter_log_revisions(remote_extra,
5071
remote_branch.repository,
5074
lf.log_revision(revision)
5077
if mine_only and not local_extra:
5078
# We checked local, and found nothing extra
5079
message(gettext('This branch has no new revisions.\n'))
5080
elif theirs_only and not remote_extra:
5081
# We checked remote, and found nothing extra
5082
message(gettext('Other branch has no new revisions.\n'))
5083
elif not (mine_only or theirs_only or local_extra or
5085
# We checked both branches, and neither one had extra
5087
message(gettext("Branches are up to date.\n"))
5089
if not status_code and parent is None and other_branch is not None:
5090
self.enter_context(local_branch.lock_write())
5091
# handle race conditions - a parent might be set while we run.
5092
if local_branch.get_parent() is None:
5093
local_branch.set_parent(remote_branch.base)
5097
class cmd_pack(Command):
5098
__doc__ = """Compress the data within a repository.
5100
This operation compresses the data within a bazaar repository. As
5101
bazaar supports automatic packing of repository, this operation is
5102
normally not required to be done manually.
5104
During the pack operation, bazaar takes a backup of existing repository
5105
data, i.e. pack files. This backup is eventually removed by bazaar
5106
automatically when it is safe to do so. To save disk space by removing
5107
the backed up pack files, the --clean-obsolete-packs option may be
5110
Warning: If you use --clean-obsolete-packs and your machine crashes
5111
during or immediately after repacking, you may be left with a state
5112
where the deletion has been written to disk but the new packs have not
5113
been. In this case the repository may be unusable.
5116
_see_also = ['repositories']
5117
takes_args = ['branch_or_repo?']
5119
Option('clean-obsolete-packs',
5120
'Delete obsolete packs to save disk space.'),
5123
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5124
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5126
branch = dir.open_branch()
5127
repository = branch.repository
5128
except errors.NotBranchError:
5129
repository = dir.open_repository()
5130
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5133
class cmd_plugins(Command):
5134
__doc__ = """List the installed plugins.
5136
This command displays the list of installed plugins including
5137
version of plugin and a short description of each.
5139
--verbose shows the path where each plugin is located.
5141
A plugin is an external component for Breezy that extends the
5142
revision control system, by adding or replacing code in Breezy.
5143
Plugins can do a variety of things, including overriding commands,
5144
adding new commands, providing additional network transports and
5145
customizing log output.
5147
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5148
for further information on plugins including where to find them and how to
5149
install them. Instructions are also provided there on how to write new
5150
plugins using the Python programming language.
5152
takes_options = ['verbose']
5155
def run(self, verbose=False):
5156
from . import plugin
5157
# Don't give writelines a generator as some codecs don't like that
5158
self.outf.writelines(
5159
list(plugin.describe_plugins(show_paths=verbose)))
5162
class cmd_testament(Command):
5163
__doc__ = """Show testament (signing-form) of a revision."""
5166
Option('long', help='Produce long-format testament.'),
5168
help='Produce a strict-format testament.')]
5169
takes_args = ['branch?']
5170
encoding_type = 'exact'
5173
def run(self, branch=u'.', revision=None, long=False, strict=False):
5174
from .bzr.testament import Testament, StrictTestament
5176
testament_class = StrictTestament
5178
testament_class = Testament
5180
b = Branch.open_containing(branch)[0]
5182
b = Branch.open(branch)
5183
self.enter_context(b.lock_read())
5184
if revision is None:
5185
rev_id = b.last_revision()
5187
rev_id = revision[0].as_revision_id(b)
5188
t = testament_class.from_revision(b.repository, rev_id)
5190
self.outf.writelines(t.as_text_lines())
5192
self.outf.write(t.as_short_text())
5195
class cmd_annotate(Command):
5196
__doc__ = """Show the origin of each line in a file.
5198
This prints out the given file with an annotation on the left side
5199
indicating which revision, author and date introduced the change.
5201
If the origin is the same for a run of consecutive lines, it is
5202
shown only at the top, unless the --all option is given.
5204
# TODO: annotate directories; showing when each file was last changed
5205
# TODO: if the working copy is modified, show annotations on that
5206
# with new uncommitted lines marked
5207
aliases = ['ann', 'blame', 'praise']
5208
takes_args = ['filename']
5209
takes_options = [Option('all', help='Show annotations on all lines.'),
5210
Option('long', help='Show commit date in annotations.'),
5215
encoding_type = 'exact'
5218
def run(self, filename, all=False, long=False, revision=None,
5219
show_ids=False, directory=None):
5220
from .annotate import (
5223
wt, branch, relpath = \
5224
_open_directory_or_containing_tree_or_branch(filename, directory)
5226
self.enter_context(wt.lock_read())
5228
self.enter_context(branch.lock_read())
5229
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5230
self.enter_context(tree.lock_read())
5231
if wt is not None and revision is None:
5232
if not wt.is_versioned(relpath):
5233
raise errors.NotVersionedError(relpath)
5234
# If there is a tree and we're not annotating historical
5235
# versions, annotate the working tree's content.
5236
annotate_file_tree(wt, relpath, self.outf, long, all,
5239
if not tree.is_versioned(relpath):
5240
raise errors.NotVersionedError(relpath)
5241
annotate_file_tree(tree, relpath, self.outf, long, all,
5242
show_ids=show_ids, branch=branch)
5245
class cmd_re_sign(Command):
5246
__doc__ = """Create a digital signature for an existing revision."""
5247
# TODO be able to replace existing ones.
5249
hidden = True # is this right ?
5250
takes_args = ['revision_id*']
5251
takes_options = ['directory', 'revision']
5253
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5254
if revision_id_list is not None and revision is not None:
5255
raise errors.BzrCommandError(
5256
gettext('You can only supply one of revision_id or --revision'))
5257
if revision_id_list is None and revision is None:
5258
raise errors.BzrCommandError(
5259
gettext('You must supply either --revision or a revision_id'))
5260
b = WorkingTree.open_containing(directory)[0].branch
5261
self.enter_context(b.lock_write())
5262
return self._run(b, revision_id_list, revision)
5264
def _run(self, b, revision_id_list, revision):
5265
from .repository import WriteGroup
5266
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5267
if revision_id_list is not None:
5268
with WriteGroup(b.repository):
5269
for revision_id in revision_id_list:
5270
revision_id = cache_utf8.encode(revision_id)
5271
b.repository.sign_revision(revision_id, gpg_strategy)
5272
elif revision is not None:
5273
if len(revision) == 1:
5274
revno, rev_id = revision[0].in_history(b)
5275
with WriteGroup(b.repository):
5276
b.repository.sign_revision(rev_id, gpg_strategy)
5277
elif len(revision) == 2:
5278
# are they both on rh- if so we can walk between them
5279
# might be nice to have a range helper for arbitrary
5280
# revision paths. hmm.
5281
from_revno, from_revid = revision[0].in_history(b)
5282
to_revno, to_revid = revision[1].in_history(b)
5283
if to_revid is None:
5284
to_revno = b.revno()
5285
if from_revno is None or to_revno is None:
5286
raise errors.BzrCommandError(
5287
gettext('Cannot sign a range of non-revision-history revisions'))
5288
with WriteGroup(b.repository):
5289
for revno in range(from_revno, to_revno + 1):
5290
b.repository.sign_revision(b.get_rev_id(revno),
5293
raise errors.BzrCommandError(
5294
gettext('Please supply either one revision, or a range.'))
5297
class cmd_bind(Command):
5298
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5299
If no branch is supplied, rebind to the last bound location.
5301
Once converted into a checkout, commits must succeed on the master branch
5302
before they will be applied to the local branch.
5304
Bound branches use the nickname of its master branch unless it is set
5305
locally, in which case binding will update the local nickname to be
5309
_see_also = ['checkouts', 'unbind']
5310
takes_args = ['location?']
5311
takes_options = ['directory']
5313
def run(self, location=None, directory=u'.'):
5314
b, relpath = Branch.open_containing(directory)
5315
if location is None:
5317
location = b.get_old_bound_location()
5318
except errors.UpgradeRequired:
5319
raise errors.BzrCommandError(
5320
gettext('No location supplied. '
5321
'This format does not remember old locations.'))
5323
if location is None:
5324
if b.get_bound_location() is not None:
5325
raise errors.BzrCommandError(
5326
gettext('Branch is already bound'))
5328
raise errors.BzrCommandError(
5329
gettext('No location supplied'
5330
' and no previous location known'))
5331
b_other = Branch.open(location)
5334
except errors.DivergedBranches:
5335
raise errors.BzrCommandError(
5336
gettext('These branches have diverged.'
5337
' Try merging, and then bind again.'))
5338
if b.get_config().has_explicit_nickname():
5339
b.nick = b_other.nick
5342
class cmd_unbind(Command):
5343
__doc__ = """Convert the current checkout into a regular branch.
5345
After unbinding, the local branch is considered independent and subsequent
5346
commits will be local only.
5349
_see_also = ['checkouts', 'bind']
5351
takes_options = ['directory']
5353
def run(self, directory=u'.'):
5354
b, relpath = Branch.open_containing(directory)
5356
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5359
class cmd_uncommit(Command):
5360
__doc__ = """Remove the last committed revision.
5362
--verbose will print out what is being removed.
5363
--dry-run will go through all the motions, but not actually
5366
If --revision is specified, uncommit revisions to leave the branch at the
5367
specified revision. For example, "brz uncommit -r 15" will leave the
5368
branch at revision 15.
5370
Uncommit leaves the working tree ready for a new commit. The only change
5371
it may make is to restore any pending merges that were present before
5375
# TODO: jam 20060108 Add an option to allow uncommit to remove
5376
# unreferenced information in 'branch-as-repository' branches.
5377
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5378
# information in shared branches as well.
5379
_see_also = ['commit']
5380
takes_options = ['verbose', 'revision',
5381
Option('dry-run', help='Don\'t actually make changes.'),
5382
Option('force', help='Say yes to all questions.'),
5384
help='Keep tags that point to removed revisions.'),
5386
help="Only remove the commits from the local "
5387
"branch when in a checkout."
5390
takes_args = ['location?']
5392
encoding_type = 'replace'
5394
def run(self, location=None, dry_run=False, verbose=False,
5395
revision=None, force=False, local=False, keep_tags=False):
5396
if location is None:
5398
control, relpath = controldir.ControlDir.open_containing(location)
5400
tree = control.open_workingtree()
5402
except (errors.NoWorkingTree, errors.NotLocalUrl):
5404
b = control.open_branch()
5406
if tree is not None:
5407
self.enter_context(tree.lock_write())
5409
self.enter_context(b.lock_write())
5410
return self._run(b, tree, dry_run, verbose, revision, force,
5411
local, keep_tags, location)
5413
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5414
keep_tags, location):
5415
from .log import log_formatter, show_log
5416
from .uncommit import uncommit
5418
last_revno, last_rev_id = b.last_revision_info()
5421
if revision is None:
5423
rev_id = last_rev_id
5425
# 'brz uncommit -r 10' actually means uncommit
5426
# so that the final tree is at revno 10.
5427
# but breezy.uncommit.uncommit() actually uncommits
5428
# the revisions that are supplied.
5429
# So we need to offset it by one
5430
revno = revision[0].in_history(b).revno + 1
5431
if revno <= last_revno:
5432
rev_id = b.get_rev_id(revno)
5434
if rev_id is None or _mod_revision.is_null(rev_id):
5435
self.outf.write(gettext('No revisions to uncommit.\n'))
5438
lf = log_formatter('short',
5440
show_timezone='original')
5445
direction='forward',
5446
start_revision=revno,
5447
end_revision=last_revno)
5450
self.outf.write(gettext('Dry-run, pretending to remove'
5451
' the above revisions.\n'))
5454
gettext('The above revision(s) will be removed.\n'))
5457
if not ui.ui_factory.confirm_action(
5458
gettext(u'Uncommit these revisions'),
5459
'breezy.builtins.uncommit',
5461
self.outf.write(gettext('Canceled\n'))
5464
mutter('Uncommitting from {%s} to {%s}',
5465
last_rev_id, rev_id)
5466
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5467
revno=revno, local=local, keep_tags=keep_tags)
5470
gettext('You can restore the old tip by running:\n'
5471
' brz pull -d %s %s -r revid:%s\n')
5472
% (location, location, last_rev_id.decode('utf-8')))
5475
gettext('You can restore the old tip by running:\n'
5476
' brz pull . -r revid:%s\n')
5477
% last_rev_id.decode('utf-8'))
5480
class cmd_break_lock(Command):
5481
__doc__ = """Break a dead lock.
5483
This command breaks a lock on a repository, branch, working directory or
5486
CAUTION: Locks should only be broken when you are sure that the process
5487
holding the lock has been stopped.
5489
You can get information on what locks are open via the 'brz info
5490
[location]' command.
5494
brz break-lock brz+ssh://example.com/brz/foo
5495
brz break-lock --conf ~/.config/breezy
5498
takes_args = ['location?']
5501
help='LOCATION is the directory where the config lock is.'),
5503
help='Do not ask for confirmation before breaking the lock.'),
5506
def run(self, location=None, config=False, force=False):
5507
if location is None:
5510
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5512
{'breezy.lockdir.break': True})
5514
conf = _mod_config.LockableConfig(file_name=location)
5517
control, relpath = controldir.ControlDir.open_containing(location)
5519
control.break_lock()
5520
except NotImplementedError:
5524
class cmd_wait_until_signalled(Command):
5525
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5527
This just prints a line to signal when it is ready, then blocks on stdin.
5533
self.outf.write("running\n")
5535
sys.stdin.readline()
5538
class cmd_serve(Command):
5539
__doc__ = """Run the brz server."""
5541
aliases = ['server']
5545
help='Serve on stdin/out for use from inetd or sshd.'),
5546
RegistryOption('protocol',
5547
help="Protocol to serve.",
5548
lazy_registry=('breezy.transport',
5549
'transport_server_registry'),
5550
value_switches=True),
5552
help='Listen for connections on nominated address.',
5555
help='Listen for connections on nominated port. Passing 0 as '
5556
'the port number will result in a dynamically allocated '
5557
'port. The default port depends on the protocol.',
5559
custom_help('directory',
5560
help='Serve contents of this directory.'),
5561
Option('allow-writes',
5562
help='By default the server is a readonly server. Supplying '
5563
'--allow-writes enables write access to the contents of '
5564
'the served directory and below. Note that ``brz serve`` '
5565
'does not perform authentication, so unless some form of '
5566
'external authentication is arranged supplying this '
5567
'option leads to global uncontrolled write access to your '
5570
Option('client-timeout', type=float,
5571
help='Override the default idle client timeout (5min).'),
5574
def run(self, listen=None, port=None, inet=False, directory=None,
5575
allow_writes=False, protocol=None, client_timeout=None):
5576
from . import location, transport
5577
if directory is None:
5578
directory = osutils.getcwd()
5579
if protocol is None:
5580
protocol = transport.transport_server_registry.get()
5581
url = location.location_to_url(directory)
5582
if not allow_writes:
5583
url = 'readonly+' + url
5584
t = transport.get_transport_from_url(url)
5585
protocol(t, listen, port, inet, client_timeout)
5588
class cmd_join(Command):
5589
__doc__ = """Combine a tree into its containing tree.
5591
This command requires the target tree to be in a rich-root format.
5593
The TREE argument should be an independent tree, inside another tree, but
5594
not part of it. (Such trees can be produced by "brz split", but also by
5595
running "brz branch" with the target inside a tree.)
5597
The result is a combined tree, with the subtree no longer an independent
5598
part. This is marked as a merge of the subtree into the containing tree,
5599
and all history is preserved.
5602
_see_also = ['split']
5603
takes_args = ['tree']
5605
Option('reference', help='Join by reference.', hidden=True),
5608
def run(self, tree, reference=False):
5609
from breezy.mutabletree import BadReferenceTarget
5610
sub_tree = WorkingTree.open(tree)
5611
parent_dir = osutils.dirname(sub_tree.basedir)
5612
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5613
repo = containing_tree.branch.repository
5614
if not repo.supports_rich_root():
5615
raise errors.BzrCommandError(gettext(
5616
"Can't join trees because %s doesn't support rich root data.\n"
5617
"You can use brz upgrade on the repository.")
5621
containing_tree.add_reference(sub_tree)
5622
except BadReferenceTarget as e:
5623
# XXX: Would be better to just raise a nicely printable
5624
# exception from the real origin. Also below. mbp 20070306
5625
raise errors.BzrCommandError(
5626
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5629
containing_tree.subsume(sub_tree)
5630
except errors.BadSubsumeSource as e:
5631
raise errors.BzrCommandError(
5632
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5635
class cmd_split(Command):
5636
__doc__ = """Split a subdirectory of a tree into a separate tree.
5638
This command will produce a target tree in a format that supports
5639
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5640
converted into earlier formats like 'dirstate-tags'.
5642
The TREE argument should be a subdirectory of a working tree. That
5643
subdirectory will be converted into an independent tree, with its own
5644
branch. Commits in the top-level tree will not apply to the new subtree.
5647
_see_also = ['join']
5648
takes_args = ['tree']
5650
def run(self, tree):
5651
containing_tree, subdir = WorkingTree.open_containing(tree)
5652
if not containing_tree.is_versioned(subdir):
5653
raise errors.NotVersionedError(subdir)
5655
containing_tree.extract(subdir)
5656
except errors.RootNotRich:
5657
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5660
class cmd_merge_directive(Command):
5661
__doc__ = """Generate a merge directive for auto-merge tools.
5663
A directive requests a merge to be performed, and also provides all the
5664
information necessary to do so. This means it must either include a
5665
revision bundle, or the location of a branch containing the desired
5668
A submit branch (the location to merge into) must be supplied the first
5669
time the command is issued. After it has been supplied once, it will
5670
be remembered as the default.
5672
A public branch is optional if a revision bundle is supplied, but required
5673
if --diff or --plain is specified. It will be remembered as the default
5674
after the first use.
5677
takes_args = ['submit_branch?', 'public_branch?']
5681
_see_also = ['send']
5685
RegistryOption.from_kwargs(
5687
'The type of patch to include in the directive.',
5689
value_switches=True,
5691
bundle='Bazaar revision bundle (default).',
5692
diff='Normal unified diff.',
5693
plain='No patch, just directive.'),
5694
Option('sign', help='GPG-sign the directive.'), 'revision',
5695
Option('mail-to', type=text_type,
5696
help='Instead of printing the directive, email to this '
5698
Option('message', type=text_type, short_name='m',
5699
help='Message to use when committing this merge.')
5702
encoding_type = 'exact'
5704
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5705
sign=False, revision=None, mail_to=None, message=None,
5707
from .revision import ensure_null, NULL_REVISION
5708
include_patch, include_bundle = {
5709
'plain': (False, False),
5710
'diff': (True, False),
5711
'bundle': (True, True),
5713
branch = Branch.open(directory)
5714
stored_submit_branch = branch.get_submit_branch()
5715
if submit_branch is None:
5716
submit_branch = stored_submit_branch
5718
if stored_submit_branch is None:
5719
branch.set_submit_branch(submit_branch)
5720
if submit_branch is None:
5721
submit_branch = branch.get_parent()
5722
if submit_branch is None:
5723
raise errors.BzrCommandError(
5724
gettext('No submit branch specified or known'))
5726
stored_public_branch = branch.get_public_branch()
5727
if public_branch is None:
5728
public_branch = stored_public_branch
5729
elif stored_public_branch is None:
5730
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5731
branch.set_public_branch(public_branch)
5732
if not include_bundle and public_branch is None:
5733
raise errors.BzrCommandError(
5734
gettext('No public branch specified or known'))
5735
base_revision_id = None
5736
if revision is not None:
5737
if len(revision) > 2:
5738
raise errors.BzrCommandError(
5739
gettext('brz merge-directive takes '
5740
'at most two one revision identifiers'))
5741
revision_id = revision[-1].as_revision_id(branch)
5742
if len(revision) == 2:
5743
base_revision_id = revision[0].as_revision_id(branch)
5745
revision_id = branch.last_revision()
5746
revision_id = ensure_null(revision_id)
5747
if revision_id == NULL_REVISION:
5748
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5749
directive = merge_directive.MergeDirective2.from_objects(
5750
branch.repository, revision_id, time.time(),
5751
osutils.local_time_offset(), submit_branch,
5752
public_branch=public_branch, include_patch=include_patch,
5753
include_bundle=include_bundle, message=message,
5754
base_revision_id=base_revision_id)
5757
self.outf.write(directive.to_signed(branch))
5759
self.outf.writelines(directive.to_lines())
5761
message = directive.to_email(mail_to, branch, sign)
5762
s = SMTPConnection(branch.get_config_stack())
5763
s.send_email(message)
5766
class cmd_send(Command):
5767
__doc__ = """Mail or create a merge-directive for submitting changes.
5769
A merge directive provides many things needed for requesting merges:
5771
* A machine-readable description of the merge to perform
5773
* An optional patch that is a preview of the changes requested
5775
* An optional bundle of revision data, so that the changes can be applied
5776
directly from the merge directive, without retrieving data from a
5779
`brz send` creates a compact data set that, when applied using brz
5780
merge, has the same effect as merging from the source branch.
5782
By default the merge directive is self-contained and can be applied to any
5783
branch containing submit_branch in its ancestory without needing access to
5786
If --no-bundle is specified, then Breezy doesn't send the contents of the
5787
revisions, but only a structured request to merge from the
5788
public_location. In that case the public_branch is needed and it must be
5789
up-to-date and accessible to the recipient. The public_branch is always
5790
included if known, so that people can check it later.
5792
The submit branch defaults to the parent of the source branch, but can be
5793
overridden. Both submit branch and public branch will be remembered in
5794
branch.conf the first time they are used for a particular branch. The
5795
source branch defaults to that containing the working directory, but can
5796
be changed using --from.
5798
Both the submit branch and the public branch follow the usual behavior with
5799
respect to --remember: If there is no default location set, the first send
5800
will set it (use --no-remember to avoid setting it). After that, you can
5801
omit the location to use the default. To change the default, use
5802
--remember. The value will only be saved if the location can be accessed.
5804
In order to calculate those changes, brz must analyse the submit branch.
5805
Therefore it is most efficient for the submit branch to be a local mirror.
5806
If a public location is known for the submit_branch, that location is used
5807
in the merge directive.
5809
The default behaviour is to send the merge directive by mail, unless -o is
5810
given, in which case it is sent to a file.
5812
Mail is sent using your preferred mail program. This should be transparent
5813
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5814
If the preferred client can't be found (or used), your editor will be used.
5816
To use a specific mail program, set the mail_client configuration option.
5817
Supported values for specific clients are "claws", "evolution", "kmail",
5818
"mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options
5819
are "default", "editor", "emacsclient", "mapi", and "xdg-email". Plugins
5820
may also add supported clients.
5822
If mail is being sent, a to address is required. This can be supplied
5823
either on the commandline, by setting the submit_to configuration
5824
option in the branch itself or the child_submit_to configuration option
5825
in the submit branch.
5827
The merge directives created by brz send may be applied using brz merge or
5828
brz pull by specifying a file containing a merge directive as the location.
5830
brz send makes extensive use of public locations to map local locations into
5831
URLs that can be used by other people. See `brz help configuration` to
5832
set them, and use `brz info` to display them.
5835
encoding_type = 'exact'
5837
_see_also = ['merge', 'pull']
5839
takes_args = ['submit_branch?', 'public_branch?']
5843
help='Do not include a bundle in the merge directive.'),
5844
Option('no-patch', help='Do not include a preview patch in the merge'
5847
help='Remember submit and public branch.'),
5849
help='Branch to generate the submission from, '
5850
'rather than the one containing the working directory.',
5853
Option('output', short_name='o',
5854
help='Write merge directive to this file or directory; '
5855
'use - for stdout.',
5858
help='Refuse to send if there are uncommitted changes in'
5859
' the working tree, --no-strict disables the check.'),
5860
Option('mail-to', help='Mail the request to this address.',
5864
Option('body', help='Body for the email.', type=text_type),
5865
RegistryOption('format',
5866
help='Use the specified output format.',
5867
lazy_registry=('breezy.send', 'format_registry')),
5870
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5871
no_patch=False, revision=None, remember=None, output=None,
5872
format=None, mail_to=None, message=None, body=None,
5873
strict=None, **kwargs):
5874
from .send import send
5875
return send(submit_branch, revision, public_branch, remember,
5876
format, no_bundle, no_patch, output,
5877
kwargs.get('from', '.'), mail_to, message, body,
5882
class cmd_bundle_revisions(cmd_send):
5883
__doc__ = """Create a merge-directive for submitting changes.
5885
A merge directive provides many things needed for requesting merges:
5887
* A machine-readable description of the merge to perform
5889
* An optional patch that is a preview of the changes requested
5891
* An optional bundle of revision data, so that the changes can be applied
5892
directly from the merge directive, without retrieving data from a
5895
If --no-bundle is specified, then public_branch is needed (and must be
5896
up-to-date), so that the receiver can perform the merge using the
5897
public_branch. The public_branch is always included if known, so that
5898
people can check it later.
5900
The submit branch defaults to the parent, but can be overridden. Both
5901
submit branch and public branch will be remembered if supplied.
5903
If a public_branch is known for the submit_branch, that public submit
5904
branch is used in the merge instructions. This means that a local mirror
5905
can be used as your actual submit branch, once you have set public_branch
5911
help='Do not include a bundle in the merge directive.'),
5912
Option('no-patch', help='Do not include a preview patch in the merge'
5915
help='Remember submit and public branch.'),
5917
help='Branch to generate the submission from, '
5918
'rather than the one containing the working directory.',
5921
Option('output', short_name='o', help='Write directive to this file.',
5924
help='Refuse to bundle revisions if there are uncommitted'
5925
' changes in the working tree, --no-strict disables the check.'),
5927
RegistryOption('format',
5928
help='Use the specified output format.',
5929
lazy_registry=('breezy.send', 'format_registry')),
5931
aliases = ['bundle']
5933
_see_also = ['send', 'merge']
5937
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5938
no_patch=False, revision=None, remember=False, output=None,
5939
format=None, strict=None, **kwargs):
5942
from .send import send
5943
return send(submit_branch, revision, public_branch, remember,
5944
format, no_bundle, no_patch, output,
5945
kwargs.get('from', '.'), None, None, None,
5946
self.outf, strict=strict)
5949
class cmd_tag(Command):
5950
__doc__ = """Create, remove or modify a tag naming a revision.
5952
Tags give human-meaningful names to revisions. Commands that take a -r
5953
(--revision) option can be given -rtag:X, where X is any previously
5956
Tags are stored in the branch. Tags are copied from one branch to another
5957
along when you branch, push, pull or merge.
5959
It is an error to give a tag name that already exists unless you pass
5960
--force, in which case the tag is moved to point to the new revision.
5962
To rename a tag (change the name but keep it on the same revsion), run ``brz
5963
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
5965
If no tag name is specified it will be determined through the
5966
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5967
upstream releases by reading configure.ac. See ``brz help hooks`` for
5971
_see_also = ['commit', 'tags']
5972
takes_args = ['tag_name?']
5975
help='Delete this tag rather than placing it.',
5977
custom_help('directory',
5978
help='Branch in which to place the tag.'),
5980
help='Replace existing tags.',
5985
def run(self, tag_name=None,
5991
branch, relpath = Branch.open_containing(directory)
5992
self.enter_context(branch.lock_write())
5994
if tag_name is None:
5995
raise errors.BzrCommandError(
5996
gettext("No tag specified to delete."))
5997
branch.tags.delete_tag(tag_name)
5998
note(gettext('Deleted tag %s.') % tag_name)
6001
if len(revision) != 1:
6002
raise errors.BzrCommandError(gettext(
6003
"Tags can only be placed on a single revision, "
6005
revision_id = revision[0].as_revision_id(branch)
6007
revision_id = branch.last_revision()
6008
if tag_name is None:
6009
tag_name = branch.automatic_tag_name(revision_id)
6010
if tag_name is None:
6011
raise errors.BzrCommandError(gettext(
6012
"Please specify a tag name."))
6014
existing_target = branch.tags.lookup_tag(tag_name)
6015
except errors.NoSuchTag:
6016
existing_target = None
6017
if not force and existing_target not in (None, revision_id):
6018
raise errors.TagAlreadyExists(tag_name)
6019
if existing_target == revision_id:
6020
note(gettext('Tag %s already exists for that revision.') % tag_name)
6022
branch.tags.set_tag(tag_name, revision_id)
6023
if existing_target is None:
6024
note(gettext('Created tag %s.') % tag_name)
6026
note(gettext('Updated tag %s.') % tag_name)
6029
class cmd_tags(Command):
6030
__doc__ = """List tags.
6032
This command shows a table of tag names and the revisions they reference.
6037
custom_help('directory',
6038
help='Branch whose tags should be displayed.'),
6039
RegistryOption('sort',
6040
'Sort tags by different criteria.', title='Sorting',
6041
lazy_registry=('breezy.tag', 'tag_sort_methods')
6048
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6049
from .tag import tag_sort_methods
6050
branch, relpath = Branch.open_containing(directory)
6052
tags = list(viewitems(branch.tags.get_tag_dict()))
6056
self.enter_context(branch.lock_read())
6058
# Restrict to the specified range
6059
tags = self._tags_for_range(branch, revision)
6061
sort = tag_sort_methods.get()
6064
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6065
for index, (tag, revid) in enumerate(tags):
6067
revno = branch.revision_id_to_dotted_revno(revid)
6068
if isinstance(revno, tuple):
6069
revno = '.'.join(map(str, revno))
6070
except (errors.NoSuchRevision,
6071
errors.GhostRevisionsHaveNoRevno,
6072
errors.UnsupportedOperation):
6073
# Bad tag data/merges can lead to tagged revisions
6074
# which are not in this branch. Fail gracefully ...
6076
tags[index] = (tag, revno)
6078
tags = [(tag, revid.decode('utf-8')) for (tag, revid) in tags]
6080
for tag, revspec in tags:
6081
self.outf.write('%-20s %s\n' % (tag, revspec))
6083
def _tags_for_range(self, branch, revision):
6084
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6085
revid1, revid2 = rev1.rev_id, rev2.rev_id
6086
# _get_revision_range will always set revid2 if it's not specified.
6087
# If revid1 is None, it means we want to start from the branch
6088
# origin which is always a valid ancestor. If revid1 == revid2, the
6089
# ancestry check is useless.
6090
if revid1 and revid1 != revid2:
6091
# FIXME: We really want to use the same graph than
6092
# branch.iter_merge_sorted_revisions below, but this is not
6093
# easily available -- vila 2011-09-23
6094
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6095
# We don't want to output anything in this case...
6097
# only show revisions between revid1 and revid2 (inclusive)
6098
tagged_revids = branch.tags.get_reverse_tag_dict()
6100
for r in branch.iter_merge_sorted_revisions(
6101
start_revision_id=revid2, stop_revision_id=revid1,
6102
stop_rule='include'):
6103
revid_tags = tagged_revids.get(r[0], None)
6105
found.extend([(tag, r[0]) for tag in revid_tags])
6109
class cmd_reconfigure(Command):
6110
__doc__ = """Reconfigure the type of a brz directory.
6112
A target configuration must be specified.
6114
For checkouts, the bind-to location will be auto-detected if not specified.
6115
The order of preference is
6116
1. For a lightweight checkout, the current bound location.
6117
2. For branches that used to be checkouts, the previously-bound location.
6118
3. The push location.
6119
4. The parent location.
6120
If none of these is available, --bind-to must be specified.
6123
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6124
takes_args = ['location?']
6126
RegistryOption.from_kwargs(
6129
help='The relation between branch and tree.',
6130
value_switches=True, enum_switch=False,
6131
branch='Reconfigure to be an unbound branch with no working tree.',
6132
tree='Reconfigure to be an unbound branch with a working tree.',
6133
checkout='Reconfigure to be a bound branch with a working tree.',
6134
lightweight_checkout='Reconfigure to be a lightweight'
6135
' checkout (with no local history).',
6137
RegistryOption.from_kwargs(
6139
title='Repository type',
6140
help='Location fo the repository.',
6141
value_switches=True, enum_switch=False,
6142
standalone='Reconfigure to be a standalone branch '
6143
'(i.e. stop using shared repository).',
6144
use_shared='Reconfigure to use a shared repository.',
6146
RegistryOption.from_kwargs(
6148
title='Trees in Repository',
6149
help='Whether new branches in the repository have trees.',
6150
value_switches=True, enum_switch=False,
6151
with_trees='Reconfigure repository to create '
6152
'working trees on branches by default.',
6153
with_no_trees='Reconfigure repository to not create '
6154
'working trees on branches by default.'
6156
Option('bind-to', help='Branch to bind checkout to.', type=text_type),
6158
help='Perform reconfiguration even if local changes'
6160
Option('stacked-on',
6161
help='Reconfigure a branch to be stacked on another branch.',
6165
help='Reconfigure a branch to be unstacked. This '
6166
'may require copying substantial data into it.',
6170
def run(self, location=None, bind_to=None, force=False,
6171
tree_type=None, repository_type=None, repository_trees=None,
6172
stacked_on=None, unstacked=None):
6173
directory = controldir.ControlDir.open(location)
6174
if stacked_on and unstacked:
6175
raise errors.BzrCommandError(
6176
gettext("Can't use both --stacked-on and --unstacked"))
6177
elif stacked_on is not None:
6178
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6180
reconfigure.ReconfigureUnstacked().apply(directory)
6181
# At the moment you can use --stacked-on and a different
6182
# reconfiguration shape at the same time; there seems no good reason
6184
if (tree_type is None and
6185
repository_type is None and
6186
repository_trees is None):
6187
if stacked_on or unstacked:
6190
raise errors.BzrCommandError(gettext('No target configuration '
6192
reconfiguration = None
6193
if tree_type == 'branch':
6194
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6195
elif tree_type == 'tree':
6196
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6197
elif tree_type == 'checkout':
6198
reconfiguration = reconfigure.Reconfigure.to_checkout(
6200
elif tree_type == 'lightweight-checkout':
6201
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6204
reconfiguration.apply(force)
6205
reconfiguration = None
6206
if repository_type == 'use-shared':
6207
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6208
elif repository_type == 'standalone':
6209
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6211
reconfiguration.apply(force)
6212
reconfiguration = None
6213
if repository_trees == 'with-trees':
6214
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6216
elif repository_trees == 'with-no-trees':
6217
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6220
reconfiguration.apply(force)
6221
reconfiguration = None
6224
class cmd_switch(Command):
6225
__doc__ = """Set the branch of a checkout and update.
6227
For lightweight checkouts, this changes the branch being referenced.
6228
For heavyweight checkouts, this checks that there are no local commits
6229
versus the current bound branch, then it makes the local branch a mirror
6230
of the new location and binds to it.
6232
In both cases, the working tree is updated and uncommitted changes
6233
are merged. The user can commit or revert these as they desire.
6235
Pending merges need to be committed or reverted before using switch.
6237
The path to the branch to switch to can be specified relative to the parent
6238
directory of the current branch. For example, if you are currently in a
6239
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6242
Bound branches use the nickname of its master branch unless it is set
6243
locally, in which case switching will update the local nickname to be
6247
takes_args = ['to_location?']
6248
takes_options = ['directory',
6250
help='Switch even if local commits will be lost.'),
6252
Option('create-branch', short_name='b',
6253
help='Create the target branch from this one before'
6254
' switching to it.'),
6256
help='Store and restore uncommitted changes in the'
6260
def run(self, to_location=None, force=False, create_branch=False,
6261
revision=None, directory=u'.', store=False):
6262
from . import switch
6263
tree_location = directory
6264
revision = _get_one_revision('switch', revision)
6265
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6266
possible_transports = [control_dir.root_transport]
6267
if to_location is None:
6268
if revision is None:
6269
raise errors.BzrCommandError(gettext('You must supply either a'
6270
' revision or a location'))
6271
to_location = tree_location
6273
branch = control_dir.open_branch(
6274
possible_transports=possible_transports)
6275
had_explicit_nick = branch.get_config().has_explicit_nickname()
6276
except errors.NotBranchError:
6278
had_explicit_nick = False
6280
possible_transports.append(branch.user_transport)
6283
raise errors.BzrCommandError(
6284
gettext('cannot create branch without source branch'))
6285
to_location = lookup_new_sibling_branch(
6286
control_dir, to_location,
6287
possible_transports=possible_transports)
6288
if revision is not None:
6289
revision = revision.as_revision_id(branch)
6290
to_branch = branch.controldir.sprout(
6292
possible_transports=possible_transports,
6293
revision_id=revision,
6294
source_branch=branch).open_branch()
6297
to_branch = Branch.open(
6298
to_location, possible_transports=possible_transports)
6299
except errors.NotBranchError:
6300
to_branch = open_sibling_branch(
6301
control_dir, to_location,
6302
possible_transports=possible_transports)
6303
if revision is not None:
6304
revision = revision.as_revision_id(to_branch)
6305
possible_transports.append(to_branch.user_transport)
6307
switch.switch(control_dir, to_branch, force, revision_id=revision,
6308
store_uncommitted=store,
6309
possible_transports=possible_transports)
6310
except controldir.BranchReferenceLoop:
6311
raise errors.BzrCommandError(
6312
gettext('switching would create a branch reference loop. '
6313
'Use the "bzr up" command to switch to a '
6314
'different revision.'))
6315
if had_explicit_nick:
6316
branch = control_dir.open_branch() # get the new branch!
6317
branch.nick = to_branch.nick
6319
if to_branch.controldir.control_url != control_dir.control_url:
6320
note(gettext('Switched to branch %s at %s'),
6321
to_branch.name, urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6323
note(gettext('Switched to branch %s'), to_branch.name)
6325
note(gettext('Switched to branch at %s'),
6326
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6329
class cmd_view(Command):
6330
__doc__ = """Manage filtered views.
6332
Views provide a mask over the tree so that users can focus on
6333
a subset of a tree when doing their work. After creating a view,
6334
commands that support a list of files - status, diff, commit, etc -
6335
effectively have that list of files implicitly given each time.
6336
An explicit list of files can still be given but those files
6337
must be within the current view.
6339
In most cases, a view has a short life-span: it is created to make
6340
a selected change and is deleted once that change is committed.
6341
At other times, you may wish to create one or more named views
6342
and switch between them.
6344
To disable the current view without deleting it, you can switch to
6345
the pseudo view called ``off``. This can be useful when you need
6346
to see the whole tree for an operation or two (e.g. merge) but
6347
want to switch back to your view after that.
6350
To define the current view::
6352
brz view file1 dir1 ...
6354
To list the current view::
6358
To delete the current view::
6362
To disable the current view without deleting it::
6364
brz view --switch off
6366
To define a named view and switch to it::
6368
brz view --name view-name file1 dir1 ...
6370
To list a named view::
6372
brz view --name view-name
6374
To delete a named view::
6376
brz view --name view-name --delete
6378
To switch to a named view::
6380
brz view --switch view-name
6382
To list all views defined::
6386
To delete all views::
6388
brz view --delete --all
6392
takes_args = ['file*']
6395
help='Apply list or delete action to all views.',
6398
help='Delete the view.',
6401
help='Name of the view to define, list or delete.',
6405
help='Name of the view to switch to.',
6410
def run(self, file_list,
6416
tree, file_list = WorkingTree.open_containing_paths(file_list,
6418
current_view, view_dict = tree.views.get_view_info()
6423
raise errors.BzrCommandError(gettext(
6424
"Both --delete and a file list specified"))
6426
raise errors.BzrCommandError(gettext(
6427
"Both --delete and --switch specified"))
6429
tree.views.set_view_info(None, {})
6430
self.outf.write(gettext("Deleted all views.\n"))
6432
raise errors.BzrCommandError(
6433
gettext("No current view to delete"))
6435
tree.views.delete_view(name)
6436
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6439
raise errors.BzrCommandError(gettext(
6440
"Both --switch and a file list specified"))
6442
raise errors.BzrCommandError(gettext(
6443
"Both --switch and --all specified"))
6444
elif switch == 'off':
6445
if current_view is None:
6446
raise errors.BzrCommandError(
6447
gettext("No current view to disable"))
6448
tree.views.set_view_info(None, view_dict)
6449
self.outf.write(gettext("Disabled '%s' view.\n") %
6452
tree.views.set_view_info(switch, view_dict)
6453
view_str = views.view_display_str(tree.views.lookup_view())
6455
gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6458
self.outf.write(gettext('Views defined:\n'))
6459
for view in sorted(view_dict):
6460
if view == current_view:
6464
view_str = views.view_display_str(view_dict[view])
6465
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6467
self.outf.write(gettext('No views defined.\n'))
6470
# No name given and no current view set
6473
raise errors.BzrCommandError(gettext(
6474
"Cannot change the 'off' pseudo view"))
6475
tree.views.set_view(name, sorted(file_list))
6476
view_str = views.view_display_str(tree.views.lookup_view())
6478
gettext("Using '{0}' view: {1}\n").format(name, view_str))
6482
# No name given and no current view set
6483
self.outf.write(gettext('No current view.\n'))
6485
view_str = views.view_display_str(tree.views.lookup_view(name))
6487
gettext("'{0}' view is: {1}\n").format(name, view_str))
6490
class cmd_hooks(Command):
6491
__doc__ = """Show hooks."""
6496
for hook_key in sorted(hooks.known_hooks.keys()):
6497
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6498
self.outf.write("%s:\n" % type(some_hooks).__name__)
6499
for hook_name, hook_point in sorted(some_hooks.items()):
6500
self.outf.write(" %s:\n" % (hook_name,))
6501
found_hooks = list(hook_point)
6503
for hook in found_hooks:
6504
self.outf.write(" %s\n" %
6505
(some_hooks.get_hook_name(hook),))
6507
self.outf.write(gettext(" <no hooks installed>\n"))
6510
class cmd_remove_branch(Command):
6511
__doc__ = """Remove a branch.
6513
This will remove the branch from the specified location but
6514
will keep any working tree or repository in place.
6518
Remove the branch at repo/trunk::
6520
brz remove-branch repo/trunk
6524
takes_args = ["location?"]
6526
takes_options = ['directory',
6527
Option('force', help='Remove branch even if it is the active branch.')]
6529
aliases = ["rmbranch"]
6531
def run(self, directory=None, location=None, force=False):
6532
br = open_nearby_branch(near=directory, location=location)
6533
if not force and br.controldir.has_workingtree():
6535
active_branch = br.controldir.open_branch(name="")
6536
except errors.NotBranchError:
6537
active_branch = None
6538
if (active_branch is not None and
6539
br.control_url == active_branch.control_url):
6540
raise errors.BzrCommandError(
6541
gettext("Branch is active. Use --force to remove it."))
6542
br.controldir.destroy_branch(br.name)
6545
class cmd_shelve(Command):
6546
__doc__ = """Temporarily set aside some changes from the current tree.
6548
Shelve allows you to temporarily put changes you've made "on the shelf",
6549
ie. out of the way, until a later time when you can bring them back from
6550
the shelf with the 'unshelve' command. The changes are stored alongside
6551
your working tree, and so they aren't propagated along with your branch nor
6552
will they survive its deletion.
6554
If shelve --list is specified, previously-shelved changes are listed.
6556
Shelve is intended to help separate several sets of changes that have
6557
been inappropriately mingled. If you just want to get rid of all changes
6558
and you don't need to restore them later, use revert. If you want to
6559
shelve all text changes at once, use shelve --all.
6561
If filenames are specified, only the changes to those files will be
6562
shelved. Other files will be left untouched.
6564
If a revision is specified, changes since that revision will be shelved.
6566
You can put multiple items on the shelf, and by default, 'unshelve' will
6567
restore the most recently shelved changes.
6569
For complicated changes, it is possible to edit the changes in a separate
6570
editor program to decide what the file remaining in the working copy
6571
should look like. To do this, add the configuration option
6573
change_editor = PROGRAM {new_path} {old_path}
6575
where {new_path} is replaced with the path of the new version of the
6576
file and {old_path} is replaced with the path of the old version of
6577
the file. The PROGRAM should save the new file with the desired
6578
contents of the file in the working tree.
6582
takes_args = ['file*']
6587
Option('all', help='Shelve all changes.'),
6589
RegistryOption('writer', 'Method to use for writing diffs.',
6590
breezy.option.diff_writer_registry,
6591
value_switches=True, enum_switch=False),
6593
Option('list', help='List shelved changes.'),
6595
help='Destroy removed changes instead of shelving them.'),
6597
_see_also = ['unshelve', 'configuration']
6599
def run(self, revision=None, all=False, file_list=None, message=None,
6600
writer=None, list=False, destroy=False, directory=None):
6602
return self.run_for_list(directory=directory)
6603
from .shelf_ui import Shelver
6605
writer = breezy.option.diff_writer_registry.get()
6607
shelver = Shelver.from_args(writer(self.outf), revision, all,
6608
file_list, message, destroy=destroy, directory=directory)
6613
except errors.UserAbort:
6616
def run_for_list(self, directory=None):
6617
if directory is None:
6619
tree = WorkingTree.open_containing(directory)[0]
6620
self.enter_context(tree.lock_read())
6621
manager = tree.get_shelf_manager()
6622
shelves = manager.active_shelves()
6623
if len(shelves) == 0:
6624
note(gettext('No shelved changes.'))
6626
for shelf_id in reversed(shelves):
6627
message = manager.get_metadata(shelf_id).get(b'message')
6629
message = '<no message>'
6630
self.outf.write('%3d: %s\n' % (shelf_id, message))
6634
class cmd_unshelve(Command):
6635
__doc__ = """Restore shelved changes.
6637
By default, the most recently shelved changes are restored. However if you
6638
specify a shelf by id those changes will be restored instead. This works
6639
best when the changes don't depend on each other.
6642
takes_args = ['shelf_id?']
6645
RegistryOption.from_kwargs(
6646
'action', help="The action to perform.",
6647
enum_switch=False, value_switches=True,
6648
apply="Apply changes and remove from the shelf.",
6649
dry_run="Show changes, but do not apply or remove them.",
6650
preview="Instead of unshelving the changes, show the diff that "
6651
"would result from unshelving.",
6652
delete_only="Delete changes without applying them.",
6653
keep="Apply changes but don't delete them.",
6656
_see_also = ['shelve']
6658
def run(self, shelf_id=None, action='apply', directory=u'.'):
6659
from .shelf_ui import Unshelver
6660
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6664
unshelver.tree.unlock()
6667
class cmd_clean_tree(Command):
6668
__doc__ = """Remove unwanted files from working tree.
6670
By default, only unknown files, not ignored files, are deleted. Versioned
6671
files are never deleted.
6673
Another class is 'detritus', which includes files emitted by brz during
6674
normal operations and selftests. (The value of these files decreases with
6677
If no options are specified, unknown files are deleted. Otherwise, option
6678
flags are respected, and may be combined.
6680
To check what clean-tree will do, use --dry-run.
6682
takes_options = ['directory',
6683
Option('ignored', help='Delete all ignored files.'),
6684
Option('detritus', help='Delete conflict files, merge and revert'
6685
' backups, and failed selftest dirs.'),
6687
help='Delete files unknown to brz (default).'),
6688
Option('dry-run', help='Show files to delete instead of'
6690
Option('force', help='Do not prompt before deleting.')]
6692
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6693
force=False, directory=u'.'):
6694
from .clean_tree import clean_tree
6695
if not (unknown or ignored or detritus):
6699
clean_tree(directory, unknown=unknown, ignored=ignored,
6700
detritus=detritus, dry_run=dry_run, no_prompt=force)
6703
class cmd_reference(Command):
6704
__doc__ = """list, view and set branch locations for nested trees.
6706
If no arguments are provided, lists the branch locations for nested trees.
6707
If one argument is provided, display the branch location for that tree.
6708
If two arguments are provided, set the branch location for that tree.
6713
takes_args = ['path?', 'location?']
6715
Option('force-unversioned',
6716
help='Set reference even if path is not versioned.'),
6719
def run(self, path=None, location=None, force_unversioned=False):
6721
if path is not None:
6723
tree, branch, relpath = (
6724
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6725
if path is not None:
6728
tree = branch.basis_tree()
6730
info = viewitems(branch._get_all_reference_info())
6731
self._display_reference_info(tree, branch, info)
6733
if not tree.is_versioned(path) and not force_unversioned:
6734
raise errors.NotVersionedError(path)
6735
if location is None:
6736
info = [(path, branch.get_reference_info(path))]
6737
self._display_reference_info(tree, branch, info)
6739
branch.set_reference_info(
6740
path, location, file_id=tree.path2id(path))
6742
def _display_reference_info(self, tree, branch, info):
6744
for path, (location, file_id) in info:
6745
ref_list.append((path, location))
6746
for path, location in sorted(ref_list):
6747
self.outf.write('%s %s\n' % (path, location))
6750
class cmd_export_pot(Command):
6751
__doc__ = """Export command helps and error messages in po format."""
6754
takes_options = [Option('plugin',
6755
help='Export help text from named command '
6756
'(defaults to all built in commands).',
6758
Option('include-duplicates',
6759
help='Output multiple copies of the same msgid '
6760
'string if it appears more than once.'),
6763
def run(self, plugin=None, include_duplicates=False):
6764
from .export_pot import export_pot
6765
export_pot(self.outf, plugin, include_duplicates)
6768
class cmd_import(Command):
6769
__doc__ = """Import sources from a directory, tarball or zip file
6771
This command will import a directory, tarball or zip file into a bzr
6772
tree, replacing any versioned files already present. If a directory is
6773
specified, it is used as the target. If the directory does not exist, or
6774
is not versioned, it is created.
6776
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6778
If the tarball or zip has a single root directory, that directory is
6779
stripped when extracting the tarball. This is not done for directories.
6782
takes_args = ['source', 'tree?']
6784
def run(self, source, tree=None):
6785
from .upstream_import import do_import
6786
do_import(source, tree)
6789
class cmd_link_tree(Command):
6790
__doc__ = """Hardlink matching files to another tree.
6792
Only files with identical content and execute bit will be linked.
6795
takes_args = ['location']
6797
def run(self, location):
6798
from .transform import link_tree
6799
target_tree = WorkingTree.open_containing(".")[0]
6800
source_tree = WorkingTree.open(location)
6801
with target_tree.lock_write(), source_tree.lock_read():
6802
link_tree(target_tree, source_tree)
6805
class cmd_fetch_ghosts(Command):
6806
__doc__ = """Attempt to retrieve ghosts from another branch.
6808
If the other branch is not supplied, the last-pulled branch is used.
6812
aliases = ['fetch-missing']
6813
takes_args = ['branch?']
6814
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6816
def run(self, branch=None, no_fix=False):
6817
from .fetch_ghosts import GhostFetcher
6818
installed, failed = GhostFetcher.from_cmdline(branch).run()
6819
if len(installed) > 0:
6820
self.outf.write("Installed:\n")
6821
for rev in installed:
6822
self.outf.write(rev.decode('utf-8') + "\n")
6824
self.outf.write("Still missing:\n")
6826
self.outf.write(rev.decode('utf-8') + "\n")
6827
if not no_fix and len(installed) > 0:
6828
cmd_reconcile().run(".")
6831
class cmd_grep(Command):
6832
"""Print lines matching PATTERN for specified files and revisions.
6834
This command searches the specified files and revisions for a given
6835
pattern. The pattern is specified as a Python regular expressions[1].
6837
If the file name is not specified, the revisions starting with the
6838
current directory are searched recursively. If the revision number is
6839
not specified, the working copy is searched. To search the last committed
6840
revision, use the '-r -1' or '-r last:1' option.
6842
Unversioned files are not searched unless explicitly specified on the
6843
command line. Unversioned directores are not searched.
6845
When searching a pattern, the output is shown in the 'filepath:string'
6846
format. If a revision is explicitly searched, the output is shown as
6847
'filepath~N:string', where N is the revision number.
6849
--include and --exclude options can be used to search only (or exclude
6850
from search) files with base name matches the specified Unix style GLOB
6851
pattern. The GLOB pattern an use *, ?, and [...] as wildcards, and \\
6852
to quote wildcard or backslash character literally. Note that the glob
6853
pattern is not a regular expression.
6855
[1] http://docs.python.org/library/re.html#regular-expression-syntax
6858
encoding_type = 'replace'
6859
takes_args = ['pattern', 'path*']
6863
Option('color', type=text_type, argname='when',
6864
help='Show match in color. WHEN is never, always or auto.'),
6865
Option('diff', short_name='p',
6866
help='Grep for pattern in changeset for each revision.'),
6867
ListOption('exclude', type=text_type, argname='glob', short_name='X',
6868
help="Skip files whose base name matches GLOB."),
6869
ListOption('include', type=text_type, argname='glob', short_name='I',
6870
help="Search only files whose base name matches GLOB."),
6871
Option('files-with-matches', short_name='l',
6872
help='Print only the name of each input file in '
6873
'which PATTERN is found.'),
6874
Option('files-without-match', short_name='L',
6875
help='Print only the name of each input file in '
6876
'which PATTERN is not found.'),
6877
Option('fixed-string', short_name='F',
6878
help='Interpret PATTERN is a single fixed string (not regex).'),
6880
help='Search for pattern starting from the root of the branch. '
6881
'(implies --recursive)'),
6882
Option('ignore-case', short_name='i',
6883
help='Ignore case distinctions while matching.'),
6885
help='Number of levels to display - 0 for all, 1 for collapsed '
6888
type=_parse_levels),
6889
Option('line-number', short_name='n',
6890
help='Show 1-based line number.'),
6891
Option('no-recursive',
6892
help="Don't recurse into subdirectories. (default is --recursive)"),
6893
Option('null', short_name='Z',
6894
help='Write an ASCII NUL (\\0) separator '
6895
'between output lines rather than a newline.'),
6899
def run(self, verbose=False, ignore_case=False, no_recursive=False,
6900
from_root=False, null=False, levels=None, line_number=False,
6901
path_list=None, revision=None, pattern=None, include=None,
6902
exclude=None, fixed_string=False, files_with_matches=False,
6903
files_without_match=False, color=None, diff=False):
6904
from breezy import _termcolor
6907
if path_list is None:
6911
raise errors.BzrCommandError(
6912
'cannot specify both --from-root and PATH.')
6914
if files_with_matches and files_without_match:
6915
raise errors.BzrCommandError(
6916
'cannot specify both '
6917
'-l/--files-with-matches and -L/--files-without-matches.')
6919
global_config = _mod_config.GlobalConfig()
6922
color = global_config.get_user_option('grep_color')
6927
if color not in ['always', 'never', 'auto']:
6928
raise errors.BzrCommandError('Valid values for --color are '
6929
'"always", "never" or "auto".')
6935
if revision is not None or levels == 0:
6936
# print revision numbers as we may be showing multiple revisions
6943
if not ignore_case and grep.is_fixed_string(pattern):
6944
# if the pattern isalnum, implicitly use to -F for faster grep
6946
elif ignore_case and fixed_string:
6947
# GZ 2010-06-02: Fall back to regexp rather than lowercasing
6948
# pattern and text which will cause pain later
6949
fixed_string = False
6950
pattern = re.escape(pattern)
6953
re_flags = re.MULTILINE
6955
re_flags |= re.IGNORECASE
6957
if not fixed_string:
6958
patternc = grep.compile_pattern(
6959
pattern.encode(grep._user_encoding), re_flags)
6961
if color == 'always':
6963
elif color == 'never':
6965
elif color == 'auto':
6966
show_color = _termcolor.allow_color()
6968
opts = grep.GrepOptions()
6970
opts.verbose = verbose
6971
opts.ignore_case = ignore_case
6972
opts.no_recursive = no_recursive
6973
opts.from_root = from_root
6975
opts.levels = levels
6976
opts.line_number = line_number
6977
opts.path_list = path_list
6978
opts.revision = revision
6979
opts.pattern = pattern
6980
opts.include = include
6981
opts.exclude = exclude
6982
opts.fixed_string = fixed_string
6983
opts.files_with_matches = files_with_matches
6984
opts.files_without_match = files_without_match
6988
opts.eol_marker = eol_marker
6989
opts.print_revno = print_revno
6990
opts.patternc = patternc
6991
opts.recursive = not no_recursive
6992
opts.fixed_string = fixed_string
6993
opts.outf = self.outf
6994
opts.show_color = show_color
6998
# files_with_matches, files_without_match
6999
# levels(?), line_number, from_root
7001
# These are silently ignored.
7002
grep.grep_diff(opts)
7003
elif revision is None:
7004
grep.workingtree_grep(opts)
7006
grep.versioned_grep(opts)
7009
class cmd_patch(Command):
7010
"""Apply a named patch to the current tree.
7014
takes_args = ['filename?']
7015
takes_options = [Option('strip', type=int, short_name='p',
7016
help=("Strip the smallest prefix containing num "
7017
"leading slashes from filenames.")),
7018
Option('silent', help='Suppress chatter.')]
7020
def run(self, filename=None, strip=None, silent=False):
7021
from .patch import patch_tree
7022
wt = WorkingTree.open_containing('.')[0]
7026
if filename is None:
7027
my_file = getattr(sys.stdin, 'buffer', sys.stdin)
7029
my_file = open(filename, 'rb')
7030
patches = [my_file.read()]
7031
return patch_tree(wt, patches, strip, quiet=is_quiet(), out=self.outf)
7034
class cmd_resolve_location(Command):
7035
__doc__ = """Expand a location to a full URL.
7038
Look up a Launchpad URL.
7040
brz resolve-location lp:brz
7042
takes_args = ['location']
7045
def run(self, location):
7046
from .location import location_to_url
7047
url = location_to_url(location)
7048
display_url = urlutils.unescape_for_display(url, self.outf.encoding)
7049
self.outf.write('%s\n' % display_url)
7052
def _register_lazy_builtins():
7053
# register lazy builtins from other modules; called at startup and should
7054
# be only called once.
7055
for (name, aliases, module_name) in [
7056
('cmd_bisect', [], 'breezy.bisect'),
7057
('cmd_bundle_info', [], 'breezy.bzr.bundle.commands'),
7058
('cmd_config', [], 'breezy.config'),
7059
('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
7060
('cmd_file_id', [], 'breezy.bzr.debug_commands'),
7061
('cmd_file_path', [], 'breezy.bzr.debug_commands'),
7062
('cmd_version_info', [], 'breezy.cmd_version_info'),
7063
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
7064
('cmd_conflicts', [], 'breezy.conflicts'),
7065
('cmd_ping', [], 'breezy.bzr.smart.ping'),
7066
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
7067
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
7068
('cmd_test_script', [], 'breezy.cmd_test_script'),
7070
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
