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
861
help='List entries of a particular kind: file, directory, '
865
takes_args = ['file*']
868
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
869
if kind and kind not in ['file', 'directory', 'symlink']:
870
raise errors.BzrCommandError(
871
gettext('invalid kind %r specified') % (kind,))
873
revision = _get_one_revision('inventory', revision)
874
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
875
self.enter_context(work_tree.lock_read())
876
if revision is not None:
877
tree = revision.as_tree(work_tree.branch)
879
extra_trees = [work_tree]
880
self.enter_context(tree.lock_read())
885
self.enter_context(tree.lock_read())
886
if file_list is not None:
887
paths = tree.find_related_paths_across_trees(
888
file_list, extra_trees, require_versioned=True)
889
# find_ids_across_trees may include some paths that don't
891
entries = tree.iter_entries_by_dir(specific_files=paths)
893
entries = tree.iter_entries_by_dir()
895
for path, entry in sorted(entries):
896
if kind and kind != entry.kind:
901
self.outf.write('%-50s %s\n' % (
902
path, entry.file_id.decode('utf-8')))
904
self.outf.write(path)
905
self.outf.write('\n')
908
class cmd_cp(Command):
909
__doc__ = """Copy a file.
912
brz cp OLDNAME NEWNAME
914
brz cp SOURCE... DESTINATION
916
If the last argument is a versioned directory, all the other names
917
are copied into it. Otherwise, there must be exactly two arguments
918
and the file is copied to a new name.
920
Files cannot be copied between branches. Only files can be copied
924
takes_args = ['names*']
927
encoding_type = 'replace'
929
def run(self, names_list):
930
if names_list is None:
932
if len(names_list) < 2:
933
raise errors.BzrCommandError(gettext("missing file argument"))
934
tree, rel_names = WorkingTree.open_containing_paths(
935
names_list, canonicalize=False)
936
for file_name in rel_names[0:-1]:
938
raise errors.BzrCommandError(
939
gettext("can not copy root of branch"))
940
self.enter_context(tree.lock_tree_write())
941
into_existing = osutils.isdir(names_list[-1])
942
if not into_existing:
944
(src, dst) = rel_names
946
raise errors.BzrCommandError(
947
gettext('to copy multiple files the'
948
' destination must be a versioned'
953
(n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
954
for n in rel_names[:-1]]
956
for src, dst in pairs:
958
src_kind = tree.stored_kind(src)
959
except errors.NoSuchFile:
960
raise errors.BzrCommandError(
961
gettext('Could not copy %s => %s: %s is not versioned.')
964
raise errors.BzrCommandError(
965
gettext('Could not copy %s => %s . %s is not versioned\\.'
967
if src_kind == 'directory':
968
raise errors.BzrCommandError(
969
gettext('Could not copy %s => %s . %s is a directory.'
971
dst_parent = osutils.split(dst)[0]
974
dst_parent_kind = tree.stored_kind(dst_parent)
975
except errors.NoSuchFile:
976
raise errors.BzrCommandError(
977
gettext('Could not copy %s => %s: %s is not versioned.')
978
% (src, dst, dst_parent))
979
if dst_parent_kind != 'directory':
980
raise errors.BzrCommandError(
981
gettext('Could not copy to %s: %s is not a directory.')
982
% (dst_parent, dst_parent))
984
tree.copy_one(src, dst)
987
class cmd_mv(Command):
988
__doc__ = """Move or rename a file.
991
brz mv OLDNAME NEWNAME
993
brz mv SOURCE... DESTINATION
995
If the last argument is a versioned directory, all the other names
996
are moved into it. Otherwise, there must be exactly two arguments
997
and the file is changed to a new name.
999
If OLDNAME does not exist on the filesystem but is versioned and
1000
NEWNAME does exist on the filesystem but is not versioned, mv
1001
assumes that the file has been manually moved and only updates
1002
its internal inventory to reflect that change.
1003
The same is valid when moving many SOURCE files to a DESTINATION.
1005
Files cannot be moved between branches.
1008
takes_args = ['names*']
1009
takes_options = [Option("after", help="Move only the brz identifier"
1010
" of the file, because the file has already been moved."),
1011
Option('auto', help='Automatically guess renames.'),
1013
'dry-run', help='Avoid making changes when guessing renames.'),
1015
aliases = ['move', 'rename']
1016
encoding_type = 'replace'
1018
def run(self, names_list, after=False, auto=False, dry_run=False):
1020
return self.run_auto(names_list, after, dry_run)
1022
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1023
if names_list is None:
1025
if len(names_list) < 2:
1026
raise errors.BzrCommandError(gettext("missing file argument"))
1027
tree, rel_names = WorkingTree.open_containing_paths(
1028
names_list, canonicalize=False)
1029
for file_name in rel_names[0:-1]:
1031
raise errors.BzrCommandError(
1032
gettext("can not move root of branch"))
1033
self.enter_context(tree.lock_tree_write())
1034
self._run(tree, names_list, rel_names, after)
1036
def run_auto(self, names_list, after, dry_run):
1037
if names_list is not None and len(names_list) > 1:
1038
raise errors.BzrCommandError(
1039
gettext('Only one path may be specified to --auto.'))
1041
raise errors.BzrCommandError(
1042
gettext('--after cannot be specified with --auto.'))
1043
work_tree, file_list = WorkingTree.open_containing_paths(
1044
names_list, default_directory='.')
1045
self.enter_context(work_tree.lock_tree_write())
1046
rename_map.RenameMap.guess_renames(
1047
work_tree.basis_tree(), work_tree, dry_run)
1049
def _run(self, tree, names_list, rel_names, after):
1050
into_existing = osutils.isdir(names_list[-1])
1051
if into_existing and len(names_list) == 2:
1053
# a. case-insensitive filesystem and change case of dir
1054
# b. move directory after the fact (if the source used to be
1055
# a directory, but now doesn't exist in the working tree
1056
# and the target is an existing directory, just rename it)
1057
if (not tree.case_sensitive
1058
and rel_names[0].lower() == rel_names[1].lower()):
1059
into_existing = False
1061
# 'fix' the case of a potential 'from'
1062
from_path = tree.get_canonical_path(rel_names[0])
1063
if (not osutils.lexists(names_list[0]) and
1064
tree.is_versioned(from_path) and
1065
tree.stored_kind(from_path) == "directory"):
1066
into_existing = False
1069
# move into existing directory
1070
# All entries reference existing inventory items, so fix them up
1071
# for cicp file-systems.
1072
rel_names = list(tree.get_canonical_paths(rel_names))
1073
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1075
self.outf.write("%s => %s\n" % (src, dest))
1077
if len(names_list) != 2:
1078
raise errors.BzrCommandError(gettext('to mv multiple files the'
1079
' destination must be a versioned'
1082
# for cicp file-systems: the src references an existing inventory
1084
src = tree.get_canonical_path(rel_names[0])
1085
# Find the canonical version of the destination: In all cases, the
1086
# parent of the target must be in the inventory, so we fetch the
1087
# canonical version from there (we do not always *use* the
1088
# canonicalized tail portion - we may be attempting to rename the
1090
canon_dest = tree.get_canonical_path(rel_names[1])
1091
dest_parent = osutils.dirname(canon_dest)
1092
spec_tail = osutils.basename(rel_names[1])
1093
# For a CICP file-system, we need to avoid creating 2 inventory
1094
# entries that differ only by case. So regardless of the case
1095
# we *want* to use (ie, specified by the user or the file-system),
1096
# we must always choose to use the case of any existing inventory
1097
# items. The only exception to this is when we are attempting a
1098
# case-only rename (ie, canonical versions of src and dest are
1100
dest_id = tree.path2id(canon_dest)
1101
if dest_id is None or tree.path2id(src) == dest_id:
1102
# No existing item we care about, so work out what case we
1103
# are actually going to use.
1105
# If 'after' is specified, the tail must refer to a file on disk.
1107
dest_parent_fq = osutils.pathjoin(
1108
tree.basedir, dest_parent)
1110
# pathjoin with an empty tail adds a slash, which breaks
1112
dest_parent_fq = tree.basedir
1114
dest_tail = osutils.canonical_relpath(
1116
osutils.pathjoin(dest_parent_fq, spec_tail))
1118
# not 'after', so case as specified is used
1119
dest_tail = spec_tail
1121
# Use the existing item so 'mv' fails with AlreadyVersioned.
1122
dest_tail = os.path.basename(canon_dest)
1123
dest = osutils.pathjoin(dest_parent, dest_tail)
1124
mutter("attempting to move %s => %s", src, dest)
1125
tree.rename_one(src, dest, after=after)
1127
self.outf.write("%s => %s\n" % (src, dest))
1130
class cmd_pull(Command):
1131
__doc__ = """Turn this branch into a mirror of another branch.
1133
By default, this command only works on branches that have not diverged.
1134
Branches are considered diverged if the destination branch's most recent
1135
commit is one that has not been merged (directly or indirectly) into the
1138
If branches have diverged, you can use 'brz merge' to integrate the changes
1139
from one into the other. Once one branch has merged, the other should
1140
be able to pull it again.
1142
If you want to replace your local changes and just want your branch to
1143
match the remote one, use pull --overwrite. This will work even if the two
1144
branches have diverged.
1146
If there is no default location set, the first pull will set it (use
1147
--no-remember to avoid setting it). After that, you can omit the
1148
location to use the default. To change the default, use --remember. The
1149
value will only be saved if the remote location can be accessed.
1151
The --verbose option will display the revisions pulled using the log_format
1152
configuration option. You can use a different format by overriding it with
1153
-Olog_format=<other_format>.
1155
Note: The location can be specified either in the form of a branch,
1156
or in the form of a path to a file containing a merge directive generated
1160
_see_also = ['push', 'update', 'status-flags', 'send']
1161
takes_options = ['remember', 'overwrite', 'revision',
1162
custom_help('verbose',
1163
help='Show logs of pulled revisions.'),
1164
custom_help('directory',
1165
help='Branch to pull into, '
1166
'rather than the one containing the working directory.'),
1168
help="Perform a local pull in a bound "
1169
"branch. Local pulls are not applied to "
1170
"the master branch."
1173
help="Show base revision text in conflicts."),
1174
Option('overwrite-tags',
1175
help="Overwrite tags only."),
1177
takes_args = ['location?']
1178
encoding_type = 'replace'
1180
def run(self, location=None, remember=None, overwrite=False,
1181
revision=None, verbose=False,
1182
directory=None, local=False,
1183
show_base=False, overwrite_tags=False):
1186
overwrite = ["history", "tags"]
1187
elif overwrite_tags:
1188
overwrite = ["tags"]
1191
# FIXME: too much stuff is in the command class
1194
if directory is None:
1197
tree_to = WorkingTree.open_containing(directory)[0]
1198
branch_to = tree_to.branch
1199
self.enter_context(tree_to.lock_write())
1200
except errors.NoWorkingTree:
1202
branch_to = Branch.open_containing(directory)[0]
1203
self.enter_context(branch_to.lock_write())
1205
warning(gettext("No working tree, ignoring --show-base"))
1207
if local and not branch_to.get_bound_location():
1208
raise errors.LocalRequiresBoundBranch()
1210
possible_transports = []
1211
if location is not None:
1213
mergeable = _mod_mergeable.read_mergeable_from_url(
1214
location, possible_transports=possible_transports)
1215
except errors.NotABundle:
1218
stored_loc = branch_to.get_parent()
1219
if location is None:
1220
if stored_loc is None:
1221
raise errors.BzrCommandError(gettext("No pull location known or"
1224
display_url = urlutils.unescape_for_display(stored_loc,
1228
gettext("Using saved parent location: %s\n") % display_url)
1229
location = stored_loc
1231
revision = _get_one_revision('pull', revision)
1232
if mergeable is not None:
1233
if revision is not None:
1234
raise errors.BzrCommandError(gettext(
1235
'Cannot use -r with merge directives or bundles'))
1236
mergeable.install_revisions(branch_to.repository)
1237
base_revision_id, revision_id, verified = \
1238
mergeable.get_merge_request(branch_to.repository)
1239
branch_from = branch_to
1241
branch_from = Branch.open(location,
1242
possible_transports=possible_transports)
1243
self.enter_context(branch_from.lock_read())
1244
# Remembers if asked explicitly or no previous location is set
1246
or (remember is None and branch_to.get_parent() is None)):
1247
# FIXME: This shouldn't be done before the pull
1248
# succeeds... -- vila 2012-01-02
1249
branch_to.set_parent(branch_from.base)
1251
if revision is not None:
1252
revision_id = revision.as_revision_id(branch_from)
1254
if tree_to is not None:
1255
view_info = _get_view_info_for_change_reporter(tree_to)
1256
change_reporter = delta._ChangeReporter(
1257
unversioned_filter=tree_to.is_ignored,
1258
view_info=view_info)
1259
result = tree_to.pull(
1260
branch_from, overwrite, revision_id, change_reporter,
1261
local=local, show_base=show_base)
1263
result = branch_to.pull(
1264
branch_from, overwrite, revision_id, local=local)
1266
result.report(self.outf)
1267
if verbose and result.old_revid != result.new_revid:
1268
log.show_branch_change(
1269
branch_to, self.outf, result.old_revno,
1271
if getattr(result, 'tag_conflicts', None):
1277
class cmd_push(Command):
1278
__doc__ = """Update a mirror of this branch.
1280
The target branch will not have its working tree populated because this
1281
is both expensive, and is not supported on remote file systems.
1283
Some smart servers or protocols *may* put the working tree in place in
1286
This command only works on branches that have not diverged. Branches are
1287
considered diverged if the destination branch's most recent commit is one
1288
that has not been merged (directly or indirectly) by the source branch.
1290
If branches have diverged, you can use 'brz push --overwrite' to replace
1291
the other branch completely, discarding its unmerged changes.
1293
If you want to ensure you have the different changes in the other branch,
1294
do a merge (see brz help merge) from the other branch, and commit that.
1295
After that you will be able to do a push without '--overwrite'.
1297
If there is no default push location set, the first push will set it (use
1298
--no-remember to avoid setting it). After that, you can omit the
1299
location to use the default. To change the default, use --remember. The
1300
value will only be saved if the remote location can be accessed.
1302
The --verbose option will display the revisions pushed using the log_format
1303
configuration option. You can use a different format by overriding it with
1304
-Olog_format=<other_format>.
1307
_see_also = ['pull', 'update', 'working-trees']
1308
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1309
Option('create-prefix',
1310
help='Create the path leading up to the branch '
1311
'if it does not already exist.'),
1312
custom_help('directory',
1313
help='Branch to push from, '
1314
'rather than the one containing the working directory.'),
1315
Option('use-existing-dir',
1316
help='By default push will fail if the target'
1317
' directory exists, but does not already'
1318
' have a control directory. This flag will'
1319
' allow push to proceed.'),
1321
help='Create a stacked branch that references the public location '
1322
'of the parent branch.'),
1323
Option('stacked-on',
1324
help='Create a stacked branch that refers to another branch '
1325
'for the commit history. Only the work not present in the '
1326
'referenced branch is included in the branch created.',
1329
help='Refuse to push if there are uncommitted changes in'
1330
' the working tree, --no-strict disables the check.'),
1332
help="Don't populate the working tree, even for protocols"
1333
" that support it."),
1334
Option('overwrite-tags',
1335
help="Overwrite tags only."),
1336
Option('lossy', help="Allow lossy push, i.e. dropping metadata "
1337
"that can't be represented in the target.")
1339
takes_args = ['location?']
1340
encoding_type = 'replace'
1342
def run(self, location=None, remember=None, overwrite=False,
1343
create_prefix=False, verbose=False, revision=None,
1344
use_existing_dir=False, directory=None, stacked_on=None,
1345
stacked=False, strict=None, no_tree=False,
1346
overwrite_tags=False, lossy=False):
1347
from .location import location_to_url
1348
from .push import _show_push_branch
1351
overwrite = ["history", "tags"]
1352
elif overwrite_tags:
1353
overwrite = ["tags"]
1357
if directory is None:
1359
# Get the source branch
1361
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1362
# Get the tip's revision_id
1363
revision = _get_one_revision('push', revision)
1364
if revision is not None:
1365
revision_id = revision.in_history(br_from).rev_id
1368
if tree is not None and revision_id is None:
1369
tree.check_changed_or_out_of_date(
1370
strict, 'push_strict',
1371
more_error='Use --no-strict to force the push.',
1372
more_warning='Uncommitted changes will not be pushed.')
1373
# Get the stacked_on branch, if any
1374
if stacked_on is not None:
1375
stacked_on = location_to_url(stacked_on, 'read')
1376
stacked_on = urlutils.normalize_url(stacked_on)
1378
parent_url = br_from.get_parent()
1380
parent = Branch.open(parent_url)
1381
stacked_on = parent.get_public_branch()
1383
# I considered excluding non-http url's here, thus forcing
1384
# 'public' branches only, but that only works for some
1385
# users, so it's best to just depend on the user spotting an
1386
# error by the feedback given to them. RBC 20080227.
1387
stacked_on = parent_url
1389
raise errors.BzrCommandError(gettext(
1390
"Could not determine branch to refer to."))
1392
# Get the destination location
1393
if location is None:
1394
stored_loc = br_from.get_push_location()
1395
if stored_loc is None:
1396
parent_loc = br_from.get_parent()
1398
raise errors.BzrCommandError(gettext(
1399
"No push location known or specified. To push to the "
1400
"parent branch (at %s), use 'brz push :parent'." %
1401
urlutils.unescape_for_display(parent_loc,
1402
self.outf.encoding)))
1404
raise errors.BzrCommandError(gettext(
1405
"No push location known or specified."))
1407
display_url = urlutils.unescape_for_display(stored_loc,
1409
note(gettext("Using saved push location: %s") % display_url)
1410
location = stored_loc
1412
_show_push_branch(br_from, revision_id, location, self.outf,
1413
verbose=verbose, overwrite=overwrite, remember=remember,
1414
stacked_on=stacked_on, create_prefix=create_prefix,
1415
use_existing_dir=use_existing_dir, no_tree=no_tree,
1419
class cmd_branch(Command):
1420
__doc__ = """Create a new branch that is a copy of an existing branch.
1422
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1423
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1424
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1425
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1426
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1429
To retrieve the branch as of a particular revision, supply the --revision
1430
parameter, as in "branch foo/bar -r 5".
1433
_see_also = ['checkout']
1434
takes_args = ['from_location', 'to_location?']
1435
takes_options = ['revision',
1437
'hardlink', help='Hard-link working tree files where possible.'),
1438
Option('files-from', type=text_type,
1439
help="Get file contents from this tree."),
1441
help="Create a branch without a working-tree."),
1443
help="Switch the checkout in the current directory "
1444
"to the new branch."),
1446
help='Create a stacked branch referring to the source branch. '
1447
'The new branch will depend on the availability of the source '
1448
'branch for all operations.'),
1449
Option('standalone',
1450
help='Do not use a shared repository, even if available.'),
1451
Option('use-existing-dir',
1452
help='By default branch will fail if the target'
1453
' directory exists, but does not already'
1454
' have a control directory. This flag will'
1455
' allow branch to proceed.'),
1457
help="Bind new branch to from location."),
1460
def run(self, from_location, to_location=None, revision=None,
1461
hardlink=False, stacked=False, standalone=False, no_tree=False,
1462
use_existing_dir=False, switch=False, bind=False,
1464
from breezy import switch as _mod_switch
1465
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1467
if not (hardlink or files_from):
1468
# accelerator_tree is usually slower because you have to read N
1469
# files (no readahead, lots of seeks, etc), but allow the user to
1470
# explicitly request it
1471
accelerator_tree = None
1472
if files_from is not None and files_from != from_location:
1473
accelerator_tree = WorkingTree.open(files_from)
1474
revision = _get_one_revision('branch', revision)
1475
self.enter_context(br_from.lock_read())
1476
if revision is not None:
1477
revision_id = revision.as_revision_id(br_from)
1479
# FIXME - wt.last_revision, fallback to branch, fall back to
1480
# None or perhaps NULL_REVISION to mean copy nothing
1482
revision_id = br_from.last_revision()
1483
if to_location is None:
1484
to_location = urlutils.derive_to_location(from_location)
1485
to_transport = transport.get_transport(to_location, purpose='write')
1487
to_transport.mkdir('.')
1488
except errors.FileExists:
1490
to_dir = controldir.ControlDir.open_from_transport(
1492
except errors.NotBranchError:
1493
if not use_existing_dir:
1494
raise errors.BzrCommandError(gettext('Target directory "%s" '
1495
'already exists.') % to_location)
1500
to_dir.open_branch()
1501
except errors.NotBranchError:
1504
raise errors.AlreadyBranchError(to_location)
1505
except errors.NoSuchFile:
1506
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1512
# preserve whatever source format we have.
1513
to_dir = br_from.controldir.sprout(
1514
to_transport.base, revision_id,
1515
possible_transports=[to_transport],
1516
accelerator_tree=accelerator_tree, hardlink=hardlink,
1517
stacked=stacked, force_new_repo=standalone,
1518
create_tree_if_local=not no_tree, source_branch=br_from)
1519
branch = to_dir.open_branch(
1520
possible_transports=[
1521
br_from.controldir.root_transport, to_transport])
1522
except errors.NoSuchRevision:
1523
to_transport.delete_tree('.')
1524
msg = gettext("The branch {0} has no revision {1}.").format(
1525
from_location, revision)
1526
raise errors.BzrCommandError(msg)
1529
to_repo = to_dir.open_repository()
1530
except errors.NoRepositoryPresent:
1531
to_repo = to_dir.create_repository()
1532
to_repo.fetch(br_from.repository, revision_id=revision_id)
1533
branch = br_from.sprout(to_dir, revision_id=revision_id)
1534
br_from.tags.merge_to(branch.tags)
1536
# If the source branch is stacked, the new branch may
1537
# be stacked whether we asked for that explicitly or not.
1538
# We therefore need a try/except here and not just 'if stacked:'
1540
note(gettext('Created new stacked branch referring to %s.') %
1541
branch.get_stacked_on_url())
1542
except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
1543
errors.UnstackableRepositoryFormat) as e:
1544
revno = branch.revno()
1545
if revno is not None:
1546
note(ngettext('Branched %d revision.',
1547
'Branched %d revisions.',
1548
branch.revno()) % revno)
1550
note(gettext('Created new branch.'))
1552
# Bind to the parent
1553
parent_branch = Branch.open(from_location)
1554
branch.bind(parent_branch)
1555
note(gettext('New branch bound to %s') % from_location)
1557
# Switch to the new branch
1558
wt, _ = WorkingTree.open_containing('.')
1559
_mod_switch.switch(wt.controldir, branch)
1560
note(gettext('Switched to branch: %s'),
1561
urlutils.unescape_for_display(branch.base, 'utf-8'))
1564
class cmd_branches(Command):
1565
__doc__ = """List the branches available at the current location.
1567
This command will print the names of all the branches at the current
1571
takes_args = ['location?']
1573
Option('recursive', short_name='R',
1574
help='Recursively scan for branches rather than '
1575
'just looking in the specified location.')]
1577
def run(self, location=".", recursive=False):
1579
t = transport.get_transport(location, purpose='read')
1580
if not t.listable():
1581
raise errors.BzrCommandError(
1582
"Can't scan this type of location.")
1583
for b in controldir.ControlDir.find_branches(t):
1584
self.outf.write("%s\n" % urlutils.unescape_for_display(
1585
urlutils.relative_url(t.base, b.base),
1586
self.outf.encoding).rstrip("/"))
1588
dir = controldir.ControlDir.open_containing(location)[0]
1590
active_branch = dir.open_branch(name="")
1591
except errors.NotBranchError:
1592
active_branch = None
1594
for name, branch in iter_sibling_branches(dir):
1597
active = (active_branch is not None and
1598
active_branch.user_url == branch.user_url)
1599
names[name] = active
1600
# Only mention the current branch explicitly if it's not
1601
# one of the colocated branches
1602
if not any(viewvalues(names)) and active_branch is not None:
1603
self.outf.write("* %s\n" % gettext("(default)"))
1604
for name in sorted(names):
1605
active = names[name]
1610
self.outf.write("%s %s\n" % (
1611
prefix, (name if PY3 else name.encode(self.outf.encoding))))
1614
class cmd_checkout(Command):
1615
__doc__ = """Create a new checkout of an existing branch.
1617
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree
1618
for the branch found in '.'. This is useful if you have removed the working
1619
tree or if it was never created - i.e. if you pushed the branch to its
1620
current location using SFTP.
1622
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION
1623
will be used. In other words, "checkout ../foo/bar" will attempt to create
1624
./bar. If the BRANCH_LOCATION has no / or path separator embedded, the
1625
TO_LOCATION is derived from the BRANCH_LOCATION by stripping a leading
1626
scheme or drive identifier, if any. For example, "checkout lp:foo-bar" will
1627
attempt to create ./foo-bar.
1629
To retrieve the branch as of a particular revision, supply the --revision
1630
parameter, as in "checkout foo/bar -r 5". Note that this will be
1631
immediately out of date [so you cannot commit] but it may be useful (i.e.
1632
to examine old code.)
1635
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1636
takes_args = ['branch_location?', 'to_location?']
1637
takes_options = ['revision',
1638
Option('lightweight',
1639
help="Perform a lightweight checkout. Lightweight "
1640
"checkouts depend on access to the branch for "
1641
"every operation. Normal checkouts can perform "
1642
"common operations like diff and status without "
1643
"such access, and also support local commits."
1645
Option('files-from', type=text_type,
1646
help="Get file contents from this tree."),
1648
help='Hard-link working tree files where possible.'
1653
def run(self, branch_location=None, to_location=None, revision=None,
1654
lightweight=False, files_from=None, hardlink=False):
1655
if branch_location is None:
1656
branch_location = osutils.getcwd()
1657
to_location = branch_location
1658
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1660
if not (hardlink or files_from):
1661
# accelerator_tree is usually slower because you have to read N
1662
# files (no readahead, lots of seeks, etc), but allow the user to
1663
# explicitly request it
1664
accelerator_tree = None
1665
revision = _get_one_revision('checkout', revision)
1666
if files_from is not None and files_from != branch_location:
1667
accelerator_tree = WorkingTree.open(files_from)
1668
if revision is not None:
1669
revision_id = revision.as_revision_id(source)
1672
if to_location is None:
1673
to_location = urlutils.derive_to_location(branch_location)
1674
# if the source and to_location are the same,
1675
# and there is no working tree,
1676
# then reconstitute a branch
1677
if osutils.abspath(to_location) == osutils.abspath(branch_location):
1679
source.controldir.open_workingtree()
1680
except errors.NoWorkingTree:
1681
source.controldir.create_workingtree(revision_id)
1683
source.create_checkout(to_location, revision_id, lightweight,
1684
accelerator_tree, hardlink)
1687
class cmd_renames(Command):
1688
__doc__ = """Show list of renamed files.
1690
# TODO: Option to show renames between two historical versions.
1692
# TODO: Only show renames under dir, rather than in the whole branch.
1693
_see_also = ['status']
1694
takes_args = ['dir?']
1697
def run(self, dir=u'.'):
1698
tree = WorkingTree.open_containing(dir)[0]
1699
self.enter_context(tree.lock_read())
1700
old_tree = tree.basis_tree()
1701
self.enter_context(old_tree.lock_read())
1703
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1704
for change in iterator:
1705
if change.path[0] == change.path[1]:
1707
if None in change.path:
1709
renames.append(change.path)
1711
for old_name, new_name in renames:
1712
self.outf.write("%s => %s\n" % (old_name, new_name))
1715
class cmd_update(Command):
1716
__doc__ = """Update a working tree to a new revision.
1718
This will perform a merge of the destination revision (the tip of the
1719
branch, or the specified revision) into the working tree, and then make
1720
that revision the basis revision for the working tree.
1722
You can use this to visit an older revision, or to update a working tree
1723
that is out of date from its branch.
1725
If there are any uncommitted changes in the tree, they will be carried
1726
across and remain as uncommitted changes after the update. To discard
1727
these changes, use 'brz revert'. The uncommitted changes may conflict
1728
with the changes brought in by the change in basis revision.
1730
If the tree's branch is bound to a master branch, brz will also update
1731
the branch from the master.
1733
You cannot update just a single file or directory, because each Breezy
1734
working tree has just a single basis revision. If you want to restore a
1735
file that has been removed locally, use 'brz revert' instead of 'brz
1736
update'. If you want to restore a file to its state in a previous
1737
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1738
out the old content of that file to a new location.
1740
The 'dir' argument, if given, must be the location of the root of a
1741
working tree to update. By default, the working tree that contains the
1742
current working directory is used.
1745
_see_also = ['pull', 'working-trees', 'status-flags']
1746
takes_args = ['dir?']
1747
takes_options = ['revision',
1749
help="Show base revision text in conflicts."),
1753
def run(self, dir=None, revision=None, show_base=None):
1754
if revision is not None and len(revision) != 1:
1755
raise errors.BzrCommandError(gettext(
1756
"brz update --revision takes exactly one revision"))
1758
tree = WorkingTree.open_containing('.')[0]
1760
tree, relpath = WorkingTree.open_containing(dir)
1763
raise errors.BzrCommandError(gettext(
1764
"brz update can only update a whole tree, "
1765
"not a file or subdirectory"))
1766
branch = tree.branch
1767
possible_transports = []
1768
master = branch.get_master_branch(
1769
possible_transports=possible_transports)
1770
if master is not None:
1771
branch_location = master.base
1772
self.enter_context(tree.lock_write())
1774
branch_location = tree.branch.base
1775
self.enter_context(tree.lock_tree_write())
1776
# get rid of the final '/' and be ready for display
1777
branch_location = urlutils.unescape_for_display(
1778
branch_location.rstrip('/'),
1780
existing_pending_merges = tree.get_parent_ids()[1:]
1784
# may need to fetch data into a heavyweight checkout
1785
# XXX: this may take some time, maybe we should display a
1787
old_tip = branch.update(possible_transports)
1788
if revision is not None:
1789
revision_id = revision[0].as_revision_id(branch)
1791
revision_id = branch.last_revision()
1792
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1793
revno = branch.revision_id_to_dotted_revno(revision_id)
1794
note(gettext("Tree is up to date at revision {0} of branch {1}"
1795
).format('.'.join(map(str, revno)), branch_location))
1797
view_info = _get_view_info_for_change_reporter(tree)
1798
change_reporter = delta._ChangeReporter(
1799
unversioned_filter=tree.is_ignored,
1800
view_info=view_info)
1802
conflicts = tree.update(
1804
possible_transports=possible_transports,
1805
revision=revision_id,
1807
show_base=show_base)
1808
except errors.NoSuchRevision as e:
1809
raise errors.BzrCommandError(gettext(
1810
"branch has no revision %s\n"
1811
"brz update --revision only works"
1812
" for a revision in the branch history")
1814
revno = tree.branch.revision_id_to_dotted_revno(
1815
_mod_revision.ensure_null(tree.last_revision()))
1816
note(gettext('Updated to revision {0} of branch {1}').format(
1817
'.'.join(map(str, revno)), branch_location))
1818
parent_ids = tree.get_parent_ids()
1819
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1820
note(gettext('Your local commits will now show as pending merges with '
1821
"'brz status', and can be committed with 'brz commit'."))
1828
class cmd_info(Command):
1829
__doc__ = """Show information about a working tree, branch or repository.
1831
This command will show all known locations and formats associated to the
1832
tree, branch or repository.
1834
In verbose mode, statistical information is included with each report.
1835
To see extended statistic information, use a verbosity level of 2 or
1836
higher by specifying the verbose option multiple times, e.g. -vv.
1838
Branches and working trees will also report any missing revisions.
1842
Display information on the format and related locations:
1846
Display the above together with extended format information and
1847
basic statistics (like the number of files in the working tree and
1848
number of revisions in the branch and repository):
1852
Display the above together with number of committers to the branch:
1856
_see_also = ['revno', 'working-trees', 'repositories']
1857
takes_args = ['location?']
1858
takes_options = ['verbose']
1859
encoding_type = 'replace'
1862
def run(self, location=None, verbose=False):
1864
noise_level = get_verbosity_level()
1867
from .info import show_bzrdir_info
1868
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1869
verbose=noise_level, outfile=self.outf)
1872
class cmd_remove(Command):
1873
__doc__ = """Remove files or directories.
1875
This makes Breezy stop tracking changes to the specified files. Breezy will
1876
delete them if they can easily be recovered using revert otherwise they
1877
will be backed up (adding an extension of the form .~#~). If no options or
1878
parameters are given Breezy will scan for files that are being tracked by
1879
Breezy but missing in your tree and stop tracking them for you.
1881
takes_args = ['file*']
1882
takes_options = ['verbose',
1884
'new', help='Only remove files that have never been committed.'),
1885
RegistryOption.from_kwargs('file-deletion-strategy',
1886
'The file deletion mode to be used.',
1887
title='Deletion Strategy', value_switches=True, enum_switch=False,
1888
safe='Backup changed files (default).',
1889
keep='Delete from brz but leave the working copy.',
1890
no_backup='Don\'t backup changed files.'),
1892
aliases = ['rm', 'del']
1893
encoding_type = 'replace'
1895
def run(self, file_list, verbose=False, new=False,
1896
file_deletion_strategy='safe'):
1898
tree, file_list = WorkingTree.open_containing_paths(file_list)
1900
if file_list is not None:
1901
file_list = [f for f in file_list]
1903
self.enter_context(tree.lock_write())
1904
# Heuristics should probably all move into tree.remove_smart or
1907
added = tree.changes_from(tree.basis_tree(),
1908
specific_files=file_list).added
1909
file_list = sorted([f[0] for f in added], reverse=True)
1910
if len(file_list) == 0:
1911
raise errors.BzrCommandError(gettext('No matching files.'))
1912
elif file_list is None:
1913
# missing files show up in iter_changes(basis) as
1914
# versioned-with-no-kind.
1916
for change in tree.iter_changes(tree.basis_tree()):
1917
# Find paths in the working tree that have no kind:
1918
if change.path[1] is not None and change.kind[1] is None:
1919
missing.append(change.path[1])
1920
file_list = sorted(missing, reverse=True)
1921
file_deletion_strategy = 'keep'
1922
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1923
keep_files=file_deletion_strategy == 'keep',
1924
force=(file_deletion_strategy == 'no-backup'))
1927
class cmd_reconcile(Command):
1928
__doc__ = """Reconcile brz metadata in a branch.
1930
This can correct data mismatches that may have been caused by
1931
previous ghost operations or brz upgrades. You should only
1932
need to run this command if 'brz check' or a brz developer
1933
advises you to run it.
1935
If a second branch is provided, cross-branch reconciliation is
1936
also attempted, which will check that data like the tree root
1937
id which was not present in very early brz versions is represented
1938
correctly in both branches.
1940
At the same time it is run it may recompress data resulting in
1941
a potential saving in disk space or performance gain.
1943
The branch *MUST* be on a listable system such as local disk or sftp.
1946
_see_also = ['check']
1947
takes_args = ['branch?']
1949
Option('canonicalize-chks',
1950
help='Make sure CHKs are in canonical form (repairs '
1955
def run(self, branch=".", canonicalize_chks=False):
1956
from .reconcile import reconcile
1957
dir = controldir.ControlDir.open(branch)
1958
reconcile(dir, canonicalize_chks=canonicalize_chks)
1961
class cmd_revision_history(Command):
1962
__doc__ = """Display the list of revision ids on a branch."""
1965
takes_args = ['location?']
1970
def run(self, location="."):
1971
branch = Branch.open_containing(location)[0]
1972
self.enter_context(branch.lock_read())
1973
graph = branch.repository.get_graph()
1974
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1975
[_mod_revision.NULL_REVISION]))
1976
for revid in reversed(history):
1977
self.outf.write(revid)
1978
self.outf.write('\n')
1981
class cmd_ancestry(Command):
1982
__doc__ = """List all revisions merged into this branch."""
1984
_see_also = ['log', 'revision-history']
1985
takes_args = ['location?']
1990
def run(self, location="."):
1992
wt = WorkingTree.open_containing(location)[0]
1993
except errors.NoWorkingTree:
1994
b = Branch.open(location)
1995
last_revision = b.last_revision()
1998
last_revision = wt.last_revision()
2000
self.enter_context(b.repository.lock_read())
2001
graph = b.repository.get_graph()
2002
revisions = [revid for revid, parents in
2003
graph.iter_ancestry([last_revision])]
2004
for revision_id in reversed(revisions):
2005
if _mod_revision.is_null(revision_id):
2007
self.outf.write(revision_id.decode('utf-8') + '\n')
2010
class cmd_init(Command):
2011
__doc__ = """Make a directory into a versioned branch.
2013
Use this to create an empty branch, or before importing an
2016
If there is a repository in a parent directory of the location, then
2017
the history of the branch will be stored in the repository. Otherwise
2018
init creates a standalone branch which carries its own history
2019
in the .bzr directory.
2021
If there is already a branch at the location but it has no working tree,
2022
the tree can be populated with 'brz checkout'.
2024
Recipe for importing a tree of files::
2030
brz commit -m "imported project"
2033
_see_also = ['init-repository', 'branch', 'checkout']
2034
takes_args = ['location?']
2036
Option('create-prefix',
2037
help='Create the path leading up to the branch '
2038
'if it does not already exist.'),
2039
RegistryOption('format',
2040
help='Specify a format for this branch. '
2041
'See "help formats" for a full list.',
2042
lazy_registry=('breezy.controldir', 'format_registry'),
2043
converter=lambda name: controldir.format_registry.make_controldir(
2045
value_switches=True,
2046
title="Branch format",
2048
Option('append-revisions-only',
2049
help='Never change revnos or the existing log.'
2050
' Append revisions to it only.'),
2052
'Create a branch without a working tree.')
2055
def run(self, location=None, format=None, append_revisions_only=False,
2056
create_prefix=False, no_tree=False):
2058
format = controldir.format_registry.make_controldir('default')
2059
if location is None:
2062
to_transport = transport.get_transport(location, purpose='write')
2064
# The path has to exist to initialize a
2065
# branch inside of it.
2066
# Just using os.mkdir, since I don't
2067
# believe that we want to create a bunch of
2068
# locations if the user supplies an extended path
2070
to_transport.ensure_base()
2071
except errors.NoSuchFile:
2072
if not create_prefix:
2073
raise errors.BzrCommandError(gettext("Parent directory of %s"
2075
"\nYou may supply --create-prefix to create all"
2076
" leading parent directories.")
2078
to_transport.create_prefix()
2081
a_controldir = controldir.ControlDir.open_from_transport(
2083
except errors.NotBranchError:
2084
# really a NotBzrDir error...
2085
create_branch = controldir.ControlDir.create_branch_convenience
2087
force_new_tree = False
2089
force_new_tree = None
2090
branch = create_branch(to_transport.base, format=format,
2091
possible_transports=[to_transport],
2092
force_new_tree=force_new_tree)
2093
a_controldir = branch.controldir
2095
from .transport.local import LocalTransport
2096
if a_controldir.has_branch():
2097
if (isinstance(to_transport, LocalTransport)
2098
and not a_controldir.has_workingtree()):
2099
raise errors.BranchExistsWithoutWorkingTree(location)
2100
raise errors.AlreadyBranchError(location)
2101
branch = a_controldir.create_branch()
2102
if not no_tree and not a_controldir.has_workingtree():
2103
a_controldir.create_workingtree()
2104
if append_revisions_only:
2106
branch.set_append_revisions_only(True)
2107
except errors.UpgradeRequired:
2108
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2109
' to append-revisions-only. Try --default.'))
2111
from .info import describe_layout, describe_format
2113
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2114
except (errors.NoWorkingTree, errors.NotLocalUrl):
2116
repository = branch.repository
2117
layout = describe_layout(repository, branch, tree).lower()
2118
format = describe_format(a_controldir, repository, branch, tree)
2119
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2121
if repository.is_shared():
2122
# XXX: maybe this can be refactored into transport.path_or_url()
2123
url = repository.controldir.root_transport.external_url()
2125
url = urlutils.local_path_from_url(url)
2126
except urlutils.InvalidURL:
2128
self.outf.write(gettext("Using shared repository: %s\n") % url)
2131
class cmd_init_repository(Command):
2132
__doc__ = """Create a shared repository for branches to share storage space.
2134
New branches created under the repository directory will store their
2135
revisions in the repository, not in the branch directory. For branches
2136
with shared history, this reduces the amount of storage needed and
2137
speeds up the creation of new branches.
2139
If the --no-trees option is given then the branches in the repository
2140
will not have working trees by default. They will still exist as
2141
directories on disk, but they will not have separate copies of the
2142
files at a certain revision. This can be useful for repositories that
2143
store branches which are interacted with through checkouts or remote
2144
branches, such as on a server.
2147
Create a shared repository holding just branches::
2149
brz init-repo --no-trees repo
2152
Make a lightweight checkout elsewhere::
2154
brz checkout --lightweight repo/trunk trunk-checkout
2159
_see_also = ['init', 'branch', 'checkout', 'repositories']
2160
takes_args = ["location"]
2161
takes_options = [RegistryOption('format',
2162
help='Specify a format for this repository. See'
2163
' "brz help formats" for details.',
2165
'breezy.controldir', 'format_registry'),
2166
converter=lambda name: controldir.format_registry.make_controldir(
2168
value_switches=True, title='Repository format'),
2170
help='Branches in the repository will default to'
2171
' not having a working tree.'),
2173
aliases = ["init-repo"]
2175
def run(self, location, format=None, no_trees=False):
2177
format = controldir.format_registry.make_controldir('default')
2179
if location is None:
2182
to_transport = transport.get_transport(location, purpose='write')
2184
if format.fixed_components:
2185
repo_format_name = None
2187
repo_format_name = format.repository_format.get_format_string()
2189
(repo, newdir, require_stacking, repository_policy) = (
2190
format.initialize_on_transport_ex(to_transport,
2191
create_prefix=True, make_working_trees=not no_trees,
2192
shared_repo=True, force_new_repo=True,
2193
use_existing_dir=True,
2194
repo_format_name=repo_format_name))
2196
from .info import show_bzrdir_info
2197
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2200
class cmd_diff(Command):
2201
__doc__ = """Show differences in the working tree, between revisions or branches.
2203
If no arguments are given, all changes for the current tree are listed.
2204
If files are given, only the changes in those files are listed.
2205
Remote and multiple branches can be compared by using the --old and
2206
--new options. If not provided, the default for both is derived from
2207
the first argument, if any, or the current tree if no arguments are
2210
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2211
produces patches suitable for "patch -p1".
2213
Note that when using the -r argument with a range of revisions, the
2214
differences are computed between the two specified revisions. That
2215
is, the command does not show the changes introduced by the first
2216
revision in the range. This differs from the interpretation of
2217
revision ranges used by "brz log" which includes the first revision
2222
2 - unrepresentable changes
2227
Shows the difference in the working tree versus the last commit::
2231
Difference between the working tree and revision 1::
2235
Difference between revision 3 and revision 1::
2239
Difference between revision 3 and revision 1 for branch xxx::
2243
The changes introduced by revision 2 (equivalent to -r1..2)::
2247
To see the changes introduced by revision X::
2251
Note that in the case of a merge, the -c option shows the changes
2252
compared to the left hand parent. To see the changes against
2253
another parent, use::
2255
brz diff -r<chosen_parent>..X
2257
The changes between the current revision and the previous revision
2258
(equivalent to -c-1 and -r-2..-1)
2262
Show just the differences for file NEWS::
2266
Show the differences in working tree xxx for file NEWS::
2270
Show the differences from branch xxx to this working tree:
2274
Show the differences between two branches for file NEWS::
2276
brz diff --old xxx --new yyy NEWS
2278
Same as 'brz diff' but prefix paths with old/ and new/::
2280
brz diff --prefix old/:new/
2282
Show the differences using a custom diff program with options::
2284
brz diff --using /usr/bin/diff --diff-options -wu
2286
_see_also = ['status']
2287
takes_args = ['file*']
2289
Option('diff-options', type=text_type,
2290
help='Pass these options to the external diff program.'),
2291
Option('prefix', type=text_type,
2293
help='Set prefixes added to old and new filenames, as '
2294
'two values separated by a colon. (eg "old/:new/").'),
2296
help='Branch/tree to compare from.',
2300
help='Branch/tree to compare to.',
2306
help='Use this command to compare files.',
2309
RegistryOption('format',
2311
help='Diff format to use.',
2312
lazy_registry=('breezy.diff', 'format_registry'),
2313
title='Diff format'),
2315
help='How many lines of context to show.',
2319
aliases = ['di', 'dif']
2320
encoding_type = 'exact'
2323
def run(self, revision=None, file_list=None, diff_options=None,
2324
prefix=None, old=None, new=None, using=None, format=None,
2326
from .diff import (get_trees_and_branches_to_diff_locked,
2333
elif prefix == u'1' or prefix is None:
2336
elif u':' in prefix:
2337
old_label, new_label = prefix.split(u":")
2339
raise errors.BzrCommandError(gettext(
2340
'--prefix expects two values separated by a colon'
2341
' (eg "old/:new/")'))
2343
if revision and len(revision) > 2:
2344
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2345
' one or two revision specifiers'))
2347
if using is not None and format is not None:
2348
raise errors.BzrCommandError(gettext(
2349
'{0} and {1} are mutually exclusive').format(
2350
'--using', '--format'))
2352
(old_tree, new_tree,
2353
old_branch, new_branch,
2354
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2355
file_list, revision, old, new, self._exit_stack, apply_view=True)
2356
# GNU diff on Windows uses ANSI encoding for filenames
2357
path_encoding = osutils.get_diff_header_encoding()
2358
return show_diff_trees(old_tree, new_tree, self.outf,
2359
specific_files=specific_files,
2360
external_diff_options=diff_options,
2361
old_label=old_label, new_label=new_label,
2362
extra_trees=extra_trees,
2363
path_encoding=path_encoding,
2364
using=using, context=context,
2368
class cmd_deleted(Command):
2369
__doc__ = """List files deleted in the working tree.
2371
# TODO: Show files deleted since a previous revision, or
2372
# between two revisions.
2373
# TODO: Much more efficient way to do this: read in new
2374
# directories with readdir, rather than stating each one. Same
2375
# level of effort but possibly much less IO. (Or possibly not,
2376
# if the directories are very large...)
2377
_see_also = ['status', 'ls']
2378
takes_options = ['directory', 'show-ids']
2381
def run(self, show_ids=False, directory=u'.'):
2382
tree = WorkingTree.open_containing(directory)[0]
2383
self.enter_context(tree.lock_read())
2384
old = tree.basis_tree()
2385
self.enter_context(old.lock_read())
2386
for path, ie in old.iter_entries_by_dir():
2387
if not tree.has_id(ie.file_id):
2388
self.outf.write(path)
2390
self.outf.write(' ')
2391
self.outf.write(ie.file_id)
2392
self.outf.write('\n')
2395
class cmd_modified(Command):
2396
__doc__ = """List files modified in working tree.
2400
_see_also = ['status', 'ls']
2401
takes_options = ['directory', 'null']
2404
def run(self, null=False, directory=u'.'):
2405
tree = WorkingTree.open_containing(directory)[0]
2406
self.enter_context(tree.lock_read())
2407
td = tree.changes_from(tree.basis_tree())
2409
for path, id, kind, text_modified, meta_modified in td.modified:
2411
self.outf.write(path + '\0')
2413
self.outf.write(osutils.quotefn(path) + '\n')
2416
class cmd_added(Command):
2417
__doc__ = """List files added in working tree.
2421
_see_also = ['status', 'ls']
2422
takes_options = ['directory', 'null']
2425
def run(self, null=False, directory=u'.'):
2426
wt = WorkingTree.open_containing(directory)[0]
2427
self.enter_context(wt.lock_read())
2428
basis = wt.basis_tree()
2429
self.enter_context(basis.lock_read())
2430
for path in wt.all_versioned_paths():
2431
if basis.has_filename(path):
2435
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2438
self.outf.write(path + '\0')
2440
self.outf.write(osutils.quotefn(path) + '\n')
2443
class cmd_root(Command):
2444
__doc__ = """Show the tree root directory.
2446
The root is the nearest enclosing directory with a control
2449
takes_args = ['filename?']
2452
def run(self, filename=None):
2453
"""Print the branch root."""
2454
tree = WorkingTree.open_containing(filename)[0]
2455
self.outf.write(tree.basedir + '\n')
2458
def _parse_limit(limitstring):
2460
return int(limitstring)
2462
msg = gettext("The limit argument must be an integer.")
2463
raise errors.BzrCommandError(msg)
2466
def _parse_levels(s):
2470
msg = gettext("The levels argument must be an integer.")
2471
raise errors.BzrCommandError(msg)
2474
class cmd_log(Command):
2475
__doc__ = """Show historical log for a branch or subset of a branch.
2477
log is brz's default tool for exploring the history of a branch.
2478
The branch to use is taken from the first parameter. If no parameters
2479
are given, the branch containing the working directory is logged.
2480
Here are some simple examples::
2482
brz log log the current branch
2483
brz log foo.py log a file in its branch
2484
brz log http://server/branch log a branch on a server
2486
The filtering, ordering and information shown for each revision can
2487
be controlled as explained below. By default, all revisions are
2488
shown sorted (topologically) so that newer revisions appear before
2489
older ones and descendants always appear before ancestors. If displayed,
2490
merged revisions are shown indented under the revision in which they
2495
The log format controls how information about each revision is
2496
displayed. The standard log formats are called ``long``, ``short``
2497
and ``line``. The default is long. See ``brz help log-formats``
2498
for more details on log formats.
2500
The following options can be used to control what information is
2503
-l N display a maximum of N revisions
2504
-n N display N levels of revisions (0 for all, 1 for collapsed)
2505
-v display a status summary (delta) for each revision
2506
-p display a diff (patch) for each revision
2507
--show-ids display revision-ids (and file-ids), not just revnos
2509
Note that the default number of levels to display is a function of the
2510
log format. If the -n option is not used, the standard log formats show
2511
just the top level (mainline).
2513
Status summaries are shown using status flags like A, M, etc. To see
2514
the changes explained using words like ``added`` and ``modified``
2515
instead, use the -vv option.
2519
To display revisions from oldest to newest, use the --forward option.
2520
In most cases, using this option will have little impact on the total
2521
time taken to produce a log, though --forward does not incrementally
2522
display revisions like --reverse does when it can.
2524
:Revision filtering:
2526
The -r option can be used to specify what revision or range of revisions
2527
to filter against. The various forms are shown below::
2529
-rX display revision X
2530
-rX.. display revision X and later
2531
-r..Y display up to and including revision Y
2532
-rX..Y display from X to Y inclusive
2534
See ``brz help revisionspec`` for details on how to specify X and Y.
2535
Some common examples are given below::
2537
-r-1 show just the tip
2538
-r-10.. show the last 10 mainline revisions
2539
-rsubmit:.. show what's new on this branch
2540
-rancestor:path.. show changes since the common ancestor of this
2541
branch and the one at location path
2542
-rdate:yesterday.. show changes since yesterday
2544
When logging a range of revisions using -rX..Y, log starts at
2545
revision Y and searches back in history through the primary
2546
("left-hand") parents until it finds X. When logging just the
2547
top level (using -n1), an error is reported if X is not found
2548
along the way. If multi-level logging is used (-n0), X may be
2549
a nested merge revision and the log will be truncated accordingly.
2553
If parameters are given and the first one is not a branch, the log
2554
will be filtered to show only those revisions that changed the
2555
nominated files or directories.
2557
Filenames are interpreted within their historical context. To log a
2558
deleted file, specify a revision range so that the file existed at
2559
the end or start of the range.
2561
Historical context is also important when interpreting pathnames of
2562
renamed files/directories. Consider the following example:
2564
* revision 1: add tutorial.txt
2565
* revision 2: modify tutorial.txt
2566
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2570
* ``brz log guide.txt`` will log the file added in revision 1
2572
* ``brz log tutorial.txt`` will log the new file added in revision 3
2574
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2575
the original file in revision 2.
2577
* ``brz log -r2 -p guide.txt`` will display an error message as there
2578
was no file called guide.txt in revision 2.
2580
Renames are always followed by log. By design, there is no need to
2581
explicitly ask for this (and no way to stop logging a file back
2582
until it was last renamed).
2586
The --match option can be used for finding revisions that match a
2587
regular expression in a commit message, committer, author or bug.
2588
Specifying the option several times will match any of the supplied
2589
expressions. --match-author, --match-bugs, --match-committer and
2590
--match-message can be used to only match a specific field.
2594
GUI tools and IDEs are often better at exploring history than command
2595
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2596
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2597
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2598
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2600
You may find it useful to add the aliases below to ``breezy.conf``::
2604
top = log -l10 --line
2607
``brz tip`` will then show the latest revision while ``brz top``
2608
will show the last 10 mainline revisions. To see the details of a
2609
particular revision X, ``brz show -rX``.
2611
If you are interested in looking deeper into a particular merge X,
2612
use ``brz log -n0 -rX``.
2614
``brz log -v`` on a branch with lots of history is currently
2615
very slow. A fix for this issue is currently under development.
2616
With or without that fix, it is recommended that a revision range
2617
be given when using the -v option.
2619
brz has a generic full-text matching plugin, brz-search, that can be
2620
used to find revisions matching user names, commit messages, etc.
2621
Among other features, this plugin can find all revisions containing
2622
a list of words but not others.
2624
When exploring non-mainline history on large projects with deep
2625
history, the performance of log can be greatly improved by installing
2626
the historycache plugin. This plugin buffers historical information
2627
trading disk space for faster speed.
2629
takes_args = ['file*']
2630
_see_also = ['log-formats', 'revisionspec']
2633
help='Show from oldest to newest.'),
2635
custom_help('verbose',
2636
help='Show files changed in each revision.'),
2640
type=breezy.option._parse_revision_str,
2642
help='Show just the specified revision.'
2643
' See also "help revisionspec".'),
2645
RegistryOption('authors',
2646
'What names to list as authors - first, all or committer.',
2649
'breezy.log', 'author_list_registry'),
2653
help='Number of levels to display - 0 for all, 1 for flat.',
2655
type=_parse_levels),
2657
help='Show revisions whose message matches this '
2658
'regular expression.',
2663
help='Limit the output to the first N revisions.',
2668
help='Show changes made in each revision as a patch.'),
2669
Option('include-merged',
2670
help='Show merged revisions like --levels 0 does.'),
2671
Option('include-merges', hidden=True,
2672
help='Historical alias for --include-merged.'),
2673
Option('omit-merges',
2674
help='Do not report commits with more than one parent.'),
2675
Option('exclude-common-ancestry',
2676
help='Display only the revisions that are not part'
2677
' of both ancestries (require -rX..Y).'
2679
Option('signatures',
2680
help='Show digital signature validity.'),
2683
help='Show revisions whose properties match this '
2686
ListOption('match-message',
2687
help='Show revisions whose message matches this '
2690
ListOption('match-committer',
2691
help='Show revisions whose committer matches this '
2694
ListOption('match-author',
2695
help='Show revisions whose authors match this '
2698
ListOption('match-bugs',
2699
help='Show revisions whose bugs match this '
2703
encoding_type = 'replace'
2706
def run(self, file_list=None, timezone='original',
2717
include_merged=None,
2719
exclude_common_ancestry=False,
2723
match_committer=None,
2730
make_log_request_dict,
2731
_get_info_for_log_files,
2733
direction = (forward and 'forward') or 'reverse'
2734
if include_merged is None:
2735
include_merged = False
2736
if (exclude_common_ancestry
2737
and (revision is None or len(revision) != 2)):
2738
raise errors.BzrCommandError(gettext(
2739
'--exclude-common-ancestry requires -r with two revisions'))
2744
raise errors.BzrCommandError(gettext(
2745
'{0} and {1} are mutually exclusive').format(
2746
'--levels', '--include-merged'))
2748
if change is not None:
2750
raise errors.RangeInChangeOption()
2751
if revision is not None:
2752
raise errors.BzrCommandError(gettext(
2753
'{0} and {1} are mutually exclusive').format(
2754
'--revision', '--change'))
2759
filter_by_dir = False
2761
# find the file ids to log and check for directory filtering
2762
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2763
revision, file_list, self._exit_stack)
2764
for relpath, file_id, kind in file_info_list:
2766
raise errors.BzrCommandError(gettext(
2767
"Path unknown at end or start of revision range: %s") %
2769
# If the relpath is the top of the tree, we log everything
2774
file_ids.append(file_id)
2775
filter_by_dir = filter_by_dir or (
2776
kind in ['directory', 'tree-reference'])
2779
# FIXME ? log the current subdir only RBC 20060203
2780
if revision is not None \
2781
and len(revision) > 0 and revision[0].get_branch():
2782
location = revision[0].get_branch()
2785
dir, relpath = controldir.ControlDir.open_containing(location)
2786
b = dir.open_branch()
2787
self.enter_context(b.lock_read())
2788
rev1, rev2 = _get_revision_range(revision, b, self.name())
2790
if b.get_config_stack().get('validate_signatures_in_log'):
2794
if not gpg.GPGStrategy.verify_signatures_available():
2795
raise errors.GpgmeNotInstalled(None)
2797
# Decide on the type of delta & diff filtering to use
2798
# TODO: add an --all-files option to make this configurable & consistent
2806
diff_type = 'partial'
2810
# Build the log formatter
2811
if log_format is None:
2812
log_format = log.log_formatter_registry.get_default(b)
2813
# Make a non-encoding output to include the diffs - bug 328007
2814
unencoded_output = ui.ui_factory.make_output_stream(
2815
encoding_type='exact')
2816
lf = log_format(show_ids=show_ids, to_file=self.outf,
2817
to_exact_file=unencoded_output,
2818
show_timezone=timezone,
2819
delta_format=get_verbosity_level(),
2821
show_advice=levels is None,
2822
author_list_handler=authors)
2824
# Choose the algorithm for doing the logging. It's annoying
2825
# having multiple code paths like this but necessary until
2826
# the underlying repository format is faster at generating
2827
# deltas or can provide everything we need from the indices.
2828
# The default algorithm - match-using-deltas - works for
2829
# multiple files and directories and is faster for small
2830
# amounts of history (200 revisions say). However, it's too
2831
# slow for logging a single file in a repository with deep
2832
# history, i.e. > 10K revisions. In the spirit of "do no
2833
# evil when adding features", we continue to use the
2834
# original algorithm - per-file-graph - for the "single
2835
# file that isn't a directory without showing a delta" case.
2836
partial_history = revision and b.repository._format.supports_chks
2837
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2838
or delta_type or partial_history)
2842
match_dict[''] = match
2844
match_dict['message'] = match_message
2846
match_dict['committer'] = match_committer
2848
match_dict['author'] = match_author
2850
match_dict['bugs'] = match_bugs
2852
# Build the LogRequest and execute it
2853
if len(file_ids) == 0:
2855
rqst = make_log_request_dict(
2856
direction=direction, specific_fileids=file_ids,
2857
start_revision=rev1, end_revision=rev2, limit=limit,
2858
message_search=message, delta_type=delta_type,
2859
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2860
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2861
signature=signatures, omit_merges=omit_merges,
2863
Logger(b, rqst).show(lf)
2866
def _get_revision_range(revisionspec_list, branch, command_name):
2867
"""Take the input of a revision option and turn it into a revision range.
2869
It returns RevisionInfo objects which can be used to obtain the rev_id's
2870
of the desired revisions. It does some user input validations.
2872
if revisionspec_list is None:
2875
elif len(revisionspec_list) == 1:
2876
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2877
elif len(revisionspec_list) == 2:
2878
start_spec = revisionspec_list[0]
2879
end_spec = revisionspec_list[1]
2880
if end_spec.get_branch() != start_spec.get_branch():
2881
# b is taken from revision[0].get_branch(), and
2882
# show_log will use its revision_history. Having
2883
# different branches will lead to weird behaviors.
2884
raise errors.BzrCommandError(gettext(
2885
"brz %s doesn't accept two revisions in different"
2886
" branches.") % command_name)
2887
if start_spec.spec is None:
2888
# Avoid loading all the history.
2889
rev1 = RevisionInfo(branch, None, None)
2891
rev1 = start_spec.in_history(branch)
2892
# Avoid loading all of history when we know a missing
2893
# end of range means the last revision ...
2894
if end_spec.spec is None:
2895
last_revno, last_revision_id = branch.last_revision_info()
2896
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2898
rev2 = end_spec.in_history(branch)
2900
raise errors.BzrCommandError(gettext(
2901
'brz %s --revision takes one or two values.') % command_name)
2905
def _revision_range_to_revid_range(revision_range):
2908
if revision_range[0] is not None:
2909
rev_id1 = revision_range[0].rev_id
2910
if revision_range[1] is not None:
2911
rev_id2 = revision_range[1].rev_id
2912
return rev_id1, rev_id2
2915
def get_log_format(long=False, short=False, line=False, default='long'):
2916
log_format = default
2920
log_format = 'short'
2926
class cmd_touching_revisions(Command):
2927
__doc__ = """Return revision-ids which affected a particular file.
2929
A more user-friendly interface is "brz log FILE".
2933
takes_args = ["filename"]
2936
def run(self, filename):
2937
tree, relpath = WorkingTree.open_containing(filename)
2938
with tree.lock_read():
2939
touching_revs = log.find_touching_revisions(
2940
tree.branch.repository, tree.branch.last_revision(), tree, relpath)
2941
for revno, revision_id, what in reversed(list(touching_revs)):
2942
self.outf.write("%6d %s\n" % (revno, what))
2945
class cmd_ls(Command):
2946
__doc__ = """List files in a tree.
2949
_see_also = ['status', 'cat']
2950
takes_args = ['path?']
2954
Option('recursive', short_name='R',
2955
help='Recurse into subdirectories.'),
2957
help='Print paths relative to the root of the branch.'),
2958
Option('unknown', short_name='u',
2959
help='Print unknown files.'),
2960
Option('versioned', help='Print versioned files.',
2962
Option('ignored', short_name='i',
2963
help='Print ignored files.'),
2964
Option('kind', short_name='k',
2965
help=('List entries of a particular kind: file, '
2966
'directory, symlink, tree-reference.'),
2974
def run(self, revision=None, verbose=False,
2975
recursive=False, from_root=False,
2976
unknown=False, versioned=False, ignored=False,
2977
null=False, kind=None, show_ids=False, path=None, directory=None):
2979
if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
2980
raise errors.BzrCommandError(gettext('invalid kind specified'))
2982
if verbose and null:
2983
raise errors.BzrCommandError(
2984
gettext('Cannot set both --verbose and --null'))
2985
all = not (unknown or versioned or ignored)
2987
selection = {'I': ignored, '?': unknown, 'V': versioned}
2993
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2996
tree, branch, relpath = \
2997
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2999
# Calculate the prefix to use
3003
prefix = relpath + '/'
3004
elif fs_path != '.' and not fs_path.endswith('/'):
3005
prefix = fs_path + '/'
3007
if revision is not None or tree is None:
3008
tree = _get_one_revision_tree('ls', revision, branch=branch)
3011
if isinstance(tree, WorkingTree) and tree.supports_views():
3012
view_files = tree.views.lookup_view()
3015
view_str = views.view_display_str(view_files)
3016
note(gettext("Ignoring files outside view. View is %s") % view_str)
3018
self.enter_context(tree.lock_read())
3019
for fp, fc, fkind, entry in tree.list_files(
3020
include_root=False, from_dir=relpath, recursive=recursive):
3021
# Apply additional masking
3022
if not all and not selection[fc]:
3024
if kind is not None and fkind != kind:
3029
fullpath = osutils.pathjoin(relpath, fp)
3032
views.check_path_in_view(tree, fullpath)
3033
except views.FileOutsideView:
3038
fp = osutils.pathjoin(prefix, fp)
3039
kindch = entry.kind_character()
3040
outstring = fp + kindch
3041
ui.ui_factory.clear_term()
3043
outstring = '%-8s %s' % (fc, outstring)
3044
if show_ids and getattr(entry, 'file_id', None) is not None:
3045
outstring = "%-50s %s" % (outstring, entry.file_id.decode('utf-8'))
3046
self.outf.write(outstring + '\n')
3048
self.outf.write(fp + '\0')
3050
if getattr(entry, 'file_id', None) is not None:
3051
self.outf.write(entry.file_id.decode('utf-8'))
3052
self.outf.write('\0')
3056
if getattr(entry, 'file_id', None) is not None:
3057
my_id = entry.file_id.decode('utf-8')
3060
self.outf.write('%-50s %s\n' % (outstring, my_id))
3062
self.outf.write(outstring + '\n')
3065
class cmd_unknowns(Command):
3066
__doc__ = """List unknown files.
3071
takes_options = ['directory']
3074
def run(self, directory=u'.'):
3075
for f in WorkingTree.open_containing(directory)[0].unknowns():
3076
self.outf.write(osutils.quotefn(f) + '\n')
3079
class cmd_ignore(Command):
3080
__doc__ = """Ignore specified files or patterns.
3082
See ``brz help patterns`` for details on the syntax of patterns.
3084
If a .bzrignore file does not exist, the ignore command
3085
will create one and add the specified files or patterns to the newly
3086
created file. The ignore command will also automatically add the
3087
.bzrignore file to be versioned. Creating a .bzrignore file without
3088
the use of the ignore command will require an explicit add command.
3090
To remove patterns from the ignore list, edit the .bzrignore file.
3091
After adding, editing or deleting that file either indirectly by
3092
using this command or directly by using an editor, be sure to commit
3095
Breezy also supports a global ignore file ~/.config/breezy/ignore. On
3096
Windows the global ignore file can be found in the application data
3098
C:\\Documents and Settings\\<user>\\Application Data\\Breezy\\3.0\\ignore.
3099
Global ignores are not touched by this command. The global ignore file
3100
can be edited directly using an editor.
3102
Patterns prefixed with '!' are exceptions to ignore patterns and take
3103
precedence over regular ignores. Such exceptions are used to specify
3104
files that should be versioned which would otherwise be ignored.
3106
Patterns prefixed with '!!' act as regular ignore patterns, but have
3107
precedence over the '!' exception patterns.
3111
* Ignore patterns containing shell wildcards must be quoted from
3114
* Ignore patterns starting with "#" act as comments in the ignore file.
3115
To ignore patterns that begin with that character, use the "RE:" prefix.
3118
Ignore the top level Makefile::
3120
brz ignore ./Makefile
3122
Ignore .class files in all directories...::
3124
brz ignore "*.class"
3126
...but do not ignore "special.class"::
3128
brz ignore "!special.class"
3130
Ignore files whose name begins with the "#" character::
3134
Ignore .o files under the lib directory::
3136
brz ignore "lib/**/*.o"
3138
Ignore .o files under the lib directory::
3140
brz ignore "RE:lib/.*\\.o"
3142
Ignore everything but the "debian" toplevel directory::
3144
brz ignore "RE:(?!debian/).*"
3146
Ignore everything except the "local" toplevel directory,
3147
but always ignore autosave files ending in ~, even under local/::
3150
brz ignore "!./local"
3154
_see_also = ['status', 'ignored', 'patterns']
3155
takes_args = ['name_pattern*']
3156
takes_options = ['directory',
3157
Option('default-rules',
3158
help='Display the default ignore rules that brz uses.')
3161
def run(self, name_pattern_list=None, default_rules=None,
3163
from breezy import ignores
3164
if default_rules is not None:
3165
# dump the default rules and exit
3166
for pattern in ignores.USER_DEFAULTS:
3167
self.outf.write("%s\n" % pattern)
3169
if not name_pattern_list:
3170
raise errors.BzrCommandError(gettext("ignore requires at least one "
3171
"NAME_PATTERN or --default-rules."))
3172
name_pattern_list = [globbing.normalize_pattern(p)
3173
for p in name_pattern_list]
3175
bad_patterns_count = 0
3176
for p in name_pattern_list:
3177
if not globbing.Globster.is_pattern_valid(p):
3178
bad_patterns_count += 1
3179
bad_patterns += ('\n %s' % p)
3181
msg = (ngettext('Invalid ignore pattern found. %s',
3182
'Invalid ignore patterns found. %s',
3183
bad_patterns_count) % bad_patterns)
3184
ui.ui_factory.show_error(msg)
3185
raise lazy_regex.InvalidPattern('')
3186
for name_pattern in name_pattern_list:
3187
if (name_pattern[0] == '/' or
3188
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3189
raise errors.BzrCommandError(gettext(
3190
"NAME_PATTERN should not be an absolute path"))
3191
tree, relpath = WorkingTree.open_containing(directory)
3192
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3193
ignored = globbing.Globster(name_pattern_list)
3195
self.enter_context(tree.lock_read())
3196
for filename, fc, fkind, entry in tree.list_files():
3197
id = getattr(entry, 'file_id', None)
3199
if ignored.match(filename):
3200
matches.append(filename)
3201
if len(matches) > 0:
3202
self.outf.write(gettext("Warning: the following files are version "
3203
"controlled and match your ignore pattern:\n%s"
3204
"\nThese files will continue to be version controlled"
3205
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3208
class cmd_ignored(Command):
3209
__doc__ = """List ignored files and the patterns that matched them.
3211
List all the ignored files and the ignore pattern that caused the file to
3214
Alternatively, to list just the files::
3219
encoding_type = 'replace'
3220
_see_also = ['ignore', 'ls']
3221
takes_options = ['directory']
3224
def run(self, directory=u'.'):
3225
tree = WorkingTree.open_containing(directory)[0]
3226
self.enter_context(tree.lock_read())
3227
for path, file_class, kind, entry in tree.list_files():
3228
if file_class != 'I':
3230
# XXX: Slightly inefficient since this was already calculated
3231
pat = tree.is_ignored(path)
3232
self.outf.write('%-50s %s\n' % (path, pat))
3235
class cmd_lookup_revision(Command):
3236
__doc__ = """Lookup the revision-id from a revision-number
3239
brz lookup-revision 33
3242
takes_args = ['revno']
3243
takes_options = ['directory']
3246
def run(self, revno, directory=u'.'):
3250
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3252
revid = WorkingTree.open_containing(
3253
directory)[0].branch.get_rev_id(revno)
3254
self.outf.write("%s\n" % revid.decode('utf-8'))
3257
class cmd_export(Command):
3258
__doc__ = """Export current or past revision to a destination directory or archive.
3260
If no revision is specified this exports the last committed revision.
3262
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3263
given, try to find the format with the extension. If no extension
3264
is found exports to a directory (equivalent to --format=dir).
3266
If root is supplied, it will be used as the root directory inside
3267
container formats (tar, zip, etc). If it is not supplied it will default
3268
to the exported filename. The root option has no effect for 'dir' format.
3270
If branch is omitted then the branch containing the current working
3271
directory will be used.
3273
Note: Export of tree with non-ASCII filenames to zip is not supported.
3275
================= =========================
3276
Supported formats Autodetected by extension
3277
================= =========================
3280
tbz2 .tar.bz2, .tbz2
3283
================= =========================
3286
encoding_type = 'exact'
3287
takes_args = ['dest', 'branch_or_subdir?']
3288
takes_options = ['directory',
3290
help="Type of file to export to.",
3293
Option('filters', help='Apply content filters to export the '
3294
'convenient form.'),
3297
help="Name of the root directory inside the exported file."),
3298
Option('per-file-timestamps',
3299
help='Set modification time of files to that of the last '
3300
'revision in which it was changed.'),
3301
Option('uncommitted',
3302
help='Export the working tree contents rather than that of the '
3306
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3307
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3309
from .export import export, guess_format, get_root_name
3311
if branch_or_subdir is None:
3312
branch_or_subdir = directory
3314
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3316
if tree is not None:
3317
self.enter_context(tree.lock_read())
3321
raise errors.BzrCommandError(
3322
gettext("--uncommitted requires a working tree"))
3325
export_tree = _get_one_revision_tree(
3326
'export', revision, branch=b,
3330
format = guess_format(dest)
3333
root = get_root_name(dest)
3335
if not per_file_timestamps:
3336
force_mtime = time.time()
3341
from breezy.filter_tree import ContentFilterTree
3342
export_tree = ContentFilterTree(
3343
export_tree, export_tree._content_filter_stack)
3346
export(export_tree, dest, format, root, subdir,
3347
per_file_timestamps=per_file_timestamps)
3348
except errors.NoSuchExportFormat as e:
3349
raise errors.BzrCommandError(
3350
gettext('Unsupported export format: %s') % e.format)
3353
class cmd_cat(Command):
3354
__doc__ = """Write the contents of a file as of a given revision to standard output.
3356
If no revision is nominated, the last revision is used.
3358
Note: Take care to redirect standard output when using this command on a
3363
takes_options = ['directory',
3364
Option('name-from-revision',
3365
help='The path name in the old tree.'),
3366
Option('filters', help='Apply content filters to display the '
3367
'convenience form.'),
3370
takes_args = ['filename']
3371
encoding_type = 'exact'
3374
def run(self, filename, revision=None, name_from_revision=False,
3375
filters=False, directory=None):
3376
if revision is not None and len(revision) != 1:
3377
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3378
" one revision specifier"))
3379
tree, branch, relpath = \
3380
_open_directory_or_containing_tree_or_branch(filename, directory)
3381
self.enter_context(branch.lock_read())
3382
return self._run(tree, branch, relpath, filename, revision,
3383
name_from_revision, filters)
3385
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3389
tree = b.basis_tree()
3390
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3391
self.enter_context(rev_tree.lock_read())
3393
if name_from_revision:
3394
# Try in revision if requested
3395
if not rev_tree.is_versioned(relpath):
3396
raise errors.BzrCommandError(gettext(
3397
"{0!r} is not present in revision {1}").format(
3398
filename, rev_tree.get_revision_id()))
3399
rev_tree_path = relpath
3402
rev_tree_path = _mod_tree.find_previous_path(
3403
tree, rev_tree, relpath)
3404
except errors.NoSuchFile:
3405
rev_tree_path = None
3407
if rev_tree_path is None:
3408
# Path didn't exist in working tree
3409
if not rev_tree.is_versioned(relpath):
3410
raise errors.BzrCommandError(gettext(
3411
"{0!r} is not present in revision {1}").format(
3412
filename, rev_tree.get_revision_id()))
3414
# Fall back to the same path in the basis tree, if present.
3415
rev_tree_path = relpath
3418
from .filter_tree import ContentFilterTree
3419
filter_tree = ContentFilterTree(
3420
rev_tree, rev_tree._content_filter_stack)
3421
fileobj = filter_tree.get_file(rev_tree_path)
3423
fileobj = rev_tree.get_file(rev_tree_path)
3424
shutil.copyfileobj(fileobj, self.outf)
3428
class cmd_local_time_offset(Command):
3429
__doc__ = """Show the offset in seconds from GMT to local time."""
3434
self.outf.write("%s\n" % osutils.local_time_offset())
3437
class cmd_commit(Command):
3438
__doc__ = """Commit changes into a new revision.
3440
An explanatory message needs to be given for each commit. This is
3441
often done by using the --message option (getting the message from the
3442
command line) or by using the --file option (getting the message from
3443
a file). If neither of these options is given, an editor is opened for
3444
the user to enter the message. To see the changed files in the
3445
boilerplate text loaded into the editor, use the --show-diff option.
3447
By default, the entire tree is committed and the person doing the
3448
commit is assumed to be the author. These defaults can be overridden
3453
If selected files are specified, only changes to those files are
3454
committed. If a directory is specified then the directory and
3455
everything within it is committed.
3457
When excludes are given, they take precedence over selected files.
3458
For example, to commit only changes within foo, but not changes
3461
brz commit foo -x foo/bar
3463
A selective commit after a merge is not yet supported.
3467
If the author of the change is not the same person as the committer,
3468
you can specify the author's name using the --author option. The
3469
name should be in the same format as a committer-id, e.g.
3470
"John Doe <jdoe@example.com>". If there is more than one author of
3471
the change you can specify the option multiple times, once for each
3476
A common mistake is to forget to add a new file or directory before
3477
running the commit command. The --strict option checks for unknown
3478
files and aborts the commit if any are found. More advanced pre-commit
3479
checks can be implemented by defining hooks. See ``brz help hooks``
3484
If you accidentally commit the wrong changes or make a spelling
3485
mistake in the commit message say, you can use the uncommit command
3486
to undo it. See ``brz help uncommit`` for details.
3488
Hooks can also be configured to run after a commit. This allows you
3489
to trigger updates to external systems like bug trackers. The --fixes
3490
option can be used to record the association between a revision and
3491
one or more bugs. See ``brz help bugs`` for details.
3494
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3495
takes_args = ['selected*']
3498
'exclude', type=text_type, short_name='x',
3499
help="Do not consider changes made to a given path."),
3500
Option('message', type=text_type,
3502
help="Description of the new revision."),
3505
help='Commit even if nothing has changed.'),
3506
Option('file', type=text_type,
3509
help='Take commit message from this file.'),
3511
help="Refuse to commit if there are unknown "
3512
"files in the working tree."),
3513
Option('commit-time', type=text_type,
3514
help="Manually set a commit time using commit date "
3515
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3517
'bugs', type=text_type,
3518
help="Link to a related bug. (see \"brz help bugs\")."),
3520
'fixes', type=text_type,
3521
help="Mark a bug as being fixed by this revision "
3522
"(see \"brz help bugs\")."),
3524
'author', type=text_type,
3525
help="Set the author's name, if it's different "
3526
"from the committer."),
3528
help="Perform a local commit in a bound "
3529
"branch. Local commits are not pushed to "
3530
"the master branch until a normal commit "
3533
Option('show-diff', short_name='p',
3534
help='When no message is supplied, show the diff along'
3535
' with the status summary in the message editor.'),
3537
help='When committing to a foreign version control '
3538
'system do not push data that can not be natively '
3540
aliases = ['ci', 'checkin']
3542
def _iter_bug_urls(self, bugs, branch, status):
3543
default_bugtracker = None
3544
# Configure the properties for bug fixing attributes.
3546
tokens = bug.split(':')
3547
if len(tokens) == 1:
3548
if default_bugtracker is None:
3549
branch_config = branch.get_config_stack()
3550
default_bugtracker = branch_config.get(
3552
if default_bugtracker is None:
3553
raise errors.BzrCommandError(gettext(
3554
"No tracker specified for bug %s. Use the form "
3555
"'tracker:id' or specify a default bug tracker "
3556
"using the `bugtracker` option.\nSee "
3557
"\"brz help bugs\" for more information on this "
3558
"feature. Commit refused.") % bug)
3559
tag = default_bugtracker
3561
elif len(tokens) != 2:
3562
raise errors.BzrCommandError(gettext(
3563
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3564
"See \"brz help bugs\" for more information on this "
3565
"feature.\nCommit refused.") % bug)
3567
tag, bug_id = tokens
3569
yield bugtracker.get_bug_url(tag, branch, bug_id), status
3570
except bugtracker.UnknownBugTrackerAbbreviation:
3571
raise errors.BzrCommandError(gettext(
3572
'Unrecognized bug %s. Commit refused.') % bug)
3573
except bugtracker.MalformedBugIdentifier as e:
3574
raise errors.BzrCommandError(gettext(
3575
u"%s\nCommit refused.") % (e,))
3577
def run(self, message=None, file=None, verbose=False, selected_list=None,
3578
unchanged=False, strict=False, local=False, fixes=None, bugs=None,
3579
author=None, show_diff=False, exclude=None, commit_time=None,
3582
from .commit import (
3585
from .errors import (
3589
from .msgeditor import (
3590
edit_commit_message_encoded,
3591
generate_commit_message_template,
3592
make_commit_message_template_encoded,
3596
commit_stamp = offset = None
3597
if commit_time is not None:
3599
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3600
except ValueError as e:
3601
raise errors.BzrCommandError(gettext(
3602
"Could not parse --commit-time: " + str(e)))
3606
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3607
if selected_list == ['']:
3608
# workaround - commit of root of tree should be exactly the same
3609
# as just default commit in that tree, and succeed even though
3610
# selected-file merge commit is not done yet
3617
bug_property = bugtracker.encode_fixes_bug_urls(
3619
self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
3620
self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
3622
properties[u'bugs'] = bug_property
3624
if local and not tree.branch.get_bound_location():
3625
raise errors.LocalRequiresBoundBranch()
3627
if message is not None:
3629
file_exists = osutils.lexists(message)
3630
except UnicodeError:
3631
# The commit message contains unicode characters that can't be
3632
# represented in the filesystem encoding, so that can't be a
3637
'The commit message is a file name: "%(f)s".\n'
3638
'(use --file "%(f)s" to take commit message from that file)'
3640
ui.ui_factory.show_warning(warning_msg)
3642
message = message.replace('\r\n', '\n')
3643
message = message.replace('\r', '\n')
3645
raise errors.BzrCommandError(gettext(
3646
"please specify either --message or --file"))
3648
def get_message(commit_obj):
3649
"""Callback to get commit message"""
3651
with open(file, 'rb') as f:
3652
my_message = f.read().decode(osutils.get_user_encoding())
3653
elif message is not None:
3654
my_message = message
3656
# No message supplied: make one up.
3657
# text is the status of the tree
3658
text = make_commit_message_template_encoded(tree,
3659
selected_list, diff=show_diff,
3660
output_encoding=osutils.get_user_encoding())
3661
# start_message is the template generated from hooks
3662
# XXX: Warning - looks like hooks return unicode,
3663
# make_commit_message_template_encoded returns user encoding.
3664
# We probably want to be using edit_commit_message instead to
3666
my_message = set_commit_message(commit_obj)
3667
if my_message is None:
3668
start_message = generate_commit_message_template(
3670
if start_message is not None:
3671
start_message = start_message.encode(
3672
osutils.get_user_encoding())
3673
my_message = edit_commit_message_encoded(text,
3674
start_message=start_message)
3675
if my_message is None:
3676
raise errors.BzrCommandError(gettext("please specify a commit"
3677
" message with either --message or --file"))
3678
if my_message == "":
3679
raise errors.BzrCommandError(gettext("Empty commit message specified."
3680
" Please specify a commit message with either"
3681
" --message or --file or leave a blank message"
3682
" with --message \"\"."))
3685
# The API permits a commit with a filter of [] to mean 'select nothing'
3686
# but the command line should not do that.
3687
if not selected_list:
3688
selected_list = None
3690
tree.commit(message_callback=get_message,
3691
specific_files=selected_list,
3692
allow_pointless=unchanged, strict=strict, local=local,
3693
reporter=None, verbose=verbose, revprops=properties,
3694
authors=author, timestamp=commit_stamp,
3696
exclude=tree.safe_relpath_files(exclude),
3698
except PointlessCommit:
3699
raise errors.BzrCommandError(gettext("No changes to commit."
3700
" Please 'brz add' the files you want to commit, or use"
3701
" --unchanged to force an empty commit."))
3702
except ConflictsInTree:
3703
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3704
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3706
except StrictCommitFailed:
3707
raise errors.BzrCommandError(gettext("Commit refused because there are"
3708
" unknown files in the working tree."))
3709
except errors.BoundBranchOutOfDate as e:
3710
e.extra_help = (gettext("\n"
3711
'To commit to master branch, run update and then commit.\n'
3712
'You can also pass --local to commit to continue working '
3717
class cmd_check(Command):
3718
__doc__ = """Validate working tree structure, branch consistency and repository history.
3720
This command checks various invariants about branch and repository storage
3721
to detect data corruption or brz bugs.
3723
The working tree and branch checks will only give output if a problem is
3724
detected. The output fields of the repository check are:
3727
This is just the number of revisions checked. It doesn't
3731
This is just the number of versionedfiles checked. It
3732
doesn't indicate a problem.
3734
unreferenced ancestors
3735
Texts that are ancestors of other texts, but
3736
are not properly referenced by the revision ancestry. This is a
3737
subtle problem that Breezy can work around.
3740
This is the total number of unique file contents
3741
seen in the checked revisions. It does not indicate a problem.
3744
This is the total number of repeated texts seen
3745
in the checked revisions. Texts can be repeated when their file
3746
entries are modified, but the file contents are not. It does not
3749
If no restrictions are specified, all data that is found at the given
3750
location will be checked.
3754
Check the tree and branch at 'foo'::
3756
brz check --tree --branch foo
3758
Check only the repository at 'bar'::
3760
brz check --repo bar
3762
Check everything at 'baz'::
3767
_see_also = ['reconcile']
3768
takes_args = ['path?']
3769
takes_options = ['verbose',
3770
Option('branch', help="Check the branch related to the"
3771
" current directory."),
3772
Option('repo', help="Check the repository related to the"
3773
" current directory."),
3774
Option('tree', help="Check the working tree related to"
3775
" the current directory.")]
3777
def run(self, path=None, verbose=False, branch=False, repo=False,
3779
from .check import check_dwim
3782
if not branch and not repo and not tree:
3783
branch = repo = tree = True
3784
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3787
class cmd_upgrade(Command):
3788
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3790
When the default format has changed after a major new release of
3791
Bazaar/Breezy, you may be informed during certain operations that you
3792
should upgrade. Upgrading to a newer format may improve performance
3793
or make new features available. It may however limit interoperability
3794
with older repositories or with older versions of Bazaar or Breezy.
3796
If you wish to upgrade to a particular format rather than the
3797
current default, that can be specified using the --format option.
3798
As a consequence, you can use the upgrade command this way to
3799
"downgrade" to an earlier format, though some conversions are
3800
a one way process (e.g. changing from the 1.x default to the
3801
2.x default) so downgrading is not always possible.
3803
A backup.bzr.~#~ directory is created at the start of the conversion
3804
process (where # is a number). By default, this is left there on
3805
completion. If the conversion fails, delete the new .bzr directory
3806
and rename this one back in its place. Use the --clean option to ask
3807
for the backup.bzr directory to be removed on successful conversion.
3808
Alternatively, you can delete it by hand if everything looks good
3811
If the location given is a shared repository, dependent branches
3812
are also converted provided the repository converts successfully.
3813
If the conversion of a branch fails, remaining branches are still
3816
For more information on upgrades, see the Breezy Upgrade Guide,
3817
https://www.breezy-vcs.org/doc/en/upgrade-guide/.
3820
_see_also = ['check', 'reconcile', 'formats']
3821
takes_args = ['url?']
3823
RegistryOption('format',
3824
help='Upgrade to a specific format. See "brz help'
3825
' formats" for details.',
3826
lazy_registry=('breezy.controldir', 'format_registry'),
3827
converter=lambda name: controldir.format_registry.make_controldir(
3829
value_switches=True, title='Branch format'),
3831
help='Remove the backup.bzr directory if successful.'),
3833
help="Show what would be done, but don't actually do anything."),
3836
def run(self, url='.', format=None, clean=False, dry_run=False):
3837
from .upgrade import upgrade
3838
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3840
if len(exceptions) == 1:
3841
# Compatibility with historical behavior
3847
class cmd_whoami(Command):
3848
__doc__ = """Show or set brz user id.
3851
Show the email of the current user::
3855
Set the current user::
3857
brz whoami "Frank Chu <fchu@example.com>"
3859
takes_options = ['directory',
3861
help='Display email address only.'),
3863
help='Set identity for the current branch instead of '
3866
takes_args = ['name?']
3867
encoding_type = 'replace'
3870
def run(self, email=False, branch=False, name=None, directory=None):
3872
if directory is None:
3873
# use branch if we're inside one; otherwise global config
3875
c = Branch.open_containing(u'.')[0].get_config_stack()
3876
except errors.NotBranchError:
3877
c = _mod_config.GlobalStack()
3879
c = Branch.open(directory).get_config_stack()
3880
identity = c.get('email')
3882
self.outf.write(_mod_config.extract_email_address(identity)
3885
self.outf.write(identity + '\n')
3889
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3892
# display a warning if an email address isn't included in the given name.
3894
_mod_config.extract_email_address(name)
3895
except _mod_config.NoEmailInUsername:
3896
warning('"%s" does not seem to contain an email address. '
3897
'This is allowed, but not recommended.', name)
3899
# use global config unless --branch given
3901
if directory is None:
3902
c = Branch.open_containing(u'.')[0].get_config_stack()
3904
b = Branch.open(directory)
3905
self.enter_context(b.lock_write())
3906
c = b.get_config_stack()
3908
c = _mod_config.GlobalStack()
3909
c.set('email', name)
3912
class cmd_nick(Command):
3913
__doc__ = """Print or set the branch nickname.
3915
If unset, the colocated branch name is used for colocated branches, and
3916
the branch directory name is used for other branches. To print the
3917
current nickname, execute with no argument.
3919
Bound branches use the nickname of its master branch unless it is set
3923
_see_also = ['info']
3924
takes_args = ['nickname?']
3925
takes_options = ['directory']
3927
def run(self, nickname=None, directory=u'.'):
3928
branch = Branch.open_containing(directory)[0]
3929
if nickname is None:
3930
self.printme(branch)
3932
branch.nick = nickname
3935
def printme(self, branch):
3936
self.outf.write('%s\n' % branch.nick)
3939
class cmd_alias(Command):
3940
__doc__ = """Set/unset and display aliases.
3943
Show the current aliases::
3947
Show the alias specified for 'll'::
3951
Set an alias for 'll'::
3953
brz alias ll="log --line -r-10..-1"
3955
To remove an alias for 'll'::
3957
brz alias --remove ll
3960
takes_args = ['name?']
3962
Option('remove', help='Remove the alias.'),
3965
def run(self, name=None, remove=False):
3967
self.remove_alias(name)
3969
self.print_aliases()
3971
equal_pos = name.find('=')
3973
self.print_alias(name)
3975
self.set_alias(name[:equal_pos], name[equal_pos + 1:])
3977
def remove_alias(self, alias_name):
3978
if alias_name is None:
3979
raise errors.BzrCommandError(gettext(
3980
'brz alias --remove expects an alias to remove.'))
3981
# If alias is not found, print something like:
3982
# unalias: foo: not found
3983
c = _mod_config.GlobalConfig()
3984
c.unset_alias(alias_name)
3987
def print_aliases(self):
3988
"""Print out the defined aliases in a similar format to bash."""
3989
aliases = _mod_config.GlobalConfig().get_aliases()
3990
for key, value in sorted(viewitems(aliases)):
3991
self.outf.write('brz alias %s="%s"\n' % (key, value))
3994
def print_alias(self, alias_name):
3995
from .commands import get_alias
3996
alias = get_alias(alias_name)
3998
self.outf.write("brz alias: %s: not found\n" % alias_name)
4001
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
4003
def set_alias(self, alias_name, alias_command):
4004
"""Save the alias in the global config."""
4005
c = _mod_config.GlobalConfig()
4006
c.set_alias(alias_name, alias_command)
4009
class cmd_selftest(Command):
4010
__doc__ = """Run internal test suite.
4012
If arguments are given, they are regular expressions that say which tests
4013
should run. Tests matching any expression are run, and other tests are
4016
Alternatively if --first is given, matching tests are run first and then
4017
all other tests are run. This is useful if you have been working in a
4018
particular area, but want to make sure nothing else was broken.
4020
If --exclude is given, tests that match that regular expression are
4021
excluded, regardless of whether they match --first or not.
4023
To help catch accidential dependencies between tests, the --randomize
4024
option is useful. In most cases, the argument used is the word 'now'.
4025
Note that the seed used for the random number generator is displayed
4026
when this option is used. The seed can be explicitly passed as the
4027
argument to this option if required. This enables reproduction of the
4028
actual ordering used if and when an order sensitive problem is encountered.
4030
If --list-only is given, the tests that would be run are listed. This is
4031
useful when combined with --first, --exclude and/or --randomize to
4032
understand their impact. The test harness reports "Listed nn tests in ..."
4033
instead of "Ran nn tests in ..." when list mode is enabled.
4035
If the global option '--no-plugins' is given, plugins are not loaded
4036
before running the selftests. This has two effects: features provided or
4037
modified by plugins will not be tested, and tests provided by plugins will
4040
Tests that need working space on disk use a common temporary directory,
4041
typically inside $TMPDIR or /tmp.
4043
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4044
into a pdb postmortem session.
4046
The --coverage=DIRNAME global option produces a report with covered code
4050
Run only tests relating to 'ignore'::
4054
Disable plugins and list tests as they're run::
4056
brz --no-plugins selftest -v
4058
# NB: this is used from the class without creating an instance, which is
4059
# why it does not have a self parameter.
4061
def get_transport_type(typestring):
4062
"""Parse and return a transport specifier."""
4063
if typestring == "sftp":
4064
from .tests import stub_sftp
4065
return stub_sftp.SFTPAbsoluteServer
4066
elif typestring == "memory":
4067
from .tests import test_server
4068
return memory.MemoryServer
4069
elif typestring == "fakenfs":
4070
from .tests import test_server
4071
return test_server.FakeNFSServer
4072
msg = "No known transport type %s. Supported types are: sftp\n" %\
4074
raise errors.BzrCommandError(msg)
4077
takes_args = ['testspecs*']
4078
takes_options = ['verbose',
4080
help='Stop when one test fails.',
4084
help='Use a different transport by default '
4085
'throughout the test suite.',
4086
type=get_transport_type),
4088
help='Run the benchmarks rather than selftests.',
4090
Option('lsprof-timed',
4091
help='Generate lsprof output for benchmarked'
4092
' sections of code.'),
4093
Option('lsprof-tests',
4094
help='Generate lsprof output for each test.'),
4096
help='Run all tests, but run specified tests first.',
4100
help='List the tests instead of running them.'),
4101
RegistryOption('parallel',
4102
help="Run the test suite in parallel.",
4104
'breezy.tests', 'parallel_registry'),
4105
value_switches=False,
4107
Option('randomize', type=text_type, argname="SEED",
4108
help='Randomize the order of tests using the given'
4109
' seed or "now" for the current time.'),
4110
ListOption('exclude', type=text_type, argname="PATTERN",
4112
help='Exclude tests that match this regular'
4115
help='Output test progress via subunit v1.'),
4117
help='Output test progress via subunit v2.'),
4118
Option('strict', help='Fail on missing dependencies or '
4120
Option('load-list', type=text_type, argname='TESTLISTFILE',
4121
help='Load a test id list from a text file.'),
4122
ListOption('debugflag', type=text_type, short_name='E',
4123
help='Turn on a selftest debug flag.'),
4124
ListOption('starting-with', type=text_type, argname='TESTID',
4125
param_name='starting_with', short_name='s',
4126
help='Load only the tests starting with TESTID.'),
4128
help="By default we disable fsync and fdatasync"
4129
" while running the test suite.")
4131
encoding_type = 'replace'
4134
Command.__init__(self)
4135
self.additional_selftest_args = {}
4137
def run(self, testspecs_list=None, verbose=False, one=False,
4138
transport=None, benchmark=None,
4140
first=False, list_only=False,
4141
randomize=None, exclude=None, strict=False,
4142
load_list=None, debugflag=None, starting_with=None, subunit1=False,
4143
subunit2=False, parallel=None, lsprof_tests=False, sync=False):
4145
# During selftest, disallow proxying, as it can cause severe
4146
# performance penalties and is only needed for thread
4147
# safety. The selftest command is assumed to not use threads
4148
# too heavily. The call should be as early as possible, as
4149
# error reporting for past duplicate imports won't have useful
4151
if sys.version_info[0] < 3:
4152
# TODO(pad.lv/1696545): Allow proxying on Python 3, since
4153
# disallowing it currently leads to failures in many places.
4154
lazy_import.disallow_proxying()
4159
raise errors.BzrCommandError("tests not available. Install the "
4160
"breezy tests to run the breezy testsuite.")
4162
if testspecs_list is not None:
4163
pattern = '|'.join(testspecs_list)
4168
from .tests import SubUnitBzrRunnerv1
4170
raise errors.BzrCommandError(gettext(
4171
"subunit not available. subunit needs to be installed "
4172
"to use --subunit."))
4173
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
4174
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4175
# stdout, which would corrupt the subunit stream.
4176
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4177
# following code can be deleted when it's sufficiently deployed
4178
# -- vila/mgz 20100514
4179
if (sys.platform == "win32"
4180
and getattr(sys.stdout, 'fileno', None) is not None):
4182
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4185
from .tests import SubUnitBzrRunnerv2
4187
raise errors.BzrCommandError(gettext(
4188
"subunit not available. subunit "
4189
"needs to be installed to use --subunit2."))
4190
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
4193
self.additional_selftest_args.setdefault(
4194
'suite_decorators', []).append(parallel)
4196
raise errors.BzrCommandError(gettext(
4197
"--benchmark is no longer supported from brz 2.2; "
4198
"use bzr-usertest instead"))
4199
test_suite_factory = None
4201
exclude_pattern = None
4203
exclude_pattern = '(' + '|'.join(exclude) + ')'
4205
self._disable_fsync()
4206
selftest_kwargs = {"verbose": verbose,
4208
"stop_on_failure": one,
4209
"transport": transport,
4210
"test_suite_factory": test_suite_factory,
4211
"lsprof_timed": lsprof_timed,
4212
"lsprof_tests": lsprof_tests,
4213
"matching_tests_first": first,
4214
"list_only": list_only,
4215
"random_seed": randomize,
4216
"exclude_pattern": exclude_pattern,
4218
"load_list": load_list,
4219
"debug_flags": debugflag,
4220
"starting_with": starting_with
4222
selftest_kwargs.update(self.additional_selftest_args)
4224
# Make deprecation warnings visible, unless -Werror is set
4225
cleanup = symbol_versioning.activate_deprecation_warnings(
4228
result = tests.selftest(**selftest_kwargs)
4231
return int(not result)
4233
def _disable_fsync(self):
4234
"""Change the 'os' functionality to not synchronize."""
4235
self._orig_fsync = getattr(os, 'fsync', None)
4236
if self._orig_fsync is not None:
4237
os.fsync = lambda filedes: None
4238
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4239
if self._orig_fdatasync is not None:
4240
os.fdatasync = lambda filedes: None
4243
class cmd_version(Command):
4244
__doc__ = """Show version of brz."""
4246
encoding_type = 'replace'
4248
Option("short", help="Print just the version number."),
4252
def run(self, short=False):
4253
from .version import show_version
4255
self.outf.write(breezy.version_string + '\n')
4257
show_version(to_file=self.outf)
4260
class cmd_rocks(Command):
4261
__doc__ = """Statement of optimism."""
4267
self.outf.write(gettext("It sure does!\n"))
4270
class cmd_find_merge_base(Command):
4271
__doc__ = """Find and print a base revision for merging two branches."""
4272
# TODO: Options to specify revisions on either side, as if
4273
# merging only part of the history.
4274
takes_args = ['branch', 'other']
4278
def run(self, branch, other):
4279
from .revision import ensure_null
4281
branch1 = Branch.open_containing(branch)[0]
4282
branch2 = Branch.open_containing(other)[0]
4283
self.enter_context(branch1.lock_read())
4284
self.enter_context(branch2.lock_read())
4285
last1 = ensure_null(branch1.last_revision())
4286
last2 = ensure_null(branch2.last_revision())
4288
graph = branch1.repository.get_graph(branch2.repository)
4289
base_rev_id = graph.find_unique_lca(last1, last2)
4291
self.outf.write(gettext('merge base is revision %s\n') %
4292
base_rev_id.decode('utf-8'))
4295
class cmd_merge(Command):
4296
__doc__ = """Perform a three-way merge.
4298
The source of the merge can be specified either in the form of a branch,
4299
or in the form of a path to a file containing a merge directive generated
4300
with brz send. If neither is specified, the default is the upstream branch
4301
or the branch most recently merged using --remember. The source of the
4302
merge may also be specified in the form of a path to a file in another
4303
branch: in this case, only the modifications to that file are merged into
4304
the current working tree.
4306
When merging from a branch, by default brz will try to merge in all new
4307
work from the other branch, automatically determining an appropriate base
4308
revision. If this fails, you may need to give an explicit base.
4310
To pick a different ending revision, pass "--revision OTHER". brz will
4311
try to merge in all new work up to and including revision OTHER.
4313
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4314
through OTHER, excluding BASE but including OTHER, will be merged. If this
4315
causes some revisions to be skipped, i.e. if the destination branch does
4316
not already contain revision BASE, such a merge is commonly referred to as
4317
a "cherrypick". Unlike a normal merge, Breezy does not currently track
4318
cherrypicks. The changes look like a normal commit, and the history of the
4319
changes from the other branch is not stored in the commit.
4321
Revision numbers are always relative to the source branch.
4323
Merge will do its best to combine the changes in two branches, but there
4324
are some kinds of problems only a human can fix. When it encounters those,
4325
it will mark a conflict. A conflict means that you need to fix something,
4326
before you can commit.
4328
Use brz resolve when you have fixed a problem. See also brz conflicts.
4330
If there is no default branch set, the first merge will set it (use
4331
--no-remember to avoid setting it). After that, you can omit the branch
4332
to use the default. To change the default, use --remember. The value will
4333
only be saved if the remote location can be accessed.
4335
The results of the merge are placed into the destination working
4336
directory, where they can be reviewed (with brz diff), tested, and then
4337
committed to record the result of the merge.
4339
merge refuses to run if there are any uncommitted changes, unless
4340
--force is given. If --force is given, then the changes from the source
4341
will be merged with the current working tree, including any uncommitted
4342
changes in the tree. The --force option can also be used to create a
4343
merge revision which has more than two parents.
4345
If one would like to merge changes from the working tree of the other
4346
branch without merging any committed revisions, the --uncommitted option
4349
To select only some changes to merge, use "merge -i", which will prompt
4350
you to apply each diff hunk and file change, similar to "shelve".
4353
To merge all new revisions from brz.dev::
4355
brz merge ../brz.dev
4357
To merge changes up to and including revision 82 from brz.dev::
4359
brz merge -r 82 ../brz.dev
4361
To merge the changes introduced by 82, without previous changes::
4363
brz merge -r 81..82 ../brz.dev
4365
To apply a merge directive contained in /tmp/merge::
4367
brz merge /tmp/merge
4369
To create a merge revision with three parents from two branches
4370
feature1a and feature1b:
4372
brz merge ../feature1a
4373
brz merge ../feature1b --force
4374
brz commit -m 'revision with three parents'
4377
encoding_type = 'exact'
4378
_see_also = ['update', 'remerge', 'status-flags', 'send']
4379
takes_args = ['location?']
4384
help='Merge even if the destination tree has uncommitted changes.'),
4388
Option('show-base', help="Show base revision text in "
4390
Option('uncommitted', help='Apply uncommitted changes'
4391
' from a working copy, instead of branch changes.'),
4392
Option('pull', help='If the destination is already'
4393
' completely merged into the source, pull from the'
4394
' source rather than merging. When this happens,'
4395
' you do not need to commit the result.'),
4396
custom_help('directory',
4397
help='Branch to merge into, '
4398
'rather than the one containing the working directory.'),
4399
Option('preview', help='Instead of merging, show a diff of the'
4401
Option('interactive', help='Select changes interactively.',
4405
def run(self, location=None, revision=None, force=False,
4406
merge_type=None, show_base=False, reprocess=None, remember=None,
4407
uncommitted=False, pull=False,
4412
if merge_type is None:
4413
merge_type = _mod_merge.Merge3Merger
4415
if directory is None:
4417
possible_transports = []
4419
allow_pending = True
4420
verified = 'inapplicable'
4422
tree = WorkingTree.open_containing(directory)[0]
4423
if tree.branch.last_revision() == _mod_revision.NULL_REVISION:
4424
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4425
'https://bugs.launchpad.net/bzr/+bug/308562'))
4427
# die as quickly as possible if there are uncommitted changes
4429
if tree.has_changes():
4430
raise errors.UncommittedChanges(tree)
4432
view_info = _get_view_info_for_change_reporter(tree)
4433
change_reporter = delta._ChangeReporter(
4434
unversioned_filter=tree.is_ignored, view_info=view_info)
4435
pb = ui.ui_factory.nested_progress_bar()
4436
self.enter_context(pb)
4437
self.enter_context(tree.lock_write())
4438
if location is not None:
4440
mergeable = _mod_mergeable.read_mergeable_from_url(
4441
location, possible_transports=possible_transports)
4442
except errors.NotABundle:
4446
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4447
' with bundles or merge directives.'))
4449
if revision is not None:
4450
raise errors.BzrCommandError(gettext(
4451
'Cannot use -r with merge directives or bundles'))
4452
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4455
if merger is None and uncommitted:
4456
if revision is not None and len(revision) > 0:
4457
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4458
' --revision at the same time.'))
4459
merger = self.get_merger_from_uncommitted(tree, location, None)
4460
allow_pending = False
4463
merger, allow_pending = self._get_merger_from_branch(tree,
4464
location, revision, remember, possible_transports, None)
4466
merger.merge_type = merge_type
4467
merger.reprocess = reprocess
4468
merger.show_base = show_base
4469
self.sanity_check_merger(merger)
4470
if (merger.base_rev_id == merger.other_rev_id and
4471
merger.other_rev_id is not None):
4472
# check if location is a nonexistent file (and not a branch) to
4473
# disambiguate the 'Nothing to do'
4474
if merger.interesting_files:
4475
if not merger.other_tree.has_filename(
4476
merger.interesting_files[0]):
4477
note(gettext("merger: ") + str(merger))
4478
raise errors.PathsDoNotExist([location])
4479
note(gettext('Nothing to do.'))
4481
if pull and not preview:
4482
if merger.interesting_files is not None:
4483
raise errors.BzrCommandError(
4484
gettext('Cannot pull individual files'))
4485
if (merger.base_rev_id == tree.last_revision()):
4486
result = tree.pull(merger.other_branch, False,
4487
merger.other_rev_id)
4488
result.report(self.outf)
4490
if merger.this_basis is None:
4491
raise errors.BzrCommandError(gettext(
4492
"This branch has no commits."
4493
" (perhaps you would prefer 'brz pull')"))
4495
return self._do_preview(merger)
4497
return self._do_interactive(merger)
4499
return self._do_merge(merger, change_reporter, allow_pending,
4502
def _get_preview(self, merger):
4503
tree_merger = merger.make_merger()
4504
tt = tree_merger.make_preview_transform()
4505
self.enter_context(tt)
4506
result_tree = tt.get_preview_tree()
4509
def _do_preview(self, merger):
4510
from .diff import show_diff_trees
4511
result_tree = self._get_preview(merger)
4512
path_encoding = osutils.get_diff_header_encoding()
4513
show_diff_trees(merger.this_tree, result_tree, self.outf,
4514
old_label='', new_label='',
4515
path_encoding=path_encoding)
4517
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4518
merger.change_reporter = change_reporter
4519
conflict_count = merger.do_merge()
4521
merger.set_pending()
4522
if verified == 'failed':
4523
warning('Preview patch does not match changes')
4524
if conflict_count != 0:
4529
def _do_interactive(self, merger):
4530
"""Perform an interactive merge.
4532
This works by generating a preview tree of the merge, then using
4533
Shelver to selectively remove the differences between the working tree
4534
and the preview tree.
4536
from . import shelf_ui
4537
result_tree = self._get_preview(merger)
4538
writer = breezy.option.diff_writer_registry.get()
4539
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4540
reporter=shelf_ui.ApplyReporter(),
4541
diff_writer=writer(self.outf))
4547
def sanity_check_merger(self, merger):
4548
if (merger.show_base and
4549
merger.merge_type is not _mod_merge.Merge3Merger):
4550
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4551
" merge type. %s") % merger.merge_type)
4552
if merger.reprocess is None:
4553
if merger.show_base:
4554
merger.reprocess = False
4556
# Use reprocess if the merger supports it
4557
merger.reprocess = merger.merge_type.supports_reprocess
4558
if merger.reprocess and not merger.merge_type.supports_reprocess:
4559
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4560
" for merge type %s.") %
4562
if merger.reprocess and merger.show_base:
4563
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4566
if (merger.merge_type.requires_file_merge_plan and
4567
(not getattr(merger.this_tree, 'plan_file_merge', None) or
4568
not getattr(merger.other_tree, 'plan_file_merge', None) or
4569
(merger.base_tree is not None and
4570
not getattr(merger.base_tree, 'plan_file_merge', None)))):
4571
raise errors.BzrCommandError(
4572
gettext('Plan file merge unsupported: '
4573
'Merge type incompatible with tree formats.'))
4575
def _get_merger_from_branch(self, tree, location, revision, remember,
4576
possible_transports, pb):
4577
"""Produce a merger from a location, assuming it refers to a branch."""
4578
# find the branch locations
4579
other_loc, user_location = self._select_branch_location(tree, location,
4581
if revision is not None and len(revision) == 2:
4582
base_loc, _unused = self._select_branch_location(tree,
4583
location, revision, 0)
4585
base_loc = other_loc
4587
other_branch, other_path = Branch.open_containing(other_loc,
4588
possible_transports)
4589
if base_loc == other_loc:
4590
base_branch = other_branch
4592
base_branch, base_path = Branch.open_containing(base_loc,
4593
possible_transports)
4594
# Find the revision ids
4595
other_revision_id = None
4596
base_revision_id = None
4597
if revision is not None:
4598
if len(revision) >= 1:
4599
other_revision_id = revision[-1].as_revision_id(other_branch)
4600
if len(revision) == 2:
4601
base_revision_id = revision[0].as_revision_id(base_branch)
4602
if other_revision_id is None:
4603
other_revision_id = _mod_revision.ensure_null(
4604
other_branch.last_revision())
4605
# Remember where we merge from. We need to remember if:
4606
# - user specify a location (and we don't merge from the parent
4608
# - user ask to remember or there is no previous location set to merge
4609
# from and user didn't ask to *not* remember
4610
if (user_location is not None
4612
(remember is None and
4613
tree.branch.get_submit_branch() is None)))):
4614
tree.branch.set_submit_branch(other_branch.base)
4615
# Merge tags (but don't set them in the master branch yet, the user
4616
# might revert this merge). Commit will propagate them.
4617
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4618
merger = _mod_merge.Merger.from_revision_ids(tree,
4619
other_revision_id, base_revision_id, other_branch, base_branch)
4620
if other_path != '':
4621
allow_pending = False
4622
merger.interesting_files = [other_path]
4624
allow_pending = True
4625
return merger, allow_pending
4627
def get_merger_from_uncommitted(self, tree, location, pb):
4628
"""Get a merger for uncommitted changes.
4630
:param tree: The tree the merger should apply to.
4631
:param location: The location containing uncommitted changes.
4632
:param pb: The progress bar to use for showing progress.
4634
location = self._select_branch_location(tree, location)[0]
4635
other_tree, other_path = WorkingTree.open_containing(location)
4636
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4637
if other_path != '':
4638
merger.interesting_files = [other_path]
4641
def _select_branch_location(self, tree, user_location, revision=None,
4643
"""Select a branch location, according to possible inputs.
4645
If provided, branches from ``revision`` are preferred. (Both
4646
``revision`` and ``index`` must be supplied.)
4648
Otherwise, the ``location`` parameter is used. If it is None, then the
4649
``submit`` or ``parent`` location is used, and a note is printed.
4651
:param tree: The working tree to select a branch for merging into
4652
:param location: The location entered by the user
4653
:param revision: The revision parameter to the command
4654
:param index: The index to use for the revision parameter. Negative
4655
indices are permitted.
4656
:return: (selected_location, user_location). The default location
4657
will be the user-entered location.
4659
if (revision is not None and index is not None
4660
and revision[index] is not None):
4661
branch = revision[index].get_branch()
4662
if branch is not None:
4663
return branch, branch
4664
if user_location is None:
4665
location = self._get_remembered(tree, 'Merging from')
4667
location = user_location
4668
return location, user_location
4670
def _get_remembered(self, tree, verb_string):
4671
"""Use tree.branch's parent if none was supplied.
4673
Report if the remembered location was used.
4675
stored_location = tree.branch.get_submit_branch()
4676
stored_location_type = "submit"
4677
if stored_location is None:
4678
stored_location = tree.branch.get_parent()
4679
stored_location_type = "parent"
4680
mutter("%s", stored_location)
4681
if stored_location is None:
4682
raise errors.BzrCommandError(
4683
gettext("No location specified or remembered"))
4684
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4685
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4686
stored_location_type, display_url))
4687
return stored_location
4690
class cmd_remerge(Command):
4691
__doc__ = """Redo a merge.
4693
Use this if you want to try a different merge technique while resolving
4694
conflicts. Some merge techniques are better than others, and remerge
4695
lets you try different ones on different files.
4697
The options for remerge have the same meaning and defaults as the ones for
4698
merge. The difference is that remerge can (only) be run when there is a
4699
pending merge, and it lets you specify particular files.
4702
Re-do the merge of all conflicted files, and show the base text in
4703
conflict regions, in addition to the usual THIS and OTHER texts::
4705
brz remerge --show-base
4707
Re-do the merge of "foobar", using the weave merge algorithm, with
4708
additional processing to reduce the size of conflict regions::
4710
brz remerge --merge-type weave --reprocess foobar
4712
takes_args = ['file*']
4717
help="Show base revision text in conflicts."),
4720
def run(self, file_list=None, merge_type=None, show_base=False,
4722
from .conflicts import restore
4723
if merge_type is None:
4724
merge_type = _mod_merge.Merge3Merger
4725
tree, file_list = WorkingTree.open_containing_paths(file_list)
4726
self.enter_context(tree.lock_write())
4727
parents = tree.get_parent_ids()
4728
if len(parents) != 2:
4729
raise errors.BzrCommandError(
4730
gettext("Sorry, remerge only works after normal"
4731
" merges. Not cherrypicking or multi-merges."))
4732
interesting_files = None
4734
conflicts = tree.conflicts()
4735
if file_list is not None:
4736
interesting_files = set()
4737
for filename in file_list:
4738
if not tree.is_versioned(filename):
4739
raise errors.NotVersionedError(filename)
4740
interesting_files.add(filename)
4741
if tree.kind(filename) != "directory":
4744
for path, ie in tree.iter_entries_by_dir(
4745
specific_files=[filename]):
4746
interesting_files.add(path)
4747
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4749
# Remerge only supports resolving contents conflicts
4750
allowed_conflicts = ('text conflict', 'contents conflict')
4751
restore_files = [c.path for c in conflicts
4752
if c.typestring in allowed_conflicts]
4753
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
4754
tree.set_conflicts(ConflictList(new_conflicts))
4755
if file_list is not None:
4756
restore_files = file_list
4757
for filename in restore_files:
4759
restore(tree.abspath(filename))
4760
except errors.NotConflicted:
4762
# Disable pending merges, because the file texts we are remerging
4763
# have not had those merges performed. If we use the wrong parents
4764
# list, we imply that the working tree text has seen and rejected
4765
# all the changes from the other tree, when in fact those changes
4766
# have not yet been seen.
4767
tree.set_parent_ids(parents[:1])
4769
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4770
merger.interesting_files = interesting_files
4771
merger.merge_type = merge_type
4772
merger.show_base = show_base
4773
merger.reprocess = reprocess
4774
conflicts = merger.do_merge()
4776
tree.set_parent_ids(parents)
4783
class cmd_revert(Command):
4785
Set files in the working tree back to the contents of a previous revision.
4787
Giving a list of files will revert only those files. Otherwise, all files
4788
will be reverted. If the revision is not specified with '--revision', the
4789
working tree basis revision is used. A revert operation affects only the
4790
working tree, not any revision history like the branch and repository or
4791
the working tree basis revision.
4793
To remove only some changes, without reverting to a prior version, use
4794
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4795
will remove the changes introduced by the second last commit (-2), without
4796
affecting the changes introduced by the last commit (-1). To remove
4797
certain changes on a hunk-by-hunk basis, see the shelve command.
4798
To update the branch to a specific revision or the latest revision and
4799
update the working tree accordingly while preserving local changes, see the
4802
Uncommitted changes to files that are reverted will be discarded.
4803
However, by default, any files that have been manually changed will be
4804
backed up first. (Files changed only by merge are not backed up.) Backup
4805
files have '.~#~' appended to their name, where # is a number.
4807
When you provide files, you can use their current pathname or the pathname
4808
from the target revision. So you can use revert to "undelete" a file by
4809
name. If you name a directory, all the contents of that directory will be
4812
If you have newly added files since the target revision, they will be
4813
removed. If the files to be removed have been changed, backups will be
4814
created as above. Directories containing unknown files will not be
4817
The working tree contains a list of revisions that have been merged but
4818
not yet committed. These revisions will be included as additional parents
4819
of the next commit. Normally, using revert clears that list as well as
4820
reverting the files. If any files are specified, revert leaves the list
4821
of uncommitted merges alone and reverts only the files. Use ``brz revert
4822
.`` in the tree root to revert all files but keep the recorded merges,
4823
and ``brz revert --forget-merges`` to clear the pending merge list without
4824
reverting any files.
4826
Using "brz revert --forget-merges", it is possible to apply all of the
4827
changes from a branch in a single revision. To do this, perform the merge
4828
as desired. Then doing revert with the "--forget-merges" option will keep
4829
the content of the tree as it was, but it will clear the list of pending
4830
merges. The next commit will then contain all of the changes that are
4831
present in the other branch, but without any other parent revisions.
4832
Because this technique forgets where these changes originated, it may
4833
cause additional conflicts on later merges involving the same source and
4837
_see_also = ['cat', 'export', 'merge', 'shelve']
4840
Option('no-backup', "Do not save backups of reverted files."),
4841
Option('forget-merges',
4842
'Remove pending merge marker, without changing any files.'),
4844
takes_args = ['file*']
4846
def run(self, revision=None, no_backup=False, file_list=None,
4847
forget_merges=None):
4848
tree, file_list = WorkingTree.open_containing_paths(file_list)
4849
self.enter_context(tree.lock_tree_write())
4851
tree.set_parent_ids(tree.get_parent_ids()[:1])
4853
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4856
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4857
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4858
tree.revert(file_list, rev_tree, not no_backup, None,
4859
report_changes=True)
4862
class cmd_assert_fail(Command):
4863
__doc__ = """Test reporting of assertion failures"""
4864
# intended just for use in testing
4869
raise AssertionError("always fails")
4872
class cmd_help(Command):
4873
__doc__ = """Show help on a command or other topic.
4876
_see_also = ['topics']
4878
Option('long', 'Show help on all commands.'),
4880
takes_args = ['topic?']
4881
aliases = ['?', '--help', '-?', '-h']
4884
def run(self, topic=None, long=False):
4886
if topic is None and long:
4888
breezy.help.help(topic)
4891
class cmd_shell_complete(Command):
4892
__doc__ = """Show appropriate completions for context.
4894
For a list of all available commands, say 'brz shell-complete'.
4896
takes_args = ['context?']
4901
def run(self, context=None):
4902
from . import shellcomplete
4903
shellcomplete.shellcomplete(context)
4906
class cmd_missing(Command):
4907
__doc__ = """Show unmerged/unpulled revisions between two branches.
4909
OTHER_BRANCH may be local or remote.
4911
To filter on a range of revisions, you can use the command -r begin..end
4912
-r revision requests a specific revision, -r ..end or -r begin.. are
4916
1 - some missing revisions
4917
0 - no missing revisions
4921
Determine the missing revisions between this and the branch at the
4922
remembered pull location::
4926
Determine the missing revisions between this and another branch::
4928
brz missing http://server/branch
4930
Determine the missing revisions up to a specific revision on the other
4933
brz missing -r ..-10
4935
Determine the missing revisions up to a specific revision on this
4938
brz missing --my-revision ..-10
4941
_see_also = ['merge', 'pull']
4942
takes_args = ['other_branch?']
4945
Option('reverse', 'Reverse the order of revisions.'),
4947
'Display changes in the local branch only.'),
4948
Option('this', 'Same as --mine-only.'),
4949
Option('theirs-only',
4950
'Display changes in the remote branch only.'),
4951
Option('other', 'Same as --theirs-only.'),
4955
custom_help('revision',
4956
help='Filter on other branch revisions (inclusive). '
4957
'See "help revisionspec" for details.'),
4958
Option('my-revision',
4959
type=_parse_revision_str,
4960
help='Filter on local branch revisions (inclusive). '
4961
'See "help revisionspec" for details.'),
4962
Option('include-merged',
4963
'Show all revisions in addition to the mainline ones.'),
4964
Option('include-merges', hidden=True,
4965
help='Historical alias for --include-merged.'),
4967
encoding_type = 'replace'
4970
def run(self, other_branch=None, reverse=False, mine_only=False,
4972
log_format=None, long=False, short=False, line=False,
4973
show_ids=False, verbose=False, this=False, other=False,
4974
include_merged=None, revision=None, my_revision=None,
4976
from breezy.missing import find_unmerged, iter_log_revisions
4982
if include_merged is None:
4983
include_merged = False
4988
# TODO: We should probably check that we don't have mine-only and
4989
# theirs-only set, but it gets complicated because we also have
4990
# this and other which could be used.
4997
local_branch = Branch.open_containing(directory)[0]
4998
self.enter_context(local_branch.lock_read())
5000
parent = local_branch.get_parent()
5001
if other_branch is None:
5002
other_branch = parent
5003
if other_branch is None:
5004
raise errors.BzrCommandError(gettext("No peer location known"
5006
display_url = urlutils.unescape_for_display(parent,
5008
message(gettext("Using saved parent location: {0}\n").format(
5011
remote_branch = Branch.open(other_branch)
5012
if remote_branch.base == local_branch.base:
5013
remote_branch = local_branch
5015
self.enter_context(remote_branch.lock_read())
5017
local_revid_range = _revision_range_to_revid_range(
5018
_get_revision_range(my_revision, local_branch,
5021
remote_revid_range = _revision_range_to_revid_range(
5022
_get_revision_range(revision,
5023
remote_branch, self.name()))
5025
local_extra, remote_extra = find_unmerged(
5026
local_branch, remote_branch, restrict,
5027
backward=not reverse,
5028
include_merged=include_merged,
5029
local_revid_range=local_revid_range,
5030
remote_revid_range=remote_revid_range)
5032
if log_format is None:
5033
registry = log.log_formatter_registry
5034
log_format = registry.get_default(local_branch)
5035
lf = log_format(to_file=self.outf,
5037
show_timezone='original')
5040
if local_extra and not theirs_only:
5041
message(ngettext("You have %d extra revision:\n",
5042
"You have %d extra revisions:\n",
5046
if local_branch.supports_tags():
5047
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5048
for revision in iter_log_revisions(local_extra,
5049
local_branch.repository,
5052
lf.log_revision(revision)
5053
printed_local = True
5056
printed_local = False
5058
if remote_extra and not mine_only:
5059
if printed_local is True:
5061
message(ngettext("You are missing %d revision:\n",
5062
"You are missing %d revisions:\n",
5063
len(remote_extra)) %
5065
if remote_branch.supports_tags():
5066
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5067
for revision in iter_log_revisions(remote_extra,
5068
remote_branch.repository,
5071
lf.log_revision(revision)
5074
if mine_only and not local_extra:
5075
# We checked local, and found nothing extra
5076
message(gettext('This branch has no new revisions.\n'))
5077
elif theirs_only and not remote_extra:
5078
# We checked remote, and found nothing extra
5079
message(gettext('Other branch has no new revisions.\n'))
5080
elif not (mine_only or theirs_only or local_extra or
5082
# We checked both branches, and neither one had extra
5084
message(gettext("Branches are up to date.\n"))
5086
if not status_code and parent is None and other_branch is not None:
5087
self.enter_context(local_branch.lock_write())
5088
# handle race conditions - a parent might be set while we run.
5089
if local_branch.get_parent() is None:
5090
local_branch.set_parent(remote_branch.base)
5094
class cmd_pack(Command):
5095
__doc__ = """Compress the data within a repository.
5097
This operation compresses the data within a bazaar repository. As
5098
bazaar supports automatic packing of repository, this operation is
5099
normally not required to be done manually.
5101
During the pack operation, bazaar takes a backup of existing repository
5102
data, i.e. pack files. This backup is eventually removed by bazaar
5103
automatically when it is safe to do so. To save disk space by removing
5104
the backed up pack files, the --clean-obsolete-packs option may be
5107
Warning: If you use --clean-obsolete-packs and your machine crashes
5108
during or immediately after repacking, you may be left with a state
5109
where the deletion has been written to disk but the new packs have not
5110
been. In this case the repository may be unusable.
5113
_see_also = ['repositories']
5114
takes_args = ['branch_or_repo?']
5116
Option('clean-obsolete-packs',
5117
'Delete obsolete packs to save disk space.'),
5120
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5121
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5123
branch = dir.open_branch()
5124
repository = branch.repository
5125
except errors.NotBranchError:
5126
repository = dir.open_repository()
5127
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5130
class cmd_plugins(Command):
5131
__doc__ = """List the installed plugins.
5133
This command displays the list of installed plugins including
5134
version of plugin and a short description of each.
5136
--verbose shows the path where each plugin is located.
5138
A plugin is an external component for Breezy that extends the
5139
revision control system, by adding or replacing code in Breezy.
5140
Plugins can do a variety of things, including overriding commands,
5141
adding new commands, providing additional network transports and
5142
customizing log output.
5144
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5145
for further information on plugins including where to find them and how to
5146
install them. Instructions are also provided there on how to write new
5147
plugins using the Python programming language.
5149
takes_options = ['verbose']
5152
def run(self, verbose=False):
5153
from . import plugin
5154
# Don't give writelines a generator as some codecs don't like that
5155
self.outf.writelines(
5156
list(plugin.describe_plugins(show_paths=verbose)))
5159
class cmd_testament(Command):
5160
__doc__ = """Show testament (signing-form) of a revision."""
5163
Option('long', help='Produce long-format testament.'),
5165
help='Produce a strict-format testament.')]
5166
takes_args = ['branch?']
5167
encoding_type = 'exact'
5170
def run(self, branch=u'.', revision=None, long=False, strict=False):
5171
from .bzr.testament import Testament, StrictTestament
5173
testament_class = StrictTestament
5175
testament_class = Testament
5177
b = Branch.open_containing(branch)[0]
5179
b = Branch.open(branch)
5180
self.enter_context(b.lock_read())
5181
if revision is None:
5182
rev_id = b.last_revision()
5184
rev_id = revision[0].as_revision_id(b)
5185
t = testament_class.from_revision(b.repository, rev_id)
5187
self.outf.writelines(t.as_text_lines())
5189
self.outf.write(t.as_short_text())
5192
class cmd_annotate(Command):
5193
__doc__ = """Show the origin of each line in a file.
5195
This prints out the given file with an annotation on the left side
5196
indicating which revision, author and date introduced the change.
5198
If the origin is the same for a run of consecutive lines, it is
5199
shown only at the top, unless the --all option is given.
5201
# TODO: annotate directories; showing when each file was last changed
5202
# TODO: if the working copy is modified, show annotations on that
5203
# with new uncommitted lines marked
5204
aliases = ['ann', 'blame', 'praise']
5205
takes_args = ['filename']
5206
takes_options = [Option('all', help='Show annotations on all lines.'),
5207
Option('long', help='Show commit date in annotations.'),
5212
encoding_type = 'exact'
5215
def run(self, filename, all=False, long=False, revision=None,
5216
show_ids=False, directory=None):
5217
from .annotate import (
5220
wt, branch, relpath = \
5221
_open_directory_or_containing_tree_or_branch(filename, directory)
5223
self.enter_context(wt.lock_read())
5225
self.enter_context(branch.lock_read())
5226
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5227
self.enter_context(tree.lock_read())
5228
if wt is not None and revision is None:
5229
if not wt.is_versioned(relpath):
5230
raise errors.NotVersionedError(relpath)
5231
# If there is a tree and we're not annotating historical
5232
# versions, annotate the working tree's content.
5233
annotate_file_tree(wt, relpath, self.outf, long, all,
5236
if not tree.is_versioned(relpath):
5237
raise errors.NotVersionedError(relpath)
5238
annotate_file_tree(tree, relpath, self.outf, long, all,
5239
show_ids=show_ids, branch=branch)
5242
class cmd_re_sign(Command):
5243
__doc__ = """Create a digital signature for an existing revision."""
5244
# TODO be able to replace existing ones.
5246
hidden = True # is this right ?
5247
takes_args = ['revision_id*']
5248
takes_options = ['directory', 'revision']
5250
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5251
if revision_id_list is not None and revision is not None:
5252
raise errors.BzrCommandError(
5253
gettext('You can only supply one of revision_id or --revision'))
5254
if revision_id_list is None and revision is None:
5255
raise errors.BzrCommandError(
5256
gettext('You must supply either --revision or a revision_id'))
5257
b = WorkingTree.open_containing(directory)[0].branch
5258
self.enter_context(b.lock_write())
5259
return self._run(b, revision_id_list, revision)
5261
def _run(self, b, revision_id_list, revision):
5262
from .repository import WriteGroup
5263
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5264
if revision_id_list is not None:
5265
with WriteGroup(b.repository):
5266
for revision_id in revision_id_list:
5267
revision_id = cache_utf8.encode(revision_id)
5268
b.repository.sign_revision(revision_id, gpg_strategy)
5269
elif revision is not None:
5270
if len(revision) == 1:
5271
revno, rev_id = revision[0].in_history(b)
5272
with WriteGroup(b.repository):
5273
b.repository.sign_revision(rev_id, gpg_strategy)
5274
elif len(revision) == 2:
5275
# are they both on rh- if so we can walk between them
5276
# might be nice to have a range helper for arbitrary
5277
# revision paths. hmm.
5278
from_revno, from_revid = revision[0].in_history(b)
5279
to_revno, to_revid = revision[1].in_history(b)
5280
if to_revid is None:
5281
to_revno = b.revno()
5282
if from_revno is None or to_revno is None:
5283
raise errors.BzrCommandError(
5284
gettext('Cannot sign a range of non-revision-history revisions'))
5285
with WriteGroup(b.repository):
5286
for revno in range(from_revno, to_revno + 1):
5287
b.repository.sign_revision(b.get_rev_id(revno),
5290
raise errors.BzrCommandError(
5291
gettext('Please supply either one revision, or a range.'))
5294
class cmd_bind(Command):
5295
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5296
If no branch is supplied, rebind to the last bound location.
5298
Once converted into a checkout, commits must succeed on the master branch
5299
before they will be applied to the local branch.
5301
Bound branches use the nickname of its master branch unless it is set
5302
locally, in which case binding will update the local nickname to be
5306
_see_also = ['checkouts', 'unbind']
5307
takes_args = ['location?']
5308
takes_options = ['directory']
5310
def run(self, location=None, directory=u'.'):
5311
b, relpath = Branch.open_containing(directory)
5312
if location is None:
5314
location = b.get_old_bound_location()
5315
except errors.UpgradeRequired:
5316
raise errors.BzrCommandError(
5317
gettext('No location supplied. '
5318
'This format does not remember old locations.'))
5320
if location is None:
5321
if b.get_bound_location() is not None:
5322
raise errors.BzrCommandError(
5323
gettext('Branch is already bound'))
5325
raise errors.BzrCommandError(
5326
gettext('No location supplied'
5327
' and no previous location known'))
5328
b_other = Branch.open(location)
5331
except errors.DivergedBranches:
5332
raise errors.BzrCommandError(
5333
gettext('These branches have diverged.'
5334
' Try merging, and then bind again.'))
5335
if b.get_config().has_explicit_nickname():
5336
b.nick = b_other.nick
5339
class cmd_unbind(Command):
5340
__doc__ = """Convert the current checkout into a regular branch.
5342
After unbinding, the local branch is considered independent and subsequent
5343
commits will be local only.
5346
_see_also = ['checkouts', 'bind']
5348
takes_options = ['directory']
5350
def run(self, directory=u'.'):
5351
b, relpath = Branch.open_containing(directory)
5353
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5356
class cmd_uncommit(Command):
5357
__doc__ = """Remove the last committed revision.
5359
--verbose will print out what is being removed.
5360
--dry-run will go through all the motions, but not actually
5363
If --revision is specified, uncommit revisions to leave the branch at the
5364
specified revision. For example, "brz uncommit -r 15" will leave the
5365
branch at revision 15.
5367
Uncommit leaves the working tree ready for a new commit. The only change
5368
it may make is to restore any pending merges that were present before
5372
# TODO: jam 20060108 Add an option to allow uncommit to remove
5373
# unreferenced information in 'branch-as-repository' branches.
5374
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5375
# information in shared branches as well.
5376
_see_also = ['commit']
5377
takes_options = ['verbose', 'revision',
5378
Option('dry-run', help='Don\'t actually make changes.'),
5379
Option('force', help='Say yes to all questions.'),
5381
help='Keep tags that point to removed revisions.'),
5383
help="Only remove the commits from the local "
5384
"branch when in a checkout."
5387
takes_args = ['location?']
5389
encoding_type = 'replace'
5391
def run(self, location=None, dry_run=False, verbose=False,
5392
revision=None, force=False, local=False, keep_tags=False):
5393
if location is None:
5395
control, relpath = controldir.ControlDir.open_containing(location)
5397
tree = control.open_workingtree()
5399
except (errors.NoWorkingTree, errors.NotLocalUrl):
5401
b = control.open_branch()
5403
if tree is not None:
5404
self.enter_context(tree.lock_write())
5406
self.enter_context(b.lock_write())
5407
return self._run(b, tree, dry_run, verbose, revision, force,
5408
local, keep_tags, location)
5410
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5411
keep_tags, location):
5412
from .log import log_formatter, show_log
5413
from .uncommit import uncommit
5415
last_revno, last_rev_id = b.last_revision_info()
5418
if revision is None:
5420
rev_id = last_rev_id
5422
# 'brz uncommit -r 10' actually means uncommit
5423
# so that the final tree is at revno 10.
5424
# but breezy.uncommit.uncommit() actually uncommits
5425
# the revisions that are supplied.
5426
# So we need to offset it by one
5427
revno = revision[0].in_history(b).revno + 1
5428
if revno <= last_revno:
5429
rev_id = b.get_rev_id(revno)
5431
if rev_id is None or _mod_revision.is_null(rev_id):
5432
self.outf.write(gettext('No revisions to uncommit.\n'))
5435
lf = log_formatter('short',
5437
show_timezone='original')
5442
direction='forward',
5443
start_revision=revno,
5444
end_revision=last_revno)
5447
self.outf.write(gettext('Dry-run, pretending to remove'
5448
' the above revisions.\n'))
5451
gettext('The above revision(s) will be removed.\n'))
5454
if not ui.ui_factory.confirm_action(
5455
gettext(u'Uncommit these revisions'),
5456
'breezy.builtins.uncommit',
5458
self.outf.write(gettext('Canceled\n'))
5461
mutter('Uncommitting from {%s} to {%s}',
5462
last_rev_id, rev_id)
5463
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5464
revno=revno, local=local, keep_tags=keep_tags)
5467
gettext('You can restore the old tip by running:\n'
5468
' brz pull -d %s %s -r revid:%s\n')
5469
% (location, location, last_rev_id.decode('utf-8')))
5472
gettext('You can restore the old tip by running:\n'
5473
' brz pull . -r revid:%s\n')
5474
% last_rev_id.decode('utf-8'))
5477
class cmd_break_lock(Command):
5478
__doc__ = """Break a dead lock.
5480
This command breaks a lock on a repository, branch, working directory or
5483
CAUTION: Locks should only be broken when you are sure that the process
5484
holding the lock has been stopped.
5486
You can get information on what locks are open via the 'brz info
5487
[location]' command.
5491
brz break-lock brz+ssh://example.com/brz/foo
5492
brz break-lock --conf ~/.config/breezy
5495
takes_args = ['location?']
5498
help='LOCATION is the directory where the config lock is.'),
5500
help='Do not ask for confirmation before breaking the lock.'),
5503
def run(self, location=None, config=False, force=False):
5504
if location is None:
5507
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5509
{'breezy.lockdir.break': True})
5511
conf = _mod_config.LockableConfig(file_name=location)
5514
control, relpath = controldir.ControlDir.open_containing(location)
5516
control.break_lock()
5517
except NotImplementedError:
5521
class cmd_wait_until_signalled(Command):
5522
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5524
This just prints a line to signal when it is ready, then blocks on stdin.
5530
self.outf.write("running\n")
5532
sys.stdin.readline()
5535
class cmd_serve(Command):
5536
__doc__ = """Run the brz server."""
5538
aliases = ['server']
5542
help='Serve on stdin/out for use from inetd or sshd.'),
5543
RegistryOption('protocol',
5544
help="Protocol to serve.",
5545
lazy_registry=('breezy.transport',
5546
'transport_server_registry'),
5547
value_switches=True),
5549
help='Listen for connections on nominated address.',
5552
help='Listen for connections on nominated port. Passing 0 as '
5553
'the port number will result in a dynamically allocated '
5554
'port. The default port depends on the protocol.',
5556
custom_help('directory',
5557
help='Serve contents of this directory.'),
5558
Option('allow-writes',
5559
help='By default the server is a readonly server. Supplying '
5560
'--allow-writes enables write access to the contents of '
5561
'the served directory and below. Note that ``brz serve`` '
5562
'does not perform authentication, so unless some form of '
5563
'external authentication is arranged supplying this '
5564
'option leads to global uncontrolled write access to your '
5567
Option('client-timeout', type=float,
5568
help='Override the default idle client timeout (5min).'),
5571
def run(self, listen=None, port=None, inet=False, directory=None,
5572
allow_writes=False, protocol=None, client_timeout=None):
5573
from . import location, transport
5574
if directory is None:
5575
directory = osutils.getcwd()
5576
if protocol is None:
5577
protocol = transport.transport_server_registry.get()
5578
url = location.location_to_url(directory)
5579
if not allow_writes:
5580
url = 'readonly+' + url
5581
t = transport.get_transport_from_url(url)
5582
protocol(t, listen, port, inet, client_timeout)
5585
class cmd_join(Command):
5586
__doc__ = """Combine a tree into its containing tree.
5588
This command requires the target tree to be in a rich-root format.
5590
The TREE argument should be an independent tree, inside another tree, but
5591
not part of it. (Such trees can be produced by "brz split", but also by
5592
running "brz branch" with the target inside a tree.)
5594
The result is a combined tree, with the subtree no longer an independent
5595
part. This is marked as a merge of the subtree into the containing tree,
5596
and all history is preserved.
5599
_see_also = ['split']
5600
takes_args = ['tree']
5602
Option('reference', help='Join by reference.', hidden=True),
5605
def run(self, tree, reference=False):
5606
from breezy.mutabletree import BadReferenceTarget
5607
sub_tree = WorkingTree.open(tree)
5608
parent_dir = osutils.dirname(sub_tree.basedir)
5609
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5610
repo = containing_tree.branch.repository
5611
if not repo.supports_rich_root():
5612
raise errors.BzrCommandError(gettext(
5613
"Can't join trees because %s doesn't support rich root data.\n"
5614
"You can use brz upgrade on the repository.")
5618
containing_tree.add_reference(sub_tree)
5619
except BadReferenceTarget as e:
5620
# XXX: Would be better to just raise a nicely printable
5621
# exception from the real origin. Also below. mbp 20070306
5622
raise errors.BzrCommandError(
5623
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5626
containing_tree.subsume(sub_tree)
5627
except errors.BadSubsumeSource as e:
5628
raise errors.BzrCommandError(
5629
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5632
class cmd_split(Command):
5633
__doc__ = """Split a subdirectory of a tree into a separate tree.
5635
This command will produce a target tree in a format that supports
5636
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5637
converted into earlier formats like 'dirstate-tags'.
5639
The TREE argument should be a subdirectory of a working tree. That
5640
subdirectory will be converted into an independent tree, with its own
5641
branch. Commits in the top-level tree will not apply to the new subtree.
5644
_see_also = ['join']
5645
takes_args = ['tree']
5647
def run(self, tree):
5648
containing_tree, subdir = WorkingTree.open_containing(tree)
5649
if not containing_tree.is_versioned(subdir):
5650
raise errors.NotVersionedError(subdir)
5652
containing_tree.extract(subdir)
5653
except errors.RootNotRich:
5654
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5657
class cmd_merge_directive(Command):
5658
__doc__ = """Generate a merge directive for auto-merge tools.
5660
A directive requests a merge to be performed, and also provides all the
5661
information necessary to do so. This means it must either include a
5662
revision bundle, or the location of a branch containing the desired
5665
A submit branch (the location to merge into) must be supplied the first
5666
time the command is issued. After it has been supplied once, it will
5667
be remembered as the default.
5669
A public branch is optional if a revision bundle is supplied, but required
5670
if --diff or --plain is specified. It will be remembered as the default
5671
after the first use.
5674
takes_args = ['submit_branch?', 'public_branch?']
5678
_see_also = ['send']
5682
RegistryOption.from_kwargs(
5684
'The type of patch to include in the directive.',
5686
value_switches=True,
5688
bundle='Bazaar revision bundle (default).',
5689
diff='Normal unified diff.',
5690
plain='No patch, just directive.'),
5691
Option('sign', help='GPG-sign the directive.'), 'revision',
5692
Option('mail-to', type=text_type,
5693
help='Instead of printing the directive, email to this '
5695
Option('message', type=text_type, short_name='m',
5696
help='Message to use when committing this merge.')
5699
encoding_type = 'exact'
5701
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5702
sign=False, revision=None, mail_to=None, message=None,
5704
from .revision import ensure_null, NULL_REVISION
5705
include_patch, include_bundle = {
5706
'plain': (False, False),
5707
'diff': (True, False),
5708
'bundle': (True, True),
5710
branch = Branch.open(directory)
5711
stored_submit_branch = branch.get_submit_branch()
5712
if submit_branch is None:
5713
submit_branch = stored_submit_branch
5715
if stored_submit_branch is None:
5716
branch.set_submit_branch(submit_branch)
5717
if submit_branch is None:
5718
submit_branch = branch.get_parent()
5719
if submit_branch is None:
5720
raise errors.BzrCommandError(
5721
gettext('No submit branch specified or known'))
5723
stored_public_branch = branch.get_public_branch()
5724
if public_branch is None:
5725
public_branch = stored_public_branch
5726
elif stored_public_branch is None:
5727
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5728
branch.set_public_branch(public_branch)
5729
if not include_bundle and public_branch is None:
5730
raise errors.BzrCommandError(
5731
gettext('No public branch specified or known'))
5732
base_revision_id = None
5733
if revision is not None:
5734
if len(revision) > 2:
5735
raise errors.BzrCommandError(
5736
gettext('brz merge-directive takes '
5737
'at most two one revision identifiers'))
5738
revision_id = revision[-1].as_revision_id(branch)
5739
if len(revision) == 2:
5740
base_revision_id = revision[0].as_revision_id(branch)
5742
revision_id = branch.last_revision()
5743
revision_id = ensure_null(revision_id)
5744
if revision_id == NULL_REVISION:
5745
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5746
directive = merge_directive.MergeDirective2.from_objects(
5747
branch.repository, revision_id, time.time(),
5748
osutils.local_time_offset(), submit_branch,
5749
public_branch=public_branch, include_patch=include_patch,
5750
include_bundle=include_bundle, message=message,
5751
base_revision_id=base_revision_id)
5754
self.outf.write(directive.to_signed(branch))
5756
self.outf.writelines(directive.to_lines())
5758
message = directive.to_email(mail_to, branch, sign)
5759
s = SMTPConnection(branch.get_config_stack())
5760
s.send_email(message)
5763
class cmd_send(Command):
5764
__doc__ = """Mail or create a merge-directive for submitting changes.
5766
A merge directive provides many things needed for requesting merges:
5768
* A machine-readable description of the merge to perform
5770
* An optional patch that is a preview of the changes requested
5772
* An optional bundle of revision data, so that the changes can be applied
5773
directly from the merge directive, without retrieving data from a
5776
`brz send` creates a compact data set that, when applied using brz
5777
merge, has the same effect as merging from the source branch.
5779
By default the merge directive is self-contained and can be applied to any
5780
branch containing submit_branch in its ancestory without needing access to
5783
If --no-bundle is specified, then Breezy doesn't send the contents of the
5784
revisions, but only a structured request to merge from the
5785
public_location. In that case the public_branch is needed and it must be
5786
up-to-date and accessible to the recipient. The public_branch is always
5787
included if known, so that people can check it later.
5789
The submit branch defaults to the parent of the source branch, but can be
5790
overridden. Both submit branch and public branch will be remembered in
5791
branch.conf the first time they are used for a particular branch. The
5792
source branch defaults to that containing the working directory, but can
5793
be changed using --from.
5795
Both the submit branch and the public branch follow the usual behavior with
5796
respect to --remember: If there is no default location set, the first send
5797
will set it (use --no-remember to avoid setting it). After that, you can
5798
omit the location to use the default. To change the default, use
5799
--remember. The value will only be saved if the location can be accessed.
5801
In order to calculate those changes, brz must analyse the submit branch.
5802
Therefore it is most efficient for the submit branch to be a local mirror.
5803
If a public location is known for the submit_branch, that location is used
5804
in the merge directive.
5806
The default behaviour is to send the merge directive by mail, unless -o is
5807
given, in which case it is sent to a file.
5809
Mail is sent using your preferred mail program. This should be transparent
5810
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5811
If the preferred client can't be found (or used), your editor will be used.
5813
To use a specific mail program, set the mail_client configuration option.
5814
Supported values for specific clients are "claws", "evolution", "kmail",
5815
"mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options
5816
are "default", "editor", "emacsclient", "mapi", and "xdg-email". Plugins
5817
may also add supported clients.
5819
If mail is being sent, a to address is required. This can be supplied
5820
either on the commandline, by setting the submit_to configuration
5821
option in the branch itself or the child_submit_to configuration option
5822
in the submit branch.
5824
The merge directives created by brz send may be applied using brz merge or
5825
brz pull by specifying a file containing a merge directive as the location.
5827
brz send makes extensive use of public locations to map local locations into
5828
URLs that can be used by other people. See `brz help configuration` to
5829
set them, and use `brz info` to display them.
5832
encoding_type = 'exact'
5834
_see_also = ['merge', 'pull']
5836
takes_args = ['submit_branch?', 'public_branch?']
5840
help='Do not include a bundle in the merge directive.'),
5841
Option('no-patch', help='Do not include a preview patch in the merge'
5844
help='Remember submit and public branch.'),
5846
help='Branch to generate the submission from, '
5847
'rather than the one containing the working directory.',
5850
Option('output', short_name='o',
5851
help='Write merge directive to this file or directory; '
5852
'use - for stdout.',
5855
help='Refuse to send if there are uncommitted changes in'
5856
' the working tree, --no-strict disables the check.'),
5857
Option('mail-to', help='Mail the request to this address.',
5861
Option('body', help='Body for the email.', type=text_type),
5862
RegistryOption('format',
5863
help='Use the specified output format.',
5864
lazy_registry=('breezy.send', 'format_registry')),
5867
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5868
no_patch=False, revision=None, remember=None, output=None,
5869
format=None, mail_to=None, message=None, body=None,
5870
strict=None, **kwargs):
5871
from .send import send
5872
return send(submit_branch, revision, public_branch, remember,
5873
format, no_bundle, no_patch, output,
5874
kwargs.get('from', '.'), mail_to, message, body,
5879
class cmd_bundle_revisions(cmd_send):
5880
__doc__ = """Create a merge-directive for submitting changes.
5882
A merge directive provides many things needed for requesting merges:
5884
* A machine-readable description of the merge to perform
5886
* An optional patch that is a preview of the changes requested
5888
* An optional bundle of revision data, so that the changes can be applied
5889
directly from the merge directive, without retrieving data from a
5892
If --no-bundle is specified, then public_branch is needed (and must be
5893
up-to-date), so that the receiver can perform the merge using the
5894
public_branch. The public_branch is always included if known, so that
5895
people can check it later.
5897
The submit branch defaults to the parent, but can be overridden. Both
5898
submit branch and public branch will be remembered if supplied.
5900
If a public_branch is known for the submit_branch, that public submit
5901
branch is used in the merge instructions. This means that a local mirror
5902
can be used as your actual submit branch, once you have set public_branch
5908
help='Do not include a bundle in the merge directive.'),
5909
Option('no-patch', help='Do not include a preview patch in the merge'
5912
help='Remember submit and public branch.'),
5914
help='Branch to generate the submission from, '
5915
'rather than the one containing the working directory.',
5918
Option('output', short_name='o', help='Write directive to this file.',
5921
help='Refuse to bundle revisions if there are uncommitted'
5922
' changes in the working tree, --no-strict disables the check.'),
5924
RegistryOption('format',
5925
help='Use the specified output format.',
5926
lazy_registry=('breezy.send', 'format_registry')),
5928
aliases = ['bundle']
5930
_see_also = ['send', 'merge']
5934
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5935
no_patch=False, revision=None, remember=False, output=None,
5936
format=None, strict=None, **kwargs):
5939
from .send import send
5940
return send(submit_branch, revision, public_branch, remember,
5941
format, no_bundle, no_patch, output,
5942
kwargs.get('from', '.'), None, None, None,
5943
self.outf, strict=strict)
5946
class cmd_tag(Command):
5947
__doc__ = """Create, remove or modify a tag naming a revision.
5949
Tags give human-meaningful names to revisions. Commands that take a -r
5950
(--revision) option can be given -rtag:X, where X is any previously
5953
Tags are stored in the branch. Tags are copied from one branch to another
5954
along when you branch, push, pull or merge.
5956
It is an error to give a tag name that already exists unless you pass
5957
--force, in which case the tag is moved to point to the new revision.
5959
To rename a tag (change the name but keep it on the same revsion), run ``brz
5960
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
5962
If no tag name is specified it will be determined through the
5963
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5964
upstream releases by reading configure.ac. See ``brz help hooks`` for
5968
_see_also = ['commit', 'tags']
5969
takes_args = ['tag_name?']
5972
help='Delete this tag rather than placing it.',
5974
custom_help('directory',
5975
help='Branch in which to place the tag.'),
5977
help='Replace existing tags.',
5982
def run(self, tag_name=None,
5988
branch, relpath = Branch.open_containing(directory)
5989
self.enter_context(branch.lock_write())
5991
if tag_name is None:
5992
raise errors.BzrCommandError(
5993
gettext("No tag specified to delete."))
5994
branch.tags.delete_tag(tag_name)
5995
note(gettext('Deleted tag %s.') % tag_name)
5998
if len(revision) != 1:
5999
raise errors.BzrCommandError(gettext(
6000
"Tags can only be placed on a single revision, "
6002
revision_id = revision[0].as_revision_id(branch)
6004
revision_id = branch.last_revision()
6005
if tag_name is None:
6006
tag_name = branch.automatic_tag_name(revision_id)
6007
if tag_name is None:
6008
raise errors.BzrCommandError(gettext(
6009
"Please specify a tag name."))
6011
existing_target = branch.tags.lookup_tag(tag_name)
6012
except errors.NoSuchTag:
6013
existing_target = None
6014
if not force and existing_target not in (None, revision_id):
6015
raise errors.TagAlreadyExists(tag_name)
6016
if existing_target == revision_id:
6017
note(gettext('Tag %s already exists for that revision.') % tag_name)
6019
branch.tags.set_tag(tag_name, revision_id)
6020
if existing_target is None:
6021
note(gettext('Created tag %s.') % tag_name)
6023
note(gettext('Updated tag %s.') % tag_name)
6026
class cmd_tags(Command):
6027
__doc__ = """List tags.
6029
This command shows a table of tag names and the revisions they reference.
6034
custom_help('directory',
6035
help='Branch whose tags should be displayed.'),
6036
RegistryOption('sort',
6037
'Sort tags by different criteria.', title='Sorting',
6038
lazy_registry=('breezy.tag', 'tag_sort_methods')
6045
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6046
from .tag import tag_sort_methods
6047
branch, relpath = Branch.open_containing(directory)
6049
tags = list(viewitems(branch.tags.get_tag_dict()))
6053
self.enter_context(branch.lock_read())
6055
# Restrict to the specified range
6056
tags = self._tags_for_range(branch, revision)
6058
sort = tag_sort_methods.get()
6061
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6062
for index, (tag, revid) in enumerate(tags):
6064
revno = branch.revision_id_to_dotted_revno(revid)
6065
if isinstance(revno, tuple):
6066
revno = '.'.join(map(str, revno))
6067
except (errors.NoSuchRevision,
6068
errors.GhostRevisionsHaveNoRevno,
6069
errors.UnsupportedOperation):
6070
# Bad tag data/merges can lead to tagged revisions
6071
# which are not in this branch. Fail gracefully ...
6073
tags[index] = (tag, revno)
6075
tags = [(tag, revid.decode('utf-8')) for (tag, revid) in tags]
6077
for tag, revspec in tags:
6078
self.outf.write('%-20s %s\n' % (tag, revspec))
6080
def _tags_for_range(self, branch, revision):
6081
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6082
revid1, revid2 = rev1.rev_id, rev2.rev_id
6083
# _get_revision_range will always set revid2 if it's not specified.
6084
# If revid1 is None, it means we want to start from the branch
6085
# origin which is always a valid ancestor. If revid1 == revid2, the
6086
# ancestry check is useless.
6087
if revid1 and revid1 != revid2:
6088
# FIXME: We really want to use the same graph than
6089
# branch.iter_merge_sorted_revisions below, but this is not
6090
# easily available -- vila 2011-09-23
6091
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6092
# We don't want to output anything in this case...
6094
# only show revisions between revid1 and revid2 (inclusive)
6095
tagged_revids = branch.tags.get_reverse_tag_dict()
6097
for r in branch.iter_merge_sorted_revisions(
6098
start_revision_id=revid2, stop_revision_id=revid1,
6099
stop_rule='include'):
6100
revid_tags = tagged_revids.get(r[0], None)
6102
found.extend([(tag, r[0]) for tag in revid_tags])
6106
class cmd_reconfigure(Command):
6107
__doc__ = """Reconfigure the type of a brz directory.
6109
A target configuration must be specified.
6111
For checkouts, the bind-to location will be auto-detected if not specified.
6112
The order of preference is
6113
1. For a lightweight checkout, the current bound location.
6114
2. For branches that used to be checkouts, the previously-bound location.
6115
3. The push location.
6116
4. The parent location.
6117
If none of these is available, --bind-to must be specified.
6120
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6121
takes_args = ['location?']
6123
RegistryOption.from_kwargs(
6126
help='The relation between branch and tree.',
6127
value_switches=True, enum_switch=False,
6128
branch='Reconfigure to be an unbound branch with no working tree.',
6129
tree='Reconfigure to be an unbound branch with a working tree.',
6130
checkout='Reconfigure to be a bound branch with a working tree.',
6131
lightweight_checkout='Reconfigure to be a lightweight'
6132
' checkout (with no local history).',
6134
RegistryOption.from_kwargs(
6136
title='Repository type',
6137
help='Location fo the repository.',
6138
value_switches=True, enum_switch=False,
6139
standalone='Reconfigure to be a standalone branch '
6140
'(i.e. stop using shared repository).',
6141
use_shared='Reconfigure to use a shared repository.',
6143
RegistryOption.from_kwargs(
6145
title='Trees in Repository',
6146
help='Whether new branches in the repository have trees.',
6147
value_switches=True, enum_switch=False,
6148
with_trees='Reconfigure repository to create '
6149
'working trees on branches by default.',
6150
with_no_trees='Reconfigure repository to not create '
6151
'working trees on branches by default.'
6153
Option('bind-to', help='Branch to bind checkout to.', type=text_type),
6155
help='Perform reconfiguration even if local changes'
6157
Option('stacked-on',
6158
help='Reconfigure a branch to be stacked on another branch.',
6162
help='Reconfigure a branch to be unstacked. This '
6163
'may require copying substantial data into it.',
6167
def run(self, location=None, bind_to=None, force=False,
6168
tree_type=None, repository_type=None, repository_trees=None,
6169
stacked_on=None, unstacked=None):
6170
directory = controldir.ControlDir.open(location)
6171
if stacked_on and unstacked:
6172
raise errors.BzrCommandError(
6173
gettext("Can't use both --stacked-on and --unstacked"))
6174
elif stacked_on is not None:
6175
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6177
reconfigure.ReconfigureUnstacked().apply(directory)
6178
# At the moment you can use --stacked-on and a different
6179
# reconfiguration shape at the same time; there seems no good reason
6181
if (tree_type is None and
6182
repository_type is None and
6183
repository_trees is None):
6184
if stacked_on or unstacked:
6187
raise errors.BzrCommandError(gettext('No target configuration '
6189
reconfiguration = None
6190
if tree_type == 'branch':
6191
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6192
elif tree_type == 'tree':
6193
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6194
elif tree_type == 'checkout':
6195
reconfiguration = reconfigure.Reconfigure.to_checkout(
6197
elif tree_type == 'lightweight-checkout':
6198
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6201
reconfiguration.apply(force)
6202
reconfiguration = None
6203
if repository_type == 'use-shared':
6204
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6205
elif repository_type == 'standalone':
6206
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6208
reconfiguration.apply(force)
6209
reconfiguration = None
6210
if repository_trees == 'with-trees':
6211
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6213
elif repository_trees == 'with-no-trees':
6214
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6217
reconfiguration.apply(force)
6218
reconfiguration = None
6221
class cmd_switch(Command):
6222
__doc__ = """Set the branch of a checkout and update.
6224
For lightweight checkouts, this changes the branch being referenced.
6225
For heavyweight checkouts, this checks that there are no local commits
6226
versus the current bound branch, then it makes the local branch a mirror
6227
of the new location and binds to it.
6229
In both cases, the working tree is updated and uncommitted changes
6230
are merged. The user can commit or revert these as they desire.
6232
Pending merges need to be committed or reverted before using switch.
6234
The path to the branch to switch to can be specified relative to the parent
6235
directory of the current branch. For example, if you are currently in a
6236
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6239
Bound branches use the nickname of its master branch unless it is set
6240
locally, in which case switching will update the local nickname to be
6244
takes_args = ['to_location?']
6245
takes_options = ['directory',
6247
help='Switch even if local commits will be lost.'),
6249
Option('create-branch', short_name='b',
6250
help='Create the target branch from this one before'
6251
' switching to it.'),
6253
help='Store and restore uncommitted changes in the'
6257
def run(self, to_location=None, force=False, create_branch=False,
6258
revision=None, directory=u'.', store=False):
6259
from . import switch
6260
tree_location = directory
6261
revision = _get_one_revision('switch', revision)
6262
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6263
possible_transports = [control_dir.root_transport]
6264
if to_location is None:
6265
if revision is None:
6266
raise errors.BzrCommandError(gettext('You must supply either a'
6267
' revision or a location'))
6268
to_location = tree_location
6270
branch = control_dir.open_branch(
6271
possible_transports=possible_transports)
6272
had_explicit_nick = branch.get_config().has_explicit_nickname()
6273
except errors.NotBranchError:
6275
had_explicit_nick = False
6277
possible_transports.append(branch.user_transport)
6280
raise errors.BzrCommandError(
6281
gettext('cannot create branch without source branch'))
6282
to_location = lookup_new_sibling_branch(
6283
control_dir, to_location,
6284
possible_transports=possible_transports)
6285
if revision is not None:
6286
revision = revision.as_revision_id(branch)
6287
to_branch = branch.controldir.sprout(
6289
possible_transports=possible_transports,
6290
revision_id=revision,
6291
source_branch=branch).open_branch()
6294
to_branch = Branch.open(
6295
to_location, possible_transports=possible_transports)
6296
except errors.NotBranchError:
6297
to_branch = open_sibling_branch(
6298
control_dir, to_location,
6299
possible_transports=possible_transports)
6300
if revision is not None:
6301
revision = revision.as_revision_id(to_branch)
6302
possible_transports.append(to_branch.user_transport)
6304
switch.switch(control_dir, to_branch, force, revision_id=revision,
6305
store_uncommitted=store,
6306
possible_transports=possible_transports)
6307
except controldir.BranchReferenceLoop:
6308
raise errors.BzrCommandError(
6309
gettext('switching would create a branch reference loop. '
6310
'Use the "bzr up" command to switch to a '
6311
'different revision.'))
6312
if had_explicit_nick:
6313
branch = control_dir.open_branch() # get the new branch!
6314
branch.nick = to_branch.nick
6316
if to_branch.controldir.control_url != control_dir.control_url:
6317
note(gettext('Switched to branch %s at %s'),
6318
to_branch.name, urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6320
note(gettext('Switched to branch %s'), to_branch.name)
6322
note(gettext('Switched to branch at %s'),
6323
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6326
class cmd_view(Command):
6327
__doc__ = """Manage filtered views.
6329
Views provide a mask over the tree so that users can focus on
6330
a subset of a tree when doing their work. After creating a view,
6331
commands that support a list of files - status, diff, commit, etc -
6332
effectively have that list of files implicitly given each time.
6333
An explicit list of files can still be given but those files
6334
must be within the current view.
6336
In most cases, a view has a short life-span: it is created to make
6337
a selected change and is deleted once that change is committed.
6338
At other times, you may wish to create one or more named views
6339
and switch between them.
6341
To disable the current view without deleting it, you can switch to
6342
the pseudo view called ``off``. This can be useful when you need
6343
to see the whole tree for an operation or two (e.g. merge) but
6344
want to switch back to your view after that.
6347
To define the current view::
6349
brz view file1 dir1 ...
6351
To list the current view::
6355
To delete the current view::
6359
To disable the current view without deleting it::
6361
brz view --switch off
6363
To define a named view and switch to it::
6365
brz view --name view-name file1 dir1 ...
6367
To list a named view::
6369
brz view --name view-name
6371
To delete a named view::
6373
brz view --name view-name --delete
6375
To switch to a named view::
6377
brz view --switch view-name
6379
To list all views defined::
6383
To delete all views::
6385
brz view --delete --all
6389
takes_args = ['file*']
6392
help='Apply list or delete action to all views.',
6395
help='Delete the view.',
6398
help='Name of the view to define, list or delete.',
6402
help='Name of the view to switch to.',
6407
def run(self, file_list,
6413
tree, file_list = WorkingTree.open_containing_paths(file_list,
6415
current_view, view_dict = tree.views.get_view_info()
6420
raise errors.BzrCommandError(gettext(
6421
"Both --delete and a file list specified"))
6423
raise errors.BzrCommandError(gettext(
6424
"Both --delete and --switch specified"))
6426
tree.views.set_view_info(None, {})
6427
self.outf.write(gettext("Deleted all views.\n"))
6429
raise errors.BzrCommandError(
6430
gettext("No current view to delete"))
6432
tree.views.delete_view(name)
6433
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6436
raise errors.BzrCommandError(gettext(
6437
"Both --switch and a file list specified"))
6439
raise errors.BzrCommandError(gettext(
6440
"Both --switch and --all specified"))
6441
elif switch == 'off':
6442
if current_view is None:
6443
raise errors.BzrCommandError(
6444
gettext("No current view to disable"))
6445
tree.views.set_view_info(None, view_dict)
6446
self.outf.write(gettext("Disabled '%s' view.\n") %
6449
tree.views.set_view_info(switch, view_dict)
6450
view_str = views.view_display_str(tree.views.lookup_view())
6452
gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6455
self.outf.write(gettext('Views defined:\n'))
6456
for view in sorted(view_dict):
6457
if view == current_view:
6461
view_str = views.view_display_str(view_dict[view])
6462
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6464
self.outf.write(gettext('No views defined.\n'))
6467
# No name given and no current view set
6470
raise errors.BzrCommandError(gettext(
6471
"Cannot change the 'off' pseudo view"))
6472
tree.views.set_view(name, sorted(file_list))
6473
view_str = views.view_display_str(tree.views.lookup_view())
6475
gettext("Using '{0}' view: {1}\n").format(name, view_str))
6479
# No name given and no current view set
6480
self.outf.write(gettext('No current view.\n'))
6482
view_str = views.view_display_str(tree.views.lookup_view(name))
6484
gettext("'{0}' view is: {1}\n").format(name, view_str))
6487
class cmd_hooks(Command):
6488
__doc__ = """Show hooks."""
6493
for hook_key in sorted(hooks.known_hooks.keys()):
6494
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6495
self.outf.write("%s:\n" % type(some_hooks).__name__)
6496
for hook_name, hook_point in sorted(some_hooks.items()):
6497
self.outf.write(" %s:\n" % (hook_name,))
6498
found_hooks = list(hook_point)
6500
for hook in found_hooks:
6501
self.outf.write(" %s\n" %
6502
(some_hooks.get_hook_name(hook),))
6504
self.outf.write(gettext(" <no hooks installed>\n"))
6507
class cmd_remove_branch(Command):
6508
__doc__ = """Remove a branch.
6510
This will remove the branch from the specified location but
6511
will keep any working tree or repository in place.
6515
Remove the branch at repo/trunk::
6517
brz remove-branch repo/trunk
6521
takes_args = ["location?"]
6523
takes_options = ['directory',
6524
Option('force', help='Remove branch even if it is the active branch.')]
6526
aliases = ["rmbranch"]
6528
def run(self, directory=None, location=None, force=False):
6529
br = open_nearby_branch(near=directory, location=location)
6530
if not force and br.controldir.has_workingtree():
6532
active_branch = br.controldir.open_branch(name="")
6533
except errors.NotBranchError:
6534
active_branch = None
6535
if (active_branch is not None and
6536
br.control_url == active_branch.control_url):
6537
raise errors.BzrCommandError(
6538
gettext("Branch is active. Use --force to remove it."))
6539
br.controldir.destroy_branch(br.name)
6542
class cmd_shelve(Command):
6543
__doc__ = """Temporarily set aside some changes from the current tree.
6545
Shelve allows you to temporarily put changes you've made "on the shelf",
6546
ie. out of the way, until a later time when you can bring them back from
6547
the shelf with the 'unshelve' command. The changes are stored alongside
6548
your working tree, and so they aren't propagated along with your branch nor
6549
will they survive its deletion.
6551
If shelve --list is specified, previously-shelved changes are listed.
6553
Shelve is intended to help separate several sets of changes that have
6554
been inappropriately mingled. If you just want to get rid of all changes
6555
and you don't need to restore them later, use revert. If you want to
6556
shelve all text changes at once, use shelve --all.
6558
If filenames are specified, only the changes to those files will be
6559
shelved. Other files will be left untouched.
6561
If a revision is specified, changes since that revision will be shelved.
6563
You can put multiple items on the shelf, and by default, 'unshelve' will
6564
restore the most recently shelved changes.
6566
For complicated changes, it is possible to edit the changes in a separate
6567
editor program to decide what the file remaining in the working copy
6568
should look like. To do this, add the configuration option
6570
change_editor = PROGRAM @new_path @old_path
6572
where @new_path is replaced with the path of the new version of the
6573
file and @old_path is replaced with the path of the old version of
6574
the file. The PROGRAM should save the new file with the desired
6575
contents of the file in the working tree.
6579
takes_args = ['file*']
6584
Option('all', help='Shelve all changes.'),
6586
RegistryOption('writer', 'Method to use for writing diffs.',
6587
breezy.option.diff_writer_registry,
6588
value_switches=True, enum_switch=False),
6590
Option('list', help='List shelved changes.'),
6592
help='Destroy removed changes instead of shelving them.'),
6594
_see_also = ['unshelve', 'configuration']
6596
def run(self, revision=None, all=False, file_list=None, message=None,
6597
writer=None, list=False, destroy=False, directory=None):
6599
return self.run_for_list(directory=directory)
6600
from .shelf_ui import Shelver
6602
writer = breezy.option.diff_writer_registry.get()
6604
shelver = Shelver.from_args(writer(self.outf), revision, all,
6605
file_list, message, destroy=destroy, directory=directory)
6610
except errors.UserAbort:
6613
def run_for_list(self, directory=None):
6614
if directory is None:
6616
tree = WorkingTree.open_containing(directory)[0]
6617
self.enter_context(tree.lock_read())
6618
manager = tree.get_shelf_manager()
6619
shelves = manager.active_shelves()
6620
if len(shelves) == 0:
6621
note(gettext('No shelved changes.'))
6623
for shelf_id in reversed(shelves):
6624
message = manager.get_metadata(shelf_id).get(b'message')
6626
message = '<no message>'
6627
self.outf.write('%3d: %s\n' % (shelf_id, message))
6631
class cmd_unshelve(Command):
6632
__doc__ = """Restore shelved changes.
6634
By default, the most recently shelved changes are restored. However if you
6635
specify a shelf by id those changes will be restored instead. This works
6636
best when the changes don't depend on each other.
6639
takes_args = ['shelf_id?']
6642
RegistryOption.from_kwargs(
6643
'action', help="The action to perform.",
6644
enum_switch=False, value_switches=True,
6645
apply="Apply changes and remove from the shelf.",
6646
dry_run="Show changes, but do not apply or remove them.",
6647
preview="Instead of unshelving the changes, show the diff that "
6648
"would result from unshelving.",
6649
delete_only="Delete changes without applying them.",
6650
keep="Apply changes but don't delete them.",
6653
_see_also = ['shelve']
6655
def run(self, shelf_id=None, action='apply', directory=u'.'):
6656
from .shelf_ui import Unshelver
6657
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6661
unshelver.tree.unlock()
6664
class cmd_clean_tree(Command):
6665
__doc__ = """Remove unwanted files from working tree.
6667
By default, only unknown files, not ignored files, are deleted. Versioned
6668
files are never deleted.
6670
Another class is 'detritus', which includes files emitted by brz during
6671
normal operations and selftests. (The value of these files decreases with
6674
If no options are specified, unknown files are deleted. Otherwise, option
6675
flags are respected, and may be combined.
6677
To check what clean-tree will do, use --dry-run.
6679
takes_options = ['directory',
6680
Option('ignored', help='Delete all ignored files.'),
6681
Option('detritus', help='Delete conflict files, merge and revert'
6682
' backups, and failed selftest dirs.'),
6684
help='Delete files unknown to brz (default).'),
6685
Option('dry-run', help='Show files to delete instead of'
6687
Option('force', help='Do not prompt before deleting.')]
6689
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6690
force=False, directory=u'.'):
6691
from .clean_tree import clean_tree
6692
if not (unknown or ignored or detritus):
6696
clean_tree(directory, unknown=unknown, ignored=ignored,
6697
detritus=detritus, dry_run=dry_run, no_prompt=force)
6700
class cmd_reference(Command):
6701
__doc__ = """list, view and set branch locations for nested trees.
6703
If no arguments are provided, lists the branch locations for nested trees.
6704
If one argument is provided, display the branch location for that tree.
6705
If two arguments are provided, set the branch location for that tree.
6710
takes_args = ['path?', 'location?']
6712
Option('force-unversioned',
6713
help='Set reference even if path is not versioned.'),
6716
def run(self, path=None, location=None, force_unversioned=False):
6718
if path is not None:
6720
tree, branch, relpath = (
6721
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6722
if path is not None:
6725
tree = branch.basis_tree()
6727
info = viewitems(branch._get_all_reference_info())
6728
self._display_reference_info(tree, branch, info)
6730
if not tree.is_versioned(path) and not force_unversioned:
6731
raise errors.NotVersionedError(path)
6732
if location is None:
6733
info = [(path, branch.get_reference_info(path))]
6734
self._display_reference_info(tree, branch, info)
6736
branch.set_reference_info(
6737
path, location, file_id=tree.path2id(path))
6739
def _display_reference_info(self, tree, branch, info):
6741
for path, (location, file_id) in info:
6742
ref_list.append((path, location))
6743
for path, location in sorted(ref_list):
6744
self.outf.write('%s %s\n' % (path, location))
6747
class cmd_export_pot(Command):
6748
__doc__ = """Export command helps and error messages in po format."""
6751
takes_options = [Option('plugin',
6752
help='Export help text from named command '
6753
'(defaults to all built in commands).',
6755
Option('include-duplicates',
6756
help='Output multiple copies of the same msgid '
6757
'string if it appears more than once.'),
6760
def run(self, plugin=None, include_duplicates=False):
6761
from .export_pot import export_pot
6762
export_pot(self.outf, plugin, include_duplicates)
6765
class cmd_import(Command):
6766
__doc__ = """Import sources from a directory, tarball or zip file
6768
This command will import a directory, tarball or zip file into a bzr
6769
tree, replacing any versioned files already present. If a directory is
6770
specified, it is used as the target. If the directory does not exist, or
6771
is not versioned, it is created.
6773
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6775
If the tarball or zip has a single root directory, that directory is
6776
stripped when extracting the tarball. This is not done for directories.
6779
takes_args = ['source', 'tree?']
6781
def run(self, source, tree=None):
6782
from .upstream_import import do_import
6783
do_import(source, tree)
6786
class cmd_link_tree(Command):
6787
__doc__ = """Hardlink matching files to another tree.
6789
Only files with identical content and execute bit will be linked.
6792
takes_args = ['location']
6794
def run(self, location):
6795
from .transform import link_tree
6796
target_tree = WorkingTree.open_containing(".")[0]
6797
source_tree = WorkingTree.open(location)
6798
with target_tree.lock_write(), source_tree.lock_read():
6799
link_tree(target_tree, source_tree)
6802
class cmd_fetch_ghosts(Command):
6803
__doc__ = """Attempt to retrieve ghosts from another branch.
6805
If the other branch is not supplied, the last-pulled branch is used.
6809
aliases = ['fetch-missing']
6810
takes_args = ['branch?']
6811
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6813
def run(self, branch=None, no_fix=False):
6814
from .fetch_ghosts import GhostFetcher
6815
installed, failed = GhostFetcher.from_cmdline(branch).run()
6816
if len(installed) > 0:
6817
self.outf.write("Installed:\n")
6818
for rev in installed:
6819
self.outf.write(rev.decode('utf-8') + "\n")
6821
self.outf.write("Still missing:\n")
6823
self.outf.write(rev.decode('utf-8') + "\n")
6824
if not no_fix and len(installed) > 0:
6825
cmd_reconcile().run(".")
6828
class cmd_grep(Command):
6829
"""Print lines matching PATTERN for specified files and revisions.
6831
This command searches the specified files and revisions for a given
6832
pattern. The pattern is specified as a Python regular expressions[1].
6834
If the file name is not specified, the revisions starting with the
6835
current directory are searched recursively. If the revision number is
6836
not specified, the working copy is searched. To search the last committed
6837
revision, use the '-r -1' or '-r last:1' option.
6839
Unversioned files are not searched unless explicitly specified on the
6840
command line. Unversioned directores are not searched.
6842
When searching a pattern, the output is shown in the 'filepath:string'
6843
format. If a revision is explicitly searched, the output is shown as
6844
'filepath~N:string', where N is the revision number.
6846
--include and --exclude options can be used to search only (or exclude
6847
from search) files with base name matches the specified Unix style GLOB
6848
pattern. The GLOB pattern an use *, ?, and [...] as wildcards, and \\
6849
to quote wildcard or backslash character literally. Note that the glob
6850
pattern is not a regular expression.
6852
[1] http://docs.python.org/library/re.html#regular-expression-syntax
6855
encoding_type = 'replace'
6856
takes_args = ['pattern', 'path*']
6860
Option('color', type=text_type, argname='when',
6861
help='Show match in color. WHEN is never, always or auto.'),
6862
Option('diff', short_name='p',
6863
help='Grep for pattern in changeset for each revision.'),
6864
ListOption('exclude', type=text_type, argname='glob', short_name='X',
6865
help="Skip files whose base name matches GLOB."),
6866
ListOption('include', type=text_type, argname='glob', short_name='I',
6867
help="Search only files whose base name matches GLOB."),
6868
Option('files-with-matches', short_name='l',
6869
help='Print only the name of each input file in '
6870
'which PATTERN is found.'),
6871
Option('files-without-match', short_name='L',
6872
help='Print only the name of each input file in '
6873
'which PATTERN is not found.'),
6874
Option('fixed-string', short_name='F',
6875
help='Interpret PATTERN is a single fixed string (not regex).'),
6877
help='Search for pattern starting from the root of the branch. '
6878
'(implies --recursive)'),
6879
Option('ignore-case', short_name='i',
6880
help='Ignore case distinctions while matching.'),
6882
help='Number of levels to display - 0 for all, 1 for collapsed '
6885
type=_parse_levels),
6886
Option('line-number', short_name='n',
6887
help='Show 1-based line number.'),
6888
Option('no-recursive',
6889
help="Don't recurse into subdirectories. (default is --recursive)"),
6890
Option('null', short_name='Z',
6891
help='Write an ASCII NUL (\\0) separator '
6892
'between output lines rather than a newline.'),
6896
def run(self, verbose=False, ignore_case=False, no_recursive=False,
6897
from_root=False, null=False, levels=None, line_number=False,
6898
path_list=None, revision=None, pattern=None, include=None,
6899
exclude=None, fixed_string=False, files_with_matches=False,
6900
files_without_match=False, color=None, diff=False):
6901
from breezy import _termcolor
6904
if path_list is None:
6908
raise errors.BzrCommandError(
6909
'cannot specify both --from-root and PATH.')
6911
if files_with_matches and files_without_match:
6912
raise errors.BzrCommandError(
6913
'cannot specify both '
6914
'-l/--files-with-matches and -L/--files-without-matches.')
6916
global_config = _mod_config.GlobalConfig()
6919
color = global_config.get_user_option('grep_color')
6924
if color not in ['always', 'never', 'auto']:
6925
raise errors.BzrCommandError('Valid values for --color are '
6926
'"always", "never" or "auto".')
6932
if revision is not None or levels == 0:
6933
# print revision numbers as we may be showing multiple revisions
6940
if not ignore_case and grep.is_fixed_string(pattern):
6941
# if the pattern isalnum, implicitly use to -F for faster grep
6943
elif ignore_case and fixed_string:
6944
# GZ 2010-06-02: Fall back to regexp rather than lowercasing
6945
# pattern and text which will cause pain later
6946
fixed_string = False
6947
pattern = re.escape(pattern)
6950
re_flags = re.MULTILINE
6952
re_flags |= re.IGNORECASE
6954
if not fixed_string:
6955
patternc = grep.compile_pattern(
6956
pattern.encode(grep._user_encoding), re_flags)
6958
if color == 'always':
6960
elif color == 'never':
6962
elif color == 'auto':
6963
show_color = _termcolor.allow_color()
6965
opts = grep.GrepOptions()
6967
opts.verbose = verbose
6968
opts.ignore_case = ignore_case
6969
opts.no_recursive = no_recursive
6970
opts.from_root = from_root
6972
opts.levels = levels
6973
opts.line_number = line_number
6974
opts.path_list = path_list
6975
opts.revision = revision
6976
opts.pattern = pattern
6977
opts.include = include
6978
opts.exclude = exclude
6979
opts.fixed_string = fixed_string
6980
opts.files_with_matches = files_with_matches
6981
opts.files_without_match = files_without_match
6985
opts.eol_marker = eol_marker
6986
opts.print_revno = print_revno
6987
opts.patternc = patternc
6988
opts.recursive = not no_recursive
6989
opts.fixed_string = fixed_string
6990
opts.outf = self.outf
6991
opts.show_color = show_color
6995
# files_with_matches, files_without_match
6996
# levels(?), line_number, from_root
6998
# These are silently ignored.
6999
grep.grep_diff(opts)
7000
elif revision is None:
7001
grep.workingtree_grep(opts)
7003
grep.versioned_grep(opts)
7006
class cmd_patch(Command):
7007
"""Apply a named patch to the current tree.
7011
takes_args = ['filename?']
7012
takes_options = [Option('strip', type=int, short_name='p',
7013
help=("Strip the smallest prefix containing num "
7014
"leading slashes from filenames.")),
7015
Option('silent', help='Suppress chatter.')]
7017
def run(self, filename=None, strip=None, silent=False):
7018
from .patch import patch_tree
7019
wt = WorkingTree.open_containing('.')[0]
7023
if filename is None:
7024
my_file = getattr(sys.stdin, 'buffer', sys.stdin)
7026
my_file = open(filename, 'rb')
7027
patches = [my_file.read()]
7028
return patch_tree(wt, patches, strip, quiet=is_quiet(), out=self.outf)
7031
class cmd_resolve_location(Command):
7032
__doc__ = """Expand a location to a full URL.
7035
Look up a Launchpad URL.
7037
brz resolve-location lp:brz
7039
takes_args = ['location']
7042
def run(self, location):
7043
from .location import location_to_url
7044
url = location_to_url(location)
7045
display_url = urlutils.unescape_for_display(url, self.outf.encoding)
7046
self.outf.write('%s\n' % display_url)
7049
def _register_lazy_builtins():
7050
# register lazy builtins from other modules; called at startup and should
7051
# be only called once.
7052
for (name, aliases, module_name) in [
7053
('cmd_bisect', [], 'breezy.bisect'),
7054
('cmd_bundle_info', [], 'breezy.bundle.commands'),
7055
('cmd_config', [], 'breezy.config'),
7056
('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
7057
('cmd_file_id', [], 'breezy.bzr.debug_commands'),
7058
('cmd_file_path', [], 'breezy.bzr.debug_commands'),
7059
('cmd_version_info', [], 'breezy.cmd_version_info'),
7060
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
7061
('cmd_conflicts', [], 'breezy.conflicts'),
7062
('cmd_ping', [], 'breezy.bzr.smart.ping'),
7063
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
7064
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
7065
('cmd_test_script', [], 'breezy.cmd_test_script'),
7067
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
