1
# Copyright (C) 2005-2012 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin brz commands"""
19
from __future__ import absolute_import
32
from . import lazy_import
33
lazy_import.lazy_import(globals(), """
38
branch as _mod_branch,
44
config as _mod_config,
51
mergeable as _mod_mergeable,
56
revision as _mod_revision,
65
from breezy.branch import Branch
66
from breezy.conflicts import ConflictList
67
from breezy.transport import memory
68
from breezy.smtp_connection import SMTPConnection
69
from breezy.workingtree import WorkingTree
70
from breezy.i18n import gettext, ngettext
73
from .commands import (
75
builtin_command_registry,
85
from .revisionspec import (
95
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
98
def _get_branch_location(control_dir, possible_transports=None):
99
"""Return location of branch for this control dir."""
101
target = control_dir.get_branch_reference()
102
except errors.NotBranchError:
103
return control_dir.root_transport.base
104
if target is not None:
106
this_branch = control_dir.open_branch(
107
possible_transports=possible_transports)
108
# This may be a heavy checkout, where we want the master branch
109
master_location = this_branch.get_bound_location()
110
if master_location is not None:
111
return master_location
112
# If not, use a local sibling
113
return this_branch.base
116
def _is_colocated(control_dir, possible_transports=None):
117
"""Check if the branch in control_dir is colocated.
119
:param control_dir: Control directory
120
:return: Tuple with boolean indicating whether the branch is colocated
121
and the full URL to the actual branch
123
# This path is meant to be relative to the existing branch
124
this_url = _get_branch_location(
125
control_dir, possible_transports=possible_transports)
126
# Perhaps the target control dir supports colocated branches?
128
root = controldir.ControlDir.open(
129
this_url, possible_transports=possible_transports)
130
except errors.NotBranchError:
131
return (False, this_url)
134
control_dir.open_workingtree()
135
except (errors.NoWorkingTree, errors.NotLocalUrl):
136
return (False, this_url)
139
root._format.colocated_branches and
140
control_dir.control_url == root.control_url,
144
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
145
"""Lookup the location for a new sibling branch.
147
:param control_dir: Control directory to find sibling branches from
148
:param location: Name of the new branch
149
:return: Full location to the new branch
151
location = directory_service.directories.dereference(location)
152
if '/' not in location and '\\' not in location:
153
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
156
return urlutils.join_segment_parameters(
157
this_url, {"branch": urlutils.escape(location)})
159
return urlutils.join(this_url, '..', urlutils.escape(location))
163
def open_sibling_branch(control_dir, location, possible_transports=None):
164
"""Open a branch, possibly a sibling of another.
166
:param control_dir: Control directory relative to which to lookup the
168
:param location: Location to look up
169
:return: branch to open
172
# Perhaps it's a colocated branch?
173
return control_dir.open_branch(
174
location, possible_transports=possible_transports)
175
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
176
this_url = _get_branch_location(control_dir)
179
this_url, '..', urlutils.escape(location)))
182
def open_nearby_branch(near=None, location=None, possible_transports=None):
183
"""Open a nearby branch.
185
:param near: Optional location of container from which to open branch
186
:param location: Location of the branch
187
:return: Branch instance
194
location, possible_transports=possible_transports)
195
except errors.NotBranchError:
197
cdir = controldir.ControlDir.open(
198
near, possible_transports=possible_transports)
199
return open_sibling_branch(
200
cdir, location, possible_transports=possible_transports)
203
def iter_sibling_branches(control_dir, possible_transports=None):
204
"""Iterate over the siblings of a branch.
206
:param control_dir: Control directory for which to look up the siblings
207
:return: Iterator over tuples with branch name and branch object
210
reference = control_dir.get_branch_reference()
211
except errors.NotBranchError:
213
if reference is not None:
215
ref_branch = Branch.open(
216
reference, possible_transports=possible_transports)
217
except errors.NotBranchError:
221
if ref_branch is None or ref_branch.name:
222
if ref_branch is not None:
223
control_dir = ref_branch.controldir
224
for name, branch in viewitems(control_dir.get_branches()):
227
repo = ref_branch.controldir.find_repository()
228
for branch in repo.find_branches(using=True):
229
name = urlutils.relative_url(
230
repo.user_url, branch.user_url).rstrip("/")
234
def tree_files_for_add(file_list):
236
Return a tree and list of absolute paths from a file list.
238
Similar to tree_files, but add handles files a bit differently, so it a
239
custom implementation. In particular, MutableTreeTree.smart_add expects
240
absolute paths, which it immediately converts to relative paths.
242
# FIXME Would be nice to just return the relative paths like
243
# internal_tree_files does, but there are a large number of unit tests
244
# that assume the current interface to mutabletree.smart_add
246
tree, relpath = WorkingTree.open_containing(file_list[0])
247
if tree.supports_views():
248
view_files = tree.views.lookup_view()
250
for filename in file_list:
251
if not osutils.is_inside_any(view_files, filename):
252
raise views.FileOutsideView(filename, view_files)
253
file_list = file_list[:]
254
file_list[0] = tree.abspath(relpath)
256
tree = WorkingTree.open_containing(u'.')[0]
257
if tree.supports_views():
258
view_files = tree.views.lookup_view()
260
file_list = view_files
261
view_str = views.view_display_str(view_files)
262
note(gettext("Ignoring files outside view. View is %s"),
264
return tree, file_list
267
def _get_one_revision(command_name, revisions):
268
if revisions is None:
270
if len(revisions) != 1:
271
raise errors.BzrCommandError(gettext(
272
'brz %s --revision takes exactly one revision identifier') % (
277
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
278
"""Get a revision tree. Not suitable for commands that change the tree.
280
Specifically, the basis tree in dirstate trees is coupled to the dirstate
281
and doing a commit/uncommit/pull will at best fail due to changing the
284
If tree is passed in, it should be already locked, for lifetime management
285
of the trees internal cached state.
289
if revisions is None:
291
rev_tree = tree.basis_tree()
293
rev_tree = branch.basis_tree()
295
revision = _get_one_revision(command_name, revisions)
296
rev_tree = revision.as_tree(branch)
300
def _get_view_info_for_change_reporter(tree):
301
"""Get the view information from a tree for change reporting."""
304
current_view = tree.views.get_view_info()[0]
305
if current_view is not None:
306
view_info = (current_view, tree.views.lookup_view())
307
except views.ViewsNotSupported:
312
def _open_directory_or_containing_tree_or_branch(filename, directory):
313
"""Open the tree or branch containing the specified file, unless
314
the --directory option is used to specify a different branch."""
315
if directory is not None:
316
return (None, Branch.open(directory), filename)
317
return controldir.ControlDir.open_containing_tree_or_branch(filename)
320
# TODO: Make sure no commands unconditionally use the working directory as a
321
# branch. If a filename argument is used, the first of them should be used to
322
# specify the branch. (Perhaps this can be factored out into some kind of
323
# Argument class, representing a file in a branch, where the first occurrence
326
class cmd_status(Command):
327
__doc__ = """Display status summary.
329
This reports on versioned and unknown files, reporting them
330
grouped by state. Possible states are:
333
Versioned in the working copy but not in the previous revision.
336
Versioned in the previous revision but removed or deleted
340
Path of this file changed from the previous revision;
341
the text may also have changed. This includes files whose
342
parent directory was renamed.
345
Text has changed since the previous revision.
348
File kind has been changed (e.g. from file to directory).
351
Not versioned and not matching an ignore pattern.
353
Additionally for directories, symlinks and files with a changed
354
executable bit, Breezy indicates their type using a trailing
355
character: '/', '@' or '*' respectively. These decorations can be
356
disabled using the '--no-classify' option.
358
To see ignored files use 'brz ignored'. For details on the
359
changes to file texts, use 'brz diff'.
361
Note that --short or -S gives status flags for each item, similar
362
to Subversion's status command. To get output similar to svn -q,
365
If no arguments are specified, the status of the entire working
366
directory is shown. Otherwise, only the status of the specified
367
files or directories is reported. If a directory is given, status
368
is reported for everything inside that directory.
370
Before merges are committed, the pending merge tip revisions are
371
shown. To see all pending merge revisions, use the -v option.
372
To skip the display of pending merge information altogether, use
373
the no-pending option or specify a file/directory.
375
To compare the working directory to a specific revision, pass a
376
single revision to the revision argument.
378
To see which files have changed in a specific revision, or between
379
two revisions, pass a revision range to the revision argument.
380
This will produce the same results as calling 'brz diff --summarize'.
383
# TODO: --no-recurse/-N, --recurse options
385
takes_args = ['file*']
386
takes_options = ['show-ids', 'revision', 'change', 'verbose',
387
Option('short', help='Use short status indicators.',
389
Option('versioned', help='Only show versioned files.',
391
Option('no-pending', help='Don\'t show pending merges.'),
392
Option('no-classify',
393
help='Do not mark object type using indicator.'),
395
aliases = ['st', 'stat']
397
encoding_type = 'replace'
398
_see_also = ['diff', 'revert', 'status-flags']
401
def run(self, show_ids=False, file_list=None, revision=None, short=False,
402
versioned=False, no_pending=False, verbose=False,
404
from .status import show_tree_status
406
if revision and len(revision) > 2:
407
raise errors.BzrCommandError(
408
gettext('brz status --revision takes exactly'
409
' one or two revision specifiers'))
411
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
412
# Avoid asking for specific files when that is not needed.
413
if relfile_list == ['']:
415
# Don't disable pending merges for full trees other than '.'.
416
if file_list == ['.']:
418
# A specific path within a tree was given.
419
elif relfile_list is not None:
421
show_tree_status(tree, show_ids=show_ids,
422
specific_files=relfile_list, revision=revision,
423
to_file=self.outf, short=short, versioned=versioned,
424
show_pending=(not no_pending), verbose=verbose,
425
classify=not no_classify)
428
class cmd_cat_revision(Command):
429
__doc__ = """Write out metadata for a revision.
431
The revision to print can either be specified by a specific
432
revision identifier, or you can use --revision.
436
takes_args = ['revision_id?']
437
takes_options = ['directory', 'revision']
438
# cat-revision is more for frontends so should be exact
441
def print_revision(self, revisions, revid):
442
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
443
record = next(stream)
444
if record.storage_kind == 'absent':
445
raise errors.NoSuchRevision(revisions, revid)
446
revtext = record.get_bytes_as('fulltext')
447
self.outf.write(revtext.decode('utf-8'))
450
def run(self, revision_id=None, revision=None, directory=u'.'):
451
if revision_id is not None and revision is not None:
452
raise errors.BzrCommandError(gettext('You can only supply one of'
453
' revision_id or --revision'))
454
if revision_id is None and revision is None:
455
raise errors.BzrCommandError(
456
gettext('You must supply either --revision or a revision_id'))
458
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
460
revisions = getattr(b.repository, "revisions", None)
461
if revisions is None:
462
raise errors.BzrCommandError(
463
gettext('Repository %r does not support '
464
'access to raw revision texts') % b.repository)
466
with b.repository.lock_read():
467
# TODO: jam 20060112 should cat-revision always output utf-8?
468
if revision_id is not None:
469
revision_id = cache_utf8.encode(revision_id)
471
self.print_revision(revisions, revision_id)
472
except errors.NoSuchRevision:
474
"The repository {0} contains no revision {1}.").format(
475
b.repository.base, revision_id.decode('utf-8'))
476
raise errors.BzrCommandError(msg)
477
elif revision is not None:
480
raise errors.BzrCommandError(
481
gettext('You cannot specify a NULL revision.'))
482
rev_id = rev.as_revision_id(b)
483
self.print_revision(revisions, rev_id)
486
class cmd_remove_tree(Command):
487
__doc__ = """Remove the working tree from a given branch/checkout.
489
Since a lightweight checkout is little more than a working tree
490
this will refuse to run against one.
492
To re-create the working tree, use "brz checkout".
494
_see_also = ['checkout', 'working-trees']
495
takes_args = ['location*']
498
help='Remove the working tree even if it has '
499
'uncommitted or shelved changes.'),
502
def run(self, location_list, force=False):
503
if not location_list:
504
location_list = ['.']
506
for location in location_list:
507
d = controldir.ControlDir.open(location)
510
working = d.open_workingtree()
511
except errors.NoWorkingTree:
512
raise errors.BzrCommandError(
513
gettext("No working tree to remove"))
514
except errors.NotLocalUrl:
515
raise errors.BzrCommandError(
516
gettext("You cannot remove the working tree"
517
" of a remote path"))
519
if (working.has_changes()):
520
raise errors.UncommittedChanges(working)
521
if working.get_shelf_manager().last_shelf() is not None:
522
raise errors.ShelvedChanges(working)
524
if working.user_url != working.branch.user_url:
525
raise errors.BzrCommandError(
526
gettext("You cannot remove the working tree"
527
" from a lightweight checkout"))
529
d.destroy_workingtree()
532
class cmd_repair_workingtree(Command):
533
__doc__ = """Reset the working tree state file.
535
This is not meant to be used normally, but more as a way to recover from
536
filesystem corruption, etc. This rebuilds the working inventory back to a
537
'known good' state. Any new modifications (adding a file, renaming, etc)
538
will be lost, though modified files will still be detected as such.
540
Most users will want something more like "brz revert" or "brz update"
541
unless the state file has become corrupted.
543
By default this attempts to recover the current state by looking at the
544
headers of the state file. If the state file is too corrupted to even do
545
that, you can supply --revision to force the state of the tree.
549
'revision', 'directory',
551
help='Reset the tree even if it doesn\'t appear to be'
556
def run(self, revision=None, directory='.', force=False):
557
tree, _ = WorkingTree.open_containing(directory)
558
self.enter_context(tree.lock_tree_write())
562
except errors.BzrError:
563
pass # There seems to be a real error here, so we'll reset
566
raise errors.BzrCommandError(gettext(
567
'The tree does not appear to be corrupt. You probably'
568
' want "brz revert" instead. Use "--force" if you are'
569
' sure you want to reset the working tree.'))
573
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
575
tree.reset_state(revision_ids)
576
except errors.BzrError:
577
if revision_ids is None:
578
extra = gettext(', the header appears corrupt, try passing '
579
'-r -1 to set the state to the last commit')
582
raise errors.BzrCommandError(
583
gettext('failed to reset the tree state{0}').format(extra))
586
class cmd_revno(Command):
587
__doc__ = """Show current revision number.
589
This is equal to the number of revisions on this branch.
593
takes_args = ['location?']
595
Option('tree', help='Show revno of working tree.'),
600
def run(self, tree=False, location=u'.', revision=None):
601
if revision is not None and tree:
602
raise errors.BzrCommandError(
603
gettext("--tree and --revision can not be used together"))
607
wt = WorkingTree.open_containing(location)[0]
608
self.enter_context(wt.lock_read())
609
except (errors.NoWorkingTree, errors.NotLocalUrl):
610
raise errors.NoWorkingTree(location)
612
revid = wt.last_revision()
614
b = Branch.open_containing(location)[0]
615
self.enter_context(b.lock_read())
617
if len(revision) != 1:
618
raise errors.BzrCommandError(gettext(
619
"Revision numbers only make sense for single "
620
"revisions, not ranges"))
621
revid = revision[0].as_revision_id(b)
623
revid = b.last_revision()
625
revno_t = b.revision_id_to_dotted_revno(revid)
626
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
628
revno = ".".join(str(n) for n in revno_t)
630
self.outf.write(revno + '\n')
633
class cmd_revision_info(Command):
634
__doc__ = """Show revision number and revision id for a given revision identifier.
637
takes_args = ['revision_info*']
640
custom_help('directory', help='Branch to examine, '
641
'rather than the one containing the working directory.'),
642
Option('tree', help='Show revno of working tree.'),
646
def run(self, revision=None, directory=u'.', tree=False,
647
revision_info_list=[]):
650
wt = WorkingTree.open_containing(directory)[0]
652
self.enter_context(wt.lock_read())
653
except (errors.NoWorkingTree, errors.NotLocalUrl):
655
b = Branch.open_containing(directory)[0]
656
self.enter_context(b.lock_read())
658
if revision is not None:
659
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
660
if revision_info_list is not None:
661
for rev_str in revision_info_list:
662
rev_spec = RevisionSpec.from_string(rev_str)
663
revision_ids.append(rev_spec.as_revision_id(b))
664
# No arguments supplied, default to the last revision
665
if len(revision_ids) == 0:
668
raise errors.NoWorkingTree(directory)
669
revision_ids.append(wt.last_revision())
671
revision_ids.append(b.last_revision())
675
for revision_id in revision_ids:
677
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
678
revno = '.'.join(str(i) for i in dotted_revno)
679
except errors.NoSuchRevision:
681
maxlen = max(maxlen, len(revno))
682
revinfos.append((revno, revision_id))
685
for revno, revid in revinfos:
687
'%*s %s\n' % (maxlen, revno, revid.decode('utf-8')))
690
class cmd_add(Command):
691
__doc__ = """Add specified files or directories.
693
In non-recursive mode, all the named items are added, regardless
694
of whether they were previously ignored. A warning is given if
695
any of the named files are already versioned.
697
In recursive mode (the default), files are treated the same way
698
but the behaviour for directories is different. Directories that
699
are already versioned do not give a warning. All directories,
700
whether already versioned or not, are searched for files or
701
subdirectories that are neither versioned or ignored, and these
702
are added. This search proceeds recursively into versioned
703
directories. If no names are given '.' is assumed.
705
A warning will be printed when nested trees are encountered,
706
unless they are explicitly ignored.
708
Therefore simply saying 'brz add' will version all files that
709
are currently unknown.
711
Adding a file whose parent directory is not versioned will
712
implicitly add the parent, and so on up to the root. This means
713
you should never need to explicitly add a directory, they'll just
714
get added when you add a file in the directory.
716
--dry-run will show which files would be added, but not actually
719
--file-ids-from will try to use the file ids from the supplied path.
720
It looks up ids trying to find a matching parent directory with the
721
same filename, and then by pure path. This option is rarely needed
722
but can be useful when adding the same logical file into two
723
branches that will be merged later (without showing the two different
724
adds as a conflict). It is also useful when merging another project
725
into a subdirectory of this one.
727
Any files matching patterns in the ignore list will not be added
728
unless they are explicitly mentioned.
730
In recursive mode, files larger than the configuration option
731
add.maximum_file_size will be skipped. Named items are never skipped due
734
takes_args = ['file*']
737
help="Don't recursively add the contents of directories.",
740
help="Show what would be done, but don't actually do "
743
Option('file-ids-from',
745
help='Lookup file ids from this tree.'),
747
encoding_type = 'replace'
748
_see_also = ['remove', 'ignore']
750
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
755
if file_ids_from is not None:
757
base_tree, base_path = WorkingTree.open_containing(
759
except errors.NoWorkingTree:
760
base_branch, base_path = Branch.open_containing(
762
base_tree = base_branch.basis_tree()
764
action = breezy.add.AddFromBaseAction(
765
base_tree, base_path, to_file=self.outf,
766
should_print=(not is_quiet()))
768
action = breezy.add.AddWithSkipLargeAction(
769
to_file=self.outf, should_print=(not is_quiet()))
772
self.enter_context(base_tree.lock_read())
773
tree, file_list = tree_files_for_add(file_list)
774
added, ignored = tree.smart_add(
775
file_list, not no_recurse, action=action, save=not dry_run)
779
for glob in sorted(ignored):
780
for path in ignored[glob]:
782
gettext("ignored {0} matching \"{1}\"\n").format(
786
class cmd_mkdir(Command):
787
__doc__ = """Create a new versioned directory.
789
This is equivalent to creating the directory and then adding it.
792
takes_args = ['dir+']
796
help='No error if existing, make parent directories as needed.',
800
encoding_type = 'replace'
803
def add_file_with_parents(cls, wt, relpath):
804
if wt.is_versioned(relpath):
806
cls.add_file_with_parents(wt, osutils.dirname(relpath))
810
def add_file_single(cls, wt, relpath):
813
def run(self, dir_list, parents=False):
815
add_file = self.add_file_with_parents
817
add_file = self.add_file_single
819
wt, relpath = WorkingTree.open_containing(dir)
824
if e.errno != errno.EEXIST:
828
add_file(wt, relpath)
830
self.outf.write(gettext('added %s\n') % dir)
833
class cmd_relpath(Command):
834
__doc__ = """Show path of a file relative to root"""
836
takes_args = ['filename']
840
def run(self, filename):
841
# TODO: jam 20050106 Can relpath return a munged path if
842
# sys.stdout encoding cannot represent it?
843
tree, relpath = WorkingTree.open_containing(filename)
844
self.outf.write(relpath)
845
self.outf.write('\n')
848
class cmd_inventory(Command):
849
__doc__ = """Show inventory of the current working copy or a revision.
851
It is possible to limit the output to a particular entry
852
type using the --kind option. For example: --kind file.
854
It is also possible to restrict the list of files to a specific
855
set. For example: brz inventory --show-ids this/file
863
Option('include-root',
864
help='Include the entry for the root of the tree, if any.'),
866
help='List entries of a particular kind: file, directory, '
870
takes_args = ['file*']
873
def run(self, revision=None, show_ids=False, kind=None, include_root=False,
875
if kind and kind not in ['file', 'directory', 'symlink']:
876
raise errors.BzrCommandError(
877
gettext('invalid kind %r specified') % (kind,))
879
revision = _get_one_revision('inventory', revision)
880
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
881
self.enter_context(work_tree.lock_read())
882
if revision is not None:
883
tree = revision.as_tree(work_tree.branch)
885
extra_trees = [work_tree]
886
self.enter_context(tree.lock_read())
891
self.enter_context(tree.lock_read())
892
if file_list is not None:
893
paths = tree.find_related_paths_across_trees(
894
file_list, extra_trees, require_versioned=True)
895
# find_ids_across_trees may include some paths that don't
897
entries = tree.iter_entries_by_dir(specific_files=paths)
899
entries = tree.iter_entries_by_dir()
901
for path, entry in sorted(entries):
902
if kind and kind != entry.kind:
904
if path == "" and not include_root:
907
self.outf.write('%-50s %s\n' % (
908
path, entry.file_id.decode('utf-8')))
910
self.outf.write(path)
911
self.outf.write('\n')
914
class cmd_cp(Command):
915
__doc__ = """Copy a file.
918
brz cp OLDNAME NEWNAME
920
brz cp SOURCE... DESTINATION
922
If the last argument is a versioned directory, all the other names
923
are copied into it. Otherwise, there must be exactly two arguments
924
and the file is copied to a new name.
926
Files cannot be copied between branches. Only files can be copied
930
takes_args = ['names*']
933
encoding_type = 'replace'
935
def run(self, names_list):
936
if names_list is None:
938
if len(names_list) < 2:
939
raise errors.BzrCommandError(gettext("missing file argument"))
940
tree, rel_names = WorkingTree.open_containing_paths(
941
names_list, canonicalize=False)
942
for file_name in rel_names[0:-1]:
944
raise errors.BzrCommandError(
945
gettext("can not copy root of branch"))
946
self.enter_context(tree.lock_tree_write())
947
into_existing = osutils.isdir(names_list[-1])
948
if not into_existing:
950
(src, dst) = rel_names
952
raise errors.BzrCommandError(
953
gettext('to copy multiple files the'
954
' destination must be a versioned'
959
(n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
960
for n in rel_names[:-1]]
962
for src, dst in pairs:
964
src_kind = tree.stored_kind(src)
965
except errors.NoSuchFile:
966
raise errors.BzrCommandError(
967
gettext('Could not copy %s => %s: %s is not versioned.')
970
raise errors.BzrCommandError(
971
gettext('Could not copy %s => %s . %s is not versioned\\.'
973
if src_kind == 'directory':
974
raise errors.BzrCommandError(
975
gettext('Could not copy %s => %s . %s is a directory.'
977
dst_parent = osutils.split(dst)[0]
980
dst_parent_kind = tree.stored_kind(dst_parent)
981
except errors.NoSuchFile:
982
raise errors.BzrCommandError(
983
gettext('Could not copy %s => %s: %s is not versioned.')
984
% (src, dst, dst_parent))
985
if dst_parent_kind != 'directory':
986
raise errors.BzrCommandError(
987
gettext('Could not copy to %s: %s is not a directory.')
988
% (dst_parent, dst_parent))
990
tree.copy_one(src, dst)
993
class cmd_mv(Command):
994
__doc__ = """Move or rename a file.
997
brz mv OLDNAME NEWNAME
999
brz mv SOURCE... DESTINATION
1001
If the last argument is a versioned directory, all the other names
1002
are moved into it. Otherwise, there must be exactly two arguments
1003
and the file is changed to a new name.
1005
If OLDNAME does not exist on the filesystem but is versioned and
1006
NEWNAME does exist on the filesystem but is not versioned, mv
1007
assumes that the file has been manually moved and only updates
1008
its internal inventory to reflect that change.
1009
The same is valid when moving many SOURCE files to a DESTINATION.
1011
Files cannot be moved between branches.
1014
takes_args = ['names*']
1015
takes_options = [Option("after", help="Move only the brz identifier"
1016
" of the file, because the file has already been moved."),
1017
Option('auto', help='Automatically guess renames.'),
1019
'dry-run', help='Avoid making changes when guessing renames.'),
1021
aliases = ['move', 'rename']
1022
encoding_type = 'replace'
1024
def run(self, names_list, after=False, auto=False, dry_run=False):
1026
return self.run_auto(names_list, after, dry_run)
1028
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1029
if names_list is None:
1031
if len(names_list) < 2:
1032
raise errors.BzrCommandError(gettext("missing file argument"))
1033
tree, rel_names = WorkingTree.open_containing_paths(
1034
names_list, canonicalize=False)
1035
for file_name in rel_names[0:-1]:
1037
raise errors.BzrCommandError(
1038
gettext("can not move root of branch"))
1039
self.enter_context(tree.lock_tree_write())
1040
self._run(tree, names_list, rel_names, after)
1042
def run_auto(self, names_list, after, dry_run):
1043
if names_list is not None and len(names_list) > 1:
1044
raise errors.BzrCommandError(
1045
gettext('Only one path may be specified to --auto.'))
1047
raise errors.BzrCommandError(
1048
gettext('--after cannot be specified with --auto.'))
1049
work_tree, file_list = WorkingTree.open_containing_paths(
1050
names_list, default_directory='.')
1051
self.enter_context(work_tree.lock_tree_write())
1052
rename_map.RenameMap.guess_renames(
1053
work_tree.basis_tree(), work_tree, dry_run)
1055
def _run(self, tree, names_list, rel_names, after):
1056
into_existing = osutils.isdir(names_list[-1])
1057
if into_existing and len(names_list) == 2:
1059
# a. case-insensitive filesystem and change case of dir
1060
# b. move directory after the fact (if the source used to be
1061
# a directory, but now doesn't exist in the working tree
1062
# and the target is an existing directory, just rename it)
1063
if (not tree.case_sensitive
1064
and rel_names[0].lower() == rel_names[1].lower()):
1065
into_existing = False
1067
# 'fix' the case of a potential 'from'
1068
from_path = tree.get_canonical_path(rel_names[0])
1069
if (not osutils.lexists(names_list[0]) and
1070
tree.is_versioned(from_path) and
1071
tree.stored_kind(from_path) == "directory"):
1072
into_existing = False
1075
# move into existing directory
1076
# All entries reference existing inventory items, so fix them up
1077
# for cicp file-systems.
1078
rel_names = list(tree.get_canonical_paths(rel_names))
1079
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1081
self.outf.write("%s => %s\n" % (src, dest))
1083
if len(names_list) != 2:
1084
raise errors.BzrCommandError(gettext('to mv multiple files the'
1085
' destination must be a versioned'
1088
# for cicp file-systems: the src references an existing inventory
1090
src = tree.get_canonical_path(rel_names[0])
1091
# Find the canonical version of the destination: In all cases, the
1092
# parent of the target must be in the inventory, so we fetch the
1093
# canonical version from there (we do not always *use* the
1094
# canonicalized tail portion - we may be attempting to rename the
1096
canon_dest = tree.get_canonical_path(rel_names[1])
1097
dest_parent = osutils.dirname(canon_dest)
1098
spec_tail = osutils.basename(rel_names[1])
1099
# For a CICP file-system, we need to avoid creating 2 inventory
1100
# entries that differ only by case. So regardless of the case
1101
# we *want* to use (ie, specified by the user or the file-system),
1102
# we must always choose to use the case of any existing inventory
1103
# items. The only exception to this is when we are attempting a
1104
# case-only rename (ie, canonical versions of src and dest are
1106
dest_id = tree.path2id(canon_dest)
1107
if dest_id is None or tree.path2id(src) == dest_id:
1108
# No existing item we care about, so work out what case we
1109
# are actually going to use.
1111
# If 'after' is specified, the tail must refer to a file on disk.
1113
dest_parent_fq = osutils.pathjoin(
1114
tree.basedir, dest_parent)
1116
# pathjoin with an empty tail adds a slash, which breaks
1118
dest_parent_fq = tree.basedir
1120
dest_tail = osutils.canonical_relpath(
1122
osutils.pathjoin(dest_parent_fq, spec_tail))
1124
# not 'after', so case as specified is used
1125
dest_tail = spec_tail
1127
# Use the existing item so 'mv' fails with AlreadyVersioned.
1128
dest_tail = os.path.basename(canon_dest)
1129
dest = osutils.pathjoin(dest_parent, dest_tail)
1130
mutter("attempting to move %s => %s", src, dest)
1131
tree.rename_one(src, dest, after=after)
1133
self.outf.write("%s => %s\n" % (src, dest))
1136
class cmd_pull(Command):
1137
__doc__ = """Turn this branch into a mirror of another branch.
1139
By default, this command only works on branches that have not diverged.
1140
Branches are considered diverged if the destination branch's most recent
1141
commit is one that has not been merged (directly or indirectly) into the
1144
If branches have diverged, you can use 'brz merge' to integrate the changes
1145
from one into the other. Once one branch has merged, the other should
1146
be able to pull it again.
1148
If you want to replace your local changes and just want your branch to
1149
match the remote one, use pull --overwrite. This will work even if the two
1150
branches have diverged.
1152
If there is no default location set, the first pull will set it (use
1153
--no-remember to avoid setting it). After that, you can omit the
1154
location to use the default. To change the default, use --remember. The
1155
value will only be saved if the remote location can be accessed.
1157
The --verbose option will display the revisions pulled using the log_format
1158
configuration option. You can use a different format by overriding it with
1159
-Olog_format=<other_format>.
1161
Note: The location can be specified either in the form of a branch,
1162
or in the form of a path to a file containing a merge directive generated
1166
_see_also = ['push', 'update', 'status-flags', 'send']
1167
takes_options = ['remember', 'overwrite', 'revision',
1168
custom_help('verbose',
1169
help='Show logs of pulled revisions.'),
1170
custom_help('directory',
1171
help='Branch to pull into, '
1172
'rather than the one containing the working directory.'),
1174
help="Perform a local pull in a bound "
1175
"branch. Local pulls are not applied to "
1176
"the master branch."
1179
help="Show base revision text in conflicts."),
1180
Option('overwrite-tags',
1181
help="Overwrite tags only."),
1183
takes_args = ['location?']
1184
encoding_type = 'replace'
1186
def run(self, location=None, remember=None, overwrite=False,
1187
revision=None, verbose=False,
1188
directory=None, local=False,
1189
show_base=False, overwrite_tags=False):
1192
overwrite = ["history", "tags"]
1193
elif overwrite_tags:
1194
overwrite = ["tags"]
1197
# FIXME: too much stuff is in the command class
1200
if directory is None:
1203
tree_to = WorkingTree.open_containing(directory)[0]
1204
branch_to = tree_to.branch
1205
self.enter_context(tree_to.lock_write())
1206
except errors.NoWorkingTree:
1208
branch_to = Branch.open_containing(directory)[0]
1209
self.enter_context(branch_to.lock_write())
1211
warning(gettext("No working tree, ignoring --show-base"))
1213
if local and not branch_to.get_bound_location():
1214
raise errors.LocalRequiresBoundBranch()
1216
possible_transports = []
1217
if location is not None:
1219
mergeable = _mod_mergeable.read_mergeable_from_url(
1220
location, possible_transports=possible_transports)
1221
except errors.NotABundle:
1224
stored_loc = branch_to.get_parent()
1225
if location is None:
1226
if stored_loc is None:
1227
raise errors.BzrCommandError(gettext("No pull location known or"
1230
display_url = urlutils.unescape_for_display(stored_loc,
1234
gettext("Using saved parent location: %s\n") % display_url)
1235
location = stored_loc
1237
revision = _get_one_revision('pull', revision)
1238
if mergeable is not None:
1239
if revision is not None:
1240
raise errors.BzrCommandError(gettext(
1241
'Cannot use -r with merge directives or bundles'))
1242
mergeable.install_revisions(branch_to.repository)
1243
base_revision_id, revision_id, verified = \
1244
mergeable.get_merge_request(branch_to.repository)
1245
branch_from = branch_to
1247
branch_from = Branch.open(location,
1248
possible_transports=possible_transports)
1249
self.enter_context(branch_from.lock_read())
1250
# Remembers if asked explicitly or no previous location is set
1252
or (remember is None and branch_to.get_parent() is None)):
1253
# FIXME: This shouldn't be done before the pull
1254
# succeeds... -- vila 2012-01-02
1255
branch_to.set_parent(branch_from.base)
1257
if revision is not None:
1258
revision_id = revision.as_revision_id(branch_from)
1260
if tree_to is not None:
1261
view_info = _get_view_info_for_change_reporter(tree_to)
1262
change_reporter = delta._ChangeReporter(
1263
unversioned_filter=tree_to.is_ignored,
1264
view_info=view_info)
1265
result = tree_to.pull(
1266
branch_from, overwrite, revision_id, change_reporter,
1267
local=local, show_base=show_base)
1269
result = branch_to.pull(
1270
branch_from, overwrite, revision_id, local=local)
1272
result.report(self.outf)
1273
if verbose and result.old_revid != result.new_revid:
1274
log.show_branch_change(
1275
branch_to, self.outf, result.old_revno,
1277
if getattr(result, 'tag_conflicts', None):
1283
class cmd_push(Command):
1284
__doc__ = """Update a mirror of this branch.
1286
The target branch will not have its working tree populated because this
1287
is both expensive, and is not supported on remote file systems.
1289
Some smart servers or protocols *may* put the working tree in place in
1292
This command only works on branches that have not diverged. Branches are
1293
considered diverged if the destination branch's most recent commit is one
1294
that has not been merged (directly or indirectly) by the source branch.
1296
If branches have diverged, you can use 'brz push --overwrite' to replace
1297
the other branch completely, discarding its unmerged changes.
1299
If you want to ensure you have the different changes in the other branch,
1300
do a merge (see brz help merge) from the other branch, and commit that.
1301
After that you will be able to do a push without '--overwrite'.
1303
If there is no default push location set, the first push will set it (use
1304
--no-remember to avoid setting it). After that, you can omit the
1305
location to use the default. To change the default, use --remember. The
1306
value will only be saved if the remote location can be accessed.
1308
The --verbose option will display the revisions pushed using the log_format
1309
configuration option. You can use a different format by overriding it with
1310
-Olog_format=<other_format>.
1313
_see_also = ['pull', 'update', 'working-trees']
1314
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1315
Option('create-prefix',
1316
help='Create the path leading up to the branch '
1317
'if it does not already exist.'),
1318
custom_help('directory',
1319
help='Branch to push from, '
1320
'rather than the one containing the working directory.'),
1321
Option('use-existing-dir',
1322
help='By default push will fail if the target'
1323
' directory exists, but does not already'
1324
' have a control directory. This flag will'
1325
' allow push to proceed.'),
1327
help='Create a stacked branch that references the public location '
1328
'of the parent branch.'),
1329
Option('stacked-on',
1330
help='Create a stacked branch that refers to another branch '
1331
'for the commit history. Only the work not present in the '
1332
'referenced branch is included in the branch created.',
1335
help='Refuse to push if there are uncommitted changes in'
1336
' the working tree, --no-strict disables the check.'),
1338
help="Don't populate the working tree, even for protocols"
1339
" that support it."),
1340
Option('overwrite-tags',
1341
help="Overwrite tags only."),
1342
Option('lossy', help="Allow lossy push, i.e. dropping metadata "
1343
"that can't be represented in the target.")
1345
takes_args = ['location?']
1346
encoding_type = 'replace'
1348
def run(self, location=None, remember=None, overwrite=False,
1349
create_prefix=False, verbose=False, revision=None,
1350
use_existing_dir=False, directory=None, stacked_on=None,
1351
stacked=False, strict=None, no_tree=False,
1352
overwrite_tags=False, lossy=False):
1353
from .location import location_to_url
1354
from .push import _show_push_branch
1357
overwrite = ["history", "tags"]
1358
elif overwrite_tags:
1359
overwrite = ["tags"]
1363
if directory is None:
1365
# Get the source branch
1367
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1368
# Get the tip's revision_id
1369
revision = _get_one_revision('push', revision)
1370
if revision is not None:
1371
revision_id = revision.in_history(br_from).rev_id
1374
if tree is not None and revision_id is None:
1375
tree.check_changed_or_out_of_date(
1376
strict, 'push_strict',
1377
more_error='Use --no-strict to force the push.',
1378
more_warning='Uncommitted changes will not be pushed.')
1379
# Get the stacked_on branch, if any
1380
if stacked_on is not None:
1381
stacked_on = location_to_url(stacked_on, 'read')
1382
stacked_on = urlutils.normalize_url(stacked_on)
1384
parent_url = br_from.get_parent()
1386
parent = Branch.open(parent_url)
1387
stacked_on = parent.get_public_branch()
1389
# I considered excluding non-http url's here, thus forcing
1390
# 'public' branches only, but that only works for some
1391
# users, so it's best to just depend on the user spotting an
1392
# error by the feedback given to them. RBC 20080227.
1393
stacked_on = parent_url
1395
raise errors.BzrCommandError(gettext(
1396
"Could not determine branch to refer to."))
1398
# Get the destination location
1399
if location is None:
1400
stored_loc = br_from.get_push_location()
1401
if stored_loc is None:
1402
parent_loc = br_from.get_parent()
1404
raise errors.BzrCommandError(gettext(
1405
"No push location known or specified. To push to the "
1406
"parent branch (at %s), use 'brz push :parent'." %
1407
urlutils.unescape_for_display(parent_loc,
1408
self.outf.encoding)))
1410
raise errors.BzrCommandError(gettext(
1411
"No push location known or specified."))
1413
display_url = urlutils.unescape_for_display(stored_loc,
1415
note(gettext("Using saved push location: %s") % display_url)
1416
location = stored_loc
1418
_show_push_branch(br_from, revision_id, location, self.outf,
1419
verbose=verbose, overwrite=overwrite, remember=remember,
1420
stacked_on=stacked_on, create_prefix=create_prefix,
1421
use_existing_dir=use_existing_dir, no_tree=no_tree,
1425
class cmd_branch(Command):
1426
__doc__ = """Create a new branch that is a copy of an existing branch.
1428
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1429
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1430
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1431
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1432
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1435
To retrieve the branch as of a particular revision, supply the --revision
1436
parameter, as in "branch foo/bar -r 5".
1439
_see_also = ['checkout']
1440
takes_args = ['from_location', 'to_location?']
1441
takes_options = ['revision',
1443
'hardlink', help='Hard-link working tree files where possible.'),
1444
Option('files-from', type=text_type,
1445
help="Get file contents from this tree."),
1447
help="Create a branch without a working-tree."),
1449
help="Switch the checkout in the current directory "
1450
"to the new branch."),
1452
help='Create a stacked branch referring to the source branch. '
1453
'The new branch will depend on the availability of the source '
1454
'branch for all operations.'),
1455
Option('standalone',
1456
help='Do not use a shared repository, even if available.'),
1457
Option('use-existing-dir',
1458
help='By default branch will fail if the target'
1459
' directory exists, but does not already'
1460
' have a control directory. This flag will'
1461
' allow branch to proceed.'),
1463
help="Bind new branch to from location."),
1466
def run(self, from_location, to_location=None, revision=None,
1467
hardlink=False, stacked=False, standalone=False, no_tree=False,
1468
use_existing_dir=False, switch=False, bind=False,
1470
from breezy import switch as _mod_switch
1471
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1473
if not (hardlink or files_from):
1474
# accelerator_tree is usually slower because you have to read N
1475
# files (no readahead, lots of seeks, etc), but allow the user to
1476
# explicitly request it
1477
accelerator_tree = None
1478
if files_from is not None and files_from != from_location:
1479
accelerator_tree = WorkingTree.open(files_from)
1480
revision = _get_one_revision('branch', revision)
1481
self.enter_context(br_from.lock_read())
1482
if revision is not None:
1483
revision_id = revision.as_revision_id(br_from)
1485
# FIXME - wt.last_revision, fallback to branch, fall back to
1486
# None or perhaps NULL_REVISION to mean copy nothing
1488
revision_id = br_from.last_revision()
1489
if to_location is None:
1490
to_location = urlutils.derive_to_location(from_location)
1491
to_transport = transport.get_transport(to_location, purpose='write')
1493
to_transport.mkdir('.')
1494
except errors.FileExists:
1496
to_dir = controldir.ControlDir.open_from_transport(
1498
except errors.NotBranchError:
1499
if not use_existing_dir:
1500
raise errors.BzrCommandError(gettext('Target directory "%s" '
1501
'already exists.') % to_location)
1506
to_dir.open_branch()
1507
except errors.NotBranchError:
1510
raise errors.AlreadyBranchError(to_location)
1511
except errors.NoSuchFile:
1512
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1518
# preserve whatever source format we have.
1519
to_dir = br_from.controldir.sprout(
1520
to_transport.base, revision_id,
1521
possible_transports=[to_transport],
1522
accelerator_tree=accelerator_tree, hardlink=hardlink,
1523
stacked=stacked, force_new_repo=standalone,
1524
create_tree_if_local=not no_tree, source_branch=br_from)
1525
branch = to_dir.open_branch(
1526
possible_transports=[
1527
br_from.controldir.root_transport, to_transport])
1528
except errors.NoSuchRevision:
1529
to_transport.delete_tree('.')
1530
msg = gettext("The branch {0} has no revision {1}.").format(
1531
from_location, revision)
1532
raise errors.BzrCommandError(msg)
1535
to_repo = to_dir.open_repository()
1536
except errors.NoRepositoryPresent:
1537
to_repo = to_dir.create_repository()
1538
to_repo.fetch(br_from.repository, revision_id=revision_id)
1539
branch = br_from.sprout(to_dir, revision_id=revision_id)
1540
br_from.tags.merge_to(branch.tags)
1542
# If the source branch is stacked, the new branch may
1543
# be stacked whether we asked for that explicitly or not.
1544
# We therefore need a try/except here and not just 'if stacked:'
1546
note(gettext('Created new stacked branch referring to %s.') %
1547
branch.get_stacked_on_url())
1548
except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
1549
errors.UnstackableRepositoryFormat) as e:
1550
revno = branch.revno()
1551
if revno is not None:
1552
note(ngettext('Branched %d revision.',
1553
'Branched %d revisions.',
1554
branch.revno()) % revno)
1556
note(gettext('Created new branch.'))
1558
# Bind to the parent
1559
parent_branch = Branch.open(from_location)
1560
branch.bind(parent_branch)
1561
note(gettext('New branch bound to %s') % from_location)
1563
# Switch to the new branch
1564
wt, _ = WorkingTree.open_containing('.')
1565
_mod_switch.switch(wt.controldir, branch)
1566
note(gettext('Switched to branch: %s'),
1567
urlutils.unescape_for_display(branch.base, 'utf-8'))
1570
class cmd_branches(Command):
1571
__doc__ = """List the branches available at the current location.
1573
This command will print the names of all the branches at the current
1577
takes_args = ['location?']
1579
Option('recursive', short_name='R',
1580
help='Recursively scan for branches rather than '
1581
'just looking in the specified location.')]
1583
def run(self, location=".", recursive=False):
1585
t = transport.get_transport(location, purpose='read')
1586
if not t.listable():
1587
raise errors.BzrCommandError(
1588
"Can't scan this type of location.")
1589
for b in controldir.ControlDir.find_branches(t):
1590
self.outf.write("%s\n" % urlutils.unescape_for_display(
1591
urlutils.relative_url(t.base, b.base),
1592
self.outf.encoding).rstrip("/"))
1594
dir = controldir.ControlDir.open_containing(location)[0]
1596
active_branch = dir.open_branch(name="")
1597
except errors.NotBranchError:
1598
active_branch = None
1600
for name, branch in iter_sibling_branches(dir):
1603
active = (active_branch is not None and
1604
active_branch.user_url == branch.user_url)
1605
names[name] = active
1606
# Only mention the current branch explicitly if it's not
1607
# one of the colocated branches
1608
if not any(viewvalues(names)) and active_branch is not None:
1609
self.outf.write("* %s\n" % gettext("(default)"))
1610
for name in sorted(names):
1611
active = names[name]
1616
self.outf.write("%s %s\n" % (
1617
prefix, (name if PY3 else name.encode(self.outf.encoding))))
1620
class cmd_checkout(Command):
1621
__doc__ = """Create a new checkout of an existing branch.
1623
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree
1624
for the branch found in '.'. This is useful if you have removed the working
1625
tree or if it was never created - i.e. if you pushed the branch to its
1626
current location using SFTP.
1628
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION
1629
will be used. In other words, "checkout ../foo/bar" will attempt to create
1630
./bar. If the BRANCH_LOCATION has no / or path separator embedded, the
1631
TO_LOCATION is derived from the BRANCH_LOCATION by stripping a leading
1632
scheme or drive identifier, if any. For example, "checkout lp:foo-bar" will
1633
attempt to create ./foo-bar.
1635
To retrieve the branch as of a particular revision, supply the --revision
1636
parameter, as in "checkout foo/bar -r 5". Note that this will be
1637
immediately out of date [so you cannot commit] but it may be useful (i.e.
1638
to examine old code.)
1641
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1642
takes_args = ['branch_location?', 'to_location?']
1643
takes_options = ['revision',
1644
Option('lightweight',
1645
help="Perform a lightweight checkout. Lightweight "
1646
"checkouts depend on access to the branch for "
1647
"every operation. Normal checkouts can perform "
1648
"common operations like diff and status without "
1649
"such access, and also support local commits."
1651
Option('files-from', type=text_type,
1652
help="Get file contents from this tree."),
1654
help='Hard-link working tree files where possible.'
1659
def run(self, branch_location=None, to_location=None, revision=None,
1660
lightweight=False, files_from=None, hardlink=False):
1661
if branch_location is None:
1662
branch_location = osutils.getcwd()
1663
to_location = branch_location
1664
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1666
if not (hardlink or files_from):
1667
# accelerator_tree is usually slower because you have to read N
1668
# files (no readahead, lots of seeks, etc), but allow the user to
1669
# explicitly request it
1670
accelerator_tree = None
1671
revision = _get_one_revision('checkout', revision)
1672
if files_from is not None and files_from != branch_location:
1673
accelerator_tree = WorkingTree.open(files_from)
1674
if revision is not None:
1675
revision_id = revision.as_revision_id(source)
1678
if to_location is None:
1679
to_location = urlutils.derive_to_location(branch_location)
1680
# if the source and to_location are the same,
1681
# and there is no working tree,
1682
# then reconstitute a branch
1683
if osutils.abspath(to_location) == osutils.abspath(branch_location):
1685
source.controldir.open_workingtree()
1686
except errors.NoWorkingTree:
1687
source.controldir.create_workingtree(revision_id)
1689
source.create_checkout(to_location, revision_id, lightweight,
1690
accelerator_tree, hardlink)
1693
class cmd_renames(Command):
1694
__doc__ = """Show list of renamed files.
1696
# TODO: Option to show renames between two historical versions.
1698
# TODO: Only show renames under dir, rather than in the whole branch.
1699
_see_also = ['status']
1700
takes_args = ['dir?']
1703
def run(self, dir=u'.'):
1704
tree = WorkingTree.open_containing(dir)[0]
1705
self.enter_context(tree.lock_read())
1706
old_tree = tree.basis_tree()
1707
self.enter_context(old_tree.lock_read())
1709
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1710
for change in iterator:
1711
if change.path[0] == change.path[1]:
1713
if None in change.path:
1715
renames.append(change.path)
1717
for old_name, new_name in renames:
1718
self.outf.write("%s => %s\n" % (old_name, new_name))
1721
class cmd_update(Command):
1722
__doc__ = """Update a working tree to a new revision.
1724
This will perform a merge of the destination revision (the tip of the
1725
branch, or the specified revision) into the working tree, and then make
1726
that revision the basis revision for the working tree.
1728
You can use this to visit an older revision, or to update a working tree
1729
that is out of date from its branch.
1731
If there are any uncommitted changes in the tree, they will be carried
1732
across and remain as uncommitted changes after the update. To discard
1733
these changes, use 'brz revert'. The uncommitted changes may conflict
1734
with the changes brought in by the change in basis revision.
1736
If the tree's branch is bound to a master branch, brz will also update
1737
the branch from the master.
1739
You cannot update just a single file or directory, because each Breezy
1740
working tree has just a single basis revision. If you want to restore a
1741
file that has been removed locally, use 'brz revert' instead of 'brz
1742
update'. If you want to restore a file to its state in a previous
1743
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1744
out the old content of that file to a new location.
1746
The 'dir' argument, if given, must be the location of the root of a
1747
working tree to update. By default, the working tree that contains the
1748
current working directory is used.
1751
_see_also = ['pull', 'working-trees', 'status-flags']
1752
takes_args = ['dir?']
1753
takes_options = ['revision',
1755
help="Show base revision text in conflicts."),
1759
def run(self, dir=None, revision=None, show_base=None):
1760
if revision is not None and len(revision) != 1:
1761
raise errors.BzrCommandError(gettext(
1762
"brz update --revision takes exactly one revision"))
1764
tree = WorkingTree.open_containing('.')[0]
1766
tree, relpath = WorkingTree.open_containing(dir)
1769
raise errors.BzrCommandError(gettext(
1770
"brz update can only update a whole tree, "
1771
"not a file or subdirectory"))
1772
branch = tree.branch
1773
possible_transports = []
1774
master = branch.get_master_branch(
1775
possible_transports=possible_transports)
1776
if master is not None:
1777
branch_location = master.base
1778
self.enter_context(tree.lock_write())
1780
branch_location = tree.branch.base
1781
self.enter_context(tree.lock_tree_write())
1782
# get rid of the final '/' and be ready for display
1783
branch_location = urlutils.unescape_for_display(
1784
branch_location.rstrip('/'),
1786
existing_pending_merges = tree.get_parent_ids()[1:]
1790
# may need to fetch data into a heavyweight checkout
1791
# XXX: this may take some time, maybe we should display a
1793
old_tip = branch.update(possible_transports)
1794
if revision is not None:
1795
revision_id = revision[0].as_revision_id(branch)
1797
revision_id = branch.last_revision()
1798
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1799
revno = branch.revision_id_to_dotted_revno(revision_id)
1800
note(gettext("Tree is up to date at revision {0} of branch {1}"
1801
).format('.'.join(map(str, revno)), branch_location))
1803
view_info = _get_view_info_for_change_reporter(tree)
1804
change_reporter = delta._ChangeReporter(
1805
unversioned_filter=tree.is_ignored,
1806
view_info=view_info)
1808
conflicts = tree.update(
1810
possible_transports=possible_transports,
1811
revision=revision_id,
1813
show_base=show_base)
1814
except errors.NoSuchRevision as e:
1815
raise errors.BzrCommandError(gettext(
1816
"branch has no revision %s\n"
1817
"brz update --revision only works"
1818
" for a revision in the branch history")
1820
revno = tree.branch.revision_id_to_dotted_revno(
1821
_mod_revision.ensure_null(tree.last_revision()))
1822
note(gettext('Updated to revision {0} of branch {1}').format(
1823
'.'.join(map(str, revno)), branch_location))
1824
parent_ids = tree.get_parent_ids()
1825
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1826
note(gettext('Your local commits will now show as pending merges with '
1827
"'brz status', and can be committed with 'brz commit'."))
1834
class cmd_info(Command):
1835
__doc__ = """Show information about a working tree, branch or repository.
1837
This command will show all known locations and formats associated to the
1838
tree, branch or repository.
1840
In verbose mode, statistical information is included with each report.
1841
To see extended statistic information, use a verbosity level of 2 or
1842
higher by specifying the verbose option multiple times, e.g. -vv.
1844
Branches and working trees will also report any missing revisions.
1848
Display information on the format and related locations:
1852
Display the above together with extended format information and
1853
basic statistics (like the number of files in the working tree and
1854
number of revisions in the branch and repository):
1858
Display the above together with number of committers to the branch:
1862
_see_also = ['revno', 'working-trees', 'repositories']
1863
takes_args = ['location?']
1864
takes_options = ['verbose']
1865
encoding_type = 'replace'
1868
def run(self, location=None, verbose=False):
1870
noise_level = get_verbosity_level()
1873
from .info import show_bzrdir_info
1874
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1875
verbose=noise_level, outfile=self.outf)
1878
class cmd_remove(Command):
1879
__doc__ = """Remove files or directories.
1881
This makes Breezy stop tracking changes to the specified files. Breezy will
1882
delete them if they can easily be recovered using revert otherwise they
1883
will be backed up (adding an extension of the form .~#~). If no options or
1884
parameters are given Breezy will scan for files that are being tracked by
1885
Breezy but missing in your tree and stop tracking them for you.
1887
takes_args = ['file*']
1888
takes_options = ['verbose',
1890
'new', help='Only remove files that have never been committed.'),
1891
RegistryOption.from_kwargs('file-deletion-strategy',
1892
'The file deletion mode to be used.',
1893
title='Deletion Strategy', value_switches=True, enum_switch=False,
1894
safe='Backup changed files (default).',
1895
keep='Delete from brz but leave the working copy.',
1896
no_backup='Don\'t backup changed files.'),
1898
aliases = ['rm', 'del']
1899
encoding_type = 'replace'
1901
def run(self, file_list, verbose=False, new=False,
1902
file_deletion_strategy='safe'):
1904
tree, file_list = WorkingTree.open_containing_paths(file_list)
1906
if file_list is not None:
1907
file_list = [f for f in file_list]
1909
self.enter_context(tree.lock_write())
1910
# Heuristics should probably all move into tree.remove_smart or
1913
added = tree.changes_from(tree.basis_tree(),
1914
specific_files=file_list).added
1915
file_list = sorted([f.path[1] for f in added], reverse=True)
1916
if len(file_list) == 0:
1917
raise errors.BzrCommandError(gettext('No matching files.'))
1918
elif file_list is None:
1919
# missing files show up in iter_changes(basis) as
1920
# versioned-with-no-kind.
1922
for change in tree.iter_changes(tree.basis_tree()):
1923
# Find paths in the working tree that have no kind:
1924
if change.path[1] is not None and change.kind[1] is None:
1925
missing.append(change.path[1])
1926
file_list = sorted(missing, reverse=True)
1927
file_deletion_strategy = 'keep'
1928
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1929
keep_files=file_deletion_strategy == 'keep',
1930
force=(file_deletion_strategy == 'no-backup'))
1933
class cmd_reconcile(Command):
1934
__doc__ = """Reconcile brz metadata in a branch.
1936
This can correct data mismatches that may have been caused by
1937
previous ghost operations or brz upgrades. You should only
1938
need to run this command if 'brz check' or a brz developer
1939
advises you to run it.
1941
If a second branch is provided, cross-branch reconciliation is
1942
also attempted, which will check that data like the tree root
1943
id which was not present in very early brz versions is represented
1944
correctly in both branches.
1946
At the same time it is run it may recompress data resulting in
1947
a potential saving in disk space or performance gain.
1949
The branch *MUST* be on a listable system such as local disk or sftp.
1952
_see_also = ['check']
1953
takes_args = ['branch?']
1955
Option('canonicalize-chks',
1956
help='Make sure CHKs are in canonical form (repairs '
1961
def run(self, branch=".", canonicalize_chks=False):
1962
from .reconcile import reconcile
1963
dir = controldir.ControlDir.open(branch)
1964
reconcile(dir, canonicalize_chks=canonicalize_chks)
1967
class cmd_revision_history(Command):
1968
__doc__ = """Display the list of revision ids on a branch."""
1971
takes_args = ['location?']
1976
def run(self, location="."):
1977
branch = Branch.open_containing(location)[0]
1978
self.enter_context(branch.lock_read())
1979
graph = branch.repository.get_graph()
1980
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1981
[_mod_revision.NULL_REVISION]))
1982
for revid in reversed(history):
1983
self.outf.write(revid)
1984
self.outf.write('\n')
1987
class cmd_ancestry(Command):
1988
__doc__ = """List all revisions merged into this branch."""
1990
_see_also = ['log', 'revision-history']
1991
takes_args = ['location?']
1996
def run(self, location="."):
1998
wt = WorkingTree.open_containing(location)[0]
1999
except errors.NoWorkingTree:
2000
b = Branch.open(location)
2001
last_revision = b.last_revision()
2004
last_revision = wt.last_revision()
2006
self.enter_context(b.repository.lock_read())
2007
graph = b.repository.get_graph()
2008
revisions = [revid for revid, parents in
2009
graph.iter_ancestry([last_revision])]
2010
for revision_id in reversed(revisions):
2011
if _mod_revision.is_null(revision_id):
2013
self.outf.write(revision_id.decode('utf-8') + '\n')
2016
class cmd_init(Command):
2017
__doc__ = """Make a directory into a versioned branch.
2019
Use this to create an empty branch, or before importing an
2022
If there is a repository in a parent directory of the location, then
2023
the history of the branch will be stored in the repository. Otherwise
2024
init creates a standalone branch which carries its own history
2025
in the .bzr directory.
2027
If there is already a branch at the location but it has no working tree,
2028
the tree can be populated with 'brz checkout'.
2030
Recipe for importing a tree of files::
2036
brz commit -m "imported project"
2039
_see_also = ['init-shared-repository', 'branch', 'checkout']
2040
takes_args = ['location?']
2042
Option('create-prefix',
2043
help='Create the path leading up to the branch '
2044
'if it does not already exist.'),
2045
RegistryOption('format',
2046
help='Specify a format for this branch. '
2047
'See "help formats" for a full list.',
2048
lazy_registry=('breezy.controldir', 'format_registry'),
2049
converter=lambda name: controldir.format_registry.make_controldir(
2051
value_switches=True,
2052
title="Branch format",
2054
Option('append-revisions-only',
2055
help='Never change revnos or the existing log.'
2056
' Append revisions to it only.'),
2058
'Create a branch without a working tree.')
2061
def run(self, location=None, format=None, append_revisions_only=False,
2062
create_prefix=False, no_tree=False):
2064
format = controldir.format_registry.make_controldir('default')
2065
if location is None:
2068
to_transport = transport.get_transport(location, purpose='write')
2070
# The path has to exist to initialize a
2071
# branch inside of it.
2072
# Just using os.mkdir, since I don't
2073
# believe that we want to create a bunch of
2074
# locations if the user supplies an extended path
2076
to_transport.ensure_base()
2077
except errors.NoSuchFile:
2078
if not create_prefix:
2079
raise errors.BzrCommandError(gettext("Parent directory of %s"
2081
"\nYou may supply --create-prefix to create all"
2082
" leading parent directories.")
2084
to_transport.create_prefix()
2087
a_controldir = controldir.ControlDir.open_from_transport(
2089
except errors.NotBranchError:
2090
# really a NotBzrDir error...
2091
create_branch = controldir.ControlDir.create_branch_convenience
2093
force_new_tree = False
2095
force_new_tree = None
2096
branch = create_branch(to_transport.base, format=format,
2097
possible_transports=[to_transport],
2098
force_new_tree=force_new_tree)
2099
a_controldir = branch.controldir
2101
from .transport.local import LocalTransport
2102
if a_controldir.has_branch():
2103
if (isinstance(to_transport, LocalTransport)
2104
and not a_controldir.has_workingtree()):
2105
raise errors.BranchExistsWithoutWorkingTree(location)
2106
raise errors.AlreadyBranchError(location)
2107
branch = a_controldir.create_branch()
2108
if not no_tree and not a_controldir.has_workingtree():
2109
a_controldir.create_workingtree()
2110
if append_revisions_only:
2112
branch.set_append_revisions_only(True)
2113
except errors.UpgradeRequired:
2114
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2115
' to append-revisions-only. Try --default.'))
2117
from .info import describe_layout, describe_format
2119
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2120
except (errors.NoWorkingTree, errors.NotLocalUrl):
2122
repository = branch.repository
2123
layout = describe_layout(repository, branch, tree).lower()
2124
format = describe_format(a_controldir, repository, branch, tree)
2125
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2127
if repository.is_shared():
2128
# XXX: maybe this can be refactored into transport.path_or_url()
2129
url = repository.controldir.root_transport.external_url()
2131
url = urlutils.local_path_from_url(url)
2132
except urlutils.InvalidURL:
2134
self.outf.write(gettext("Using shared repository: %s\n") % url)
2137
class cmd_init_shared_repository(Command):
2138
__doc__ = """Create a shared repository for branches to share storage space.
2140
New branches created under the repository directory will store their
2141
revisions in the repository, not in the branch directory. For branches
2142
with shared history, this reduces the amount of storage needed and
2143
speeds up the creation of new branches.
2145
If the --no-trees option is given then the branches in the repository
2146
will not have working trees by default. They will still exist as
2147
directories on disk, but they will not have separate copies of the
2148
files at a certain revision. This can be useful for repositories that
2149
store branches which are interacted with through checkouts or remote
2150
branches, such as on a server.
2153
Create a shared repository holding just branches::
2155
brz init-shared-repo --no-trees repo
2158
Make a lightweight checkout elsewhere::
2160
brz checkout --lightweight repo/trunk trunk-checkout
2165
_see_also = ['init', 'branch', 'checkout', 'repositories']
2166
takes_args = ["location"]
2167
takes_options = [RegistryOption('format',
2168
help='Specify a format for this repository. See'
2169
' "brz help formats" for details.',
2171
'breezy.controldir', 'format_registry'),
2172
converter=lambda name: controldir.format_registry.make_controldir(
2174
value_switches=True, title='Repository format'),
2176
help='Branches in the repository will default to'
2177
' not having a working tree.'),
2179
aliases = ["init-shared-repo", "init-repo"]
2181
def run(self, location, format=None, no_trees=False):
2183
format = controldir.format_registry.make_controldir('default')
2185
if location is None:
2188
to_transport = transport.get_transport(location, purpose='write')
2190
if format.fixed_components:
2191
repo_format_name = None
2193
repo_format_name = format.repository_format.get_format_string()
2195
(repo, newdir, require_stacking, repository_policy) = (
2196
format.initialize_on_transport_ex(to_transport,
2197
create_prefix=True, make_working_trees=not no_trees,
2198
shared_repo=True, force_new_repo=True,
2199
use_existing_dir=True,
2200
repo_format_name=repo_format_name))
2202
from .info import show_bzrdir_info
2203
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2206
class cmd_diff(Command):
2207
__doc__ = """Show differences in the working tree, between revisions or branches.
2209
If no arguments are given, all changes for the current tree are listed.
2210
If files are given, only the changes in those files are listed.
2211
Remote and multiple branches can be compared by using the --old and
2212
--new options. If not provided, the default for both is derived from
2213
the first argument, if any, or the current tree if no arguments are
2216
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2217
produces patches suitable for "patch -p1".
2219
Note that when using the -r argument with a range of revisions, the
2220
differences are computed between the two specified revisions. That
2221
is, the command does not show the changes introduced by the first
2222
revision in the range. This differs from the interpretation of
2223
revision ranges used by "brz log" which includes the first revision
2228
2 - unrepresentable changes
2233
Shows the difference in the working tree versus the last commit::
2237
Difference between the working tree and revision 1::
2241
Difference between revision 3 and revision 1::
2245
Difference between revision 3 and revision 1 for branch xxx::
2249
The changes introduced by revision 2 (equivalent to -r1..2)::
2253
To see the changes introduced by revision X::
2257
Note that in the case of a merge, the -c option shows the changes
2258
compared to the left hand parent. To see the changes against
2259
another parent, use::
2261
brz diff -r<chosen_parent>..X
2263
The changes between the current revision and the previous revision
2264
(equivalent to -c-1 and -r-2..-1)
2268
Show just the differences for file NEWS::
2272
Show the differences in working tree xxx for file NEWS::
2276
Show the differences from branch xxx to this working tree:
2280
Show the differences between two branches for file NEWS::
2282
brz diff --old xxx --new yyy NEWS
2284
Same as 'brz diff' but prefix paths with old/ and new/::
2286
brz diff --prefix old/:new/
2288
Show the differences using a custom diff program with options::
2290
brz diff --using /usr/bin/diff --diff-options -wu
2292
_see_also = ['status']
2293
takes_args = ['file*']
2295
Option('diff-options', type=text_type,
2296
help='Pass these options to the external diff program.'),
2297
Option('prefix', type=text_type,
2299
help='Set prefixes added to old and new filenames, as '
2300
'two values separated by a colon. (eg "old/:new/").'),
2302
help='Branch/tree to compare from.',
2306
help='Branch/tree to compare to.',
2312
help='Use this command to compare files.',
2315
RegistryOption('format',
2317
help='Diff format to use.',
2318
lazy_registry=('breezy.diff', 'format_registry'),
2319
title='Diff format'),
2321
help='How many lines of context to show.',
2325
aliases = ['di', 'dif']
2326
encoding_type = 'exact'
2329
def run(self, revision=None, file_list=None, diff_options=None,
2330
prefix=None, old=None, new=None, using=None, format=None,
2332
from .diff import (get_trees_and_branches_to_diff_locked,
2339
elif prefix == u'1' or prefix is None:
2342
elif u':' in prefix:
2343
old_label, new_label = prefix.split(u":")
2345
raise errors.BzrCommandError(gettext(
2346
'--prefix expects two values separated by a colon'
2347
' (eg "old/:new/")'))
2349
if revision and len(revision) > 2:
2350
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2351
' one or two revision specifiers'))
2353
if using is not None and format is not None:
2354
raise errors.BzrCommandError(gettext(
2355
'{0} and {1} are mutually exclusive').format(
2356
'--using', '--format'))
2358
(old_tree, new_tree,
2359
old_branch, new_branch,
2360
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2361
file_list, revision, old, new, self._exit_stack, apply_view=True)
2362
# GNU diff on Windows uses ANSI encoding for filenames
2363
path_encoding = osutils.get_diff_header_encoding()
2364
return show_diff_trees(old_tree, new_tree, self.outf,
2365
specific_files=specific_files,
2366
external_diff_options=diff_options,
2367
old_label=old_label, new_label=new_label,
2368
extra_trees=extra_trees,
2369
path_encoding=path_encoding,
2370
using=using, context=context,
2374
class cmd_deleted(Command):
2375
__doc__ = """List files deleted in the working tree.
2377
# TODO: Show files deleted since a previous revision, or
2378
# between two revisions.
2379
# TODO: Much more efficient way to do this: read in new
2380
# directories with readdir, rather than stating each one. Same
2381
# level of effort but possibly much less IO. (Or possibly not,
2382
# if the directories are very large...)
2383
_see_also = ['status', 'ls']
2384
takes_options = ['directory', 'show-ids']
2387
def run(self, show_ids=False, directory=u'.'):
2388
tree = WorkingTree.open_containing(directory)[0]
2389
self.enter_context(tree.lock_read())
2390
old = tree.basis_tree()
2391
self.enter_context(old.lock_read())
2392
delta = tree.changes_from(old)
2393
for change in delta.removed:
2394
self.outf.write(change.path[0])
2396
self.outf.write(' ')
2397
self.outf.write(change.file_id)
2398
self.outf.write('\n')
2401
class cmd_modified(Command):
2402
__doc__ = """List files modified in working tree.
2406
_see_also = ['status', 'ls']
2407
takes_options = ['directory', 'null']
2410
def run(self, null=False, directory=u'.'):
2411
tree = WorkingTree.open_containing(directory)[0]
2412
self.enter_context(tree.lock_read())
2413
td = tree.changes_from(tree.basis_tree())
2415
for change in td.modified:
2417
self.outf.write(change.path[1] + '\0')
2419
self.outf.write(osutils.quotefn(change.path[1]) + '\n')
2422
class cmd_added(Command):
2423
__doc__ = """List files added in working tree.
2427
_see_also = ['status', 'ls']
2428
takes_options = ['directory', 'null']
2431
def run(self, null=False, directory=u'.'):
2432
wt = WorkingTree.open_containing(directory)[0]
2433
self.enter_context(wt.lock_read())
2434
basis = wt.basis_tree()
2435
self.enter_context(basis.lock_read())
2436
for path in wt.all_versioned_paths():
2437
if basis.has_filename(path):
2441
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2444
self.outf.write(path + '\0')
2446
self.outf.write(osutils.quotefn(path) + '\n')
2449
class cmd_root(Command):
2450
__doc__ = """Show the tree root directory.
2452
The root is the nearest enclosing directory with a control
2455
takes_args = ['filename?']
2458
def run(self, filename=None):
2459
"""Print the branch root."""
2460
tree = WorkingTree.open_containing(filename)[0]
2461
self.outf.write(tree.basedir + '\n')
2464
def _parse_limit(limitstring):
2466
return int(limitstring)
2468
msg = gettext("The limit argument must be an integer.")
2469
raise errors.BzrCommandError(msg)
2472
def _parse_levels(s):
2476
msg = gettext("The levels argument must be an integer.")
2477
raise errors.BzrCommandError(msg)
2480
class cmd_log(Command):
2481
__doc__ = """Show historical log for a branch or subset of a branch.
2483
log is brz's default tool for exploring the history of a branch.
2484
The branch to use is taken from the first parameter. If no parameters
2485
are given, the branch containing the working directory is logged.
2486
Here are some simple examples::
2488
brz log log the current branch
2489
brz log foo.py log a file in its branch
2490
brz log http://server/branch log a branch on a server
2492
The filtering, ordering and information shown for each revision can
2493
be controlled as explained below. By default, all revisions are
2494
shown sorted (topologically) so that newer revisions appear before
2495
older ones and descendants always appear before ancestors. If displayed,
2496
merged revisions are shown indented under the revision in which they
2501
The log format controls how information about each revision is
2502
displayed. The standard log formats are called ``long``, ``short``
2503
and ``line``. The default is long. See ``brz help log-formats``
2504
for more details on log formats.
2506
The following options can be used to control what information is
2509
-l N display a maximum of N revisions
2510
-n N display N levels of revisions (0 for all, 1 for collapsed)
2511
-v display a status summary (delta) for each revision
2512
-p display a diff (patch) for each revision
2513
--show-ids display revision-ids (and file-ids), not just revnos
2515
Note that the default number of levels to display is a function of the
2516
log format. If the -n option is not used, the standard log formats show
2517
just the top level (mainline).
2519
Status summaries are shown using status flags like A, M, etc. To see
2520
the changes explained using words like ``added`` and ``modified``
2521
instead, use the -vv option.
2525
To display revisions from oldest to newest, use the --forward option.
2526
In most cases, using this option will have little impact on the total
2527
time taken to produce a log, though --forward does not incrementally
2528
display revisions like --reverse does when it can.
2530
:Revision filtering:
2532
The -r option can be used to specify what revision or range of revisions
2533
to filter against. The various forms are shown below::
2535
-rX display revision X
2536
-rX.. display revision X and later
2537
-r..Y display up to and including revision Y
2538
-rX..Y display from X to Y inclusive
2540
See ``brz help revisionspec`` for details on how to specify X and Y.
2541
Some common examples are given below::
2543
-r-1 show just the tip
2544
-r-10.. show the last 10 mainline revisions
2545
-rsubmit:.. show what's new on this branch
2546
-rancestor:path.. show changes since the common ancestor of this
2547
branch and the one at location path
2548
-rdate:yesterday.. show changes since yesterday
2550
When logging a range of revisions using -rX..Y, log starts at
2551
revision Y and searches back in history through the primary
2552
("left-hand") parents until it finds X. When logging just the
2553
top level (using -n1), an error is reported if X is not found
2554
along the way. If multi-level logging is used (-n0), X may be
2555
a nested merge revision and the log will be truncated accordingly.
2559
If parameters are given and the first one is not a branch, the log
2560
will be filtered to show only those revisions that changed the
2561
nominated files or directories.
2563
Filenames are interpreted within their historical context. To log a
2564
deleted file, specify a revision range so that the file existed at
2565
the end or start of the range.
2567
Historical context is also important when interpreting pathnames of
2568
renamed files/directories. Consider the following example:
2570
* revision 1: add tutorial.txt
2571
* revision 2: modify tutorial.txt
2572
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2576
* ``brz log guide.txt`` will log the file added in revision 1
2578
* ``brz log tutorial.txt`` will log the new file added in revision 3
2580
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2581
the original file in revision 2.
2583
* ``brz log -r2 -p guide.txt`` will display an error message as there
2584
was no file called guide.txt in revision 2.
2586
Renames are always followed by log. By design, there is no need to
2587
explicitly ask for this (and no way to stop logging a file back
2588
until it was last renamed).
2592
The --match option can be used for finding revisions that match a
2593
regular expression in a commit message, committer, author or bug.
2594
Specifying the option several times will match any of the supplied
2595
expressions. --match-author, --match-bugs, --match-committer and
2596
--match-message can be used to only match a specific field.
2600
GUI tools and IDEs are often better at exploring history than command
2601
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2602
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2603
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2604
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2606
You may find it useful to add the aliases below to ``breezy.conf``::
2610
top = log -l10 --line
2613
``brz tip`` will then show the latest revision while ``brz top``
2614
will show the last 10 mainline revisions. To see the details of a
2615
particular revision X, ``brz show -rX``.
2617
If you are interested in looking deeper into a particular merge X,
2618
use ``brz log -n0 -rX``.
2620
``brz log -v`` on a branch with lots of history is currently
2621
very slow. A fix for this issue is currently under development.
2622
With or without that fix, it is recommended that a revision range
2623
be given when using the -v option.
2625
brz has a generic full-text matching plugin, brz-search, that can be
2626
used to find revisions matching user names, commit messages, etc.
2627
Among other features, this plugin can find all revisions containing
2628
a list of words but not others.
2630
When exploring non-mainline history on large projects with deep
2631
history, the performance of log can be greatly improved by installing
2632
the historycache plugin. This plugin buffers historical information
2633
trading disk space for faster speed.
2635
takes_args = ['file*']
2636
_see_also = ['log-formats', 'revisionspec']
2639
help='Show from oldest to newest.'),
2641
custom_help('verbose',
2642
help='Show files changed in each revision.'),
2646
type=breezy.option._parse_revision_str,
2648
help='Show just the specified revision.'
2649
' See also "help revisionspec".'),
2651
RegistryOption('authors',
2652
'What names to list as authors - first, all or committer.',
2655
'breezy.log', 'author_list_registry'),
2659
help='Number of levels to display - 0 for all, 1 for flat.',
2661
type=_parse_levels),
2663
help='Show revisions whose message matches this '
2664
'regular expression.',
2669
help='Limit the output to the first N revisions.',
2674
help='Show changes made in each revision as a patch.'),
2675
Option('include-merged',
2676
help='Show merged revisions like --levels 0 does.'),
2677
Option('include-merges', hidden=True,
2678
help='Historical alias for --include-merged.'),
2679
Option('omit-merges',
2680
help='Do not report commits with more than one parent.'),
2681
Option('exclude-common-ancestry',
2682
help='Display only the revisions that are not part'
2683
' of both ancestries (require -rX..Y).'
2685
Option('signatures',
2686
help='Show digital signature validity.'),
2689
help='Show revisions whose properties match this '
2692
ListOption('match-message',
2693
help='Show revisions whose message matches this '
2696
ListOption('match-committer',
2697
help='Show revisions whose committer matches this '
2700
ListOption('match-author',
2701
help='Show revisions whose authors match this '
2704
ListOption('match-bugs',
2705
help='Show revisions whose bugs match this '
2709
encoding_type = 'replace'
2712
def run(self, file_list=None, timezone='original',
2723
include_merged=None,
2725
exclude_common_ancestry=False,
2729
match_committer=None,
2736
make_log_request_dict,
2737
_get_info_for_log_files,
2739
direction = (forward and 'forward') or 'reverse'
2740
if include_merged is None:
2741
include_merged = False
2742
if (exclude_common_ancestry
2743
and (revision is None or len(revision) != 2)):
2744
raise errors.BzrCommandError(gettext(
2745
'--exclude-common-ancestry requires -r with two revisions'))
2750
raise errors.BzrCommandError(gettext(
2751
'{0} and {1} are mutually exclusive').format(
2752
'--levels', '--include-merged'))
2754
if change is not None:
2756
raise errors.RangeInChangeOption()
2757
if revision is not None:
2758
raise errors.BzrCommandError(gettext(
2759
'{0} and {1} are mutually exclusive').format(
2760
'--revision', '--change'))
2765
filter_by_dir = False
2767
# find the file ids to log and check for directory filtering
2768
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2769
revision, file_list, self._exit_stack)
2770
for relpath, file_id, kind in file_info_list:
2772
raise errors.BzrCommandError(gettext(
2773
"Path unknown at end or start of revision range: %s") %
2775
# If the relpath is the top of the tree, we log everything
2780
file_ids.append(file_id)
2781
filter_by_dir = filter_by_dir or (
2782
kind in ['directory', 'tree-reference'])
2785
# FIXME ? log the current subdir only RBC 20060203
2786
if revision is not None \
2787
and len(revision) > 0 and revision[0].get_branch():
2788
location = revision[0].get_branch()
2791
dir, relpath = controldir.ControlDir.open_containing(location)
2792
b = dir.open_branch()
2793
self.enter_context(b.lock_read())
2794
rev1, rev2 = _get_revision_range(revision, b, self.name())
2796
if b.get_config_stack().get('validate_signatures_in_log'):
2800
if not gpg.GPGStrategy.verify_signatures_available():
2801
raise errors.GpgmeNotInstalled(None)
2803
# Decide on the type of delta & diff filtering to use
2804
# TODO: add an --all-files option to make this configurable & consistent
2812
diff_type = 'partial'
2816
# Build the log formatter
2817
if log_format is None:
2818
log_format = log.log_formatter_registry.get_default(b)
2819
# Make a non-encoding output to include the diffs - bug 328007
2820
unencoded_output = ui.ui_factory.make_output_stream(
2821
encoding_type='exact')
2822
lf = log_format(show_ids=show_ids, to_file=self.outf,
2823
to_exact_file=unencoded_output,
2824
show_timezone=timezone,
2825
delta_format=get_verbosity_level(),
2827
show_advice=levels is None,
2828
author_list_handler=authors)
2830
# Choose the algorithm for doing the logging. It's annoying
2831
# having multiple code paths like this but necessary until
2832
# the underlying repository format is faster at generating
2833
# deltas or can provide everything we need from the indices.
2834
# The default algorithm - match-using-deltas - works for
2835
# multiple files and directories and is faster for small
2836
# amounts of history (200 revisions say). However, it's too
2837
# slow for logging a single file in a repository with deep
2838
# history, i.e. > 10K revisions. In the spirit of "do no
2839
# evil when adding features", we continue to use the
2840
# original algorithm - per-file-graph - for the "single
2841
# file that isn't a directory without showing a delta" case.
2842
partial_history = revision and b.repository._format.supports_chks
2843
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2844
or delta_type or partial_history)
2848
match_dict[''] = match
2850
match_dict['message'] = match_message
2852
match_dict['committer'] = match_committer
2854
match_dict['author'] = match_author
2856
match_dict['bugs'] = match_bugs
2858
# Build the LogRequest and execute it
2859
if len(file_ids) == 0:
2861
rqst = make_log_request_dict(
2862
direction=direction, specific_fileids=file_ids,
2863
start_revision=rev1, end_revision=rev2, limit=limit,
2864
message_search=message, delta_type=delta_type,
2865
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2866
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2867
signature=signatures, omit_merges=omit_merges,
2869
Logger(b, rqst).show(lf)
2872
def _get_revision_range(revisionspec_list, branch, command_name):
2873
"""Take the input of a revision option and turn it into a revision range.
2875
It returns RevisionInfo objects which can be used to obtain the rev_id's
2876
of the desired revisions. It does some user input validations.
2878
if revisionspec_list is None:
2881
elif len(revisionspec_list) == 1:
2882
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2883
elif len(revisionspec_list) == 2:
2884
start_spec = revisionspec_list[0]
2885
end_spec = revisionspec_list[1]
2886
if end_spec.get_branch() != start_spec.get_branch():
2887
# b is taken from revision[0].get_branch(), and
2888
# show_log will use its revision_history. Having
2889
# different branches will lead to weird behaviors.
2890
raise errors.BzrCommandError(gettext(
2891
"brz %s doesn't accept two revisions in different"
2892
" branches.") % command_name)
2893
if start_spec.spec is None:
2894
# Avoid loading all the history.
2895
rev1 = RevisionInfo(branch, None, None)
2897
rev1 = start_spec.in_history(branch)
2898
# Avoid loading all of history when we know a missing
2899
# end of range means the last revision ...
2900
if end_spec.spec is None:
2901
last_revno, last_revision_id = branch.last_revision_info()
2902
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2904
rev2 = end_spec.in_history(branch)
2906
raise errors.BzrCommandError(gettext(
2907
'brz %s --revision takes one or two values.') % command_name)
2911
def _revision_range_to_revid_range(revision_range):
2914
if revision_range[0] is not None:
2915
rev_id1 = revision_range[0].rev_id
2916
if revision_range[1] is not None:
2917
rev_id2 = revision_range[1].rev_id
2918
return rev_id1, rev_id2
2921
def get_log_format(long=False, short=False, line=False, default='long'):
2922
log_format = default
2926
log_format = 'short'
2932
class cmd_touching_revisions(Command):
2933
__doc__ = """Return revision-ids which affected a particular file.
2935
A more user-friendly interface is "brz log FILE".
2939
takes_args = ["filename"]
2942
def run(self, filename):
2943
tree, relpath = WorkingTree.open_containing(filename)
2944
with tree.lock_read():
2945
touching_revs = log.find_touching_revisions(
2946
tree.branch.repository, tree.branch.last_revision(), tree, relpath)
2947
for revno, revision_id, what in reversed(list(touching_revs)):
2948
self.outf.write("%6d %s\n" % (revno, what))
2951
class cmd_ls(Command):
2952
__doc__ = """List files in a tree.
2955
_see_also = ['status', 'cat']
2956
takes_args = ['path?']
2960
Option('recursive', short_name='R',
2961
help='Recurse into subdirectories.'),
2963
help='Print paths relative to the root of the branch.'),
2964
Option('unknown', short_name='u',
2965
help='Print unknown files.'),
2966
Option('versioned', help='Print versioned files.',
2968
Option('ignored', short_name='i',
2969
help='Print ignored files.'),
2970
Option('kind', short_name='k',
2971
help=('List entries of a particular kind: file, '
2972
'directory, symlink, tree-reference.'),
2980
def run(self, revision=None, verbose=False,
2981
recursive=False, from_root=False,
2982
unknown=False, versioned=False, ignored=False,
2983
null=False, kind=None, show_ids=False, path=None, directory=None):
2985
if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
2986
raise errors.BzrCommandError(gettext('invalid kind specified'))
2988
if verbose and null:
2989
raise errors.BzrCommandError(
2990
gettext('Cannot set both --verbose and --null'))
2991
all = not (unknown or versioned or ignored)
2993
selection = {'I': ignored, '?': unknown, 'V': versioned}
2999
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3002
tree, branch, relpath = \
3003
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3005
# Calculate the prefix to use
3009
prefix = relpath + '/'
3010
elif fs_path != '.' and not fs_path.endswith('/'):
3011
prefix = fs_path + '/'
3013
if revision is not None or tree is None:
3014
tree = _get_one_revision_tree('ls', revision, branch=branch)
3017
if isinstance(tree, WorkingTree) and tree.supports_views():
3018
view_files = tree.views.lookup_view()
3021
view_str = views.view_display_str(view_files)
3022
note(gettext("Ignoring files outside view. View is %s") % view_str)
3024
self.enter_context(tree.lock_read())
3025
for fp, fc, fkind, entry in tree.list_files(
3026
include_root=False, from_dir=relpath, recursive=recursive):
3027
# Apply additional masking
3028
if not all and not selection[fc]:
3030
if kind is not None and fkind != kind:
3035
fullpath = osutils.pathjoin(relpath, fp)
3038
views.check_path_in_view(tree, fullpath)
3039
except views.FileOutsideView:
3044
fp = osutils.pathjoin(prefix, fp)
3045
kindch = entry.kind_character()
3046
outstring = fp + kindch
3047
ui.ui_factory.clear_term()
3049
outstring = '%-8s %s' % (fc, outstring)
3050
if show_ids and getattr(entry, 'file_id', None) is not None:
3051
outstring = "%-50s %s" % (outstring, entry.file_id.decode('utf-8'))
3052
self.outf.write(outstring + '\n')
3054
self.outf.write(fp + '\0')
3056
if getattr(entry, 'file_id', None) is not None:
3057
self.outf.write(entry.file_id.decode('utf-8'))
3058
self.outf.write('\0')
3062
if getattr(entry, 'file_id', None) is not None:
3063
my_id = entry.file_id.decode('utf-8')
3066
self.outf.write('%-50s %s\n' % (outstring, my_id))
3068
self.outf.write(outstring + '\n')
3071
class cmd_unknowns(Command):
3072
__doc__ = """List unknown files.
3077
takes_options = ['directory']
3080
def run(self, directory=u'.'):
3081
for f in WorkingTree.open_containing(directory)[0].unknowns():
3082
self.outf.write(osutils.quotefn(f) + '\n')
3085
class cmd_ignore(Command):
3086
__doc__ = """Ignore specified files or patterns.
3088
See ``brz help patterns`` for details on the syntax of patterns.
3090
If a .bzrignore file does not exist, the ignore command
3091
will create one and add the specified files or patterns to the newly
3092
created file. The ignore command will also automatically add the
3093
.bzrignore file to be versioned. Creating a .bzrignore file without
3094
the use of the ignore command will require an explicit add command.
3096
To remove patterns from the ignore list, edit the .bzrignore file.
3097
After adding, editing or deleting that file either indirectly by
3098
using this command or directly by using an editor, be sure to commit
3101
Breezy also supports a global ignore file ~/.config/breezy/ignore. On
3102
Windows the global ignore file can be found in the application data
3104
C:\\Documents and Settings\\<user>\\Application Data\\Breezy\\3.0\\ignore.
3105
Global ignores are not touched by this command. The global ignore file
3106
can be edited directly using an editor.
3108
Patterns prefixed with '!' are exceptions to ignore patterns and take
3109
precedence over regular ignores. Such exceptions are used to specify
3110
files that should be versioned which would otherwise be ignored.
3112
Patterns prefixed with '!!' act as regular ignore patterns, but have
3113
precedence over the '!' exception patterns.
3117
* Ignore patterns containing shell wildcards must be quoted from
3120
* Ignore patterns starting with "#" act as comments in the ignore file.
3121
To ignore patterns that begin with that character, use the "RE:" prefix.
3124
Ignore the top level Makefile::
3126
brz ignore ./Makefile
3128
Ignore .class files in all directories...::
3130
brz ignore "*.class"
3132
...but do not ignore "special.class"::
3134
brz ignore "!special.class"
3136
Ignore files whose name begins with the "#" character::
3140
Ignore .o files under the lib directory::
3142
brz ignore "lib/**/*.o"
3144
Ignore .o files under the lib directory::
3146
brz ignore "RE:lib/.*\\.o"
3148
Ignore everything but the "debian" toplevel directory::
3150
brz ignore "RE:(?!debian/).*"
3152
Ignore everything except the "local" toplevel directory,
3153
but always ignore autosave files ending in ~, even under local/::
3156
brz ignore "!./local"
3160
_see_also = ['status', 'ignored', 'patterns']
3161
takes_args = ['name_pattern*']
3162
takes_options = ['directory',
3163
Option('default-rules',
3164
help='Display the default ignore rules that brz uses.')
3167
def run(self, name_pattern_list=None, default_rules=None,
3169
from breezy import ignores
3170
if default_rules is not None:
3171
# dump the default rules and exit
3172
for pattern in ignores.USER_DEFAULTS:
3173
self.outf.write("%s\n" % pattern)
3175
if not name_pattern_list:
3176
raise errors.BzrCommandError(gettext("ignore requires at least one "
3177
"NAME_PATTERN or --default-rules."))
3178
name_pattern_list = [globbing.normalize_pattern(p)
3179
for p in name_pattern_list]
3181
bad_patterns_count = 0
3182
for p in name_pattern_list:
3183
if not globbing.Globster.is_pattern_valid(p):
3184
bad_patterns_count += 1
3185
bad_patterns += ('\n %s' % p)
3187
msg = (ngettext('Invalid ignore pattern found. %s',
3188
'Invalid ignore patterns found. %s',
3189
bad_patterns_count) % bad_patterns)
3190
ui.ui_factory.show_error(msg)
3191
raise lazy_regex.InvalidPattern('')
3192
for name_pattern in name_pattern_list:
3193
if (name_pattern[0] == '/' or
3194
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3195
raise errors.BzrCommandError(gettext(
3196
"NAME_PATTERN should not be an absolute path"))
3197
tree, relpath = WorkingTree.open_containing(directory)
3198
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3199
ignored = globbing.Globster(name_pattern_list)
3201
self.enter_context(tree.lock_read())
3202
for filename, fc, fkind, entry in tree.list_files():
3203
id = getattr(entry, 'file_id', None)
3205
if ignored.match(filename):
3206
matches.append(filename)
3207
if len(matches) > 0:
3208
self.outf.write(gettext("Warning: the following files are version "
3209
"controlled and match your ignore pattern:\n%s"
3210
"\nThese files will continue to be version controlled"
3211
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3214
class cmd_ignored(Command):
3215
__doc__ = """List ignored files and the patterns that matched them.
3217
List all the ignored files and the ignore pattern that caused the file to
3220
Alternatively, to list just the files::
3225
encoding_type = 'replace'
3226
_see_also = ['ignore', 'ls']
3227
takes_options = ['directory']
3230
def run(self, directory=u'.'):
3231
tree = WorkingTree.open_containing(directory)[0]
3232
self.enter_context(tree.lock_read())
3233
for path, file_class, kind, entry in tree.list_files():
3234
if file_class != 'I':
3236
# XXX: Slightly inefficient since this was already calculated
3237
pat = tree.is_ignored(path)
3238
self.outf.write('%-50s %s\n' % (path, pat))
3241
class cmd_lookup_revision(Command):
3242
__doc__ = """Lookup the revision-id from a revision-number
3245
brz lookup-revision 33
3248
takes_args = ['revno']
3249
takes_options = ['directory']
3252
def run(self, revno, directory=u'.'):
3256
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3258
revid = WorkingTree.open_containing(
3259
directory)[0].branch.get_rev_id(revno)
3260
self.outf.write("%s\n" % revid.decode('utf-8'))
3263
class cmd_export(Command):
3264
__doc__ = """Export current or past revision to a destination directory or archive.
3266
If no revision is specified this exports the last committed revision.
3268
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3269
given, try to find the format with the extension. If no extension
3270
is found exports to a directory (equivalent to --format=dir).
3272
If root is supplied, it will be used as the root directory inside
3273
container formats (tar, zip, etc). If it is not supplied it will default
3274
to the exported filename. The root option has no effect for 'dir' format.
3276
If branch is omitted then the branch containing the current working
3277
directory will be used.
3279
Note: Export of tree with non-ASCII filenames to zip is not supported.
3281
================= =========================
3282
Supported formats Autodetected by extension
3283
================= =========================
3286
tbz2 .tar.bz2, .tbz2
3289
================= =========================
3292
encoding_type = 'exact'
3293
takes_args = ['dest', 'branch_or_subdir?']
3294
takes_options = ['directory',
3296
help="Type of file to export to.",
3299
Option('filters', help='Apply content filters to export the '
3300
'convenient form.'),
3303
help="Name of the root directory inside the exported file."),
3304
Option('per-file-timestamps',
3305
help='Set modification time of files to that of the last '
3306
'revision in which it was changed.'),
3307
Option('uncommitted',
3308
help='Export the working tree contents rather than that of the '
3312
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3313
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3315
from .export import export, guess_format, get_root_name
3317
if branch_or_subdir is None:
3318
branch_or_subdir = directory
3320
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3322
if tree is not None:
3323
self.enter_context(tree.lock_read())
3327
raise errors.BzrCommandError(
3328
gettext("--uncommitted requires a working tree"))
3331
export_tree = _get_one_revision_tree(
3332
'export', revision, branch=b,
3336
format = guess_format(dest)
3339
root = get_root_name(dest)
3341
if not per_file_timestamps:
3342
force_mtime = time.time()
3347
from breezy.filter_tree import ContentFilterTree
3348
export_tree = ContentFilterTree(
3349
export_tree, export_tree._content_filter_stack)
3352
export(export_tree, dest, format, root, subdir,
3353
per_file_timestamps=per_file_timestamps)
3354
except errors.NoSuchExportFormat as e:
3355
raise errors.BzrCommandError(
3356
gettext('Unsupported export format: %s') % e.format)
3359
class cmd_cat(Command):
3360
__doc__ = """Write the contents of a file as of a given revision to standard output.
3362
If no revision is nominated, the last revision is used.
3364
Note: Take care to redirect standard output when using this command on a
3369
takes_options = ['directory',
3370
Option('name-from-revision',
3371
help='The path name in the old tree.'),
3372
Option('filters', help='Apply content filters to display the '
3373
'convenience form.'),
3376
takes_args = ['filename']
3377
encoding_type = 'exact'
3380
def run(self, filename, revision=None, name_from_revision=False,
3381
filters=False, directory=None):
3382
if revision is not None and len(revision) != 1:
3383
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3384
" one revision specifier"))
3385
tree, branch, relpath = \
3386
_open_directory_or_containing_tree_or_branch(filename, directory)
3387
self.enter_context(branch.lock_read())
3388
return self._run(tree, branch, relpath, filename, revision,
3389
name_from_revision, filters)
3391
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3395
tree = b.basis_tree()
3396
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3397
self.enter_context(rev_tree.lock_read())
3399
if name_from_revision:
3400
# Try in revision if requested
3401
if not rev_tree.is_versioned(relpath):
3402
raise errors.BzrCommandError(gettext(
3403
"{0!r} is not present in revision {1}").format(
3404
filename, rev_tree.get_revision_id()))
3405
rev_tree_path = relpath
3408
rev_tree_path = _mod_tree.find_previous_path(
3409
tree, rev_tree, relpath)
3410
except errors.NoSuchFile:
3411
rev_tree_path = None
3413
if rev_tree_path is None:
3414
# Path didn't exist in working tree
3415
if not rev_tree.is_versioned(relpath):
3416
raise errors.BzrCommandError(gettext(
3417
"{0!r} is not present in revision {1}").format(
3418
filename, rev_tree.get_revision_id()))
3420
# Fall back to the same path in the basis tree, if present.
3421
rev_tree_path = relpath
3424
from .filter_tree import ContentFilterTree
3425
filter_tree = ContentFilterTree(
3426
rev_tree, rev_tree._content_filter_stack)
3427
fileobj = filter_tree.get_file(rev_tree_path)
3429
fileobj = rev_tree.get_file(rev_tree_path)
3430
shutil.copyfileobj(fileobj, self.outf)
3434
class cmd_local_time_offset(Command):
3435
__doc__ = """Show the offset in seconds from GMT to local time."""
3440
self.outf.write("%s\n" % osutils.local_time_offset())
3443
class cmd_commit(Command):
3444
__doc__ = """Commit changes into a new revision.
3446
An explanatory message needs to be given for each commit. This is
3447
often done by using the --message option (getting the message from the
3448
command line) or by using the --file option (getting the message from
3449
a file). If neither of these options is given, an editor is opened for
3450
the user to enter the message. To see the changed files in the
3451
boilerplate text loaded into the editor, use the --show-diff option.
3453
By default, the entire tree is committed and the person doing the
3454
commit is assumed to be the author. These defaults can be overridden
3459
If selected files are specified, only changes to those files are
3460
committed. If a directory is specified then the directory and
3461
everything within it is committed.
3463
When excludes are given, they take precedence over selected files.
3464
For example, to commit only changes within foo, but not changes
3467
brz commit foo -x foo/bar
3469
A selective commit after a merge is not yet supported.
3473
If the author of the change is not the same person as the committer,
3474
you can specify the author's name using the --author option. The
3475
name should be in the same format as a committer-id, e.g.
3476
"John Doe <jdoe@example.com>". If there is more than one author of
3477
the change you can specify the option multiple times, once for each
3482
A common mistake is to forget to add a new file or directory before
3483
running the commit command. The --strict option checks for unknown
3484
files and aborts the commit if any are found. More advanced pre-commit
3485
checks can be implemented by defining hooks. See ``brz help hooks``
3490
If you accidentally commit the wrong changes or make a spelling
3491
mistake in the commit message say, you can use the uncommit command
3492
to undo it. See ``brz help uncommit`` for details.
3494
Hooks can also be configured to run after a commit. This allows you
3495
to trigger updates to external systems like bug trackers. The --fixes
3496
option can be used to record the association between a revision and
3497
one or more bugs. See ``brz help bugs`` for details.
3500
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3501
takes_args = ['selected*']
3504
'exclude', type=text_type, short_name='x',
3505
help="Do not consider changes made to a given path."),
3506
Option('message', type=text_type,
3508
help="Description of the new revision."),
3511
help='Commit even if nothing has changed.'),
3512
Option('file', type=text_type,
3515
help='Take commit message from this file.'),
3517
help="Refuse to commit if there are unknown "
3518
"files in the working tree."),
3519
Option('commit-time', type=text_type,
3520
help="Manually set a commit time using commit date "
3521
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3523
'bugs', type=text_type,
3524
help="Link to a related bug. (see \"brz help bugs\")."),
3526
'fixes', type=text_type,
3527
help="Mark a bug as being fixed by this revision "
3528
"(see \"brz help bugs\")."),
3530
'author', type=text_type,
3531
help="Set the author's name, if it's different "
3532
"from the committer."),
3534
help="Perform a local commit in a bound "
3535
"branch. Local commits are not pushed to "
3536
"the master branch until a normal commit "
3539
Option('show-diff', short_name='p',
3540
help='When no message is supplied, show the diff along'
3541
' with the status summary in the message editor.'),
3543
help='When committing to a foreign version control '
3544
'system do not push data that can not be natively '
3546
aliases = ['ci', 'checkin']
3548
def _iter_bug_urls(self, bugs, branch, status):
3549
default_bugtracker = None
3550
# Configure the properties for bug fixing attributes.
3552
tokens = bug.split(':')
3553
if len(tokens) == 1:
3554
if default_bugtracker is None:
3555
branch_config = branch.get_config_stack()
3556
default_bugtracker = branch_config.get(
3558
if default_bugtracker is None:
3559
raise errors.BzrCommandError(gettext(
3560
"No tracker specified for bug %s. Use the form "
3561
"'tracker:id' or specify a default bug tracker "
3562
"using the `bugtracker` option.\nSee "
3563
"\"brz help bugs\" for more information on this "
3564
"feature. Commit refused.") % bug)
3565
tag = default_bugtracker
3567
elif len(tokens) != 2:
3568
raise errors.BzrCommandError(gettext(
3569
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3570
"See \"brz help bugs\" for more information on this "
3571
"feature.\nCommit refused.") % bug)
3573
tag, bug_id = tokens
3575
yield bugtracker.get_bug_url(tag, branch, bug_id), status
3576
except bugtracker.UnknownBugTrackerAbbreviation:
3577
raise errors.BzrCommandError(gettext(
3578
'Unrecognized bug %s. Commit refused.') % bug)
3579
except bugtracker.MalformedBugIdentifier as e:
3580
raise errors.BzrCommandError(gettext(
3581
u"%s\nCommit refused.") % (e,))
3583
def run(self, message=None, file=None, verbose=False, selected_list=None,
3584
unchanged=False, strict=False, local=False, fixes=None, bugs=None,
3585
author=None, show_diff=False, exclude=None, commit_time=None,
3588
from .commit import (
3591
from .errors import (
3595
from .msgeditor import (
3596
edit_commit_message_encoded,
3597
generate_commit_message_template,
3598
make_commit_message_template_encoded,
3602
commit_stamp = offset = None
3603
if commit_time is not None:
3605
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3606
except ValueError as e:
3607
raise errors.BzrCommandError(gettext(
3608
"Could not parse --commit-time: " + str(e)))
3612
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3613
if selected_list == ['']:
3614
# workaround - commit of root of tree should be exactly the same
3615
# as just default commit in that tree, and succeed even though
3616
# selected-file merge commit is not done yet
3623
bug_property = bugtracker.encode_fixes_bug_urls(
3625
self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
3626
self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
3628
properties[u'bugs'] = bug_property
3630
if local and not tree.branch.get_bound_location():
3631
raise errors.LocalRequiresBoundBranch()
3633
if message is not None:
3635
file_exists = osutils.lexists(message)
3636
except UnicodeError:
3637
# The commit message contains unicode characters that can't be
3638
# represented in the filesystem encoding, so that can't be a
3643
'The commit message is a file name: "%(f)s".\n'
3644
'(use --file "%(f)s" to take commit message from that file)'
3646
ui.ui_factory.show_warning(warning_msg)
3648
message = message.replace('\r\n', '\n')
3649
message = message.replace('\r', '\n')
3651
raise errors.BzrCommandError(gettext(
3652
"please specify either --message or --file"))
3654
def get_message(commit_obj):
3655
"""Callback to get commit message"""
3657
with open(file, 'rb') as f:
3658
my_message = f.read().decode(osutils.get_user_encoding())
3659
elif message is not None:
3660
my_message = message
3662
# No message supplied: make one up.
3663
# text is the status of the tree
3664
text = make_commit_message_template_encoded(tree,
3665
selected_list, diff=show_diff,
3666
output_encoding=osutils.get_user_encoding())
3667
# start_message is the template generated from hooks
3668
# XXX: Warning - looks like hooks return unicode,
3669
# make_commit_message_template_encoded returns user encoding.
3670
# We probably want to be using edit_commit_message instead to
3672
my_message = set_commit_message(commit_obj)
3673
if my_message is None:
3674
start_message = generate_commit_message_template(
3676
if start_message is not None:
3677
start_message = start_message.encode(
3678
osutils.get_user_encoding())
3679
my_message = edit_commit_message_encoded(text,
3680
start_message=start_message)
3681
if my_message is None:
3682
raise errors.BzrCommandError(gettext("please specify a commit"
3683
" message with either --message or --file"))
3684
if my_message == "":
3685
raise errors.BzrCommandError(gettext("Empty commit message specified."
3686
" Please specify a commit message with either"
3687
" --message or --file or leave a blank message"
3688
" with --message \"\"."))
3691
# The API permits a commit with a filter of [] to mean 'select nothing'
3692
# but the command line should not do that.
3693
if not selected_list:
3694
selected_list = None
3696
tree.commit(message_callback=get_message,
3697
specific_files=selected_list,
3698
allow_pointless=unchanged, strict=strict, local=local,
3699
reporter=None, verbose=verbose, revprops=properties,
3700
authors=author, timestamp=commit_stamp,
3702
exclude=tree.safe_relpath_files(exclude),
3704
except PointlessCommit:
3705
raise errors.BzrCommandError(gettext("No changes to commit."
3706
" Please 'brz add' the files you want to commit, or use"
3707
" --unchanged to force an empty commit."))
3708
except ConflictsInTree:
3709
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3710
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3712
except StrictCommitFailed:
3713
raise errors.BzrCommandError(gettext("Commit refused because there are"
3714
" unknown files in the working tree."))
3715
except errors.BoundBranchOutOfDate as e:
3716
e.extra_help = (gettext("\n"
3717
'To commit to master branch, run update and then commit.\n'
3718
'You can also pass --local to commit to continue working '
3723
class cmd_check(Command):
3724
__doc__ = """Validate working tree structure, branch consistency and repository history.
3726
This command checks various invariants about branch and repository storage
3727
to detect data corruption or brz bugs.
3729
The working tree and branch checks will only give output if a problem is
3730
detected. The output fields of the repository check are:
3733
This is just the number of revisions checked. It doesn't
3737
This is just the number of versionedfiles checked. It
3738
doesn't indicate a problem.
3740
unreferenced ancestors
3741
Texts that are ancestors of other texts, but
3742
are not properly referenced by the revision ancestry. This is a
3743
subtle problem that Breezy can work around.
3746
This is the total number of unique file contents
3747
seen in the checked revisions. It does not indicate a problem.
3750
This is the total number of repeated texts seen
3751
in the checked revisions. Texts can be repeated when their file
3752
entries are modified, but the file contents are not. It does not
3755
If no restrictions are specified, all data that is found at the given
3756
location will be checked.
3760
Check the tree and branch at 'foo'::
3762
brz check --tree --branch foo
3764
Check only the repository at 'bar'::
3766
brz check --repo bar
3768
Check everything at 'baz'::
3773
_see_also = ['reconcile']
3774
takes_args = ['path?']
3775
takes_options = ['verbose',
3776
Option('branch', help="Check the branch related to the"
3777
" current directory."),
3778
Option('repo', help="Check the repository related to the"
3779
" current directory."),
3780
Option('tree', help="Check the working tree related to"
3781
" the current directory.")]
3783
def run(self, path=None, verbose=False, branch=False, repo=False,
3785
from .check import check_dwim
3788
if not branch and not repo and not tree:
3789
branch = repo = tree = True
3790
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3793
class cmd_upgrade(Command):
3794
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3796
When the default format has changed after a major new release of
3797
Bazaar/Breezy, you may be informed during certain operations that you
3798
should upgrade. Upgrading to a newer format may improve performance
3799
or make new features available. It may however limit interoperability
3800
with older repositories or with older versions of Bazaar or Breezy.
3802
If you wish to upgrade to a particular format rather than the
3803
current default, that can be specified using the --format option.
3804
As a consequence, you can use the upgrade command this way to
3805
"downgrade" to an earlier format, though some conversions are
3806
a one way process (e.g. changing from the 1.x default to the
3807
2.x default) so downgrading is not always possible.
3809
A backup.bzr.~#~ directory is created at the start of the conversion
3810
process (where # is a number). By default, this is left there on
3811
completion. If the conversion fails, delete the new .bzr directory
3812
and rename this one back in its place. Use the --clean option to ask
3813
for the backup.bzr directory to be removed on successful conversion.
3814
Alternatively, you can delete it by hand if everything looks good
3817
If the location given is a shared repository, dependent branches
3818
are also converted provided the repository converts successfully.
3819
If the conversion of a branch fails, remaining branches are still
3822
For more information on upgrades, see the Breezy Upgrade Guide,
3823
https://www.breezy-vcs.org/doc/en/upgrade-guide/.
3826
_see_also = ['check', 'reconcile', 'formats']
3827
takes_args = ['url?']
3829
RegistryOption('format',
3830
help='Upgrade to a specific format. See "brz help'
3831
' formats" for details.',
3832
lazy_registry=('breezy.controldir', 'format_registry'),
3833
converter=lambda name: controldir.format_registry.make_controldir(
3835
value_switches=True, title='Branch format'),
3837
help='Remove the backup.bzr directory if successful.'),
3839
help="Show what would be done, but don't actually do anything."),
3842
def run(self, url='.', format=None, clean=False, dry_run=False):
3843
from .upgrade import upgrade
3844
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3846
if len(exceptions) == 1:
3847
# Compatibility with historical behavior
3853
class cmd_whoami(Command):
3854
__doc__ = """Show or set brz user id.
3857
Show the email of the current user::
3861
Set the current user::
3863
brz whoami "Frank Chu <fchu@example.com>"
3865
takes_options = ['directory',
3867
help='Display email address only.'),
3869
help='Set identity for the current branch instead of '
3872
takes_args = ['name?']
3873
encoding_type = 'replace'
3876
def run(self, email=False, branch=False, name=None, directory=None):
3878
if directory is None:
3879
# use branch if we're inside one; otherwise global config
3881
c = Branch.open_containing(u'.')[0].get_config_stack()
3882
except errors.NotBranchError:
3883
c = _mod_config.GlobalStack()
3885
c = Branch.open(directory).get_config_stack()
3886
identity = c.get('email')
3888
self.outf.write(_mod_config.extract_email_address(identity)
3891
self.outf.write(identity + '\n')
3895
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3898
# display a warning if an email address isn't included in the given name.
3900
_mod_config.extract_email_address(name)
3901
except _mod_config.NoEmailInUsername:
3902
warning('"%s" does not seem to contain an email address. '
3903
'This is allowed, but not recommended.', name)
3905
# use global config unless --branch given
3907
if directory is None:
3908
c = Branch.open_containing(u'.')[0].get_config_stack()
3910
b = Branch.open(directory)
3911
self.enter_context(b.lock_write())
3912
c = b.get_config_stack()
3914
c = _mod_config.GlobalStack()
3915
c.set('email', name)
3918
class cmd_nick(Command):
3919
__doc__ = """Print or set the branch nickname.
3921
If unset, the colocated branch name is used for colocated branches, and
3922
the branch directory name is used for other branches. To print the
3923
current nickname, execute with no argument.
3925
Bound branches use the nickname of its master branch unless it is set
3929
_see_also = ['info']
3930
takes_args = ['nickname?']
3931
takes_options = ['directory']
3933
def run(self, nickname=None, directory=u'.'):
3934
branch = Branch.open_containing(directory)[0]
3935
if nickname is None:
3936
self.printme(branch)
3938
branch.nick = nickname
3941
def printme(self, branch):
3942
self.outf.write('%s\n' % branch.nick)
3945
class cmd_alias(Command):
3946
__doc__ = """Set/unset and display aliases.
3949
Show the current aliases::
3953
Show the alias specified for 'll'::
3957
Set an alias for 'll'::
3959
brz alias ll="log --line -r-10..-1"
3961
To remove an alias for 'll'::
3963
brz alias --remove ll
3966
takes_args = ['name?']
3968
Option('remove', help='Remove the alias.'),
3971
def run(self, name=None, remove=False):
3973
self.remove_alias(name)
3975
self.print_aliases()
3977
equal_pos = name.find('=')
3979
self.print_alias(name)
3981
self.set_alias(name[:equal_pos], name[equal_pos + 1:])
3983
def remove_alias(self, alias_name):
3984
if alias_name is None:
3985
raise errors.BzrCommandError(gettext(
3986
'brz alias --remove expects an alias to remove.'))
3987
# If alias is not found, print something like:
3988
# unalias: foo: not found
3989
c = _mod_config.GlobalConfig()
3990
c.unset_alias(alias_name)
3993
def print_aliases(self):
3994
"""Print out the defined aliases in a similar format to bash."""
3995
aliases = _mod_config.GlobalConfig().get_aliases()
3996
for key, value in sorted(viewitems(aliases)):
3997
self.outf.write('brz alias %s="%s"\n' % (key, value))
4000
def print_alias(self, alias_name):
4001
from .commands import get_alias
4002
alias = get_alias(alias_name)
4004
self.outf.write("brz alias: %s: not found\n" % alias_name)
4007
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
4009
def set_alias(self, alias_name, alias_command):
4010
"""Save the alias in the global config."""
4011
c = _mod_config.GlobalConfig()
4012
c.set_alias(alias_name, alias_command)
4015
class cmd_selftest(Command):
4016
__doc__ = """Run internal test suite.
4018
If arguments are given, they are regular expressions that say which tests
4019
should run. Tests matching any expression are run, and other tests are
4022
Alternatively if --first is given, matching tests are run first and then
4023
all other tests are run. This is useful if you have been working in a
4024
particular area, but want to make sure nothing else was broken.
4026
If --exclude is given, tests that match that regular expression are
4027
excluded, regardless of whether they match --first or not.
4029
To help catch accidential dependencies between tests, the --randomize
4030
option is useful. In most cases, the argument used is the word 'now'.
4031
Note that the seed used for the random number generator is displayed
4032
when this option is used. The seed can be explicitly passed as the
4033
argument to this option if required. This enables reproduction of the
4034
actual ordering used if and when an order sensitive problem is encountered.
4036
If --list-only is given, the tests that would be run are listed. This is
4037
useful when combined with --first, --exclude and/or --randomize to
4038
understand their impact. The test harness reports "Listed nn tests in ..."
4039
instead of "Ran nn tests in ..." when list mode is enabled.
4041
If the global option '--no-plugins' is given, plugins are not loaded
4042
before running the selftests. This has two effects: features provided or
4043
modified by plugins will not be tested, and tests provided by plugins will
4046
Tests that need working space on disk use a common temporary directory,
4047
typically inside $TMPDIR or /tmp.
4049
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4050
into a pdb postmortem session.
4052
The --coverage=DIRNAME global option produces a report with covered code
4056
Run only tests relating to 'ignore'::
4060
Disable plugins and list tests as they're run::
4062
brz --no-plugins selftest -v
4064
# NB: this is used from the class without creating an instance, which is
4065
# why it does not have a self parameter.
4067
def get_transport_type(typestring):
4068
"""Parse and return a transport specifier."""
4069
if typestring == "sftp":
4070
from .tests import stub_sftp
4071
return stub_sftp.SFTPAbsoluteServer
4072
elif typestring == "memory":
4073
from .tests import test_server
4074
return memory.MemoryServer
4075
elif typestring == "fakenfs":
4076
from .tests import test_server
4077
return test_server.FakeNFSServer
4078
msg = "No known transport type %s. Supported types are: sftp\n" %\
4080
raise errors.BzrCommandError(msg)
4083
takes_args = ['testspecs*']
4084
takes_options = ['verbose',
4086
help='Stop when one test fails.',
4090
help='Use a different transport by default '
4091
'throughout the test suite.',
4092
type=get_transport_type),
4094
help='Run the benchmarks rather than selftests.',
4096
Option('lsprof-timed',
4097
help='Generate lsprof output for benchmarked'
4098
' sections of code.'),
4099
Option('lsprof-tests',
4100
help='Generate lsprof output for each test.'),
4102
help='Run all tests, but run specified tests first.',
4106
help='List the tests instead of running them.'),
4107
RegistryOption('parallel',
4108
help="Run the test suite in parallel.",
4110
'breezy.tests', 'parallel_registry'),
4111
value_switches=False,
4113
Option('randomize', type=text_type, argname="SEED",
4114
help='Randomize the order of tests using the given'
4115
' seed or "now" for the current time.'),
4116
ListOption('exclude', type=text_type, argname="PATTERN",
4118
help='Exclude tests that match this regular'
4121
help='Output test progress via subunit v1.'),
4123
help='Output test progress via subunit v2.'),
4124
Option('strict', help='Fail on missing dependencies or '
4126
Option('load-list', type=text_type, argname='TESTLISTFILE',
4127
help='Load a test id list from a text file.'),
4128
ListOption('debugflag', type=text_type, short_name='E',
4129
help='Turn on a selftest debug flag.'),
4130
ListOption('starting-with', type=text_type, argname='TESTID',
4131
param_name='starting_with', short_name='s',
4132
help='Load only the tests starting with TESTID.'),
4134
help="By default we disable fsync and fdatasync"
4135
" while running the test suite.")
4137
encoding_type = 'replace'
4140
Command.__init__(self)
4141
self.additional_selftest_args = {}
4143
def run(self, testspecs_list=None, verbose=False, one=False,
4144
transport=None, benchmark=None,
4146
first=False, list_only=False,
4147
randomize=None, exclude=None, strict=False,
4148
load_list=None, debugflag=None, starting_with=None, subunit1=False,
4149
subunit2=False, parallel=None, lsprof_tests=False, sync=False):
4151
# During selftest, disallow proxying, as it can cause severe
4152
# performance penalties and is only needed for thread
4153
# safety. The selftest command is assumed to not use threads
4154
# too heavily. The call should be as early as possible, as
4155
# error reporting for past duplicate imports won't have useful
4157
if sys.version_info[0] < 3:
4158
# TODO(pad.lv/1696545): Allow proxying on Python 3, since
4159
# disallowing it currently leads to failures in many places.
4160
lazy_import.disallow_proxying()
4165
raise errors.BzrCommandError("tests not available. Install the "
4166
"breezy tests to run the breezy testsuite.")
4168
if testspecs_list is not None:
4169
pattern = '|'.join(testspecs_list)
4174
from .tests import SubUnitBzrRunnerv1
4176
raise errors.BzrCommandError(gettext(
4177
"subunit not available. subunit needs to be installed "
4178
"to use --subunit."))
4179
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
4180
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4181
# stdout, which would corrupt the subunit stream.
4182
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4183
# following code can be deleted when it's sufficiently deployed
4184
# -- vila/mgz 20100514
4185
if (sys.platform == "win32"
4186
and getattr(sys.stdout, 'fileno', None) is not None):
4188
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4191
from .tests import SubUnitBzrRunnerv2
4193
raise errors.BzrCommandError(gettext(
4194
"subunit not available. subunit "
4195
"needs to be installed to use --subunit2."))
4196
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
4199
self.additional_selftest_args.setdefault(
4200
'suite_decorators', []).append(parallel)
4202
raise errors.BzrCommandError(gettext(
4203
"--benchmark is no longer supported from brz 2.2; "
4204
"use bzr-usertest instead"))
4205
test_suite_factory = None
4207
exclude_pattern = None
4209
exclude_pattern = '(' + '|'.join(exclude) + ')'
4211
self._disable_fsync()
4212
selftest_kwargs = {"verbose": verbose,
4214
"stop_on_failure": one,
4215
"transport": transport,
4216
"test_suite_factory": test_suite_factory,
4217
"lsprof_timed": lsprof_timed,
4218
"lsprof_tests": lsprof_tests,
4219
"matching_tests_first": first,
4220
"list_only": list_only,
4221
"random_seed": randomize,
4222
"exclude_pattern": exclude_pattern,
4224
"load_list": load_list,
4225
"debug_flags": debugflag,
4226
"starting_with": starting_with
4228
selftest_kwargs.update(self.additional_selftest_args)
4230
# Make deprecation warnings visible, unless -Werror is set
4231
cleanup = symbol_versioning.activate_deprecation_warnings(
4234
result = tests.selftest(**selftest_kwargs)
4237
return int(not result)
4239
def _disable_fsync(self):
4240
"""Change the 'os' functionality to not synchronize."""
4241
self._orig_fsync = getattr(os, 'fsync', None)
4242
if self._orig_fsync is not None:
4243
os.fsync = lambda filedes: None
4244
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4245
if self._orig_fdatasync is not None:
4246
os.fdatasync = lambda filedes: None
4249
class cmd_version(Command):
4250
__doc__ = """Show version of brz."""
4252
encoding_type = 'replace'
4254
Option("short", help="Print just the version number."),
4258
def run(self, short=False):
4259
from .version import show_version
4261
self.outf.write(breezy.version_string + '\n')
4263
show_version(to_file=self.outf)
4266
class cmd_rocks(Command):
4267
__doc__ = """Statement of optimism."""
4273
self.outf.write(gettext("It sure does!\n"))
4276
class cmd_find_merge_base(Command):
4277
__doc__ = """Find and print a base revision for merging two branches."""
4278
# TODO: Options to specify revisions on either side, as if
4279
# merging only part of the history.
4280
takes_args = ['branch', 'other']
4284
def run(self, branch, other):
4285
from .revision import ensure_null
4287
branch1 = Branch.open_containing(branch)[0]
4288
branch2 = Branch.open_containing(other)[0]
4289
self.enter_context(branch1.lock_read())
4290
self.enter_context(branch2.lock_read())
4291
last1 = ensure_null(branch1.last_revision())
4292
last2 = ensure_null(branch2.last_revision())
4294
graph = branch1.repository.get_graph(branch2.repository)
4295
base_rev_id = graph.find_unique_lca(last1, last2)
4297
self.outf.write(gettext('merge base is revision %s\n') %
4298
base_rev_id.decode('utf-8'))
4301
class cmd_merge(Command):
4302
__doc__ = """Perform a three-way merge.
4304
The source of the merge can be specified either in the form of a branch,
4305
or in the form of a path to a file containing a merge directive generated
4306
with brz send. If neither is specified, the default is the upstream branch
4307
or the branch most recently merged using --remember. The source of the
4308
merge may also be specified in the form of a path to a file in another
4309
branch: in this case, only the modifications to that file are merged into
4310
the current working tree.
4312
When merging from a branch, by default brz will try to merge in all new
4313
work from the other branch, automatically determining an appropriate base
4314
revision. If this fails, you may need to give an explicit base.
4316
To pick a different ending revision, pass "--revision OTHER". brz will
4317
try to merge in all new work up to and including revision OTHER.
4319
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4320
through OTHER, excluding BASE but including OTHER, will be merged. If this
4321
causes some revisions to be skipped, i.e. if the destination branch does
4322
not already contain revision BASE, such a merge is commonly referred to as
4323
a "cherrypick". Unlike a normal merge, Breezy does not currently track
4324
cherrypicks. The changes look like a normal commit, and the history of the
4325
changes from the other branch is not stored in the commit.
4327
Revision numbers are always relative to the source branch.
4329
Merge will do its best to combine the changes in two branches, but there
4330
are some kinds of problems only a human can fix. When it encounters those,
4331
it will mark a conflict. A conflict means that you need to fix something,
4332
before you can commit.
4334
Use brz resolve when you have fixed a problem. See also brz conflicts.
4336
If there is no default branch set, the first merge will set it (use
4337
--no-remember to avoid setting it). After that, you can omit the branch
4338
to use the default. To change the default, use --remember. The value will
4339
only be saved if the remote location can be accessed.
4341
The results of the merge are placed into the destination working
4342
directory, where they can be reviewed (with brz diff), tested, and then
4343
committed to record the result of the merge.
4345
merge refuses to run if there are any uncommitted changes, unless
4346
--force is given. If --force is given, then the changes from the source
4347
will be merged with the current working tree, including any uncommitted
4348
changes in the tree. The --force option can also be used to create a
4349
merge revision which has more than two parents.
4351
If one would like to merge changes from the working tree of the other
4352
branch without merging any committed revisions, the --uncommitted option
4355
To select only some changes to merge, use "merge -i", which will prompt
4356
you to apply each diff hunk and file change, similar to "shelve".
4359
To merge all new revisions from brz.dev::
4361
brz merge ../brz.dev
4363
To merge changes up to and including revision 82 from brz.dev::
4365
brz merge -r 82 ../brz.dev
4367
To merge the changes introduced by 82, without previous changes::
4369
brz merge -r 81..82 ../brz.dev
4371
To apply a merge directive contained in /tmp/merge::
4373
brz merge /tmp/merge
4375
To create a merge revision with three parents from two branches
4376
feature1a and feature1b:
4378
brz merge ../feature1a
4379
brz merge ../feature1b --force
4380
brz commit -m 'revision with three parents'
4383
encoding_type = 'exact'
4384
_see_also = ['update', 'remerge', 'status-flags', 'send']
4385
takes_args = ['location?']
4390
help='Merge even if the destination tree has uncommitted changes.'),
4394
Option('show-base', help="Show base revision text in "
4396
Option('uncommitted', help='Apply uncommitted changes'
4397
' from a working copy, instead of branch changes.'),
4398
Option('pull', help='If the destination is already'
4399
' completely merged into the source, pull from the'
4400
' source rather than merging. When this happens,'
4401
' you do not need to commit the result.'),
4402
custom_help('directory',
4403
help='Branch to merge into, '
4404
'rather than the one containing the working directory.'),
4405
Option('preview', help='Instead of merging, show a diff of the'
4407
Option('interactive', help='Select changes interactively.',
4411
def run(self, location=None, revision=None, force=False,
4412
merge_type=None, show_base=False, reprocess=None, remember=None,
4413
uncommitted=False, pull=False,
4418
if merge_type is None:
4419
merge_type = _mod_merge.Merge3Merger
4421
if directory is None:
4423
possible_transports = []
4425
allow_pending = True
4426
verified = 'inapplicable'
4428
tree = WorkingTree.open_containing(directory)[0]
4429
if tree.branch.last_revision() == _mod_revision.NULL_REVISION:
4430
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4431
'https://bugs.launchpad.net/bzr/+bug/308562'))
4433
# die as quickly as possible if there are uncommitted changes
4435
if tree.has_changes():
4436
raise errors.UncommittedChanges(tree)
4438
view_info = _get_view_info_for_change_reporter(tree)
4439
change_reporter = delta._ChangeReporter(
4440
unversioned_filter=tree.is_ignored, view_info=view_info)
4441
pb = ui.ui_factory.nested_progress_bar()
4442
self.enter_context(pb)
4443
self.enter_context(tree.lock_write())
4444
if location is not None:
4446
mergeable = _mod_mergeable.read_mergeable_from_url(
4447
location, possible_transports=possible_transports)
4448
except errors.NotABundle:
4452
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4453
' with bundles or merge directives.'))
4455
if revision is not None:
4456
raise errors.BzrCommandError(gettext(
4457
'Cannot use -r with merge directives or bundles'))
4458
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4461
if merger is None and uncommitted:
4462
if revision is not None and len(revision) > 0:
4463
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4464
' --revision at the same time.'))
4465
merger = self.get_merger_from_uncommitted(tree, location, None)
4466
allow_pending = False
4469
merger, allow_pending = self._get_merger_from_branch(tree,
4470
location, revision, remember, possible_transports, None)
4472
merger.merge_type = merge_type
4473
merger.reprocess = reprocess
4474
merger.show_base = show_base
4475
self.sanity_check_merger(merger)
4476
if (merger.base_rev_id == merger.other_rev_id and
4477
merger.other_rev_id is not None):
4478
# check if location is a nonexistent file (and not a branch) to
4479
# disambiguate the 'Nothing to do'
4480
if merger.interesting_files:
4481
if not merger.other_tree.has_filename(
4482
merger.interesting_files[0]):
4483
note(gettext("merger: ") + str(merger))
4484
raise errors.PathsDoNotExist([location])
4485
note(gettext('Nothing to do.'))
4487
if pull and not preview:
4488
if merger.interesting_files is not None:
4489
raise errors.BzrCommandError(
4490
gettext('Cannot pull individual files'))
4491
if (merger.base_rev_id == tree.last_revision()):
4492
result = tree.pull(merger.other_branch, False,
4493
merger.other_rev_id)
4494
result.report(self.outf)
4496
if merger.this_basis is None:
4497
raise errors.BzrCommandError(gettext(
4498
"This branch has no commits."
4499
" (perhaps you would prefer 'brz pull')"))
4501
return self._do_preview(merger)
4503
return self._do_interactive(merger)
4505
return self._do_merge(merger, change_reporter, allow_pending,
4508
def _get_preview(self, merger):
4509
tree_merger = merger.make_merger()
4510
tt = tree_merger.make_preview_transform()
4511
self.enter_context(tt)
4512
result_tree = tt.get_preview_tree()
4515
def _do_preview(self, merger):
4516
from .diff import show_diff_trees
4517
result_tree = self._get_preview(merger)
4518
path_encoding = osutils.get_diff_header_encoding()
4519
show_diff_trees(merger.this_tree, result_tree, self.outf,
4520
old_label='', new_label='',
4521
path_encoding=path_encoding)
4523
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4524
merger.change_reporter = change_reporter
4525
conflict_count = merger.do_merge()
4527
merger.set_pending()
4528
if verified == 'failed':
4529
warning('Preview patch does not match changes')
4530
if conflict_count != 0:
4535
def _do_interactive(self, merger):
4536
"""Perform an interactive merge.
4538
This works by generating a preview tree of the merge, then using
4539
Shelver to selectively remove the differences between the working tree
4540
and the preview tree.
4542
from . import shelf_ui
4543
result_tree = self._get_preview(merger)
4544
writer = breezy.option.diff_writer_registry.get()
4545
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4546
reporter=shelf_ui.ApplyReporter(),
4547
diff_writer=writer(self.outf))
4553
def sanity_check_merger(self, merger):
4554
if (merger.show_base and
4555
merger.merge_type is not _mod_merge.Merge3Merger):
4556
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4557
" merge type. %s") % merger.merge_type)
4558
if merger.reprocess is None:
4559
if merger.show_base:
4560
merger.reprocess = False
4562
# Use reprocess if the merger supports it
4563
merger.reprocess = merger.merge_type.supports_reprocess
4564
if merger.reprocess and not merger.merge_type.supports_reprocess:
4565
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4566
" for merge type %s.") %
4568
if merger.reprocess and merger.show_base:
4569
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4572
if (merger.merge_type.requires_file_merge_plan and
4573
(not getattr(merger.this_tree, 'plan_file_merge', None) or
4574
not getattr(merger.other_tree, 'plan_file_merge', None) or
4575
(merger.base_tree is not None and
4576
not getattr(merger.base_tree, 'plan_file_merge', None)))):
4577
raise errors.BzrCommandError(
4578
gettext('Plan file merge unsupported: '
4579
'Merge type incompatible with tree formats.'))
4581
def _get_merger_from_branch(self, tree, location, revision, remember,
4582
possible_transports, pb):
4583
"""Produce a merger from a location, assuming it refers to a branch."""
4584
# find the branch locations
4585
other_loc, user_location = self._select_branch_location(tree, location,
4587
if revision is not None and len(revision) == 2:
4588
base_loc, _unused = self._select_branch_location(tree,
4589
location, revision, 0)
4591
base_loc = other_loc
4593
other_branch, other_path = Branch.open_containing(other_loc,
4594
possible_transports)
4595
if base_loc == other_loc:
4596
base_branch = other_branch
4598
base_branch, base_path = Branch.open_containing(base_loc,
4599
possible_transports)
4600
# Find the revision ids
4601
other_revision_id = None
4602
base_revision_id = None
4603
if revision is not None:
4604
if len(revision) >= 1:
4605
other_revision_id = revision[-1].as_revision_id(other_branch)
4606
if len(revision) == 2:
4607
base_revision_id = revision[0].as_revision_id(base_branch)
4608
if other_revision_id is None:
4609
other_revision_id = _mod_revision.ensure_null(
4610
other_branch.last_revision())
4611
# Remember where we merge from. We need to remember if:
4612
# - user specify a location (and we don't merge from the parent
4614
# - user ask to remember or there is no previous location set to merge
4615
# from and user didn't ask to *not* remember
4616
if (user_location is not None
4618
(remember is None and
4619
tree.branch.get_submit_branch() is None)))):
4620
tree.branch.set_submit_branch(other_branch.base)
4621
# Merge tags (but don't set them in the master branch yet, the user
4622
# might revert this merge). Commit will propagate them.
4623
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4624
merger = _mod_merge.Merger.from_revision_ids(tree,
4625
other_revision_id, base_revision_id, other_branch, base_branch)
4626
if other_path != '':
4627
allow_pending = False
4628
merger.interesting_files = [other_path]
4630
allow_pending = True
4631
return merger, allow_pending
4633
def get_merger_from_uncommitted(self, tree, location, pb):
4634
"""Get a merger for uncommitted changes.
4636
:param tree: The tree the merger should apply to.
4637
:param location: The location containing uncommitted changes.
4638
:param pb: The progress bar to use for showing progress.
4640
location = self._select_branch_location(tree, location)[0]
4641
other_tree, other_path = WorkingTree.open_containing(location)
4642
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4643
if other_path != '':
4644
merger.interesting_files = [other_path]
4647
def _select_branch_location(self, tree, user_location, revision=None,
4649
"""Select a branch location, according to possible inputs.
4651
If provided, branches from ``revision`` are preferred. (Both
4652
``revision`` and ``index`` must be supplied.)
4654
Otherwise, the ``location`` parameter is used. If it is None, then the
4655
``submit`` or ``parent`` location is used, and a note is printed.
4657
:param tree: The working tree to select a branch for merging into
4658
:param location: The location entered by the user
4659
:param revision: The revision parameter to the command
4660
:param index: The index to use for the revision parameter. Negative
4661
indices are permitted.
4662
:return: (selected_location, user_location). The default location
4663
will be the user-entered location.
4665
if (revision is not None and index is not None
4666
and revision[index] is not None):
4667
branch = revision[index].get_branch()
4668
if branch is not None:
4669
return branch, branch
4670
if user_location is None:
4671
location = self._get_remembered(tree, 'Merging from')
4673
location = user_location
4674
return location, user_location
4676
def _get_remembered(self, tree, verb_string):
4677
"""Use tree.branch's parent if none was supplied.
4679
Report if the remembered location was used.
4681
stored_location = tree.branch.get_submit_branch()
4682
stored_location_type = "submit"
4683
if stored_location is None:
4684
stored_location = tree.branch.get_parent()
4685
stored_location_type = "parent"
4686
mutter("%s", stored_location)
4687
if stored_location is None:
4688
raise errors.BzrCommandError(
4689
gettext("No location specified or remembered"))
4690
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4691
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4692
stored_location_type, display_url))
4693
return stored_location
4696
class cmd_remerge(Command):
4697
__doc__ = """Redo a merge.
4699
Use this if you want to try a different merge technique while resolving
4700
conflicts. Some merge techniques are better than others, and remerge
4701
lets you try different ones on different files.
4703
The options for remerge have the same meaning and defaults as the ones for
4704
merge. The difference is that remerge can (only) be run when there is a
4705
pending merge, and it lets you specify particular files.
4708
Re-do the merge of all conflicted files, and show the base text in
4709
conflict regions, in addition to the usual THIS and OTHER texts::
4711
brz remerge --show-base
4713
Re-do the merge of "foobar", using the weave merge algorithm, with
4714
additional processing to reduce the size of conflict regions::
4716
brz remerge --merge-type weave --reprocess foobar
4718
takes_args = ['file*']
4723
help="Show base revision text in conflicts."),
4726
def run(self, file_list=None, merge_type=None, show_base=False,
4728
from .conflicts import restore
4729
if merge_type is None:
4730
merge_type = _mod_merge.Merge3Merger
4731
tree, file_list = WorkingTree.open_containing_paths(file_list)
4732
self.enter_context(tree.lock_write())
4733
parents = tree.get_parent_ids()
4734
if len(parents) != 2:
4735
raise errors.BzrCommandError(
4736
gettext("Sorry, remerge only works after normal"
4737
" merges. Not cherrypicking or multi-merges."))
4738
interesting_files = None
4740
conflicts = tree.conflicts()
4741
if file_list is not None:
4742
interesting_files = set()
4743
for filename in file_list:
4744
if not tree.is_versioned(filename):
4745
raise errors.NotVersionedError(filename)
4746
interesting_files.add(filename)
4747
if tree.kind(filename) != "directory":
4750
for path, ie in tree.iter_entries_by_dir(
4751
specific_files=[filename]):
4752
interesting_files.add(path)
4753
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4755
# Remerge only supports resolving contents conflicts
4756
allowed_conflicts = ('text conflict', 'contents conflict')
4757
restore_files = [c.path for c in conflicts
4758
if c.typestring in allowed_conflicts]
4759
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
4760
tree.set_conflicts(ConflictList(new_conflicts))
4761
if file_list is not None:
4762
restore_files = file_list
4763
for filename in restore_files:
4765
restore(tree.abspath(filename))
4766
except errors.NotConflicted:
4768
# Disable pending merges, because the file texts we are remerging
4769
# have not had those merges performed. If we use the wrong parents
4770
# list, we imply that the working tree text has seen and rejected
4771
# all the changes from the other tree, when in fact those changes
4772
# have not yet been seen.
4773
tree.set_parent_ids(parents[:1])
4775
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4776
merger.interesting_files = interesting_files
4777
merger.merge_type = merge_type
4778
merger.show_base = show_base
4779
merger.reprocess = reprocess
4780
conflicts = merger.do_merge()
4782
tree.set_parent_ids(parents)
4789
class cmd_revert(Command):
4791
Set files in the working tree back to the contents of a previous revision.
4793
Giving a list of files will revert only those files. Otherwise, all files
4794
will be reverted. If the revision is not specified with '--revision', the
4795
working tree basis revision is used. A revert operation affects only the
4796
working tree, not any revision history like the branch and repository or
4797
the working tree basis revision.
4799
To remove only some changes, without reverting to a prior version, use
4800
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4801
will remove the changes introduced by the second last commit (-2), without
4802
affecting the changes introduced by the last commit (-1). To remove
4803
certain changes on a hunk-by-hunk basis, see the shelve command.
4804
To update the branch to a specific revision or the latest revision and
4805
update the working tree accordingly while preserving local changes, see the
4808
Uncommitted changes to files that are reverted will be discarded.
4809
However, by default, any files that have been manually changed will be
4810
backed up first. (Files changed only by merge are not backed up.) Backup
4811
files have '.~#~' appended to their name, where # is a number.
4813
When you provide files, you can use their current pathname or the pathname
4814
from the target revision. So you can use revert to "undelete" a file by
4815
name. If you name a directory, all the contents of that directory will be
4818
If you have newly added files since the target revision, they will be
4819
removed. If the files to be removed have been changed, backups will be
4820
created as above. Directories containing unknown files will not be
4823
The working tree contains a list of revisions that have been merged but
4824
not yet committed. These revisions will be included as additional parents
4825
of the next commit. Normally, using revert clears that list as well as
4826
reverting the files. If any files are specified, revert leaves the list
4827
of uncommitted merges alone and reverts only the files. Use ``brz revert
4828
.`` in the tree root to revert all files but keep the recorded merges,
4829
and ``brz revert --forget-merges`` to clear the pending merge list without
4830
reverting any files.
4832
Using "brz revert --forget-merges", it is possible to apply all of the
4833
changes from a branch in a single revision. To do this, perform the merge
4834
as desired. Then doing revert with the "--forget-merges" option will keep
4835
the content of the tree as it was, but it will clear the list of pending
4836
merges. The next commit will then contain all of the changes that are
4837
present in the other branch, but without any other parent revisions.
4838
Because this technique forgets where these changes originated, it may
4839
cause additional conflicts on later merges involving the same source and
4843
_see_also = ['cat', 'export', 'merge', 'shelve']
4846
Option('no-backup', "Do not save backups of reverted files."),
4847
Option('forget-merges',
4848
'Remove pending merge marker, without changing any files.'),
4850
takes_args = ['file*']
4852
def run(self, revision=None, no_backup=False, file_list=None,
4853
forget_merges=None):
4854
tree, file_list = WorkingTree.open_containing_paths(file_list)
4855
self.enter_context(tree.lock_tree_write())
4857
tree.set_parent_ids(tree.get_parent_ids()[:1])
4859
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4862
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4863
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4864
tree.revert(file_list, rev_tree, not no_backup, None,
4865
report_changes=True)
4868
class cmd_assert_fail(Command):
4869
__doc__ = """Test reporting of assertion failures"""
4870
# intended just for use in testing
4875
raise AssertionError("always fails")
4878
class cmd_help(Command):
4879
__doc__ = """Show help on a command or other topic.
4882
_see_also = ['topics']
4884
Option('long', 'Show help on all commands.'),
4886
takes_args = ['topic?']
4887
aliases = ['?', '--help', '-?', '-h']
4890
def run(self, topic=None, long=False):
4892
if topic is None and long:
4894
breezy.help.help(topic)
4897
class cmd_shell_complete(Command):
4898
__doc__ = """Show appropriate completions for context.
4900
For a list of all available commands, say 'brz shell-complete'.
4902
takes_args = ['context?']
4907
def run(self, context=None):
4908
from . import shellcomplete
4909
shellcomplete.shellcomplete(context)
4912
class cmd_missing(Command):
4913
__doc__ = """Show unmerged/unpulled revisions between two branches.
4915
OTHER_BRANCH may be local or remote.
4917
To filter on a range of revisions, you can use the command -r begin..end
4918
-r revision requests a specific revision, -r ..end or -r begin.. are
4922
1 - some missing revisions
4923
0 - no missing revisions
4927
Determine the missing revisions between this and the branch at the
4928
remembered pull location::
4932
Determine the missing revisions between this and another branch::
4934
brz missing http://server/branch
4936
Determine the missing revisions up to a specific revision on the other
4939
brz missing -r ..-10
4941
Determine the missing revisions up to a specific revision on this
4944
brz missing --my-revision ..-10
4947
_see_also = ['merge', 'pull']
4948
takes_args = ['other_branch?']
4951
Option('reverse', 'Reverse the order of revisions.'),
4953
'Display changes in the local branch only.'),
4954
Option('this', 'Same as --mine-only.'),
4955
Option('theirs-only',
4956
'Display changes in the remote branch only.'),
4957
Option('other', 'Same as --theirs-only.'),
4961
custom_help('revision',
4962
help='Filter on other branch revisions (inclusive). '
4963
'See "help revisionspec" for details.'),
4964
Option('my-revision',
4965
type=_parse_revision_str,
4966
help='Filter on local branch revisions (inclusive). '
4967
'See "help revisionspec" for details.'),
4968
Option('include-merged',
4969
'Show all revisions in addition to the mainline ones.'),
4970
Option('include-merges', hidden=True,
4971
help='Historical alias for --include-merged.'),
4973
encoding_type = 'replace'
4976
def run(self, other_branch=None, reverse=False, mine_only=False,
4978
log_format=None, long=False, short=False, line=False,
4979
show_ids=False, verbose=False, this=False, other=False,
4980
include_merged=None, revision=None, my_revision=None,
4982
from breezy.missing import find_unmerged, iter_log_revisions
4988
if include_merged is None:
4989
include_merged = False
4994
# TODO: We should probably check that we don't have mine-only and
4995
# theirs-only set, but it gets complicated because we also have
4996
# this and other which could be used.
5003
local_branch = Branch.open_containing(directory)[0]
5004
self.enter_context(local_branch.lock_read())
5006
parent = local_branch.get_parent()
5007
if other_branch is None:
5008
other_branch = parent
5009
if other_branch is None:
5010
raise errors.BzrCommandError(gettext("No peer location known"
5012
display_url = urlutils.unescape_for_display(parent,
5014
message(gettext("Using saved parent location: {0}\n").format(
5017
remote_branch = Branch.open(other_branch)
5018
if remote_branch.base == local_branch.base:
5019
remote_branch = local_branch
5021
self.enter_context(remote_branch.lock_read())
5023
local_revid_range = _revision_range_to_revid_range(
5024
_get_revision_range(my_revision, local_branch,
5027
remote_revid_range = _revision_range_to_revid_range(
5028
_get_revision_range(revision,
5029
remote_branch, self.name()))
5031
local_extra, remote_extra = find_unmerged(
5032
local_branch, remote_branch, restrict,
5033
backward=not reverse,
5034
include_merged=include_merged,
5035
local_revid_range=local_revid_range,
5036
remote_revid_range=remote_revid_range)
5038
if log_format is None:
5039
registry = log.log_formatter_registry
5040
log_format = registry.get_default(local_branch)
5041
lf = log_format(to_file=self.outf,
5043
show_timezone='original')
5046
if local_extra and not theirs_only:
5047
message(ngettext("You have %d extra revision:\n",
5048
"You have %d extra revisions:\n",
5052
if local_branch.supports_tags():
5053
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5054
for revision in iter_log_revisions(local_extra,
5055
local_branch.repository,
5058
lf.log_revision(revision)
5059
printed_local = True
5062
printed_local = False
5064
if remote_extra and not mine_only:
5065
if printed_local is True:
5067
message(ngettext("You are missing %d revision:\n",
5068
"You are missing %d revisions:\n",
5069
len(remote_extra)) %
5071
if remote_branch.supports_tags():
5072
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5073
for revision in iter_log_revisions(remote_extra,
5074
remote_branch.repository,
5077
lf.log_revision(revision)
5080
if mine_only and not local_extra:
5081
# We checked local, and found nothing extra
5082
message(gettext('This branch has no new revisions.\n'))
5083
elif theirs_only and not remote_extra:
5084
# We checked remote, and found nothing extra
5085
message(gettext('Other branch has no new revisions.\n'))
5086
elif not (mine_only or theirs_only or local_extra or
5088
# We checked both branches, and neither one had extra
5090
message(gettext("Branches are up to date.\n"))
5092
if not status_code and parent is None and other_branch is not None:
5093
self.enter_context(local_branch.lock_write())
5094
# handle race conditions - a parent might be set while we run.
5095
if local_branch.get_parent() is None:
5096
local_branch.set_parent(remote_branch.base)
5100
class cmd_pack(Command):
5101
__doc__ = """Compress the data within a repository.
5103
This operation compresses the data within a bazaar repository. As
5104
bazaar supports automatic packing of repository, this operation is
5105
normally not required to be done manually.
5107
During the pack operation, bazaar takes a backup of existing repository
5108
data, i.e. pack files. This backup is eventually removed by bazaar
5109
automatically when it is safe to do so. To save disk space by removing
5110
the backed up pack files, the --clean-obsolete-packs option may be
5113
Warning: If you use --clean-obsolete-packs and your machine crashes
5114
during or immediately after repacking, you may be left with a state
5115
where the deletion has been written to disk but the new packs have not
5116
been. In this case the repository may be unusable.
5119
_see_also = ['repositories']
5120
takes_args = ['branch_or_repo?']
5122
Option('clean-obsolete-packs',
5123
'Delete obsolete packs to save disk space.'),
5126
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5127
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5129
branch = dir.open_branch()
5130
repository = branch.repository
5131
except errors.NotBranchError:
5132
repository = dir.open_repository()
5133
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5136
class cmd_plugins(Command):
5137
__doc__ = """List the installed plugins.
5139
This command displays the list of installed plugins including
5140
version of plugin and a short description of each.
5142
--verbose shows the path where each plugin is located.
5144
A plugin is an external component for Breezy that extends the
5145
revision control system, by adding or replacing code in Breezy.
5146
Plugins can do a variety of things, including overriding commands,
5147
adding new commands, providing additional network transports and
5148
customizing log output.
5150
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5151
for further information on plugins including where to find them and how to
5152
install them. Instructions are also provided there on how to write new
5153
plugins using the Python programming language.
5155
takes_options = ['verbose']
5158
def run(self, verbose=False):
5159
from . import plugin
5160
# Don't give writelines a generator as some codecs don't like that
5161
self.outf.writelines(
5162
list(plugin.describe_plugins(show_paths=verbose)))
5165
class cmd_testament(Command):
5166
__doc__ = """Show testament (signing-form) of a revision."""
5169
Option('long', help='Produce long-format testament.'),
5171
help='Produce a strict-format testament.')]
5172
takes_args = ['branch?']
5173
encoding_type = 'exact'
5176
def run(self, branch=u'.', revision=None, long=False, strict=False):
5177
from .bzr.testament import Testament, StrictTestament
5179
testament_class = StrictTestament
5181
testament_class = Testament
5183
b = Branch.open_containing(branch)[0]
5185
b = Branch.open(branch)
5186
self.enter_context(b.lock_read())
5187
if revision is None:
5188
rev_id = b.last_revision()
5190
rev_id = revision[0].as_revision_id(b)
5191
t = testament_class.from_revision(b.repository, rev_id)
5193
self.outf.writelines(t.as_text_lines())
5195
self.outf.write(t.as_short_text())
5198
class cmd_annotate(Command):
5199
__doc__ = """Show the origin of each line in a file.
5201
This prints out the given file with an annotation on the left side
5202
indicating which revision, author and date introduced the change.
5204
If the origin is the same for a run of consecutive lines, it is
5205
shown only at the top, unless the --all option is given.
5207
# TODO: annotate directories; showing when each file was last changed
5208
# TODO: if the working copy is modified, show annotations on that
5209
# with new uncommitted lines marked
5210
aliases = ['ann', 'blame', 'praise']
5211
takes_args = ['filename']
5212
takes_options = [Option('all', help='Show annotations on all lines.'),
5213
Option('long', help='Show commit date in annotations.'),
5218
encoding_type = 'exact'
5221
def run(self, filename, all=False, long=False, revision=None,
5222
show_ids=False, directory=None):
5223
from .annotate import (
5226
wt, branch, relpath = \
5227
_open_directory_or_containing_tree_or_branch(filename, directory)
5229
self.enter_context(wt.lock_read())
5231
self.enter_context(branch.lock_read())
5232
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5233
self.enter_context(tree.lock_read())
5234
if wt is not None and revision is None:
5235
if not wt.is_versioned(relpath):
5236
raise errors.NotVersionedError(relpath)
5237
# If there is a tree and we're not annotating historical
5238
# versions, annotate the working tree's content.
5239
annotate_file_tree(wt, relpath, self.outf, long, all,
5242
if not tree.is_versioned(relpath):
5243
raise errors.NotVersionedError(relpath)
5244
annotate_file_tree(tree, relpath, self.outf, long, all,
5245
show_ids=show_ids, branch=branch)
5248
class cmd_re_sign(Command):
5249
__doc__ = """Create a digital signature for an existing revision."""
5250
# TODO be able to replace existing ones.
5252
hidden = True # is this right ?
5253
takes_args = ['revision_id*']
5254
takes_options = ['directory', 'revision']
5256
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5257
if revision_id_list is not None and revision is not None:
5258
raise errors.BzrCommandError(
5259
gettext('You can only supply one of revision_id or --revision'))
5260
if revision_id_list is None and revision is None:
5261
raise errors.BzrCommandError(
5262
gettext('You must supply either --revision or a revision_id'))
5263
b = WorkingTree.open_containing(directory)[0].branch
5264
self.enter_context(b.lock_write())
5265
return self._run(b, revision_id_list, revision)
5267
def _run(self, b, revision_id_list, revision):
5268
from .repository import WriteGroup
5269
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5270
if revision_id_list is not None:
5271
with WriteGroup(b.repository):
5272
for revision_id in revision_id_list:
5273
revision_id = cache_utf8.encode(revision_id)
5274
b.repository.sign_revision(revision_id, gpg_strategy)
5275
elif revision is not None:
5276
if len(revision) == 1:
5277
revno, rev_id = revision[0].in_history(b)
5278
with WriteGroup(b.repository):
5279
b.repository.sign_revision(rev_id, gpg_strategy)
5280
elif len(revision) == 2:
5281
# are they both on rh- if so we can walk between them
5282
# might be nice to have a range helper for arbitrary
5283
# revision paths. hmm.
5284
from_revno, from_revid = revision[0].in_history(b)
5285
to_revno, to_revid = revision[1].in_history(b)
5286
if to_revid is None:
5287
to_revno = b.revno()
5288
if from_revno is None or to_revno is None:
5289
raise errors.BzrCommandError(
5290
gettext('Cannot sign a range of non-revision-history revisions'))
5291
with WriteGroup(b.repository):
5292
for revno in range(from_revno, to_revno + 1):
5293
b.repository.sign_revision(b.get_rev_id(revno),
5296
raise errors.BzrCommandError(
5297
gettext('Please supply either one revision, or a range.'))
5300
class cmd_bind(Command):
5301
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5302
If no branch is supplied, rebind to the last bound location.
5304
Once converted into a checkout, commits must succeed on the master branch
5305
before they will be applied to the local branch.
5307
Bound branches use the nickname of its master branch unless it is set
5308
locally, in which case binding will update the local nickname to be
5312
_see_also = ['checkouts', 'unbind']
5313
takes_args = ['location?']
5314
takes_options = ['directory']
5316
def run(self, location=None, directory=u'.'):
5317
b, relpath = Branch.open_containing(directory)
5318
if location is None:
5320
location = b.get_old_bound_location()
5321
except errors.UpgradeRequired:
5322
raise errors.BzrCommandError(
5323
gettext('No location supplied. '
5324
'This format does not remember old locations.'))
5326
if location is None:
5327
if b.get_bound_location() is not None:
5328
raise errors.BzrCommandError(
5329
gettext('Branch is already bound'))
5331
raise errors.BzrCommandError(
5332
gettext('No location supplied'
5333
' and no previous location known'))
5334
b_other = Branch.open(location)
5337
except errors.DivergedBranches:
5338
raise errors.BzrCommandError(
5339
gettext('These branches have diverged.'
5340
' Try merging, and then bind again.'))
5341
if b.get_config().has_explicit_nickname():
5342
b.nick = b_other.nick
5345
class cmd_unbind(Command):
5346
__doc__ = """Convert the current checkout into a regular branch.
5348
After unbinding, the local branch is considered independent and subsequent
5349
commits will be local only.
5352
_see_also = ['checkouts', 'bind']
5354
takes_options = ['directory']
5356
def run(self, directory=u'.'):
5357
b, relpath = Branch.open_containing(directory)
5359
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5362
class cmd_uncommit(Command):
5363
__doc__ = """Remove the last committed revision.
5365
--verbose will print out what is being removed.
5366
--dry-run will go through all the motions, but not actually
5369
If --revision is specified, uncommit revisions to leave the branch at the
5370
specified revision. For example, "brz uncommit -r 15" will leave the
5371
branch at revision 15.
5373
Uncommit leaves the working tree ready for a new commit. The only change
5374
it may make is to restore any pending merges that were present before
5378
# TODO: jam 20060108 Add an option to allow uncommit to remove
5379
# unreferenced information in 'branch-as-repository' branches.
5380
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5381
# information in shared branches as well.
5382
_see_also = ['commit']
5383
takes_options = ['verbose', 'revision',
5384
Option('dry-run', help='Don\'t actually make changes.'),
5385
Option('force', help='Say yes to all questions.'),
5387
help='Keep tags that point to removed revisions.'),
5389
help="Only remove the commits from the local "
5390
"branch when in a checkout."
5393
takes_args = ['location?']
5395
encoding_type = 'replace'
5397
def run(self, location=None, dry_run=False, verbose=False,
5398
revision=None, force=False, local=False, keep_tags=False):
5399
if location is None:
5401
control, relpath = controldir.ControlDir.open_containing(location)
5403
tree = control.open_workingtree()
5405
except (errors.NoWorkingTree, errors.NotLocalUrl):
5407
b = control.open_branch()
5409
if tree is not None:
5410
self.enter_context(tree.lock_write())
5412
self.enter_context(b.lock_write())
5413
return self._run(b, tree, dry_run, verbose, revision, force,
5414
local, keep_tags, location)
5416
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5417
keep_tags, location):
5418
from .log import log_formatter, show_log
5419
from .uncommit import uncommit
5421
last_revno, last_rev_id = b.last_revision_info()
5424
if revision is None:
5426
rev_id = last_rev_id
5428
# 'brz uncommit -r 10' actually means uncommit
5429
# so that the final tree is at revno 10.
5430
# but breezy.uncommit.uncommit() actually uncommits
5431
# the revisions that are supplied.
5432
# So we need to offset it by one
5433
revno = revision[0].in_history(b).revno + 1
5434
if revno <= last_revno:
5435
rev_id = b.get_rev_id(revno)
5437
if rev_id is None or _mod_revision.is_null(rev_id):
5438
self.outf.write(gettext('No revisions to uncommit.\n'))
5441
lf = log_formatter('short',
5443
show_timezone='original')
5448
direction='forward',
5449
start_revision=revno,
5450
end_revision=last_revno)
5453
self.outf.write(gettext('Dry-run, pretending to remove'
5454
' the above revisions.\n'))
5457
gettext('The above revision(s) will be removed.\n'))
5460
if not ui.ui_factory.confirm_action(
5461
gettext(u'Uncommit these revisions'),
5462
'breezy.builtins.uncommit',
5464
self.outf.write(gettext('Canceled\n'))
5467
mutter('Uncommitting from {%s} to {%s}',
5468
last_rev_id, rev_id)
5469
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5470
revno=revno, local=local, keep_tags=keep_tags)
5473
gettext('You can restore the old tip by running:\n'
5474
' brz pull -d %s %s -r revid:%s\n')
5475
% (location, location, last_rev_id.decode('utf-8')))
5478
gettext('You can restore the old tip by running:\n'
5479
' brz pull . -r revid:%s\n')
5480
% last_rev_id.decode('utf-8'))
5483
class cmd_break_lock(Command):
5484
__doc__ = """Break a dead lock.
5486
This command breaks a lock on a repository, branch, working directory or
5489
CAUTION: Locks should only be broken when you are sure that the process
5490
holding the lock has been stopped.
5492
You can get information on what locks are open via the 'brz info
5493
[location]' command.
5497
brz break-lock brz+ssh://example.com/brz/foo
5498
brz break-lock --conf ~/.config/breezy
5501
takes_args = ['location?']
5504
help='LOCATION is the directory where the config lock is.'),
5506
help='Do not ask for confirmation before breaking the lock.'),
5509
def run(self, location=None, config=False, force=False):
5510
if location is None:
5513
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5515
{'breezy.lockdir.break': True})
5517
conf = _mod_config.LockableConfig(file_name=location)
5520
control, relpath = controldir.ControlDir.open_containing(location)
5522
control.break_lock()
5523
except NotImplementedError:
5527
class cmd_wait_until_signalled(Command):
5528
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5530
This just prints a line to signal when it is ready, then blocks on stdin.
5536
self.outf.write("running\n")
5538
sys.stdin.readline()
5541
class cmd_serve(Command):
5542
__doc__ = """Run the brz server."""
5544
aliases = ['server']
5548
help='Serve on stdin/out for use from inetd or sshd.'),
5549
RegistryOption('protocol',
5550
help="Protocol to serve.",
5551
lazy_registry=('breezy.transport',
5552
'transport_server_registry'),
5553
value_switches=True),
5555
help='Listen for connections on nominated address.',
5558
help='Listen for connections on nominated port. Passing 0 as '
5559
'the port number will result in a dynamically allocated '
5560
'port. The default port depends on the protocol.',
5562
custom_help('directory',
5563
help='Serve contents of this directory.'),
5564
Option('allow-writes',
5565
help='By default the server is a readonly server. Supplying '
5566
'--allow-writes enables write access to the contents of '
5567
'the served directory and below. Note that ``brz serve`` '
5568
'does not perform authentication, so unless some form of '
5569
'external authentication is arranged supplying this '
5570
'option leads to global uncontrolled write access to your '
5573
Option('client-timeout', type=float,
5574
help='Override the default idle client timeout (5min).'),
5577
def run(self, listen=None, port=None, inet=False, directory=None,
5578
allow_writes=False, protocol=None, client_timeout=None):
5579
from . import location, transport
5580
if directory is None:
5581
directory = osutils.getcwd()
5582
if protocol is None:
5583
protocol = transport.transport_server_registry.get()
5584
url = location.location_to_url(directory)
5585
if not allow_writes:
5586
url = 'readonly+' + url
5587
t = transport.get_transport_from_url(url)
5588
protocol(t, listen, port, inet, client_timeout)
5591
class cmd_join(Command):
5592
__doc__ = """Combine a tree into its containing tree.
5594
This command requires the target tree to be in a rich-root format.
5596
The TREE argument should be an independent tree, inside another tree, but
5597
not part of it. (Such trees can be produced by "brz split", but also by
5598
running "brz branch" with the target inside a tree.)
5600
The result is a combined tree, with the subtree no longer an independent
5601
part. This is marked as a merge of the subtree into the containing tree,
5602
and all history is preserved.
5605
_see_also = ['split']
5606
takes_args = ['tree']
5608
Option('reference', help='Join by reference.', hidden=True),
5611
def run(self, tree, reference=False):
5612
from breezy.mutabletree import BadReferenceTarget
5613
sub_tree = WorkingTree.open(tree)
5614
parent_dir = osutils.dirname(sub_tree.basedir)
5615
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5616
repo = containing_tree.branch.repository
5617
if not repo.supports_rich_root():
5618
raise errors.BzrCommandError(gettext(
5619
"Can't join trees because %s doesn't support rich root data.\n"
5620
"You can use brz upgrade on the repository.")
5624
containing_tree.add_reference(sub_tree)
5625
except BadReferenceTarget as e:
5626
# XXX: Would be better to just raise a nicely printable
5627
# exception from the real origin. Also below. mbp 20070306
5628
raise errors.BzrCommandError(
5629
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5632
containing_tree.subsume(sub_tree)
5633
except errors.BadSubsumeSource as e:
5634
raise errors.BzrCommandError(
5635
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5638
class cmd_split(Command):
5639
__doc__ = """Split a subdirectory of a tree into a separate tree.
5641
This command will produce a target tree in a format that supports
5642
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5643
converted into earlier formats like 'dirstate-tags'.
5645
The TREE argument should be a subdirectory of a working tree. That
5646
subdirectory will be converted into an independent tree, with its own
5647
branch. Commits in the top-level tree will not apply to the new subtree.
5650
_see_also = ['join']
5651
takes_args = ['tree']
5653
def run(self, tree):
5654
containing_tree, subdir = WorkingTree.open_containing(tree)
5655
if not containing_tree.is_versioned(subdir):
5656
raise errors.NotVersionedError(subdir)
5658
containing_tree.extract(subdir)
5659
except errors.RootNotRich:
5660
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5663
class cmd_merge_directive(Command):
5664
__doc__ = """Generate a merge directive for auto-merge tools.
5666
A directive requests a merge to be performed, and also provides all the
5667
information necessary to do so. This means it must either include a
5668
revision bundle, or the location of a branch containing the desired
5671
A submit branch (the location to merge into) must be supplied the first
5672
time the command is issued. After it has been supplied once, it will
5673
be remembered as the default.
5675
A public branch is optional if a revision bundle is supplied, but required
5676
if --diff or --plain is specified. It will be remembered as the default
5677
after the first use.
5680
takes_args = ['submit_branch?', 'public_branch?']
5684
_see_also = ['send']
5688
RegistryOption.from_kwargs(
5690
'The type of patch to include in the directive.',
5692
value_switches=True,
5694
bundle='Bazaar revision bundle (default).',
5695
diff='Normal unified diff.',
5696
plain='No patch, just directive.'),
5697
Option('sign', help='GPG-sign the directive.'), 'revision',
5698
Option('mail-to', type=text_type,
5699
help='Instead of printing the directive, email to this '
5701
Option('message', type=text_type, short_name='m',
5702
help='Message to use when committing this merge.')
5705
encoding_type = 'exact'
5707
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5708
sign=False, revision=None, mail_to=None, message=None,
5710
from .revision import ensure_null, NULL_REVISION
5711
include_patch, include_bundle = {
5712
'plain': (False, False),
5713
'diff': (True, False),
5714
'bundle': (True, True),
5716
branch = Branch.open(directory)
5717
stored_submit_branch = branch.get_submit_branch()
5718
if submit_branch is None:
5719
submit_branch = stored_submit_branch
5721
if stored_submit_branch is None:
5722
branch.set_submit_branch(submit_branch)
5723
if submit_branch is None:
5724
submit_branch = branch.get_parent()
5725
if submit_branch is None:
5726
raise errors.BzrCommandError(
5727
gettext('No submit branch specified or known'))
5729
stored_public_branch = branch.get_public_branch()
5730
if public_branch is None:
5731
public_branch = stored_public_branch
5732
elif stored_public_branch is None:
5733
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5734
branch.set_public_branch(public_branch)
5735
if not include_bundle and public_branch is None:
5736
raise errors.BzrCommandError(
5737
gettext('No public branch specified or known'))
5738
base_revision_id = None
5739
if revision is not None:
5740
if len(revision) > 2:
5741
raise errors.BzrCommandError(
5742
gettext('brz merge-directive takes '
5743
'at most two one revision identifiers'))
5744
revision_id = revision[-1].as_revision_id(branch)
5745
if len(revision) == 2:
5746
base_revision_id = revision[0].as_revision_id(branch)
5748
revision_id = branch.last_revision()
5749
revision_id = ensure_null(revision_id)
5750
if revision_id == NULL_REVISION:
5751
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5752
directive = merge_directive.MergeDirective2.from_objects(
5753
branch.repository, revision_id, time.time(),
5754
osutils.local_time_offset(), submit_branch,
5755
public_branch=public_branch, include_patch=include_patch,
5756
include_bundle=include_bundle, message=message,
5757
base_revision_id=base_revision_id)
5760
self.outf.write(directive.to_signed(branch))
5762
self.outf.writelines(directive.to_lines())
5764
message = directive.to_email(mail_to, branch, sign)
5765
s = SMTPConnection(branch.get_config_stack())
5766
s.send_email(message)
5769
class cmd_send(Command):
5770
__doc__ = """Mail or create a merge-directive for submitting changes.
5772
A merge directive provides many things needed for requesting merges:
5774
* A machine-readable description of the merge to perform
5776
* An optional patch that is a preview of the changes requested
5778
* An optional bundle of revision data, so that the changes can be applied
5779
directly from the merge directive, without retrieving data from a
5782
`brz send` creates a compact data set that, when applied using brz
5783
merge, has the same effect as merging from the source branch.
5785
By default the merge directive is self-contained and can be applied to any
5786
branch containing submit_branch in its ancestory without needing access to
5789
If --no-bundle is specified, then Breezy doesn't send the contents of the
5790
revisions, but only a structured request to merge from the
5791
public_location. In that case the public_branch is needed and it must be
5792
up-to-date and accessible to the recipient. The public_branch is always
5793
included if known, so that people can check it later.
5795
The submit branch defaults to the parent of the source branch, but can be
5796
overridden. Both submit branch and public branch will be remembered in
5797
branch.conf the first time they are used for a particular branch. The
5798
source branch defaults to that containing the working directory, but can
5799
be changed using --from.
5801
Both the submit branch and the public branch follow the usual behavior with
5802
respect to --remember: If there is no default location set, the first send
5803
will set it (use --no-remember to avoid setting it). After that, you can
5804
omit the location to use the default. To change the default, use
5805
--remember. The value will only be saved if the location can be accessed.
5807
In order to calculate those changes, brz must analyse the submit branch.
5808
Therefore it is most efficient for the submit branch to be a local mirror.
5809
If a public location is known for the submit_branch, that location is used
5810
in the merge directive.
5812
The default behaviour is to send the merge directive by mail, unless -o is
5813
given, in which case it is sent to a file.
5815
Mail is sent using your preferred mail program. This should be transparent
5816
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5817
If the preferred client can't be found (or used), your editor will be used.
5819
To use a specific mail program, set the mail_client configuration option.
5820
Supported values for specific clients are "claws", "evolution", "kmail",
5821
"mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options
5822
are "default", "editor", "emacsclient", "mapi", and "xdg-email". Plugins
5823
may also add supported clients.
5825
If mail is being sent, a to address is required. This can be supplied
5826
either on the commandline, by setting the submit_to configuration
5827
option in the branch itself or the child_submit_to configuration option
5828
in the submit branch.
5830
The merge directives created by brz send may be applied using brz merge or
5831
brz pull by specifying a file containing a merge directive as the location.
5833
brz send makes extensive use of public locations to map local locations into
5834
URLs that can be used by other people. See `brz help configuration` to
5835
set them, and use `brz info` to display them.
5838
encoding_type = 'exact'
5840
_see_also = ['merge', 'pull']
5842
takes_args = ['submit_branch?', 'public_branch?']
5846
help='Do not include a bundle in the merge directive.'),
5847
Option('no-patch', help='Do not include a preview patch in the merge'
5850
help='Remember submit and public branch.'),
5852
help='Branch to generate the submission from, '
5853
'rather than the one containing the working directory.',
5856
Option('output', short_name='o',
5857
help='Write merge directive to this file or directory; '
5858
'use - for stdout.',
5861
help='Refuse to send if there are uncommitted changes in'
5862
' the working tree, --no-strict disables the check.'),
5863
Option('mail-to', help='Mail the request to this address.',
5867
Option('body', help='Body for the email.', type=text_type),
5868
RegistryOption('format',
5869
help='Use the specified output format.',
5870
lazy_registry=('breezy.send', 'format_registry')),
5873
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5874
no_patch=False, revision=None, remember=None, output=None,
5875
format=None, mail_to=None, message=None, body=None,
5876
strict=None, **kwargs):
5877
from .send import send
5878
return send(submit_branch, revision, public_branch, remember,
5879
format, no_bundle, no_patch, output,
5880
kwargs.get('from', '.'), mail_to, message, body,
5885
class cmd_bundle_revisions(cmd_send):
5886
__doc__ = """Create a merge-directive for submitting changes.
5888
A merge directive provides many things needed for requesting merges:
5890
* A machine-readable description of the merge to perform
5892
* An optional patch that is a preview of the changes requested
5894
* An optional bundle of revision data, so that the changes can be applied
5895
directly from the merge directive, without retrieving data from a
5898
If --no-bundle is specified, then public_branch is needed (and must be
5899
up-to-date), so that the receiver can perform the merge using the
5900
public_branch. The public_branch is always included if known, so that
5901
people can check it later.
5903
The submit branch defaults to the parent, but can be overridden. Both
5904
submit branch and public branch will be remembered if supplied.
5906
If a public_branch is known for the submit_branch, that public submit
5907
branch is used in the merge instructions. This means that a local mirror
5908
can be used as your actual submit branch, once you have set public_branch
5914
help='Do not include a bundle in the merge directive.'),
5915
Option('no-patch', help='Do not include a preview patch in the merge'
5918
help='Remember submit and public branch.'),
5920
help='Branch to generate the submission from, '
5921
'rather than the one containing the working directory.',
5924
Option('output', short_name='o', help='Write directive to this file.',
5927
help='Refuse to bundle revisions if there are uncommitted'
5928
' changes in the working tree, --no-strict disables the check.'),
5930
RegistryOption('format',
5931
help='Use the specified output format.',
5932
lazy_registry=('breezy.send', 'format_registry')),
5934
aliases = ['bundle']
5936
_see_also = ['send', 'merge']
5940
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5941
no_patch=False, revision=None, remember=False, output=None,
5942
format=None, strict=None, **kwargs):
5945
from .send import send
5946
return send(submit_branch, revision, public_branch, remember,
5947
format, no_bundle, no_patch, output,
5948
kwargs.get('from', '.'), None, None, None,
5949
self.outf, strict=strict)
5952
class cmd_tag(Command):
5953
__doc__ = """Create, remove or modify a tag naming a revision.
5955
Tags give human-meaningful names to revisions. Commands that take a -r
5956
(--revision) option can be given -rtag:X, where X is any previously
5959
Tags are stored in the branch. Tags are copied from one branch to another
5960
along when you branch, push, pull or merge.
5962
It is an error to give a tag name that already exists unless you pass
5963
--force, in which case the tag is moved to point to the new revision.
5965
To rename a tag (change the name but keep it on the same revsion), run ``brz
5966
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
5968
If no tag name is specified it will be determined through the
5969
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5970
upstream releases by reading configure.ac. See ``brz help hooks`` for
5974
_see_also = ['commit', 'tags']
5975
takes_args = ['tag_name?']
5978
help='Delete this tag rather than placing it.',
5980
custom_help('directory',
5981
help='Branch in which to place the tag.'),
5983
help='Replace existing tags.',
5988
def run(self, tag_name=None,
5994
branch, relpath = Branch.open_containing(directory)
5995
self.enter_context(branch.lock_write())
5997
if tag_name is None:
5998
raise errors.BzrCommandError(
5999
gettext("No tag specified to delete."))
6000
branch.tags.delete_tag(tag_name)
6001
note(gettext('Deleted tag %s.') % tag_name)
6004
if len(revision) != 1:
6005
raise errors.BzrCommandError(gettext(
6006
"Tags can only be placed on a single revision, "
6008
revision_id = revision[0].as_revision_id(branch)
6010
revision_id = branch.last_revision()
6011
if tag_name is None:
6012
tag_name = branch.automatic_tag_name(revision_id)
6013
if tag_name is None:
6014
raise errors.BzrCommandError(gettext(
6015
"Please specify a tag name."))
6017
existing_target = branch.tags.lookup_tag(tag_name)
6018
except errors.NoSuchTag:
6019
existing_target = None
6020
if not force and existing_target not in (None, revision_id):
6021
raise errors.TagAlreadyExists(tag_name)
6022
if existing_target == revision_id:
6023
note(gettext('Tag %s already exists for that revision.') % tag_name)
6025
branch.tags.set_tag(tag_name, revision_id)
6026
if existing_target is None:
6027
note(gettext('Created tag %s.') % tag_name)
6029
note(gettext('Updated tag %s.') % tag_name)
6032
class cmd_tags(Command):
6033
__doc__ = """List tags.
6035
This command shows a table of tag names and the revisions they reference.
6040
custom_help('directory',
6041
help='Branch whose tags should be displayed.'),
6042
RegistryOption('sort',
6043
'Sort tags by different criteria.', title='Sorting',
6044
lazy_registry=('breezy.tag', 'tag_sort_methods')
6051
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6052
from .tag import tag_sort_methods
6053
branch, relpath = Branch.open_containing(directory)
6055
tags = list(viewitems(branch.tags.get_tag_dict()))
6059
self.enter_context(branch.lock_read())
6061
# Restrict to the specified range
6062
tags = self._tags_for_range(branch, revision)
6064
sort = tag_sort_methods.get()
6067
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6068
for index, (tag, revid) in enumerate(tags):
6070
revno = branch.revision_id_to_dotted_revno(revid)
6071
if isinstance(revno, tuple):
6072
revno = '.'.join(map(str, revno))
6073
except (errors.NoSuchRevision,
6074
errors.GhostRevisionsHaveNoRevno,
6075
errors.UnsupportedOperation):
6076
# Bad tag data/merges can lead to tagged revisions
6077
# which are not in this branch. Fail gracefully ...
6079
tags[index] = (tag, revno)
6081
tags = [(tag, revid.decode('utf-8')) for (tag, revid) in tags]
6083
for tag, revspec in tags:
6084
self.outf.write('%-20s %s\n' % (tag, revspec))
6086
def _tags_for_range(self, branch, revision):
6087
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6088
revid1, revid2 = rev1.rev_id, rev2.rev_id
6089
# _get_revision_range will always set revid2 if it's not specified.
6090
# If revid1 is None, it means we want to start from the branch
6091
# origin which is always a valid ancestor. If revid1 == revid2, the
6092
# ancestry check is useless.
6093
if revid1 and revid1 != revid2:
6094
# FIXME: We really want to use the same graph than
6095
# branch.iter_merge_sorted_revisions below, but this is not
6096
# easily available -- vila 2011-09-23
6097
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6098
# We don't want to output anything in this case...
6100
# only show revisions between revid1 and revid2 (inclusive)
6101
tagged_revids = branch.tags.get_reverse_tag_dict()
6103
for r in branch.iter_merge_sorted_revisions(
6104
start_revision_id=revid2, stop_revision_id=revid1,
6105
stop_rule='include'):
6106
revid_tags = tagged_revids.get(r[0], None)
6108
found.extend([(tag, r[0]) for tag in revid_tags])
6112
class cmd_reconfigure(Command):
6113
__doc__ = """Reconfigure the type of a brz directory.
6115
A target configuration must be specified.
6117
For checkouts, the bind-to location will be auto-detected if not specified.
6118
The order of preference is
6119
1. For a lightweight checkout, the current bound location.
6120
2. For branches that used to be checkouts, the previously-bound location.
6121
3. The push location.
6122
4. The parent location.
6123
If none of these is available, --bind-to must be specified.
6126
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6127
takes_args = ['location?']
6129
RegistryOption.from_kwargs(
6132
help='The relation between branch and tree.',
6133
value_switches=True, enum_switch=False,
6134
branch='Reconfigure to be an unbound branch with no working tree.',
6135
tree='Reconfigure to be an unbound branch with a working tree.',
6136
checkout='Reconfigure to be a bound branch with a working tree.',
6137
lightweight_checkout='Reconfigure to be a lightweight'
6138
' checkout (with no local history).',
6140
RegistryOption.from_kwargs(
6142
title='Repository type',
6143
help='Location fo the repository.',
6144
value_switches=True, enum_switch=False,
6145
standalone='Reconfigure to be a standalone branch '
6146
'(i.e. stop using shared repository).',
6147
use_shared='Reconfigure to use a shared repository.',
6149
RegistryOption.from_kwargs(
6151
title='Trees in Repository',
6152
help='Whether new branches in the repository have trees.',
6153
value_switches=True, enum_switch=False,
6154
with_trees='Reconfigure repository to create '
6155
'working trees on branches by default.',
6156
with_no_trees='Reconfigure repository to not create '
6157
'working trees on branches by default.'
6159
Option('bind-to', help='Branch to bind checkout to.', type=text_type),
6161
help='Perform reconfiguration even if local changes'
6163
Option('stacked-on',
6164
help='Reconfigure a branch to be stacked on another branch.',
6168
help='Reconfigure a branch to be unstacked. This '
6169
'may require copying substantial data into it.',
6173
def run(self, location=None, bind_to=None, force=False,
6174
tree_type=None, repository_type=None, repository_trees=None,
6175
stacked_on=None, unstacked=None):
6176
directory = controldir.ControlDir.open(location)
6177
if stacked_on and unstacked:
6178
raise errors.BzrCommandError(
6179
gettext("Can't use both --stacked-on and --unstacked"))
6180
elif stacked_on is not None:
6181
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6183
reconfigure.ReconfigureUnstacked().apply(directory)
6184
# At the moment you can use --stacked-on and a different
6185
# reconfiguration shape at the same time; there seems no good reason
6187
if (tree_type is None and
6188
repository_type is None and
6189
repository_trees is None):
6190
if stacked_on or unstacked:
6193
raise errors.BzrCommandError(gettext('No target configuration '
6195
reconfiguration = None
6196
if tree_type == 'branch':
6197
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6198
elif tree_type == 'tree':
6199
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6200
elif tree_type == 'checkout':
6201
reconfiguration = reconfigure.Reconfigure.to_checkout(
6203
elif tree_type == 'lightweight-checkout':
6204
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6207
reconfiguration.apply(force)
6208
reconfiguration = None
6209
if repository_type == 'use-shared':
6210
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6211
elif repository_type == 'standalone':
6212
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6214
reconfiguration.apply(force)
6215
reconfiguration = None
6216
if repository_trees == 'with-trees':
6217
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6219
elif repository_trees == 'with-no-trees':
6220
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6223
reconfiguration.apply(force)
6224
reconfiguration = None
6227
class cmd_switch(Command):
6228
__doc__ = """Set the branch of a checkout and update.
6230
For lightweight checkouts, this changes the branch being referenced.
6231
For heavyweight checkouts, this checks that there are no local commits
6232
versus the current bound branch, then it makes the local branch a mirror
6233
of the new location and binds to it.
6235
In both cases, the working tree is updated and uncommitted changes
6236
are merged. The user can commit or revert these as they desire.
6238
Pending merges need to be committed or reverted before using switch.
6240
The path to the branch to switch to can be specified relative to the parent
6241
directory of the current branch. For example, if you are currently in a
6242
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6245
Bound branches use the nickname of its master branch unless it is set
6246
locally, in which case switching will update the local nickname to be
6250
takes_args = ['to_location?']
6251
takes_options = ['directory',
6253
help='Switch even if local commits will be lost.'),
6255
Option('create-branch', short_name='b',
6256
help='Create the target branch from this one before'
6257
' switching to it.'),
6259
help='Store and restore uncommitted changes in the'
6263
def run(self, to_location=None, force=False, create_branch=False,
6264
revision=None, directory=u'.', store=False):
6265
from . import switch
6266
tree_location = directory
6267
revision = _get_one_revision('switch', revision)
6268
control_dir = controldir.ControlDir.open_containing(tree_location)[0]
6269
possible_transports = [control_dir.root_transport]
6270
if to_location is None:
6271
if revision is None:
6272
raise errors.BzrCommandError(gettext('You must supply either a'
6273
' revision or a location'))
6274
to_location = tree_location
6276
branch = control_dir.open_branch(
6277
possible_transports=possible_transports)
6278
had_explicit_nick = branch.get_config().has_explicit_nickname()
6279
except errors.NotBranchError:
6281
had_explicit_nick = False
6283
possible_transports.append(branch.user_transport)
6286
raise errors.BzrCommandError(
6287
gettext('cannot create branch without source branch'))
6288
to_location = lookup_new_sibling_branch(
6289
control_dir, to_location,
6290
possible_transports=possible_transports)
6291
if revision is not None:
6292
revision = revision.as_revision_id(branch)
6293
to_branch = branch.controldir.sprout(
6295
possible_transports=possible_transports,
6296
revision_id=revision,
6297
source_branch=branch).open_branch()
6300
to_branch = Branch.open(
6301
to_location, possible_transports=possible_transports)
6302
except errors.NotBranchError:
6303
to_branch = open_sibling_branch(
6304
control_dir, to_location,
6305
possible_transports=possible_transports)
6306
if revision is not None:
6307
revision = revision.as_revision_id(to_branch)
6308
possible_transports.append(to_branch.user_transport)
6310
switch.switch(control_dir, to_branch, force, revision_id=revision,
6311
store_uncommitted=store,
6312
possible_transports=possible_transports)
6313
except controldir.BranchReferenceLoop:
6314
raise errors.BzrCommandError(
6315
gettext('switching would create a branch reference loop. '
6316
'Use the "bzr up" command to switch to a '
6317
'different revision.'))
6318
if had_explicit_nick:
6319
branch = control_dir.open_branch() # get the new branch!
6320
branch.nick = to_branch.nick
6322
if to_branch.controldir.control_url != control_dir.control_url:
6323
note(gettext('Switched to branch %s at %s'),
6324
to_branch.name, urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6326
note(gettext('Switched to branch %s'), to_branch.name)
6328
note(gettext('Switched to branch at %s'),
6329
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6332
class cmd_view(Command):
6333
__doc__ = """Manage filtered views.
6335
Views provide a mask over the tree so that users can focus on
6336
a subset of a tree when doing their work. After creating a view,
6337
commands that support a list of files - status, diff, commit, etc -
6338
effectively have that list of files implicitly given each time.
6339
An explicit list of files can still be given but those files
6340
must be within the current view.
6342
In most cases, a view has a short life-span: it is created to make
6343
a selected change and is deleted once that change is committed.
6344
At other times, you may wish to create one or more named views
6345
and switch between them.
6347
To disable the current view without deleting it, you can switch to
6348
the pseudo view called ``off``. This can be useful when you need
6349
to see the whole tree for an operation or two (e.g. merge) but
6350
want to switch back to your view after that.
6353
To define the current view::
6355
brz view file1 dir1 ...
6357
To list the current view::
6361
To delete the current view::
6365
To disable the current view without deleting it::
6367
brz view --switch off
6369
To define a named view and switch to it::
6371
brz view --name view-name file1 dir1 ...
6373
To list a named view::
6375
brz view --name view-name
6377
To delete a named view::
6379
brz view --name view-name --delete
6381
To switch to a named view::
6383
brz view --switch view-name
6385
To list all views defined::
6389
To delete all views::
6391
brz view --delete --all
6395
takes_args = ['file*']
6398
help='Apply list or delete action to all views.',
6401
help='Delete the view.',
6404
help='Name of the view to define, list or delete.',
6408
help='Name of the view to switch to.',
6413
def run(self, file_list,
6419
tree, file_list = WorkingTree.open_containing_paths(file_list,
6421
current_view, view_dict = tree.views.get_view_info()
6426
raise errors.BzrCommandError(gettext(
6427
"Both --delete and a file list specified"))
6429
raise errors.BzrCommandError(gettext(
6430
"Both --delete and --switch specified"))
6432
tree.views.set_view_info(None, {})
6433
self.outf.write(gettext("Deleted all views.\n"))
6435
raise errors.BzrCommandError(
6436
gettext("No current view to delete"))
6438
tree.views.delete_view(name)
6439
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6442
raise errors.BzrCommandError(gettext(
6443
"Both --switch and a file list specified"))
6445
raise errors.BzrCommandError(gettext(
6446
"Both --switch and --all specified"))
6447
elif switch == 'off':
6448
if current_view is None:
6449
raise errors.BzrCommandError(
6450
gettext("No current view to disable"))
6451
tree.views.set_view_info(None, view_dict)
6452
self.outf.write(gettext("Disabled '%s' view.\n") %
6455
tree.views.set_view_info(switch, view_dict)
6456
view_str = views.view_display_str(tree.views.lookup_view())
6458
gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6461
self.outf.write(gettext('Views defined:\n'))
6462
for view in sorted(view_dict):
6463
if view == current_view:
6467
view_str = views.view_display_str(view_dict[view])
6468
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6470
self.outf.write(gettext('No views defined.\n'))
6473
# No name given and no current view set
6476
raise errors.BzrCommandError(gettext(
6477
"Cannot change the 'off' pseudo view"))
6478
tree.views.set_view(name, sorted(file_list))
6479
view_str = views.view_display_str(tree.views.lookup_view())
6481
gettext("Using '{0}' view: {1}\n").format(name, view_str))
6485
# No name given and no current view set
6486
self.outf.write(gettext('No current view.\n'))
6488
view_str = views.view_display_str(tree.views.lookup_view(name))
6490
gettext("'{0}' view is: {1}\n").format(name, view_str))
6493
class cmd_hooks(Command):
6494
__doc__ = """Show hooks."""
6499
for hook_key in sorted(hooks.known_hooks.keys()):
6500
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6501
self.outf.write("%s:\n" % type(some_hooks).__name__)
6502
for hook_name, hook_point in sorted(some_hooks.items()):
6503
self.outf.write(" %s:\n" % (hook_name,))
6504
found_hooks = list(hook_point)
6506
for hook in found_hooks:
6507
self.outf.write(" %s\n" %
6508
(some_hooks.get_hook_name(hook),))
6510
self.outf.write(gettext(" <no hooks installed>\n"))
6513
class cmd_remove_branch(Command):
6514
__doc__ = """Remove a branch.
6516
This will remove the branch from the specified location but
6517
will keep any working tree or repository in place.
6521
Remove the branch at repo/trunk::
6523
brz remove-branch repo/trunk
6527
takes_args = ["location?"]
6529
takes_options = ['directory',
6530
Option('force', help='Remove branch even if it is the active branch.')]
6532
aliases = ["rmbranch"]
6534
def run(self, directory=None, location=None, force=False):
6535
br = open_nearby_branch(near=directory, location=location)
6536
if not force and br.controldir.has_workingtree():
6538
active_branch = br.controldir.open_branch(name="")
6539
except errors.NotBranchError:
6540
active_branch = None
6541
if (active_branch is not None and
6542
br.control_url == active_branch.control_url):
6543
raise errors.BzrCommandError(
6544
gettext("Branch is active. Use --force to remove it."))
6545
br.controldir.destroy_branch(br.name)
6548
class cmd_shelve(Command):
6549
__doc__ = """Temporarily set aside some changes from the current tree.
6551
Shelve allows you to temporarily put changes you've made "on the shelf",
6552
ie. out of the way, until a later time when you can bring them back from
6553
the shelf with the 'unshelve' command. The changes are stored alongside
6554
your working tree, and so they aren't propagated along with your branch nor
6555
will they survive its deletion.
6557
If shelve --list is specified, previously-shelved changes are listed.
6559
Shelve is intended to help separate several sets of changes that have
6560
been inappropriately mingled. If you just want to get rid of all changes
6561
and you don't need to restore them later, use revert. If you want to
6562
shelve all text changes at once, use shelve --all.
6564
If filenames are specified, only the changes to those files will be
6565
shelved. Other files will be left untouched.
6567
If a revision is specified, changes since that revision will be shelved.
6569
You can put multiple items on the shelf, and by default, 'unshelve' will
6570
restore the most recently shelved changes.
6572
For complicated changes, it is possible to edit the changes in a separate
6573
editor program to decide what the file remaining in the working copy
6574
should look like. To do this, add the configuration option
6576
change_editor = PROGRAM {new_path} {old_path}
6578
where {new_path} is replaced with the path of the new version of the
6579
file and {old_path} is replaced with the path of the old version of
6580
the file. The PROGRAM should save the new file with the desired
6581
contents of the file in the working tree.
6585
takes_args = ['file*']
6590
Option('all', help='Shelve all changes.'),
6592
RegistryOption('writer', 'Method to use for writing diffs.',
6593
breezy.option.diff_writer_registry,
6594
value_switches=True, enum_switch=False),
6596
Option('list', help='List shelved changes.'),
6598
help='Destroy removed changes instead of shelving them.'),
6600
_see_also = ['unshelve', 'configuration']
6602
def run(self, revision=None, all=False, file_list=None, message=None,
6603
writer=None, list=False, destroy=False, directory=None):
6605
return self.run_for_list(directory=directory)
6606
from .shelf_ui import Shelver
6608
writer = breezy.option.diff_writer_registry.get()
6610
shelver = Shelver.from_args(writer(self.outf), revision, all,
6611
file_list, message, destroy=destroy, directory=directory)
6616
except errors.UserAbort:
6619
def run_for_list(self, directory=None):
6620
if directory is None:
6622
tree = WorkingTree.open_containing(directory)[0]
6623
self.enter_context(tree.lock_read())
6624
manager = tree.get_shelf_manager()
6625
shelves = manager.active_shelves()
6626
if len(shelves) == 0:
6627
note(gettext('No shelved changes.'))
6629
for shelf_id in reversed(shelves):
6630
message = manager.get_metadata(shelf_id).get(b'message')
6632
message = '<no message>'
6633
self.outf.write('%3d: %s\n' % (shelf_id, message))
6637
class cmd_unshelve(Command):
6638
__doc__ = """Restore shelved changes.
6640
By default, the most recently shelved changes are restored. However if you
6641
specify a shelf by id those changes will be restored instead. This works
6642
best when the changes don't depend on each other.
6645
takes_args = ['shelf_id?']
6648
RegistryOption.from_kwargs(
6649
'action', help="The action to perform.",
6650
enum_switch=False, value_switches=True,
6651
apply="Apply changes and remove from the shelf.",
6652
dry_run="Show changes, but do not apply or remove them.",
6653
preview="Instead of unshelving the changes, show the diff that "
6654
"would result from unshelving.",
6655
delete_only="Delete changes without applying them.",
6656
keep="Apply changes but don't delete them.",
6659
_see_also = ['shelve']
6661
def run(self, shelf_id=None, action='apply', directory=u'.'):
6662
from .shelf_ui import Unshelver
6663
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6667
unshelver.tree.unlock()
6670
class cmd_clean_tree(Command):
6671
__doc__ = """Remove unwanted files from working tree.
6673
By default, only unknown files, not ignored files, are deleted. Versioned
6674
files are never deleted.
6676
Another class is 'detritus', which includes files emitted by brz during
6677
normal operations and selftests. (The value of these files decreases with
6680
If no options are specified, unknown files are deleted. Otherwise, option
6681
flags are respected, and may be combined.
6683
To check what clean-tree will do, use --dry-run.
6685
takes_options = ['directory',
6686
Option('ignored', help='Delete all ignored files.'),
6687
Option('detritus', help='Delete conflict files, merge and revert'
6688
' backups, and failed selftest dirs.'),
6690
help='Delete files unknown to brz (default).'),
6691
Option('dry-run', help='Show files to delete instead of'
6693
Option('force', help='Do not prompt before deleting.')]
6695
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6696
force=False, directory=u'.'):
6697
from .clean_tree import clean_tree
6698
if not (unknown or ignored or detritus):
6702
clean_tree(directory, unknown=unknown, ignored=ignored,
6703
detritus=detritus, dry_run=dry_run, no_prompt=force)
6706
class cmd_reference(Command):
6707
__doc__ = """list, view and set branch locations for nested trees.
6709
If no arguments are provided, lists the branch locations for nested trees.
6710
If one argument is provided, display the branch location for that tree.
6711
If two arguments are provided, set the branch location for that tree.
6716
takes_args = ['path?', 'location?']
6718
Option('force-unversioned',
6719
help='Set reference even if path is not versioned.'),
6722
def run(self, path=None, location=None, force_unversioned=False):
6724
if path is not None:
6726
tree, branch, relpath = (
6727
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6728
if path is not None:
6731
tree = branch.basis_tree()
6733
info = viewitems(branch._get_all_reference_info())
6734
self._display_reference_info(tree, branch, info)
6736
if not tree.is_versioned(path) and not force_unversioned:
6737
raise errors.NotVersionedError(path)
6738
if location is None:
6739
info = [(path, branch.get_reference_info(path))]
6740
self._display_reference_info(tree, branch, info)
6742
branch.set_reference_info(
6743
path, location, file_id=tree.path2id(path))
6745
def _display_reference_info(self, tree, branch, info):
6747
for path, (location, file_id) in info:
6748
ref_list.append((path, location))
6749
for path, location in sorted(ref_list):
6750
self.outf.write('%s %s\n' % (path, location))
6753
class cmd_export_pot(Command):
6754
__doc__ = """Export command helps and error messages in po format."""
6757
takes_options = [Option('plugin',
6758
help='Export help text from named command '
6759
'(defaults to all built in commands).',
6761
Option('include-duplicates',
6762
help='Output multiple copies of the same msgid '
6763
'string if it appears more than once.'),
6766
def run(self, plugin=None, include_duplicates=False):
6767
from .export_pot import export_pot
6768
export_pot(self.outf, plugin, include_duplicates)
6771
class cmd_import(Command):
6772
__doc__ = """Import sources from a directory, tarball or zip file
6774
This command will import a directory, tarball or zip file into a bzr
6775
tree, replacing any versioned files already present. If a directory is
6776
specified, it is used as the target. If the directory does not exist, or
6777
is not versioned, it is created.
6779
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6781
If the tarball or zip has a single root directory, that directory is
6782
stripped when extracting the tarball. This is not done for directories.
6785
takes_args = ['source', 'tree?']
6787
def run(self, source, tree=None):
6788
from .upstream_import import do_import
6789
do_import(source, tree)
6792
class cmd_link_tree(Command):
6793
__doc__ = """Hardlink matching files to another tree.
6795
Only files with identical content and execute bit will be linked.
6798
takes_args = ['location']
6800
def run(self, location):
6801
from .transform import link_tree
6802
target_tree = WorkingTree.open_containing(".")[0]
6803
source_tree = WorkingTree.open(location)
6804
with target_tree.lock_write(), source_tree.lock_read():
6805
link_tree(target_tree, source_tree)
6808
class cmd_fetch_ghosts(Command):
6809
__doc__ = """Attempt to retrieve ghosts from another branch.
6811
If the other branch is not supplied, the last-pulled branch is used.
6815
aliases = ['fetch-missing']
6816
takes_args = ['branch?']
6817
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6819
def run(self, branch=None, no_fix=False):
6820
from .fetch_ghosts import GhostFetcher
6821
installed, failed = GhostFetcher.from_cmdline(branch).run()
6822
if len(installed) > 0:
6823
self.outf.write("Installed:\n")
6824
for rev in installed:
6825
self.outf.write(rev.decode('utf-8') + "\n")
6827
self.outf.write("Still missing:\n")
6829
self.outf.write(rev.decode('utf-8') + "\n")
6830
if not no_fix and len(installed) > 0:
6831
cmd_reconcile().run(".")
6834
class cmd_grep(Command):
6835
"""Print lines matching PATTERN for specified files and revisions.
6837
This command searches the specified files and revisions for a given
6838
pattern. The pattern is specified as a Python regular expressions[1].
6840
If the file name is not specified, the revisions starting with the
6841
current directory are searched recursively. If the revision number is
6842
not specified, the working copy is searched. To search the last committed
6843
revision, use the '-r -1' or '-r last:1' option.
6845
Unversioned files are not searched unless explicitly specified on the
6846
command line. Unversioned directores are not searched.
6848
When searching a pattern, the output is shown in the 'filepath:string'
6849
format. If a revision is explicitly searched, the output is shown as
6850
'filepath~N:string', where N is the revision number.
6852
--include and --exclude options can be used to search only (or exclude
6853
from search) files with base name matches the specified Unix style GLOB
6854
pattern. The GLOB pattern an use *, ?, and [...] as wildcards, and \\
6855
to quote wildcard or backslash character literally. Note that the glob
6856
pattern is not a regular expression.
6858
[1] http://docs.python.org/library/re.html#regular-expression-syntax
6861
encoding_type = 'replace'
6862
takes_args = ['pattern', 'path*']
6866
Option('color', type=text_type, argname='when',
6867
help='Show match in color. WHEN is never, always or auto.'),
6868
Option('diff', short_name='p',
6869
help='Grep for pattern in changeset for each revision.'),
6870
ListOption('exclude', type=text_type, argname='glob', short_name='X',
6871
help="Skip files whose base name matches GLOB."),
6872
ListOption('include', type=text_type, argname='glob', short_name='I',
6873
help="Search only files whose base name matches GLOB."),
6874
Option('files-with-matches', short_name='l',
6875
help='Print only the name of each input file in '
6876
'which PATTERN is found.'),
6877
Option('files-without-match', short_name='L',
6878
help='Print only the name of each input file in '
6879
'which PATTERN is not found.'),
6880
Option('fixed-string', short_name='F',
6881
help='Interpret PATTERN is a single fixed string (not regex).'),
6883
help='Search for pattern starting from the root of the branch. '
6884
'(implies --recursive)'),
6885
Option('ignore-case', short_name='i',
6886
help='Ignore case distinctions while matching.'),
6888
help='Number of levels to display - 0 for all, 1 for collapsed '
6891
type=_parse_levels),
6892
Option('line-number', short_name='n',
6893
help='Show 1-based line number.'),
6894
Option('no-recursive',
6895
help="Don't recurse into subdirectories. (default is --recursive)"),
6896
Option('null', short_name='Z',
6897
help='Write an ASCII NUL (\\0) separator '
6898
'between output lines rather than a newline.'),
6902
def run(self, verbose=False, ignore_case=False, no_recursive=False,
6903
from_root=False, null=False, levels=None, line_number=False,
6904
path_list=None, revision=None, pattern=None, include=None,
6905
exclude=None, fixed_string=False, files_with_matches=False,
6906
files_without_match=False, color=None, diff=False):
6907
from breezy import _termcolor
6910
if path_list is None:
6914
raise errors.BzrCommandError(
6915
'cannot specify both --from-root and PATH.')
6917
if files_with_matches and files_without_match:
6918
raise errors.BzrCommandError(
6919
'cannot specify both '
6920
'-l/--files-with-matches and -L/--files-without-matches.')
6922
global_config = _mod_config.GlobalConfig()
6925
color = global_config.get_user_option('grep_color')
6930
if color not in ['always', 'never', 'auto']:
6931
raise errors.BzrCommandError('Valid values for --color are '
6932
'"always", "never" or "auto".')
6938
if revision is not None or levels == 0:
6939
# print revision numbers as we may be showing multiple revisions
6946
if not ignore_case and grep.is_fixed_string(pattern):
6947
# if the pattern isalnum, implicitly use to -F for faster grep
6949
elif ignore_case and fixed_string:
6950
# GZ 2010-06-02: Fall back to regexp rather than lowercasing
6951
# pattern and text which will cause pain later
6952
fixed_string = False
6953
pattern = re.escape(pattern)
6956
re_flags = re.MULTILINE
6958
re_flags |= re.IGNORECASE
6960
if not fixed_string:
6961
patternc = grep.compile_pattern(
6962
pattern.encode(grep._user_encoding), re_flags)
6964
if color == 'always':
6966
elif color == 'never':
6968
elif color == 'auto':
6969
show_color = _termcolor.allow_color()
6971
opts = grep.GrepOptions()
6973
opts.verbose = verbose
6974
opts.ignore_case = ignore_case
6975
opts.no_recursive = no_recursive
6976
opts.from_root = from_root
6978
opts.levels = levels
6979
opts.line_number = line_number
6980
opts.path_list = path_list
6981
opts.revision = revision
6982
opts.pattern = pattern
6983
opts.include = include
6984
opts.exclude = exclude
6985
opts.fixed_string = fixed_string
6986
opts.files_with_matches = files_with_matches
6987
opts.files_without_match = files_without_match
6991
opts.eol_marker = eol_marker
6992
opts.print_revno = print_revno
6993
opts.patternc = patternc
6994
opts.recursive = not no_recursive
6995
opts.fixed_string = fixed_string
6996
opts.outf = self.outf
6997
opts.show_color = show_color
7001
# files_with_matches, files_without_match
7002
# levels(?), line_number, from_root
7004
# These are silently ignored.
7005
grep.grep_diff(opts)
7006
elif revision is None:
7007
grep.workingtree_grep(opts)
7009
grep.versioned_grep(opts)
7012
class cmd_patch(Command):
7013
"""Apply a named patch to the current tree.
7017
takes_args = ['filename?']
7018
takes_options = [Option('strip', type=int, short_name='p',
7019
help=("Strip the smallest prefix containing num "
7020
"leading slashes from filenames.")),
7021
Option('silent', help='Suppress chatter.')]
7023
def run(self, filename=None, strip=None, silent=False):
7024
from .patch import patch_tree
7025
wt = WorkingTree.open_containing('.')[0]
7029
if filename is None:
7030
my_file = getattr(sys.stdin, 'buffer', sys.stdin)
7032
my_file = open(filename, 'rb')
7033
patches = [my_file.read()]
7034
return patch_tree(wt, patches, strip, quiet=is_quiet(), out=self.outf)
7037
class cmd_resolve_location(Command):
7038
__doc__ = """Expand a location to a full URL.
7041
Look up a Launchpad URL.
7043
brz resolve-location lp:brz
7045
takes_args = ['location']
7048
def run(self, location):
7049
from .location import location_to_url
7050
url = location_to_url(location)
7051
display_url = urlutils.unescape_for_display(url, self.outf.encoding)
7052
self.outf.write('%s\n' % display_url)
7055
def _register_lazy_builtins():
7056
# register lazy builtins from other modules; called at startup and should
7057
# be only called once.
7058
for (name, aliases, module_name) in [
7059
('cmd_bisect', [], 'breezy.bisect'),
7060
('cmd_bundle_info', [], 'breezy.bzr.bundle.commands'),
7061
('cmd_config', [], 'breezy.config'),
7062
('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
7063
('cmd_file_id', [], 'breezy.bzr.debug_commands'),
7064
('cmd_file_path', [], 'breezy.bzr.debug_commands'),
7065
('cmd_version_info', [], 'breezy.cmd_version_info'),
7066
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
7067
('cmd_conflicts', [], 'breezy.conflicts'),
7068
('cmd_ping', [], 'breezy.bzr.smart.ping'),
7069
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
7070
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
7071
('cmd_test_script', [], 'breezy.cmd_test_script'),
7073
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
