1
# Copyright (C) 2005-2012 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin brz commands"""
19
from __future__ import absolute_import
28
from . import lazy_import
29
lazy_import.lazy_import(globals(), """
34
branch as _mod_branch,
41
config as _mod_config,
53
revision as _mod_revision,
61
from breezy.branch import Branch
62
from breezy.conflicts import ConflictList
63
from breezy.transport import memory
64
from breezy.smtp_connection import SMTPConnection
65
from breezy.workingtree import WorkingTree
66
from breezy.i18n import gettext, ngettext
69
from .commands import (
71
builtin_command_registry,
81
from .revisionspec import (
91
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
94
def _get_branch_location(control_dir, possible_transports=None):
95
"""Return location of branch for this control dir."""
97
target = control_dir.get_branch_reference()
98
except errors.NotBranchError:
99
return control_dir.root_transport.base
100
if target is not None:
102
this_branch = control_dir.open_branch(
103
possible_transports=possible_transports)
104
# This may be a heavy checkout, where we want the master branch
105
master_location = this_branch.get_bound_location()
106
if master_location is not None:
107
return master_location
108
# If not, use a local sibling
109
return this_branch.base
112
def _is_colocated(control_dir, possible_transports=None):
113
"""Check if the branch in control_dir is colocated.
115
:param control_dir: Control directory
116
:return: Tuple with boolean indicating whether the branch is colocated
117
and the full URL to the actual branch
119
# This path is meant to be relative to the existing branch
120
this_url = _get_branch_location(
121
control_dir, possible_transports=possible_transports)
122
# Perhaps the target control dir supports colocated branches?
124
root = controldir.ControlDir.open(
125
this_url, possible_transports=possible_transports)
126
except errors.NotBranchError:
127
return (False, this_url)
130
control_dir.open_workingtree()
131
except (errors.NoWorkingTree, errors.NotLocalUrl):
132
return (False, this_url)
135
root._format.colocated_branches and
136
control_dir.control_url == root.control_url,
140
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
141
"""Lookup the location for a new sibling branch.
143
:param control_dir: Control directory to find sibling branches from
144
:param location: Name of the new branch
145
:return: Full location to the new branch
147
location = directory_service.directories.dereference(location)
148
if '/' not in location and '\\' not in location:
149
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
152
return urlutils.join_segment_parameters(
153
this_url, {"branch": urlutils.escape(location)})
155
return urlutils.join(this_url, '..', urlutils.escape(location))
159
def open_sibling_branch(control_dir, location, possible_transports=None):
160
"""Open a branch, possibly a sibling of another.
162
:param control_dir: Control directory relative to which to lookup the
164
:param location: Location to look up
165
:return: branch to open
168
# Perhaps it's a colocated branch?
169
return control_dir.open_branch(
170
location, possible_transports=possible_transports)
171
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
172
this_url = _get_branch_location(control_dir)
175
this_url, '..', urlutils.escape(location)))
178
def open_nearby_branch(near=None, location=None, possible_transports=None):
179
"""Open a nearby branch.
181
:param near: Optional location of container from which to open branch
182
:param location: Location of the branch
183
:return: Branch instance
190
location, possible_transports=possible_transports)
191
except errors.NotBranchError:
193
cdir = controldir.ControlDir.open(
194
near, possible_transports=possible_transports)
195
return open_sibling_branch(
196
cdir, location, possible_transports=possible_transports)
199
def iter_sibling_branches(control_dir, possible_transports=None):
200
"""Iterate over the siblings of a branch.
202
:param control_dir: Control directory for which to look up the siblings
203
:return: Iterator over tuples with branch name and branch object
206
reference = control_dir.get_branch_reference()
207
except errors.NotBranchError:
208
# There is no active branch, just return the colocated branches.
209
for name, branch in viewitems(control_dir.get_branches()):
212
if reference is not None:
213
ref_branch = Branch.open(
214
reference, possible_transports=possible_transports)
217
if ref_branch is None or ref_branch.name:
218
if ref_branch is not None:
219
control_dir = ref_branch.controldir
220
for name, branch in viewitems(control_dir.get_branches()):
223
repo = ref_branch.controldir.find_repository()
224
for branch in repo.find_branches(using=True):
225
name = urlutils.relative_url(
226
repo.user_url, branch.user_url).rstrip("/")
230
def tree_files_for_add(file_list):
232
Return a tree and list of absolute paths from a file list.
234
Similar to tree_files, but add handles files a bit differently, so it a
235
custom implementation. In particular, MutableTreeTree.smart_add expects
236
absolute paths, which it immediately converts to relative paths.
238
# FIXME Would be nice to just return the relative paths like
239
# internal_tree_files does, but there are a large number of unit tests
240
# that assume the current interface to mutabletree.smart_add
242
tree, relpath = WorkingTree.open_containing(file_list[0])
243
if tree.supports_views():
244
view_files = tree.views.lookup_view()
246
for filename in file_list:
247
if not osutils.is_inside_any(view_files, filename):
248
raise views.FileOutsideView(filename, view_files)
249
file_list = file_list[:]
250
file_list[0] = tree.abspath(relpath)
252
tree = WorkingTree.open_containing(u'.')[0]
253
if tree.supports_views():
254
view_files = tree.views.lookup_view()
256
file_list = view_files
257
view_str = views.view_display_str(view_files)
258
note(gettext("Ignoring files outside view. View is %s"),
260
return tree, file_list
263
def _get_one_revision(command_name, revisions):
264
if revisions is None:
266
if len(revisions) != 1:
267
raise errors.BzrCommandError(gettext(
268
'brz %s --revision takes exactly one revision identifier') % (
273
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
274
"""Get a revision tree. Not suitable for commands that change the tree.
276
Specifically, the basis tree in dirstate trees is coupled to the dirstate
277
and doing a commit/uncommit/pull will at best fail due to changing the
280
If tree is passed in, it should be already locked, for lifetime management
281
of the trees internal cached state.
285
if revisions is None:
287
rev_tree = tree.basis_tree()
289
rev_tree = branch.basis_tree()
291
revision = _get_one_revision(command_name, revisions)
292
rev_tree = revision.as_tree(branch)
296
def _get_view_info_for_change_reporter(tree):
297
"""Get the view information from a tree for change reporting."""
300
current_view = tree.views.get_view_info()[0]
301
if current_view is not None:
302
view_info = (current_view, tree.views.lookup_view())
303
except views.ViewsNotSupported:
308
def _open_directory_or_containing_tree_or_branch(filename, directory):
309
"""Open the tree or branch containing the specified file, unless
310
the --directory option is used to specify a different branch."""
311
if directory is not None:
312
return (None, Branch.open(directory), filename)
313
return controldir.ControlDir.open_containing_tree_or_branch(filename)
316
# TODO: Make sure no commands unconditionally use the working directory as a
317
# branch. If a filename argument is used, the first of them should be used to
318
# specify the branch. (Perhaps this can be factored out into some kind of
319
# Argument class, representing a file in a branch, where the first occurrence
322
class cmd_status(Command):
323
__doc__ = """Display status summary.
325
This reports on versioned and unknown files, reporting them
326
grouped by state. Possible states are:
329
Versioned in the working copy but not in the previous revision.
332
Versioned in the previous revision but removed or deleted
336
Path of this file changed from the previous revision;
337
the text may also have changed. This includes files whose
338
parent directory was renamed.
341
Text has changed since the previous revision.
344
File kind has been changed (e.g. from file to directory).
347
Not versioned and not matching an ignore pattern.
349
Additionally for directories, symlinks and files with a changed
350
executable bit, Bazaar indicates their type using a trailing
351
character: '/', '@' or '*' respectively. These decorations can be
352
disabled using the '--no-classify' option.
354
To see ignored files use 'brz ignored'. For details on the
355
changes to file texts, use 'brz diff'.
357
Note that --short or -S gives status flags for each item, similar
358
to Subversion's status command. To get output similar to svn -q,
361
If no arguments are specified, the status of the entire working
362
directory is shown. Otherwise, only the status of the specified
363
files or directories is reported. If a directory is given, status
364
is reported for everything inside that directory.
366
Before merges are committed, the pending merge tip revisions are
367
shown. To see all pending merge revisions, use the -v option.
368
To skip the display of pending merge information altogether, use
369
the no-pending option or specify a file/directory.
371
To compare the working directory to a specific revision, pass a
372
single revision to the revision argument.
374
To see which files have changed in a specific revision, or between
375
two revisions, pass a revision range to the revision argument.
376
This will produce the same results as calling 'brz diff --summarize'.
379
# TODO: --no-recurse/-N, --recurse options
381
takes_args = ['file*']
382
takes_options = ['show-ids', 'revision', 'change', 'verbose',
383
Option('short', help='Use short status indicators.',
385
Option('versioned', help='Only show versioned files.',
387
Option('no-pending', help='Don\'t show pending merges.'),
388
Option('no-classify',
389
help='Do not mark object type using indicator.'),
391
aliases = ['st', 'stat']
393
encoding_type = 'replace'
394
_see_also = ['diff', 'revert', 'status-flags']
397
def run(self, show_ids=False, file_list=None, revision=None, short=False,
398
versioned=False, no_pending=False, verbose=False,
400
from .status import show_tree_status
402
if revision and len(revision) > 2:
403
raise errors.BzrCommandError(
404
gettext('brz status --revision takes exactly'
405
' one or two revision specifiers'))
407
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
408
# Avoid asking for specific files when that is not needed.
409
if relfile_list == ['']:
411
# Don't disable pending merges for full trees other than '.'.
412
if file_list == ['.']:
414
# A specific path within a tree was given.
415
elif relfile_list is not None:
417
show_tree_status(tree, show_ids=show_ids,
418
specific_files=relfile_list, revision=revision,
419
to_file=self.outf, short=short, versioned=versioned,
420
show_pending=(not no_pending), verbose=verbose,
421
classify=not no_classify)
424
class cmd_cat_revision(Command):
425
__doc__ = """Write out metadata for a revision.
427
The revision to print can either be specified by a specific
428
revision identifier, or you can use --revision.
432
takes_args = ['revision_id?']
433
takes_options = ['directory', 'revision']
434
# cat-revision is more for frontends so should be exact
437
def print_revision(self, revisions, revid):
438
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
439
record = next(stream)
440
if record.storage_kind == 'absent':
441
raise errors.NoSuchRevision(revisions, revid)
442
revtext = record.get_bytes_as('fulltext')
443
self.outf.write(revtext.decode('utf-8'))
446
def run(self, revision_id=None, revision=None, directory=u'.'):
447
if revision_id is not None and revision is not None:
448
raise errors.BzrCommandError(gettext('You can only supply one of'
449
' revision_id or --revision'))
450
if revision_id is None and revision is None:
451
raise errors.BzrCommandError(
452
gettext('You must supply either --revision or a revision_id'))
454
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
456
revisions = b.repository.revisions
457
if revisions is None:
458
raise errors.BzrCommandError(
459
gettext('Repository %r does not support '
460
'access to raw revision texts'))
462
with b.repository.lock_read():
463
# TODO: jam 20060112 should cat-revision always output utf-8?
464
if revision_id is not None:
465
revision_id = cache_utf8.encode(revision_id)
467
self.print_revision(revisions, revision_id)
468
except errors.NoSuchRevision:
470
"The repository {0} contains no revision {1}.").format(
471
b.repository.base, revision_id.decode('utf-8'))
472
raise errors.BzrCommandError(msg)
473
elif revision is not None:
476
raise errors.BzrCommandError(
477
gettext('You cannot specify a NULL revision.'))
478
rev_id = rev.as_revision_id(b)
479
self.print_revision(revisions, rev_id)
482
class cmd_remove_tree(Command):
483
__doc__ = """Remove the working tree from a given branch/checkout.
485
Since a lightweight checkout is little more than a working tree
486
this will refuse to run against one.
488
To re-create the working tree, use "brz checkout".
490
_see_also = ['checkout', 'working-trees']
491
takes_args = ['location*']
494
help='Remove the working tree even if it has '
495
'uncommitted or shelved changes.'),
498
def run(self, location_list, force=False):
499
if not location_list:
500
location_list = ['.']
502
for location in location_list:
503
d = controldir.ControlDir.open(location)
506
working = d.open_workingtree()
507
except errors.NoWorkingTree:
508
raise errors.BzrCommandError(
509
gettext("No working tree to remove"))
510
except errors.NotLocalUrl:
511
raise errors.BzrCommandError(
512
gettext("You cannot remove the working tree"
513
" of a remote path"))
515
if (working.has_changes()):
516
raise errors.UncommittedChanges(working)
517
if working.get_shelf_manager().last_shelf() is not None:
518
raise errors.ShelvedChanges(working)
520
if working.user_url != working.branch.user_url:
521
raise errors.BzrCommandError(
522
gettext("You cannot remove the working tree"
523
" from a lightweight checkout"))
525
d.destroy_workingtree()
528
class cmd_repair_workingtree(Command):
529
__doc__ = """Reset the working tree state file.
531
This is not meant to be used normally, but more as a way to recover from
532
filesystem corruption, etc. This rebuilds the working inventory back to a
533
'known good' state. Any new modifications (adding a file, renaming, etc)
534
will be lost, though modified files will still be detected as such.
536
Most users will want something more like "brz revert" or "brz update"
537
unless the state file has become corrupted.
539
By default this attempts to recover the current state by looking at the
540
headers of the state file. If the state file is too corrupted to even do
541
that, you can supply --revision to force the state of the tree.
545
'revision', 'directory',
547
help='Reset the tree even if it doesn\'t appear to be'
552
def run(self, revision=None, directory='.', force=False):
553
tree, _ = WorkingTree.open_containing(directory)
554
self.add_cleanup(tree.lock_tree_write().unlock)
558
except errors.BzrError:
559
pass # There seems to be a real error here, so we'll reset
562
raise errors.BzrCommandError(gettext(
563
'The tree does not appear to be corrupt. You probably'
564
' want "brz revert" instead. Use "--force" if you are'
565
' sure you want to reset the working tree.'))
569
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
571
tree.reset_state(revision_ids)
572
except errors.BzrError:
573
if revision_ids is None:
574
extra = gettext(', the header appears corrupt, try passing '
575
'-r -1 to set the state to the last commit')
578
raise errors.BzrCommandError(
579
gettext('failed to reset the tree state{0}').format(extra))
582
class cmd_revno(Command):
583
__doc__ = """Show current revision number.
585
This is equal to the number of revisions on this branch.
589
takes_args = ['location?']
591
Option('tree', help='Show revno of working tree.'),
596
def run(self, tree=False, location=u'.', revision=None):
597
if revision is not None and tree:
598
raise errors.BzrCommandError(
599
gettext("--tree and --revision can not be used together"))
603
wt = WorkingTree.open_containing(location)[0]
604
self.add_cleanup(wt.lock_read().unlock)
605
except (errors.NoWorkingTree, errors.NotLocalUrl):
606
raise errors.NoWorkingTree(location)
608
revid = wt.last_revision()
610
b = Branch.open_containing(location)[0]
611
self.add_cleanup(b.lock_read().unlock)
613
if len(revision) != 1:
614
raise errors.BzrCommandError(gettext(
615
"Revision numbers only make sense for single "
616
"revisions, not ranges"))
617
revid = revision[0].as_revision_id(b)
619
revid = b.last_revision()
621
revno_t = b.revision_id_to_dotted_revno(revid)
622
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
624
revno = ".".join(str(n) for n in revno_t)
626
self.outf.write(revno + '\n')
629
class cmd_revision_info(Command):
630
__doc__ = """Show revision number and revision id for a given revision identifier.
633
takes_args = ['revision_info*']
636
custom_help('directory', help='Branch to examine, '
637
'rather than the one containing the working directory.'),
638
Option('tree', help='Show revno of working tree.'),
642
def run(self, revision=None, directory=u'.', tree=False,
643
revision_info_list=[]):
646
wt = WorkingTree.open_containing(directory)[0]
648
self.add_cleanup(wt.lock_read().unlock)
649
except (errors.NoWorkingTree, errors.NotLocalUrl):
651
b = Branch.open_containing(directory)[0]
652
self.add_cleanup(b.lock_read().unlock)
654
if revision is not None:
655
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
656
if revision_info_list is not None:
657
for rev_str in revision_info_list:
658
rev_spec = RevisionSpec.from_string(rev_str)
659
revision_ids.append(rev_spec.as_revision_id(b))
660
# No arguments supplied, default to the last revision
661
if len(revision_ids) == 0:
664
raise errors.NoWorkingTree(directory)
665
revision_ids.append(wt.last_revision())
667
revision_ids.append(b.last_revision())
671
for revision_id in revision_ids:
673
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
674
revno = '.'.join(str(i) for i in dotted_revno)
675
except errors.NoSuchRevision:
677
maxlen = max(maxlen, len(revno))
678
revinfos.append((revno, revision_id))
681
for revno, revid in revinfos:
683
'%*s %s\n' % (maxlen, revno, revid.decode('utf-8')))
686
class cmd_add(Command):
687
__doc__ = """Add specified files or directories.
689
In non-recursive mode, all the named items are added, regardless
690
of whether they were previously ignored. A warning is given if
691
any of the named files are already versioned.
693
In recursive mode (the default), files are treated the same way
694
but the behaviour for directories is different. Directories that
695
are already versioned do not give a warning. All directories,
696
whether already versioned or not, are searched for files or
697
subdirectories that are neither versioned or ignored, and these
698
are added. This search proceeds recursively into versioned
699
directories. If no names are given '.' is assumed.
701
A warning will be printed when nested trees are encountered,
702
unless they are explicitly ignored.
704
Therefore simply saying 'brz add' will version all files that
705
are currently unknown.
707
Adding a file whose parent directory is not versioned will
708
implicitly add the parent, and so on up to the root. This means
709
you should never need to explicitly add a directory, they'll just
710
get added when you add a file in the directory.
712
--dry-run will show which files would be added, but not actually
715
--file-ids-from will try to use the file ids from the supplied path.
716
It looks up ids trying to find a matching parent directory with the
717
same filename, and then by pure path. This option is rarely needed
718
but can be useful when adding the same logical file into two
719
branches that will be merged later (without showing the two different
720
adds as a conflict). It is also useful when merging another project
721
into a subdirectory of this one.
723
Any files matching patterns in the ignore list will not be added
724
unless they are explicitly mentioned.
726
In recursive mode, files larger than the configuration option
727
add.maximum_file_size will be skipped. Named items are never skipped due
730
takes_args = ['file*']
733
help="Don't recursively add the contents of directories.",
736
help="Show what would be done, but don't actually do "
739
Option('file-ids-from',
741
help='Lookup file ids from this tree.'),
743
encoding_type = 'replace'
744
_see_also = ['remove', 'ignore']
746
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
751
if file_ids_from is not None:
753
base_tree, base_path = WorkingTree.open_containing(
755
except errors.NoWorkingTree:
756
base_branch, base_path = Branch.open_containing(
758
base_tree = base_branch.basis_tree()
760
action = breezy.add.AddFromBaseAction(
761
base_tree, base_path, to_file=self.outf,
762
should_print=(not is_quiet()))
764
action = breezy.add.AddWithSkipLargeAction(
765
to_file=self.outf, should_print=(not is_quiet()))
768
self.add_cleanup(base_tree.lock_read().unlock)
769
tree, file_list = tree_files_for_add(file_list)
770
added, ignored = tree.smart_add(
771
file_list, not no_recurse, action=action, save=not dry_run)
775
for glob in sorted(ignored):
776
for path in ignored[glob]:
778
gettext("ignored {0} matching \"{1}\"\n").format(
782
class cmd_mkdir(Command):
783
__doc__ = """Create a new versioned directory.
785
This is equivalent to creating the directory and then adding it.
788
takes_args = ['dir+']
792
help='No error if existing, make parent directories as needed.',
796
encoding_type = 'replace'
799
def add_file_with_parents(cls, wt, relpath):
800
if wt.is_versioned(relpath):
802
cls.add_file_with_parents(wt, osutils.dirname(relpath))
806
def add_file_single(cls, wt, relpath):
809
def run(self, dir_list, parents=False):
811
add_file = self.add_file_with_parents
813
add_file = self.add_file_single
815
wt, relpath = WorkingTree.open_containing(dir)
820
if e.errno != errno.EEXIST:
824
add_file(wt, relpath)
826
self.outf.write(gettext('added %s\n') % dir)
829
class cmd_relpath(Command):
830
__doc__ = """Show path of a file relative to root"""
832
takes_args = ['filename']
836
def run(self, filename):
837
# TODO: jam 20050106 Can relpath return a munged path if
838
# sys.stdout encoding cannot represent it?
839
tree, relpath = WorkingTree.open_containing(filename)
840
self.outf.write(relpath)
841
self.outf.write('\n')
844
class cmd_inventory(Command):
845
__doc__ = """Show inventory of the current working copy or a revision.
847
It is possible to limit the output to a particular entry
848
type using the --kind option. For example: --kind file.
850
It is also possible to restrict the list of files to a specific
851
set. For example: brz inventory --show-ids this/file
860
help='List entries of a particular kind: file, directory, '
864
takes_args = ['file*']
867
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
868
if kind and kind not in ['file', 'directory', 'symlink']:
869
raise errors.BzrCommandError(
870
gettext('invalid kind %r specified') % (kind,))
872
revision = _get_one_revision('inventory', revision)
873
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
874
self.add_cleanup(work_tree.lock_read().unlock)
875
if revision is not None:
876
tree = revision.as_tree(work_tree.branch)
878
extra_trees = [work_tree]
879
self.add_cleanup(tree.lock_read().unlock)
884
self.add_cleanup(tree.lock_read().unlock)
885
if file_list is not None:
886
paths = tree.find_related_paths_across_trees(
887
file_list, extra_trees, require_versioned=True)
888
# find_ids_across_trees may include some paths that don't
890
entries = tree.iter_entries_by_dir(specific_files=paths)
892
entries = tree.iter_entries_by_dir()
894
for path, entry in sorted(entries):
895
if kind and kind != entry.kind:
900
self.outf.write('%-50s %s\n' % (
901
path, entry.file_id.decode('utf-8')))
903
self.outf.write(path)
904
self.outf.write('\n')
907
class cmd_cp(Command):
908
__doc__ = """Copy a file.
911
brz cp OLDNAME NEWNAME
913
brz cp SOURCE... DESTINATION
915
If the last argument is a versioned directory, all the other names
916
are copied into it. Otherwise, there must be exactly two arguments
917
and the file is copied to a new name.
919
Files cannot be copied between branches. Only files can be copied
923
takes_args = ['names*']
926
encoding_type = 'replace'
928
def run(self, names_list):
929
if names_list is None:
931
if len(names_list) < 2:
932
raise errors.BzrCommandError(gettext("missing file argument"))
933
tree, rel_names = WorkingTree.open_containing_paths(
934
names_list, canonicalize=False)
935
for file_name in rel_names[0:-1]:
937
raise errors.BzrCommandError(
938
gettext("can not copy root of branch"))
939
self.add_cleanup(tree.lock_tree_write().unlock)
940
into_existing = osutils.isdir(names_list[-1])
941
if not into_existing:
943
(src, dst) = rel_names
945
raise errors.BzrCommandError(
946
gettext('to copy multiple files the'
947
' destination must be a versioned'
952
(n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
953
for n in rel_names[:-1]]
955
for src, dst in pairs:
957
src_kind = tree.stored_kind(src)
958
except errors.NoSuchFile:
959
raise errors.BzrCommandError(
960
gettext('Could not copy %s => %s: %s is not versioned.')
963
raise errors.BzrCommandError(
964
gettext('Could not copy %s => %s . %s is not versioned\\.'
966
if src_kind == 'directory':
967
raise errors.BzrCommandError(
968
gettext('Could not copy %s => %s . %s is a directory.'
970
dst_parent = osutils.split(dst)[0]
973
dst_parent_kind = tree.stored_kind(dst_parent)
974
except errors.NoSuchFile:
975
raise errors.BzrCommandError(
976
gettext('Could not copy %s => %s: %s is not versioned.')
977
% (src, dst, dst_parent))
978
if dst_parent_kind != 'directory':
979
raise errors.BzrCommandError(
980
gettext('Could not copy to %s: %s is not a directory.')
981
% (dst_parent, dst_parent))
983
tree.copy_one(src, dst)
986
class cmd_mv(Command):
987
__doc__ = """Move or rename a file.
990
brz mv OLDNAME NEWNAME
992
brz mv SOURCE... DESTINATION
994
If the last argument is a versioned directory, all the other names
995
are moved into it. Otherwise, there must be exactly two arguments
996
and the file is changed to a new name.
998
If OLDNAME does not exist on the filesystem but is versioned and
999
NEWNAME does exist on the filesystem but is not versioned, mv
1000
assumes that the file has been manually moved and only updates
1001
its internal inventory to reflect that change.
1002
The same is valid when moving many SOURCE files to a DESTINATION.
1004
Files cannot be moved between branches.
1007
takes_args = ['names*']
1008
takes_options = [Option("after", help="Move only the brz identifier"
1009
" of the file, because the file has already been moved."),
1010
Option('auto', help='Automatically guess renames.'),
1012
'dry-run', help='Avoid making changes when guessing renames.'),
1014
aliases = ['move', 'rename']
1015
encoding_type = 'replace'
1017
def run(self, names_list, after=False, auto=False, dry_run=False):
1019
return self.run_auto(names_list, after, dry_run)
1021
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1022
if names_list is None:
1024
if len(names_list) < 2:
1025
raise errors.BzrCommandError(gettext("missing file argument"))
1026
tree, rel_names = WorkingTree.open_containing_paths(
1027
names_list, canonicalize=False)
1028
for file_name in rel_names[0:-1]:
1030
raise errors.BzrCommandError(
1031
gettext("can not move root of branch"))
1032
self.add_cleanup(tree.lock_tree_write().unlock)
1033
self._run(tree, names_list, rel_names, after)
1035
def run_auto(self, names_list, after, dry_run):
1036
if names_list is not None and len(names_list) > 1:
1037
raise errors.BzrCommandError(
1038
gettext('Only one path may be specified to --auto.'))
1040
raise errors.BzrCommandError(
1041
gettext('--after cannot be specified with --auto.'))
1042
work_tree, file_list = WorkingTree.open_containing_paths(
1043
names_list, default_directory='.')
1044
self.add_cleanup(work_tree.lock_tree_write().unlock)
1045
rename_map.RenameMap.guess_renames(
1046
work_tree.basis_tree(), work_tree, dry_run)
1048
def _run(self, tree, names_list, rel_names, after):
1049
into_existing = osutils.isdir(names_list[-1])
1050
if into_existing and len(names_list) == 2:
1052
# a. case-insensitive filesystem and change case of dir
1053
# b. move directory after the fact (if the source used to be
1054
# a directory, but now doesn't exist in the working tree
1055
# and the target is an existing directory, just rename it)
1056
if (not tree.case_sensitive
1057
and rel_names[0].lower() == rel_names[1].lower()):
1058
into_existing = False
1060
# 'fix' the case of a potential 'from'
1061
from_path = tree.get_canonical_path(rel_names[0])
1062
if (not osutils.lexists(names_list[0]) and
1063
tree.is_versioned(from_path) and
1064
tree.stored_kind(from_path) == "directory"):
1065
into_existing = False
1068
# move into existing directory
1069
# All entries reference existing inventory items, so fix them up
1070
# for cicp file-systems.
1071
rel_names = list(tree.get_canonical_paths(rel_names))
1072
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1074
self.outf.write("%s => %s\n" % (src, dest))
1076
if len(names_list) != 2:
1077
raise errors.BzrCommandError(gettext('to mv multiple files the'
1078
' destination must be a versioned'
1081
# for cicp file-systems: the src references an existing inventory
1083
src = tree.get_canonical_path(rel_names[0])
1084
# Find the canonical version of the destination: In all cases, the
1085
# parent of the target must be in the inventory, so we fetch the
1086
# canonical version from there (we do not always *use* the
1087
# canonicalized tail portion - we may be attempting to rename the
1089
canon_dest = tree.get_canonical_path(rel_names[1])
1090
dest_parent = osutils.dirname(canon_dest)
1091
spec_tail = osutils.basename(rel_names[1])
1092
# For a CICP file-system, we need to avoid creating 2 inventory
1093
# entries that differ only by case. So regardless of the case
1094
# we *want* to use (ie, specified by the user or the file-system),
1095
# we must always choose to use the case of any existing inventory
1096
# items. The only exception to this is when we are attempting a
1097
# case-only rename (ie, canonical versions of src and dest are
1099
dest_id = tree.path2id(canon_dest)
1100
if dest_id is None or tree.path2id(src) == dest_id:
1101
# No existing item we care about, so work out what case we
1102
# are actually going to use.
1104
# If 'after' is specified, the tail must refer to a file on disk.
1106
dest_parent_fq = osutils.pathjoin(
1107
tree.basedir, dest_parent)
1109
# pathjoin with an empty tail adds a slash, which breaks
1111
dest_parent_fq = tree.basedir
1113
dest_tail = osutils.canonical_relpath(
1115
osutils.pathjoin(dest_parent_fq, spec_tail))
1117
# not 'after', so case as specified is used
1118
dest_tail = spec_tail
1120
# Use the existing item so 'mv' fails with AlreadyVersioned.
1121
dest_tail = os.path.basename(canon_dest)
1122
dest = osutils.pathjoin(dest_parent, dest_tail)
1123
mutter("attempting to move %s => %s", src, dest)
1124
tree.rename_one(src, dest, after=after)
1126
self.outf.write("%s => %s\n" % (src, dest))
1129
class cmd_pull(Command):
1130
__doc__ = """Turn this branch into a mirror of another branch.
1132
By default, this command only works on branches that have not diverged.
1133
Branches are considered diverged if the destination branch's most recent
1134
commit is one that has not been merged (directly or indirectly) into the
1137
If branches have diverged, you can use 'brz merge' to integrate the changes
1138
from one into the other. Once one branch has merged, the other should
1139
be able to pull it again.
1141
If you want to replace your local changes and just want your branch to
1142
match the remote one, use pull --overwrite. This will work even if the two
1143
branches have diverged.
1145
If there is no default location set, the first pull will set it (use
1146
--no-remember to avoid setting it). After that, you can omit the
1147
location to use the default. To change the default, use --remember. The
1148
value will only be saved if the remote location can be accessed.
1150
The --verbose option will display the revisions pulled using the log_format
1151
configuration option. You can use a different format by overriding it with
1152
-Olog_format=<other_format>.
1154
Note: The location can be specified either in the form of a branch,
1155
or in the form of a path to a file containing a merge directive generated
1159
_see_also = ['push', 'update', 'status-flags', 'send']
1160
takes_options = ['remember', 'overwrite', 'revision',
1161
custom_help('verbose',
1162
help='Show logs of pulled revisions.'),
1163
custom_help('directory',
1164
help='Branch to pull into, '
1165
'rather than the one containing the working directory.'),
1167
help="Perform a local pull in a bound "
1168
"branch. Local pulls are not applied to "
1169
"the master branch."
1172
help="Show base revision text in conflicts."),
1173
Option('overwrite-tags',
1174
help="Overwrite tags only."),
1176
takes_args = ['location?']
1177
encoding_type = 'replace'
1179
def run(self, location=None, remember=None, overwrite=False,
1180
revision=None, verbose=False,
1181
directory=None, local=False,
1182
show_base=False, overwrite_tags=False):
1185
overwrite = ["history", "tags"]
1186
elif overwrite_tags:
1187
overwrite = ["tags"]
1190
# FIXME: too much stuff is in the command class
1193
if directory is None:
1196
tree_to = WorkingTree.open_containing(directory)[0]
1197
branch_to = tree_to.branch
1198
self.add_cleanup(tree_to.lock_write().unlock)
1199
except errors.NoWorkingTree:
1201
branch_to = Branch.open_containing(directory)[0]
1202
self.add_cleanup(branch_to.lock_write().unlock)
1204
warning(gettext("No working tree, ignoring --show-base"))
1206
if local and not branch_to.get_bound_location():
1207
raise errors.LocalRequiresBoundBranch()
1209
possible_transports = []
1210
if location is not None:
1212
mergeable = bundle.read_mergeable_from_url(location,
1213
possible_transports=possible_transports)
1214
except errors.NotABundle:
1217
stored_loc = branch_to.get_parent()
1218
if location is None:
1219
if stored_loc is None:
1220
raise errors.BzrCommandError(gettext("No pull location known or"
1223
display_url = urlutils.unescape_for_display(stored_loc,
1227
gettext("Using saved parent location: %s\n") % display_url)
1228
location = stored_loc
1230
revision = _get_one_revision('pull', revision)
1231
if mergeable is not None:
1232
if revision is not None:
1233
raise errors.BzrCommandError(gettext(
1234
'Cannot use -r with merge directives or bundles'))
1235
mergeable.install_revisions(branch_to.repository)
1236
base_revision_id, revision_id, verified = \
1237
mergeable.get_merge_request(branch_to.repository)
1238
branch_from = branch_to
1240
branch_from = Branch.open(location,
1241
possible_transports=possible_transports)
1242
self.add_cleanup(branch_from.lock_read().unlock)
1243
# Remembers if asked explicitly or no previous location is set
1245
or (remember is None and branch_to.get_parent() is None)):
1246
# FIXME: This shouldn't be done before the pull
1247
# succeeds... -- vila 2012-01-02
1248
branch_to.set_parent(branch_from.base)
1250
if revision is not None:
1251
revision_id = revision.as_revision_id(branch_from)
1253
if tree_to is not None:
1254
view_info = _get_view_info_for_change_reporter(tree_to)
1255
change_reporter = delta._ChangeReporter(
1256
unversioned_filter=tree_to.is_ignored,
1257
view_info=view_info)
1258
result = tree_to.pull(
1259
branch_from, overwrite, revision_id, change_reporter,
1260
local=local, show_base=show_base)
1262
result = branch_to.pull(
1263
branch_from, overwrite, revision_id, local=local)
1265
result.report(self.outf)
1266
if verbose and result.old_revid != result.new_revid:
1267
log.show_branch_change(
1268
branch_to, self.outf, result.old_revno,
1270
if getattr(result, 'tag_conflicts', None):
1276
class cmd_push(Command):
1277
__doc__ = """Update a mirror of this branch.
1279
The target branch will not have its working tree populated because this
1280
is both expensive, and is not supported on remote file systems.
1282
Some smart servers or protocols *may* put the working tree in place in
1285
This command only works on branches that have not diverged. Branches are
1286
considered diverged if the destination branch's most recent commit is one
1287
that has not been merged (directly or indirectly) by the source branch.
1289
If branches have diverged, you can use 'brz push --overwrite' to replace
1290
the other branch completely, discarding its unmerged changes.
1292
If you want to ensure you have the different changes in the other branch,
1293
do a merge (see brz help merge) from the other branch, and commit that.
1294
After that you will be able to do a push without '--overwrite'.
1296
If there is no default push location set, the first push will set it (use
1297
--no-remember to avoid setting it). After that, you can omit the
1298
location to use the default. To change the default, use --remember. The
1299
value will only be saved if the remote location can be accessed.
1301
The --verbose option will display the revisions pushed using the log_format
1302
configuration option. You can use a different format by overriding it with
1303
-Olog_format=<other_format>.
1306
_see_also = ['pull', 'update', 'working-trees']
1307
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1308
Option('create-prefix',
1309
help='Create the path leading up to the branch '
1310
'if it does not already exist.'),
1311
custom_help('directory',
1312
help='Branch to push from, '
1313
'rather than the one containing the working directory.'),
1314
Option('use-existing-dir',
1315
help='By default push will fail if the target'
1316
' directory exists, but does not already'
1317
' have a control directory. This flag will'
1318
' allow push to proceed.'),
1320
help='Create a stacked branch that references the public location '
1321
'of the parent branch.'),
1322
Option('stacked-on',
1323
help='Create a stacked branch that refers to another branch '
1324
'for the commit history. Only the work not present in the '
1325
'referenced branch is included in the branch created.',
1328
help='Refuse to push if there are uncommitted changes in'
1329
' the working tree, --no-strict disables the check.'),
1331
help="Don't populate the working tree, even for protocols"
1332
" that support it."),
1333
Option('overwrite-tags',
1334
help="Overwrite tags only."),
1335
Option('lossy', help="Allow lossy push, i.e. dropping metadata "
1336
"that can't be represented in the target.")
1338
takes_args = ['location?']
1339
encoding_type = 'replace'
1341
def run(self, location=None, remember=None, overwrite=False,
1342
create_prefix=False, verbose=False, revision=None,
1343
use_existing_dir=False, directory=None, stacked_on=None,
1344
stacked=False, strict=None, no_tree=False,
1345
overwrite_tags=False, lossy=False):
1346
from .push import _show_push_branch
1349
overwrite = ["history", "tags"]
1350
elif overwrite_tags:
1351
overwrite = ["tags"]
1355
if directory is None:
1357
# Get the source branch
1359
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1360
# Get the tip's revision_id
1361
revision = _get_one_revision('push', revision)
1362
if revision is not None:
1363
revision_id = revision.in_history(br_from).rev_id
1366
if tree is not None and revision_id is None:
1367
tree.check_changed_or_out_of_date(
1368
strict, 'push_strict',
1369
more_error='Use --no-strict to force the push.',
1370
more_warning='Uncommitted changes will not be pushed.')
1371
# Get the stacked_on branch, if any
1372
if stacked_on is not None:
1373
stacked_on = urlutils.normalize_url(stacked_on)
1375
parent_url = br_from.get_parent()
1377
parent = Branch.open(parent_url)
1378
stacked_on = parent.get_public_branch()
1380
# I considered excluding non-http url's here, thus forcing
1381
# 'public' branches only, but that only works for some
1382
# users, so it's best to just depend on the user spotting an
1383
# error by the feedback given to them. RBC 20080227.
1384
stacked_on = parent_url
1386
raise errors.BzrCommandError(gettext(
1387
"Could not determine branch to refer to."))
1389
# Get the destination location
1390
if location is None:
1391
stored_loc = br_from.get_push_location()
1392
if stored_loc is None:
1393
parent_loc = br_from.get_parent()
1395
raise errors.BzrCommandError(gettext(
1396
"No push location known or specified. To push to the "
1397
"parent branch (at %s), use 'brz push :parent'." %
1398
urlutils.unescape_for_display(parent_loc,
1399
self.outf.encoding)))
1401
raise errors.BzrCommandError(gettext(
1402
"No push location known or specified."))
1404
display_url = urlutils.unescape_for_display(stored_loc,
1406
note(gettext("Using saved push location: %s") % display_url)
1407
location = stored_loc
1409
_show_push_branch(br_from, revision_id, location, self.outf,
1410
verbose=verbose, overwrite=overwrite, remember=remember,
1411
stacked_on=stacked_on, create_prefix=create_prefix,
1412
use_existing_dir=use_existing_dir, no_tree=no_tree,
1416
class cmd_branch(Command):
1417
__doc__ = """Create a new branch that is a copy of an existing branch.
1419
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1420
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1421
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1422
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1423
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1426
To retrieve the branch as of a particular revision, supply the --revision
1427
parameter, as in "branch foo/bar -r 5".
1430
_see_also = ['checkout']
1431
takes_args = ['from_location', 'to_location?']
1432
takes_options = ['revision',
1434
'hardlink', help='Hard-link working tree files where possible.'),
1435
Option('files-from', type=text_type,
1436
help="Get file contents from this tree."),
1438
help="Create a branch without a working-tree."),
1440
help="Switch the checkout in the current directory "
1441
"to the new branch."),
1443
help='Create a stacked branch referring to the source branch. '
1444
'The new branch will depend on the availability of the source '
1445
'branch for all operations.'),
1446
Option('standalone',
1447
help='Do not use a shared repository, even if available.'),
1448
Option('use-existing-dir',
1449
help='By default branch will fail if the target'
1450
' directory exists, but does not already'
1451
' have a control directory. This flag will'
1452
' allow branch to proceed.'),
1454
help="Bind new branch to from location."),
1457
def run(self, from_location, to_location=None, revision=None,
1458
hardlink=False, stacked=False, standalone=False, no_tree=False,
1459
use_existing_dir=False, switch=False, bind=False,
1461
from breezy import switch as _mod_switch
1462
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1464
if not (hardlink or files_from):
1465
# accelerator_tree is usually slower because you have to read N
1466
# files (no readahead, lots of seeks, etc), but allow the user to
1467
# explicitly request it
1468
accelerator_tree = None
1469
if files_from is not None and files_from != from_location:
1470
accelerator_tree = WorkingTree.open(files_from)
1471
revision = _get_one_revision('branch', revision)
1472
self.add_cleanup(br_from.lock_read().unlock)
1473
if revision is not None:
1474
revision_id = revision.as_revision_id(br_from)
1476
# FIXME - wt.last_revision, fallback to branch, fall back to
1477
# None or perhaps NULL_REVISION to mean copy nothing
1479
revision_id = br_from.last_revision()
1480
if to_location is None:
1481
to_location = urlutils.derive_to_location(from_location)
1482
to_transport = transport.get_transport(to_location)
1484
to_transport.mkdir('.')
1485
except errors.FileExists:
1487
to_dir = controldir.ControlDir.open_from_transport(
1489
except errors.NotBranchError:
1490
if not use_existing_dir:
1491
raise errors.BzrCommandError(gettext('Target directory "%s" '
1492
'already exists.') % to_location)
1497
to_dir.open_branch()
1498
except errors.NotBranchError:
1501
raise errors.AlreadyBranchError(to_location)
1502
except errors.NoSuchFile:
1503
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1509
# preserve whatever source format we have.
1510
to_dir = br_from.controldir.sprout(
1511
to_transport.base, revision_id,
1512
possible_transports=[to_transport],
1513
accelerator_tree=accelerator_tree, hardlink=hardlink,
1514
stacked=stacked, force_new_repo=standalone,
1515
create_tree_if_local=not no_tree, source_branch=br_from)
1516
branch = to_dir.open_branch(
1517
possible_transports=[
1518
br_from.controldir.root_transport, to_transport])
1519
except errors.NoSuchRevision:
1520
to_transport.delete_tree('.')
1521
msg = gettext("The branch {0} has no revision {1}.").format(
1522
from_location, revision)
1523
raise errors.BzrCommandError(msg)
1526
to_repo = to_dir.open_repository()
1527
except errors.NoRepositoryPresent:
1528
to_repo = to_dir.create_repository()
1529
to_repo.fetch(br_from.repository, revision_id=revision_id)
1530
branch = br_from.sprout(to_dir, revision_id=revision_id)
1531
br_from.tags.merge_to(branch.tags)
1533
# If the source branch is stacked, the new branch may
1534
# be stacked whether we asked for that explicitly or not.
1535
# We therefore need a try/except here and not just 'if stacked:'
1537
note(gettext('Created new stacked branch referring to %s.') %
1538
branch.get_stacked_on_url())
1539
except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
1540
errors.UnstackableRepositoryFormat) as e:
1541
revno = branch.revno()
1542
if revno is not None:
1543
note(ngettext('Branched %d revision.',
1544
'Branched %d revisions.',
1545
branch.revno()) % revno)
1547
note(gettext('Created new branch.'))
1549
# Bind to the parent
1550
parent_branch = Branch.open(from_location)
1551
branch.bind(parent_branch)
1552
note(gettext('New branch bound to %s') % from_location)
1554
# Switch to the new branch
1555
wt, _ = WorkingTree.open_containing('.')
1556
_mod_switch.switch(wt.controldir, branch)
1557
note(gettext('Switched to branch: %s'),
1558
urlutils.unescape_for_display(branch.base, 'utf-8'))
1561
class cmd_branches(Command):
1562
__doc__ = """List the branches available at the current location.
1564
This command will print the names of all the branches at the current
1568
takes_args = ['location?']
1570
Option('recursive', short_name='R',
1571
help='Recursively scan for branches rather than '
1572
'just looking in the specified location.')]
1574
def run(self, location=".", recursive=False):
1576
t = transport.get_transport(location)
1577
if not t.listable():
1578
raise errors.BzrCommandError(
1579
"Can't scan this type of location.")
1580
for b in controldir.ControlDir.find_branches(t):
1581
self.outf.write("%s\n" % urlutils.unescape_for_display(
1582
urlutils.relative_url(t.base, b.base),
1583
self.outf.encoding).rstrip("/"))
1585
dir = controldir.ControlDir.open_containing(location)[0]
1587
active_branch = dir.open_branch(name="")
1588
except errors.NotBranchError:
1589
active_branch = None
1591
for name, branch in iter_sibling_branches(dir):
1594
active = (active_branch is not None and
1595
active_branch.user_url == branch.user_url)
1596
names[name] = active
1597
# Only mention the current branch explicitly if it's not
1598
# one of the colocated branches
1599
if not any(viewvalues(names)) and active_branch is not None:
1600
self.outf.write("* %s\n" % gettext("(default)"))
1601
for name in sorted(names):
1602
active = names[name]
1607
self.outf.write("%s %s\n" % (
1608
prefix, (name if PY3 else name.encode(self.outf.encoding))))
1611
class cmd_checkout(Command):
1612
__doc__ = """Create a new checkout of an existing branch.
1614
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree
1615
for the branch found in '.'. This is useful if you have removed the working
1616
tree or if it was never created - i.e. if you pushed the branch to its
1617
current location using SFTP.
1619
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION
1620
will be used. In other words, "checkout ../foo/bar" will attempt to create
1621
./bar. If the BRANCH_LOCATION has no / or path separator embedded, the
1622
TO_LOCATION is derived from the BRANCH_LOCATION by stripping a leading
1623
scheme or drive identifier, if any. For example, "checkout lp:foo-bar" will
1624
attempt to create ./foo-bar.
1626
To retrieve the branch as of a particular revision, supply the --revision
1627
parameter, as in "checkout foo/bar -r 5". Note that this will be
1628
immediately out of date [so you cannot commit] but it may be useful (i.e.
1629
to examine old code.)
1632
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1633
takes_args = ['branch_location?', 'to_location?']
1634
takes_options = ['revision',
1635
Option('lightweight',
1636
help="Perform a lightweight checkout. Lightweight "
1637
"checkouts depend on access to the branch for "
1638
"every operation. Normal checkouts can perform "
1639
"common operations like diff and status without "
1640
"such access, and also support local commits."
1642
Option('files-from', type=text_type,
1643
help="Get file contents from this tree."),
1645
help='Hard-link working tree files where possible.'
1650
def run(self, branch_location=None, to_location=None, revision=None,
1651
lightweight=False, files_from=None, hardlink=False):
1652
if branch_location is None:
1653
branch_location = osutils.getcwd()
1654
to_location = branch_location
1655
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1657
if not (hardlink or files_from):
1658
# accelerator_tree is usually slower because you have to read N
1659
# files (no readahead, lots of seeks, etc), but allow the user to
1660
# explicitly request it
1661
accelerator_tree = None
1662
revision = _get_one_revision('checkout', revision)
1663
if files_from is not None and files_from != branch_location:
1664
accelerator_tree = WorkingTree.open(files_from)
1665
if revision is not None:
1666
revision_id = revision.as_revision_id(source)
1669
if to_location is None:
1670
to_location = urlutils.derive_to_location(branch_location)
1671
# if the source and to_location are the same,
1672
# and there is no working tree,
1673
# then reconstitute a branch
1674
if osutils.abspath(to_location) == osutils.abspath(branch_location):
1676
source.controldir.open_workingtree()
1677
except errors.NoWorkingTree:
1678
source.controldir.create_workingtree(revision_id)
1680
source.create_checkout(to_location, revision_id, lightweight,
1681
accelerator_tree, hardlink)
1684
class cmd_renames(Command):
1685
__doc__ = """Show list of renamed files.
1687
# TODO: Option to show renames between two historical versions.
1689
# TODO: Only show renames under dir, rather than in the whole branch.
1690
_see_also = ['status']
1691
takes_args = ['dir?']
1694
def run(self, dir=u'.'):
1695
tree = WorkingTree.open_containing(dir)[0]
1696
self.add_cleanup(tree.lock_read().unlock)
1697
old_tree = tree.basis_tree()
1698
self.add_cleanup(old_tree.lock_read().unlock)
1700
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1701
for f, paths, c, v, p, n, k, e in iterator:
1702
if paths[0] == paths[1]:
1706
renames.append(paths)
1708
for old_name, new_name in renames:
1709
self.outf.write("%s => %s\n" % (old_name, new_name))
1712
class cmd_update(Command):
1713
__doc__ = """Update a working tree to a new revision.
1715
This will perform a merge of the destination revision (the tip of the
1716
branch, or the specified revision) into the working tree, and then make
1717
that revision the basis revision for the working tree.
1719
You can use this to visit an older revision, or to update a working tree
1720
that is out of date from its branch.
1722
If there are any uncommitted changes in the tree, they will be carried
1723
across and remain as uncommitted changes after the update. To discard
1724
these changes, use 'brz revert'. The uncommitted changes may conflict
1725
with the changes brought in by the change in basis revision.
1727
If the tree's branch is bound to a master branch, brz will also update
1728
the branch from the master.
1730
You cannot update just a single file or directory, because each Bazaar
1731
working tree has just a single basis revision. If you want to restore a
1732
file that has been removed locally, use 'brz revert' instead of 'brz
1733
update'. If you want to restore a file to its state in a previous
1734
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1735
out the old content of that file to a new location.
1737
The 'dir' argument, if given, must be the location of the root of a
1738
working tree to update. By default, the working tree that contains the
1739
current working directory is used.
1742
_see_also = ['pull', 'working-trees', 'status-flags']
1743
takes_args = ['dir?']
1744
takes_options = ['revision',
1746
help="Show base revision text in conflicts."),
1750
def run(self, dir=None, revision=None, show_base=None):
1751
if revision is not None and len(revision) != 1:
1752
raise errors.BzrCommandError(gettext(
1753
"brz update --revision takes exactly one revision"))
1755
tree = WorkingTree.open_containing('.')[0]
1757
tree, relpath = WorkingTree.open_containing(dir)
1760
raise errors.BzrCommandError(gettext(
1761
"brz update can only update a whole tree, "
1762
"not a file or subdirectory"))
1763
branch = tree.branch
1764
possible_transports = []
1765
master = branch.get_master_branch(
1766
possible_transports=possible_transports)
1767
if master is not None:
1768
branch_location = master.base
1771
branch_location = tree.branch.base
1772
tree.lock_tree_write()
1773
self.add_cleanup(tree.unlock)
1774
# get rid of the final '/' and be ready for display
1775
branch_location = urlutils.unescape_for_display(
1776
branch_location.rstrip('/'),
1778
existing_pending_merges = tree.get_parent_ids()[1:]
1782
# may need to fetch data into a heavyweight checkout
1783
# XXX: this may take some time, maybe we should display a
1785
old_tip = branch.update(possible_transports)
1786
if revision is not None:
1787
revision_id = revision[0].as_revision_id(branch)
1789
revision_id = branch.last_revision()
1790
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1791
revno = branch.revision_id_to_dotted_revno(revision_id)
1792
note(gettext("Tree is up to date at revision {0} of branch {1}"
1793
).format('.'.join(map(str, revno)), branch_location))
1795
view_info = _get_view_info_for_change_reporter(tree)
1796
change_reporter = delta._ChangeReporter(
1797
unversioned_filter=tree.is_ignored,
1798
view_info=view_info)
1800
conflicts = tree.update(
1802
possible_transports=possible_transports,
1803
revision=revision_id,
1805
show_base=show_base)
1806
except errors.NoSuchRevision as e:
1807
raise errors.BzrCommandError(gettext(
1808
"branch has no revision %s\n"
1809
"brz update --revision only works"
1810
" for a revision in the branch history")
1812
revno = tree.branch.revision_id_to_dotted_revno(
1813
_mod_revision.ensure_null(tree.last_revision()))
1814
note(gettext('Updated to revision {0} of branch {1}').format(
1815
'.'.join(map(str, revno)), branch_location))
1816
parent_ids = tree.get_parent_ids()
1817
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1818
note(gettext('Your local commits will now show as pending merges with '
1819
"'brz status', and can be committed with 'brz commit'."))
1826
class cmd_info(Command):
1827
__doc__ = """Show information about a working tree, branch or repository.
1829
This command will show all known locations and formats associated to the
1830
tree, branch or repository.
1832
In verbose mode, statistical information is included with each report.
1833
To see extended statistic information, use a verbosity level of 2 or
1834
higher by specifying the verbose option multiple times, e.g. -vv.
1836
Branches and working trees will also report any missing revisions.
1840
Display information on the format and related locations:
1844
Display the above together with extended format information and
1845
basic statistics (like the number of files in the working tree and
1846
number of revisions in the branch and repository):
1850
Display the above together with number of committers to the branch:
1854
_see_also = ['revno', 'working-trees', 'repositories']
1855
takes_args = ['location?']
1856
takes_options = ['verbose']
1857
encoding_type = 'replace'
1860
def run(self, location=None, verbose=False):
1862
noise_level = get_verbosity_level()
1865
from .info import show_bzrdir_info
1866
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1867
verbose=noise_level, outfile=self.outf)
1870
class cmd_remove(Command):
1871
__doc__ = """Remove files or directories.
1873
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1874
delete them if they can easily be recovered using revert otherwise they
1875
will be backed up (adding an extension of the form .~#~). If no options or
1876
parameters are given Bazaar will scan for files that are being tracked by
1877
Bazaar but missing in your tree and stop tracking them for you.
1879
takes_args = ['file*']
1880
takes_options = ['verbose',
1882
'new', help='Only remove files that have never been committed.'),
1883
RegistryOption.from_kwargs('file-deletion-strategy',
1884
'The file deletion mode to be used.',
1885
title='Deletion Strategy', value_switches=True, enum_switch=False,
1886
safe='Backup changed files (default).',
1887
keep='Delete from brz but leave the working copy.',
1888
no_backup='Don\'t backup changed files.'),
1890
aliases = ['rm', 'del']
1891
encoding_type = 'replace'
1893
def run(self, file_list, verbose=False, new=False,
1894
file_deletion_strategy='safe'):
1896
tree, file_list = WorkingTree.open_containing_paths(file_list)
1898
if file_list is not None:
1899
file_list = [f for f in file_list]
1901
self.add_cleanup(tree.lock_write().unlock)
1902
# Heuristics should probably all move into tree.remove_smart or
1905
added = tree.changes_from(tree.basis_tree(),
1906
specific_files=file_list).added
1907
file_list = sorted([f[0] for f in added], reverse=True)
1908
if len(file_list) == 0:
1909
raise errors.BzrCommandError(gettext('No matching files.'))
1910
elif file_list is None:
1911
# missing files show up in iter_changes(basis) as
1912
# versioned-with-no-kind.
1914
for change in tree.iter_changes(tree.basis_tree()):
1915
# Find paths in the working tree that have no kind:
1916
if change[1][1] is not None and change[6][1] is None:
1917
missing.append(change[1][1])
1918
file_list = sorted(missing, reverse=True)
1919
file_deletion_strategy = 'keep'
1920
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1921
keep_files=file_deletion_strategy == 'keep',
1922
force=(file_deletion_strategy == 'no-backup'))
1925
class cmd_file_id(Command):
1926
__doc__ = """Print file_id of a particular file or directory.
1928
The file_id is assigned when the file is first added and remains the
1929
same through all revisions where the file exists, even when it is
1934
_see_also = ['inventory', 'ls']
1935
takes_args = ['filename']
1938
def run(self, filename):
1939
tree, relpath = WorkingTree.open_containing(filename)
1940
file_id = tree.path2id(relpath)
1942
raise errors.NotVersionedError(filename)
1944
self.outf.write(file_id.decode('utf-8') + '\n')
1947
class cmd_file_path(Command):
1948
__doc__ = """Print path of file_ids to a file or directory.
1950
This prints one line for each directory down to the target,
1951
starting at the branch root.
1955
takes_args = ['filename']
1958
def run(self, filename):
1959
tree, relpath = WorkingTree.open_containing(filename)
1960
fid = tree.path2id(relpath)
1962
raise errors.NotVersionedError(filename)
1963
segments = osutils.splitpath(relpath)
1964
for pos in range(1, len(segments) + 1):
1965
path = osutils.joinpath(segments[:pos])
1966
self.outf.write("%s\n" % tree.path2id(path))
1969
class cmd_reconcile(Command):
1970
__doc__ = """Reconcile brz metadata in a branch.
1972
This can correct data mismatches that may have been caused by
1973
previous ghost operations or brz upgrades. You should only
1974
need to run this command if 'brz check' or a brz developer
1975
advises you to run it.
1977
If a second branch is provided, cross-branch reconciliation is
1978
also attempted, which will check that data like the tree root
1979
id which was not present in very early brz versions is represented
1980
correctly in both branches.
1982
At the same time it is run it may recompress data resulting in
1983
a potential saving in disk space or performance gain.
1985
The branch *MUST* be on a listable system such as local disk or sftp.
1988
_see_also = ['check']
1989
takes_args = ['branch?']
1991
Option('canonicalize-chks',
1992
help='Make sure CHKs are in canonical form (repairs '
1997
def run(self, branch=".", canonicalize_chks=False):
1998
from .reconcile import reconcile
1999
dir = controldir.ControlDir.open(branch)
2000
reconcile(dir, canonicalize_chks=canonicalize_chks)
2003
class cmd_revision_history(Command):
2004
__doc__ = """Display the list of revision ids on a branch."""
2007
takes_args = ['location?']
2012
def run(self, location="."):
2013
branch = Branch.open_containing(location)[0]
2014
self.add_cleanup(branch.lock_read().unlock)
2015
graph = branch.repository.get_graph()
2016
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
2017
[_mod_revision.NULL_REVISION]))
2018
for revid in reversed(history):
2019
self.outf.write(revid)
2020
self.outf.write('\n')
2023
class cmd_ancestry(Command):
2024
__doc__ = """List all revisions merged into this branch."""
2026
_see_also = ['log', 'revision-history']
2027
takes_args = ['location?']
2032
def run(self, location="."):
2034
wt = WorkingTree.open_containing(location)[0]
2035
except errors.NoWorkingTree:
2036
b = Branch.open(location)
2037
last_revision = b.last_revision()
2040
last_revision = wt.last_revision()
2042
self.add_cleanup(b.repository.lock_read().unlock)
2043
graph = b.repository.get_graph()
2044
revisions = [revid for revid, parents in
2045
graph.iter_ancestry([last_revision])]
2046
for revision_id in reversed(revisions):
2047
if _mod_revision.is_null(revision_id):
2049
self.outf.write(revision_id.decode('utf-8') + '\n')
2052
class cmd_init(Command):
2053
__doc__ = """Make a directory into a versioned branch.
2055
Use this to create an empty branch, or before importing an
2058
If there is a repository in a parent directory of the location, then
2059
the history of the branch will be stored in the repository. Otherwise
2060
init creates a standalone branch which carries its own history
2061
in the .bzr directory.
2063
If there is already a branch at the location but it has no working tree,
2064
the tree can be populated with 'brz checkout'.
2066
Recipe for importing a tree of files::
2072
brz commit -m "imported project"
2075
_see_also = ['init-repository', 'branch', 'checkout']
2076
takes_args = ['location?']
2078
Option('create-prefix',
2079
help='Create the path leading up to the branch '
2080
'if it does not already exist.'),
2081
RegistryOption('format',
2082
help='Specify a format for this branch. '
2083
'See "help formats" for a full list.',
2084
lazy_registry=('breezy.controldir', 'format_registry'),
2085
converter=lambda name: controldir.format_registry.make_controldir(
2087
value_switches=True,
2088
title="Branch format",
2090
Option('append-revisions-only',
2091
help='Never change revnos or the existing log.'
2092
' Append revisions to it only.'),
2094
'Create a branch without a working tree.')
2097
def run(self, location=None, format=None, append_revisions_only=False,
2098
create_prefix=False, no_tree=False):
2100
format = controldir.format_registry.make_controldir('default')
2101
if location is None:
2104
to_transport = transport.get_transport(location)
2106
# The path has to exist to initialize a
2107
# branch inside of it.
2108
# Just using os.mkdir, since I don't
2109
# believe that we want to create a bunch of
2110
# locations if the user supplies an extended path
2112
to_transport.ensure_base()
2113
except errors.NoSuchFile:
2114
if not create_prefix:
2115
raise errors.BzrCommandError(gettext("Parent directory of %s"
2117
"\nYou may supply --create-prefix to create all"
2118
" leading parent directories.")
2120
to_transport.create_prefix()
2123
a_controldir = controldir.ControlDir.open_from_transport(
2125
except errors.NotBranchError:
2126
# really a NotBzrDir error...
2127
create_branch = controldir.ControlDir.create_branch_convenience
2129
force_new_tree = False
2131
force_new_tree = None
2132
branch = create_branch(to_transport.base, format=format,
2133
possible_transports=[to_transport],
2134
force_new_tree=force_new_tree)
2135
a_controldir = branch.controldir
2137
from .transport.local import LocalTransport
2138
if a_controldir.has_branch():
2139
if (isinstance(to_transport, LocalTransport)
2140
and not a_controldir.has_workingtree()):
2141
raise errors.BranchExistsWithoutWorkingTree(location)
2142
raise errors.AlreadyBranchError(location)
2143
branch = a_controldir.create_branch()
2144
if not no_tree and not a_controldir.has_workingtree():
2145
a_controldir.create_workingtree()
2146
if append_revisions_only:
2148
branch.set_append_revisions_only(True)
2149
except errors.UpgradeRequired:
2150
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2151
' to append-revisions-only. Try --default.'))
2153
from .info import describe_layout, describe_format
2155
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2156
except (errors.NoWorkingTree, errors.NotLocalUrl):
2158
repository = branch.repository
2159
layout = describe_layout(repository, branch, tree).lower()
2160
format = describe_format(a_controldir, repository, branch, tree)
2161
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2163
if repository.is_shared():
2164
# XXX: maybe this can be refactored into transport.path_or_url()
2165
url = repository.controldir.root_transport.external_url()
2167
url = urlutils.local_path_from_url(url)
2168
except urlutils.InvalidURL:
2170
self.outf.write(gettext("Using shared repository: %s\n") % url)
2173
class cmd_init_repository(Command):
2174
__doc__ = """Create a shared repository for branches to share storage space.
2176
New branches created under the repository directory will store their
2177
revisions in the repository, not in the branch directory. For branches
2178
with shared history, this reduces the amount of storage needed and
2179
speeds up the creation of new branches.
2181
If the --no-trees option is given then the branches in the repository
2182
will not have working trees by default. They will still exist as
2183
directories on disk, but they will not have separate copies of the
2184
files at a certain revision. This can be useful for repositories that
2185
store branches which are interacted with through checkouts or remote
2186
branches, such as on a server.
2189
Create a shared repository holding just branches::
2191
brz init-repo --no-trees repo
2194
Make a lightweight checkout elsewhere::
2196
brz checkout --lightweight repo/trunk trunk-checkout
2201
_see_also = ['init', 'branch', 'checkout', 'repositories']
2202
takes_args = ["location"]
2203
takes_options = [RegistryOption('format',
2204
help='Specify a format for this repository. See'
2205
' "brz help formats" for details.',
2207
'breezy.controldir', 'format_registry'),
2208
converter=lambda name: controldir.format_registry.make_controldir(
2210
value_switches=True, title='Repository format'),
2212
help='Branches in the repository will default to'
2213
' not having a working tree.'),
2215
aliases = ["init-repo"]
2217
def run(self, location, format=None, no_trees=False):
2219
format = controldir.format_registry.make_controldir('default')
2221
if location is None:
2224
to_transport = transport.get_transport(location)
2226
if format.fixed_components:
2227
repo_format_name = None
2229
repo_format_name = format.repository_format.get_format_string()
2231
(repo, newdir, require_stacking, repository_policy) = (
2232
format.initialize_on_transport_ex(to_transport,
2233
create_prefix=True, make_working_trees=not no_trees,
2234
shared_repo=True, force_new_repo=True,
2235
use_existing_dir=True,
2236
repo_format_name=repo_format_name))
2238
from .info import show_bzrdir_info
2239
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2242
class cmd_diff(Command):
2243
__doc__ = """Show differences in the working tree, between revisions or branches.
2245
If no arguments are given, all changes for the current tree are listed.
2246
If files are given, only the changes in those files are listed.
2247
Remote and multiple branches can be compared by using the --old and
2248
--new options. If not provided, the default for both is derived from
2249
the first argument, if any, or the current tree if no arguments are
2252
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2253
produces patches suitable for "patch -p1".
2255
Note that when using the -r argument with a range of revisions, the
2256
differences are computed between the two specified revisions. That
2257
is, the command does not show the changes introduced by the first
2258
revision in the range. This differs from the interpretation of
2259
revision ranges used by "brz log" which includes the first revision
2264
2 - unrepresentable changes
2269
Shows the difference in the working tree versus the last commit::
2273
Difference between the working tree and revision 1::
2277
Difference between revision 3 and revision 1::
2281
Difference between revision 3 and revision 1 for branch xxx::
2285
The changes introduced by revision 2 (equivalent to -r1..2)::
2289
To see the changes introduced by revision X::
2293
Note that in the case of a merge, the -c option shows the changes
2294
compared to the left hand parent. To see the changes against
2295
another parent, use::
2297
brz diff -r<chosen_parent>..X
2299
The changes between the current revision and the previous revision
2300
(equivalent to -c-1 and -r-2..-1)
2304
Show just the differences for file NEWS::
2308
Show the differences in working tree xxx for file NEWS::
2312
Show the differences from branch xxx to this working tree:
2316
Show the differences between two branches for file NEWS::
2318
brz diff --old xxx --new yyy NEWS
2320
Same as 'brz diff' but prefix paths with old/ and new/::
2322
brz diff --prefix old/:new/
2324
Show the differences using a custom diff program with options::
2326
brz diff --using /usr/bin/diff --diff-options -wu
2328
_see_also = ['status']
2329
takes_args = ['file*']
2331
Option('diff-options', type=text_type,
2332
help='Pass these options to the external diff program.'),
2333
Option('prefix', type=text_type,
2335
help='Set prefixes added to old and new filenames, as '
2336
'two values separated by a colon. (eg "old/:new/").'),
2338
help='Branch/tree to compare from.',
2342
help='Branch/tree to compare to.',
2348
help='Use this command to compare files.',
2351
RegistryOption('format',
2353
help='Diff format to use.',
2354
lazy_registry=('breezy.diff', 'format_registry'),
2355
title='Diff format'),
2357
help='How many lines of context to show.',
2361
aliases = ['di', 'dif']
2362
encoding_type = 'exact'
2365
def run(self, revision=None, file_list=None, diff_options=None,
2366
prefix=None, old=None, new=None, using=None, format=None,
2368
from .diff import (get_trees_and_branches_to_diff_locked,
2375
elif prefix == u'1' or prefix is None:
2378
elif u':' in prefix:
2379
old_label, new_label = prefix.split(u":")
2381
raise errors.BzrCommandError(gettext(
2382
'--prefix expects two values separated by a colon'
2383
' (eg "old/:new/")'))
2385
if revision and len(revision) > 2:
2386
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2387
' one or two revision specifiers'))
2389
if using is not None and format is not None:
2390
raise errors.BzrCommandError(gettext(
2391
'{0} and {1} are mutually exclusive').format(
2392
'--using', '--format'))
2394
(old_tree, new_tree,
2395
old_branch, new_branch,
2396
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2397
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2398
# GNU diff on Windows uses ANSI encoding for filenames
2399
path_encoding = osutils.get_diff_header_encoding()
2400
return show_diff_trees(old_tree, new_tree, self.outf,
2401
specific_files=specific_files,
2402
external_diff_options=diff_options,
2403
old_label=old_label, new_label=new_label,
2404
extra_trees=extra_trees,
2405
path_encoding=path_encoding,
2406
using=using, context=context,
2410
class cmd_deleted(Command):
2411
__doc__ = """List files deleted in the working tree.
2413
# TODO: Show files deleted since a previous revision, or
2414
# between two revisions.
2415
# TODO: Much more efficient way to do this: read in new
2416
# directories with readdir, rather than stating each one. Same
2417
# level of effort but possibly much less IO. (Or possibly not,
2418
# if the directories are very large...)
2419
_see_also = ['status', 'ls']
2420
takes_options = ['directory', 'show-ids']
2423
def run(self, show_ids=False, directory=u'.'):
2424
tree = WorkingTree.open_containing(directory)[0]
2425
self.add_cleanup(tree.lock_read().unlock)
2426
old = tree.basis_tree()
2427
self.add_cleanup(old.lock_read().unlock)
2428
for path, ie in old.iter_entries_by_dir():
2429
if not tree.has_id(ie.file_id):
2430
self.outf.write(path)
2432
self.outf.write(' ')
2433
self.outf.write(ie.file_id)
2434
self.outf.write('\n')
2437
class cmd_modified(Command):
2438
__doc__ = """List files modified in working tree.
2442
_see_also = ['status', 'ls']
2443
takes_options = ['directory', 'null']
2446
def run(self, null=False, directory=u'.'):
2447
tree = WorkingTree.open_containing(directory)[0]
2448
self.add_cleanup(tree.lock_read().unlock)
2449
td = tree.changes_from(tree.basis_tree())
2451
for path, id, kind, text_modified, meta_modified in td.modified:
2453
self.outf.write(path + '\0')
2455
self.outf.write(osutils.quotefn(path) + '\n')
2458
class cmd_added(Command):
2459
__doc__ = """List files added in working tree.
2463
_see_also = ['status', 'ls']
2464
takes_options = ['directory', 'null']
2467
def run(self, null=False, directory=u'.'):
2468
wt = WorkingTree.open_containing(directory)[0]
2469
self.add_cleanup(wt.lock_read().unlock)
2470
basis = wt.basis_tree()
2471
self.add_cleanup(basis.lock_read().unlock)
2472
for path in wt.all_versioned_paths():
2473
if basis.has_filename(path):
2477
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2480
self.outf.write(path + '\0')
2482
self.outf.write(osutils.quotefn(path) + '\n')
2485
class cmd_root(Command):
2486
__doc__ = """Show the tree root directory.
2488
The root is the nearest enclosing directory with a .bzr control
2491
takes_args = ['filename?']
2494
def run(self, filename=None):
2495
"""Print the branch root."""
2496
tree = WorkingTree.open_containing(filename)[0]
2497
self.outf.write(tree.basedir + '\n')
2500
def _parse_limit(limitstring):
2502
return int(limitstring)
2504
msg = gettext("The limit argument must be an integer.")
2505
raise errors.BzrCommandError(msg)
2508
def _parse_levels(s):
2512
msg = gettext("The levels argument must be an integer.")
2513
raise errors.BzrCommandError(msg)
2516
class cmd_log(Command):
2517
__doc__ = """Show historical log for a branch or subset of a branch.
2519
log is brz's default tool for exploring the history of a branch.
2520
The branch to use is taken from the first parameter. If no parameters
2521
are given, the branch containing the working directory is logged.
2522
Here are some simple examples::
2524
brz log log the current branch
2525
brz log foo.py log a file in its branch
2526
brz log http://server/branch log a branch on a server
2528
The filtering, ordering and information shown for each revision can
2529
be controlled as explained below. By default, all revisions are
2530
shown sorted (topologically) so that newer revisions appear before
2531
older ones and descendants always appear before ancestors. If displayed,
2532
merged revisions are shown indented under the revision in which they
2537
The log format controls how information about each revision is
2538
displayed. The standard log formats are called ``long``, ``short``
2539
and ``line``. The default is long. See ``brz help log-formats``
2540
for more details on log formats.
2542
The following options can be used to control what information is
2545
-l N display a maximum of N revisions
2546
-n N display N levels of revisions (0 for all, 1 for collapsed)
2547
-v display a status summary (delta) for each revision
2548
-p display a diff (patch) for each revision
2549
--show-ids display revision-ids (and file-ids), not just revnos
2551
Note that the default number of levels to display is a function of the
2552
log format. If the -n option is not used, the standard log formats show
2553
just the top level (mainline).
2555
Status summaries are shown using status flags like A, M, etc. To see
2556
the changes explained using words like ``added`` and ``modified``
2557
instead, use the -vv option.
2561
To display revisions from oldest to newest, use the --forward option.
2562
In most cases, using this option will have little impact on the total
2563
time taken to produce a log, though --forward does not incrementally
2564
display revisions like --reverse does when it can.
2566
:Revision filtering:
2568
The -r option can be used to specify what revision or range of revisions
2569
to filter against. The various forms are shown below::
2571
-rX display revision X
2572
-rX.. display revision X and later
2573
-r..Y display up to and including revision Y
2574
-rX..Y display from X to Y inclusive
2576
See ``brz help revisionspec`` for details on how to specify X and Y.
2577
Some common examples are given below::
2579
-r-1 show just the tip
2580
-r-10.. show the last 10 mainline revisions
2581
-rsubmit:.. show what's new on this branch
2582
-rancestor:path.. show changes since the common ancestor of this
2583
branch and the one at location path
2584
-rdate:yesterday.. show changes since yesterday
2586
When logging a range of revisions using -rX..Y, log starts at
2587
revision Y and searches back in history through the primary
2588
("left-hand") parents until it finds X. When logging just the
2589
top level (using -n1), an error is reported if X is not found
2590
along the way. If multi-level logging is used (-n0), X may be
2591
a nested merge revision and the log will be truncated accordingly.
2595
If parameters are given and the first one is not a branch, the log
2596
will be filtered to show only those revisions that changed the
2597
nominated files or directories.
2599
Filenames are interpreted within their historical context. To log a
2600
deleted file, specify a revision range so that the file existed at
2601
the end or start of the range.
2603
Historical context is also important when interpreting pathnames of
2604
renamed files/directories. Consider the following example:
2606
* revision 1: add tutorial.txt
2607
* revision 2: modify tutorial.txt
2608
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2612
* ``brz log guide.txt`` will log the file added in revision 1
2614
* ``brz log tutorial.txt`` will log the new file added in revision 3
2616
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2617
the original file in revision 2.
2619
* ``brz log -r2 -p guide.txt`` will display an error message as there
2620
was no file called guide.txt in revision 2.
2622
Renames are always followed by log. By design, there is no need to
2623
explicitly ask for this (and no way to stop logging a file back
2624
until it was last renamed).
2628
The --match option can be used for finding revisions that match a
2629
regular expression in a commit message, committer, author or bug.
2630
Specifying the option several times will match any of the supplied
2631
expressions. --match-author, --match-bugs, --match-committer and
2632
--match-message can be used to only match a specific field.
2636
GUI tools and IDEs are often better at exploring history than command
2637
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2638
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2639
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2640
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2642
You may find it useful to add the aliases below to ``breezy.conf``::
2646
top = log -l10 --line
2649
``brz tip`` will then show the latest revision while ``brz top``
2650
will show the last 10 mainline revisions. To see the details of a
2651
particular revision X, ``brz show -rX``.
2653
If you are interested in looking deeper into a particular merge X,
2654
use ``brz log -n0 -rX``.
2656
``brz log -v`` on a branch with lots of history is currently
2657
very slow. A fix for this issue is currently under development.
2658
With or without that fix, it is recommended that a revision range
2659
be given when using the -v option.
2661
brz has a generic full-text matching plugin, brz-search, that can be
2662
used to find revisions matching user names, commit messages, etc.
2663
Among other features, this plugin can find all revisions containing
2664
a list of words but not others.
2666
When exploring non-mainline history on large projects with deep
2667
history, the performance of log can be greatly improved by installing
2668
the historycache plugin. This plugin buffers historical information
2669
trading disk space for faster speed.
2671
takes_args = ['file*']
2672
_see_also = ['log-formats', 'revisionspec']
2675
help='Show from oldest to newest.'),
2677
custom_help('verbose',
2678
help='Show files changed in each revision.'),
2682
type=breezy.option._parse_revision_str,
2684
help='Show just the specified revision.'
2685
' See also "help revisionspec".'),
2687
RegistryOption('authors',
2688
'What names to list as authors - first, all or committer.',
2691
'breezy.log', 'author_list_registry'),
2695
help='Number of levels to display - 0 for all, 1 for flat.',
2697
type=_parse_levels),
2699
help='Show revisions whose message matches this '
2700
'regular expression.',
2705
help='Limit the output to the first N revisions.',
2710
help='Show changes made in each revision as a patch.'),
2711
Option('include-merged',
2712
help='Show merged revisions like --levels 0 does.'),
2713
Option('include-merges', hidden=True,
2714
help='Historical alias for --include-merged.'),
2715
Option('omit-merges',
2716
help='Do not report commits with more than one parent.'),
2717
Option('exclude-common-ancestry',
2718
help='Display only the revisions that are not part'
2719
' of both ancestries (require -rX..Y).'
2721
Option('signatures',
2722
help='Show digital signature validity.'),
2725
help='Show revisions whose properties match this '
2728
ListOption('match-message',
2729
help='Show revisions whose message matches this '
2732
ListOption('match-committer',
2733
help='Show revisions whose committer matches this '
2736
ListOption('match-author',
2737
help='Show revisions whose authors match this '
2740
ListOption('match-bugs',
2741
help='Show revisions whose bugs match this '
2745
encoding_type = 'replace'
2748
def run(self, file_list=None, timezone='original',
2759
include_merged=None,
2761
exclude_common_ancestry=False,
2765
match_committer=None,
2772
make_log_request_dict,
2773
_get_info_for_log_files,
2775
direction = (forward and 'forward') or 'reverse'
2776
if include_merged is None:
2777
include_merged = False
2778
if (exclude_common_ancestry
2779
and (revision is None or len(revision) != 2)):
2780
raise errors.BzrCommandError(gettext(
2781
'--exclude-common-ancestry requires -r with two revisions'))
2786
raise errors.BzrCommandError(gettext(
2787
'{0} and {1} are mutually exclusive').format(
2788
'--levels', '--include-merged'))
2790
if change is not None:
2792
raise errors.RangeInChangeOption()
2793
if revision is not None:
2794
raise errors.BzrCommandError(gettext(
2795
'{0} and {1} are mutually exclusive').format(
2796
'--revision', '--change'))
2801
filter_by_dir = False
2803
# find the file ids to log and check for directory filtering
2804
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2805
revision, file_list, self.add_cleanup)
2806
for relpath, file_id, kind in file_info_list:
2808
raise errors.BzrCommandError(gettext(
2809
"Path unknown at end or start of revision range: %s") %
2811
# If the relpath is the top of the tree, we log everything
2816
file_ids.append(file_id)
2817
filter_by_dir = filter_by_dir or (
2818
kind in ['directory', 'tree-reference'])
2821
# FIXME ? log the current subdir only RBC 20060203
2822
if revision is not None \
2823
and len(revision) > 0 and revision[0].get_branch():
2824
location = revision[0].get_branch()
2827
dir, relpath = controldir.ControlDir.open_containing(location)
2828
b = dir.open_branch()
2829
self.add_cleanup(b.lock_read().unlock)
2830
rev1, rev2 = _get_revision_range(revision, b, self.name())
2832
if b.get_config_stack().get('validate_signatures_in_log'):
2836
if not gpg.GPGStrategy.verify_signatures_available():
2837
raise errors.GpgmeNotInstalled(None)
2839
# Decide on the type of delta & diff filtering to use
2840
# TODO: add an --all-files option to make this configurable & consistent
2848
diff_type = 'partial'
2852
# Build the log formatter
2853
if log_format is None:
2854
log_format = log.log_formatter_registry.get_default(b)
2855
# Make a non-encoding output to include the diffs - bug 328007
2856
unencoded_output = ui.ui_factory.make_output_stream(
2857
encoding_type='exact')
2858
lf = log_format(show_ids=show_ids, to_file=self.outf,
2859
to_exact_file=unencoded_output,
2860
show_timezone=timezone,
2861
delta_format=get_verbosity_level(),
2863
show_advice=levels is None,
2864
author_list_handler=authors)
2866
# Choose the algorithm for doing the logging. It's annoying
2867
# having multiple code paths like this but necessary until
2868
# the underlying repository format is faster at generating
2869
# deltas or can provide everything we need from the indices.
2870
# The default algorithm - match-using-deltas - works for
2871
# multiple files and directories and is faster for small
2872
# amounts of history (200 revisions say). However, it's too
2873
# slow for logging a single file in a repository with deep
2874
# history, i.e. > 10K revisions. In the spirit of "do no
2875
# evil when adding features", we continue to use the
2876
# original algorithm - per-file-graph - for the "single
2877
# file that isn't a directory without showing a delta" case.
2878
partial_history = revision and b.repository._format.supports_chks
2879
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2880
or delta_type or partial_history)
2884
match_dict[''] = match
2886
match_dict['message'] = match_message
2888
match_dict['committer'] = match_committer
2890
match_dict['author'] = match_author
2892
match_dict['bugs'] = match_bugs
2894
# Build the LogRequest and execute it
2895
if len(file_ids) == 0:
2897
rqst = make_log_request_dict(
2898
direction=direction, specific_fileids=file_ids,
2899
start_revision=rev1, end_revision=rev2, limit=limit,
2900
message_search=message, delta_type=delta_type,
2901
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2902
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2903
signature=signatures, omit_merges=omit_merges,
2905
Logger(b, rqst).show(lf)
2908
def _get_revision_range(revisionspec_list, branch, command_name):
2909
"""Take the input of a revision option and turn it into a revision range.
2911
It returns RevisionInfo objects which can be used to obtain the rev_id's
2912
of the desired revisions. It does some user input validations.
2914
if revisionspec_list is None:
2917
elif len(revisionspec_list) == 1:
2918
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2919
elif len(revisionspec_list) == 2:
2920
start_spec = revisionspec_list[0]
2921
end_spec = revisionspec_list[1]
2922
if end_spec.get_branch() != start_spec.get_branch():
2923
# b is taken from revision[0].get_branch(), and
2924
# show_log will use its revision_history. Having
2925
# different branches will lead to weird behaviors.
2926
raise errors.BzrCommandError(gettext(
2927
"brz %s doesn't accept two revisions in different"
2928
" branches.") % command_name)
2929
if start_spec.spec is None:
2930
# Avoid loading all the history.
2931
rev1 = RevisionInfo(branch, None, None)
2933
rev1 = start_spec.in_history(branch)
2934
# Avoid loading all of history when we know a missing
2935
# end of range means the last revision ...
2936
if end_spec.spec is None:
2937
last_revno, last_revision_id = branch.last_revision_info()
2938
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2940
rev2 = end_spec.in_history(branch)
2942
raise errors.BzrCommandError(gettext(
2943
'brz %s --revision takes one or two values.') % command_name)
2947
def _revision_range_to_revid_range(revision_range):
2950
if revision_range[0] is not None:
2951
rev_id1 = revision_range[0].rev_id
2952
if revision_range[1] is not None:
2953
rev_id2 = revision_range[1].rev_id
2954
return rev_id1, rev_id2
2957
def get_log_format(long=False, short=False, line=False, default='long'):
2958
log_format = default
2962
log_format = 'short'
2968
class cmd_touching_revisions(Command):
2969
__doc__ = """Return revision-ids which affected a particular file.
2971
A more user-friendly interface is "brz log FILE".
2975
takes_args = ["filename"]
2978
def run(self, filename):
2979
tree, relpath = WorkingTree.open_containing(filename)
2980
with tree.lock_read():
2981
touching_revs = log.find_touching_revisions(
2982
tree.branch.repository, tree.branch.last_revision(), tree, relpath)
2983
for revno, revision_id, what in reversed(list(touching_revs)):
2984
self.outf.write("%6d %s\n" % (revno, what))
2987
class cmd_ls(Command):
2988
__doc__ = """List files in a tree.
2991
_see_also = ['status', 'cat']
2992
takes_args = ['path?']
2996
Option('recursive', short_name='R',
2997
help='Recurse into subdirectories.'),
2999
help='Print paths relative to the root of the branch.'),
3000
Option('unknown', short_name='u',
3001
help='Print unknown files.'),
3002
Option('versioned', help='Print versioned files.',
3004
Option('ignored', short_name='i',
3005
help='Print ignored files.'),
3006
Option('kind', short_name='k',
3007
help=('List entries of a particular kind: file, '
3008
'directory, symlink, tree-reference.'),
3016
def run(self, revision=None, verbose=False,
3017
recursive=False, from_root=False,
3018
unknown=False, versioned=False, ignored=False,
3019
null=False, kind=None, show_ids=False, path=None, directory=None):
3021
if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
3022
raise errors.BzrCommandError(gettext('invalid kind specified'))
3024
if verbose and null:
3025
raise errors.BzrCommandError(
3026
gettext('Cannot set both --verbose and --null'))
3027
all = not (unknown or versioned or ignored)
3029
selection = {'I': ignored, '?': unknown, 'V': versioned}
3035
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3038
tree, branch, relpath = \
3039
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3041
# Calculate the prefix to use
3045
prefix = relpath + '/'
3046
elif fs_path != '.' and not fs_path.endswith('/'):
3047
prefix = fs_path + '/'
3049
if revision is not None or tree is None:
3050
tree = _get_one_revision_tree('ls', revision, branch=branch)
3053
if isinstance(tree, WorkingTree) and tree.supports_views():
3054
view_files = tree.views.lookup_view()
3057
view_str = views.view_display_str(view_files)
3058
note(gettext("Ignoring files outside view. View is %s") % view_str)
3060
self.add_cleanup(tree.lock_read().unlock)
3061
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3062
from_dir=relpath, recursive=recursive):
3063
# Apply additional masking
3064
if not all and not selection[fc]:
3066
if kind is not None and fkind != kind:
3071
fullpath = osutils.pathjoin(relpath, fp)
3074
views.check_path_in_view(tree, fullpath)
3075
except views.FileOutsideView:
3080
fp = osutils.pathjoin(prefix, fp)
3081
kindch = entry.kind_character()
3082
outstring = fp + kindch
3083
ui.ui_factory.clear_term()
3085
outstring = '%-8s %s' % (fc, outstring)
3086
if show_ids and fid is not None:
3087
outstring = "%-50s %s" % (outstring, fid.decode('utf-8'))
3088
self.outf.write(outstring + '\n')
3090
self.outf.write(fp + '\0')
3093
self.outf.write(fid.decode('utf-8'))
3094
self.outf.write('\0')
3099
my_id = fid.decode('utf-8')
3102
self.outf.write('%-50s %s\n' % (outstring, my_id))
3104
self.outf.write(outstring + '\n')
3107
class cmd_unknowns(Command):
3108
__doc__ = """List unknown files.
3113
takes_options = ['directory']
3116
def run(self, directory=u'.'):
3117
for f in WorkingTree.open_containing(directory)[0].unknowns():
3118
self.outf.write(osutils.quotefn(f) + '\n')
3121
class cmd_ignore(Command):
3122
__doc__ = """Ignore specified files or patterns.
3124
See ``brz help patterns`` for details on the syntax of patterns.
3126
If a .bzrignore file does not exist, the ignore command
3127
will create one and add the specified files or patterns to the newly
3128
created file. The ignore command will also automatically add the
3129
.bzrignore file to be versioned. Creating a .bzrignore file without
3130
the use of the ignore command will require an explicit add command.
3132
To remove patterns from the ignore list, edit the .bzrignore file.
3133
After adding, editing or deleting that file either indirectly by
3134
using this command or directly by using an editor, be sure to commit
3137
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3138
the global ignore file can be found in the application data directory as
3139
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3140
Global ignores are not touched by this command. The global ignore file
3141
can be edited directly using an editor.
3143
Patterns prefixed with '!' are exceptions to ignore patterns and take
3144
precedence over regular ignores. Such exceptions are used to specify
3145
files that should be versioned which would otherwise be ignored.
3147
Patterns prefixed with '!!' act as regular ignore patterns, but have
3148
precedence over the '!' exception patterns.
3152
* Ignore patterns containing shell wildcards must be quoted from
3155
* Ignore patterns starting with "#" act as comments in the ignore file.
3156
To ignore patterns that begin with that character, use the "RE:" prefix.
3159
Ignore the top level Makefile::
3161
brz ignore ./Makefile
3163
Ignore .class files in all directories...::
3165
brz ignore "*.class"
3167
...but do not ignore "special.class"::
3169
brz ignore "!special.class"
3171
Ignore files whose name begins with the "#" character::
3175
Ignore .o files under the lib directory::
3177
brz ignore "lib/**/*.o"
3179
Ignore .o files under the lib directory::
3181
brz ignore "RE:lib/.*\\.o"
3183
Ignore everything but the "debian" toplevel directory::
3185
brz ignore "RE:(?!debian/).*"
3187
Ignore everything except the "local" toplevel directory,
3188
but always ignore autosave files ending in ~, even under local/::
3191
brz ignore "!./local"
3195
_see_also = ['status', 'ignored', 'patterns']
3196
takes_args = ['name_pattern*']
3197
takes_options = ['directory',
3198
Option('default-rules',
3199
help='Display the default ignore rules that brz uses.')
3202
def run(self, name_pattern_list=None, default_rules=None,
3204
from breezy import ignores
3205
if default_rules is not None:
3206
# dump the default rules and exit
3207
for pattern in ignores.USER_DEFAULTS:
3208
self.outf.write("%s\n" % pattern)
3210
if not name_pattern_list:
3211
raise errors.BzrCommandError(gettext("ignore requires at least one "
3212
"NAME_PATTERN or --default-rules."))
3213
name_pattern_list = [globbing.normalize_pattern(p)
3214
for p in name_pattern_list]
3216
bad_patterns_count = 0
3217
for p in name_pattern_list:
3218
if not globbing.Globster.is_pattern_valid(p):
3219
bad_patterns_count += 1
3220
bad_patterns += ('\n %s' % p)
3222
msg = (ngettext('Invalid ignore pattern found. %s',
3223
'Invalid ignore patterns found. %s',
3224
bad_patterns_count) % bad_patterns)
3225
ui.ui_factory.show_error(msg)
3226
raise lazy_regex.InvalidPattern('')
3227
for name_pattern in name_pattern_list:
3228
if (name_pattern[0] == '/' or
3229
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3230
raise errors.BzrCommandError(gettext(
3231
"NAME_PATTERN should not be an absolute path"))
3232
tree, relpath = WorkingTree.open_containing(directory)
3233
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3234
ignored = globbing.Globster(name_pattern_list)
3236
self.add_cleanup(tree.lock_read().unlock)
3237
for entry in tree.list_files():
3241
if ignored.match(filename):
3242
matches.append(filename)
3243
if len(matches) > 0:
3244
self.outf.write(gettext("Warning: the following files are version "
3245
"controlled and match your ignore pattern:\n%s"
3246
"\nThese files will continue to be version controlled"
3247
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3250
class cmd_ignored(Command):
3251
__doc__ = """List ignored files and the patterns that matched them.
3253
List all the ignored files and the ignore pattern that caused the file to
3256
Alternatively, to list just the files::
3261
encoding_type = 'replace'
3262
_see_also = ['ignore', 'ls']
3263
takes_options = ['directory']
3266
def run(self, directory=u'.'):
3267
tree = WorkingTree.open_containing(directory)[0]
3268
self.add_cleanup(tree.lock_read().unlock)
3269
for path, file_class, kind, file_id, entry in tree.list_files():
3270
if file_class != 'I':
3272
# XXX: Slightly inefficient since this was already calculated
3273
pat = tree.is_ignored(path)
3274
self.outf.write('%-50s %s\n' % (path, pat))
3277
class cmd_lookup_revision(Command):
3278
__doc__ = """Lookup the revision-id from a revision-number
3281
brz lookup-revision 33
3284
takes_args = ['revno']
3285
takes_options = ['directory']
3288
def run(self, revno, directory=u'.'):
3292
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3294
revid = WorkingTree.open_containing(
3295
directory)[0].branch.get_rev_id(revno)
3296
self.outf.write("%s\n" % revid.decode('utf-8'))
3299
class cmd_export(Command):
3300
__doc__ = """Export current or past revision to a destination directory or archive.
3302
If no revision is specified this exports the last committed revision.
3304
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3305
given, try to find the format with the extension. If no extension
3306
is found exports to a directory (equivalent to --format=dir).
3308
If root is supplied, it will be used as the root directory inside
3309
container formats (tar, zip, etc). If it is not supplied it will default
3310
to the exported filename. The root option has no effect for 'dir' format.
3312
If branch is omitted then the branch containing the current working
3313
directory will be used.
3315
Note: Export of tree with non-ASCII filenames to zip is not supported.
3317
================= =========================
3318
Supported formats Autodetected by extension
3319
================= =========================
3322
tbz2 .tar.bz2, .tbz2
3325
================= =========================
3328
encoding_type = 'exact'
3329
takes_args = ['dest', 'branch_or_subdir?']
3330
takes_options = ['directory',
3332
help="Type of file to export to.",
3335
Option('filters', help='Apply content filters to export the '
3336
'convenient form.'),
3339
help="Name of the root directory inside the exported file."),
3340
Option('per-file-timestamps',
3341
help='Set modification time of files to that of the last '
3342
'revision in which it was changed.'),
3343
Option('uncommitted',
3344
help='Export the working tree contents rather than that of the '
3348
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3349
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3351
from .export import export, guess_format, get_root_name
3353
if branch_or_subdir is None:
3354
branch_or_subdir = directory
3356
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3358
if tree is not None:
3359
self.add_cleanup(tree.lock_read().unlock)
3363
raise errors.BzrCommandError(
3364
gettext("--uncommitted requires a working tree"))
3367
export_tree = _get_one_revision_tree(
3368
'export', revision, branch=b,
3372
format = guess_format(dest)
3375
root = get_root_name(dest)
3377
if not per_file_timestamps:
3378
force_mtime = time.time()
3383
from breezy.filter_tree import ContentFilterTree
3384
export_tree = ContentFilterTree(
3385
export_tree, export_tree._content_filter_stack)
3388
export(export_tree, dest, format, root, subdir,
3389
per_file_timestamps=per_file_timestamps)
3390
except errors.NoSuchExportFormat as e:
3391
raise errors.BzrCommandError(
3392
gettext('Unsupported export format: %s') % e.format)
3395
class cmd_cat(Command):
3396
__doc__ = """Write the contents of a file as of a given revision to standard output.
3398
If no revision is nominated, the last revision is used.
3400
Note: Take care to redirect standard output when using this command on a
3405
takes_options = ['directory',
3406
Option('name-from-revision',
3407
help='The path name in the old tree.'),
3408
Option('filters', help='Apply content filters to display the '
3409
'convenience form.'),
3412
takes_args = ['filename']
3413
encoding_type = 'exact'
3416
def run(self, filename, revision=None, name_from_revision=False,
3417
filters=False, directory=None):
3418
if revision is not None and len(revision) != 1:
3419
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3420
" one revision specifier"))
3421
tree, branch, relpath = \
3422
_open_directory_or_containing_tree_or_branch(filename, directory)
3423
self.add_cleanup(branch.lock_read().unlock)
3424
return self._run(tree, branch, relpath, filename, revision,
3425
name_from_revision, filters)
3427
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3431
tree = b.basis_tree()
3432
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3433
self.add_cleanup(rev_tree.lock_read().unlock)
3435
old_file_id = rev_tree.path2id(relpath)
3437
# TODO: Split out this code to something that generically finds the
3438
# best id for a path across one or more trees; it's like
3439
# find_ids_across_trees but restricted to find just one. -- mbp
3441
if name_from_revision:
3442
# Try in revision if requested
3443
if old_file_id is None:
3444
raise errors.BzrCommandError(gettext(
3445
"{0!r} is not present in revision {1}").format(
3446
filename, rev_tree.get_revision_id()))
3448
actual_file_id = old_file_id
3450
cur_file_id = tree.path2id(relpath)
3451
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3452
actual_file_id = cur_file_id
3453
elif old_file_id is not None:
3454
actual_file_id = old_file_id
3456
raise errors.BzrCommandError(gettext(
3457
"{0!r} is not present in revision {1}").format(
3458
filename, rev_tree.get_revision_id()))
3459
relpath = rev_tree.id2path(actual_file_id)
3461
from .filter_tree import ContentFilterTree
3462
filter_tree = ContentFilterTree(
3463
rev_tree, rev_tree._content_filter_stack)
3464
fileobj = filter_tree.get_file(relpath)
3466
fileobj = rev_tree.get_file(relpath)
3467
shutil.copyfileobj(fileobj, self.outf)
3471
class cmd_local_time_offset(Command):
3472
__doc__ = """Show the offset in seconds from GMT to local time."""
3477
self.outf.write("%s\n" % osutils.local_time_offset())
3480
class cmd_commit(Command):
3481
__doc__ = """Commit changes into a new revision.
3483
An explanatory message needs to be given for each commit. This is
3484
often done by using the --message option (getting the message from the
3485
command line) or by using the --file option (getting the message from
3486
a file). If neither of these options is given, an editor is opened for
3487
the user to enter the message. To see the changed files in the
3488
boilerplate text loaded into the editor, use the --show-diff option.
3490
By default, the entire tree is committed and the person doing the
3491
commit is assumed to be the author. These defaults can be overridden
3496
If selected files are specified, only changes to those files are
3497
committed. If a directory is specified then the directory and
3498
everything within it is committed.
3500
When excludes are given, they take precedence over selected files.
3501
For example, to commit only changes within foo, but not changes
3504
brz commit foo -x foo/bar
3506
A selective commit after a merge is not yet supported.
3510
If the author of the change is not the same person as the committer,
3511
you can specify the author's name using the --author option. The
3512
name should be in the same format as a committer-id, e.g.
3513
"John Doe <jdoe@example.com>". If there is more than one author of
3514
the change you can specify the option multiple times, once for each
3519
A common mistake is to forget to add a new file or directory before
3520
running the commit command. The --strict option checks for unknown
3521
files and aborts the commit if any are found. More advanced pre-commit
3522
checks can be implemented by defining hooks. See ``brz help hooks``
3527
If you accidentially commit the wrong changes or make a spelling
3528
mistake in the commit message say, you can use the uncommit command
3529
to undo it. See ``brz help uncommit`` for details.
3531
Hooks can also be configured to run after a commit. This allows you
3532
to trigger updates to external systems like bug trackers. The --fixes
3533
option can be used to record the association between a revision and
3534
one or more bugs. See ``brz help bugs`` for details.
3537
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3538
takes_args = ['selected*']
3540
ListOption('exclude', type=text_type, short_name='x',
3541
help="Do not consider changes made to a given path."),
3542
Option('message', type=text_type,
3544
help="Description of the new revision."),
3547
help='Commit even if nothing has changed.'),
3548
Option('file', type=text_type,
3551
help='Take commit message from this file.'),
3553
help="Refuse to commit if there are unknown "
3554
"files in the working tree."),
3555
Option('commit-time', type=text_type,
3556
help="Manually set a commit time using commit date "
3557
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3558
ListOption('bugs', type=text_type,
3559
help="Link to a related bug. (see \"brz help bugs\")."),
3560
ListOption('fixes', type=text_type,
3561
help="Mark a bug as being fixed by this revision "
3562
"(see \"brz help bugs\")."),
3563
ListOption('author', type=text_type,
3564
help="Set the author's name, if it's different "
3565
"from the committer."),
3567
help="Perform a local commit in a bound "
3568
"branch. Local commits are not pushed to "
3569
"the master branch until a normal commit "
3572
Option('show-diff', short_name='p',
3573
help='When no message is supplied, show the diff along'
3574
' with the status summary in the message editor.'),
3576
help='When committing to a foreign version control '
3577
'system do not push data that can not be natively '
3580
aliases = ['ci', 'checkin']
3582
def _iter_bug_urls(self, bugs, branch, status):
3583
default_bugtracker = None
3584
# Configure the properties for bug fixing attributes.
3586
tokens = bug.split(':')
3587
if len(tokens) == 1:
3588
if default_bugtracker is None:
3589
branch_config = branch.get_config_stack()
3590
default_bugtracker = branch_config.get(
3592
if default_bugtracker is None:
3593
raise errors.BzrCommandError(gettext(
3594
"No tracker specified for bug %s. Use the form "
3595
"'tracker:id' or specify a default bug tracker "
3596
"using the `bugtracker` option.\nSee "
3597
"\"brz help bugs\" for more information on this "
3598
"feature. Commit refused.") % bug)
3599
tag = default_bugtracker
3601
elif len(tokens) != 2:
3602
raise errors.BzrCommandError(gettext(
3603
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3604
"See \"brz help bugs\" for more information on this "
3605
"feature.\nCommit refused.") % bug)
3607
tag, bug_id = tokens
3609
yield bugtracker.get_bug_url(tag, branch, bug_id), status
3610
except bugtracker.UnknownBugTrackerAbbreviation:
3611
raise errors.BzrCommandError(gettext(
3612
'Unrecognized bug %s. Commit refused.') % bug)
3613
except bugtracker.MalformedBugIdentifier as e:
3614
raise errors.BzrCommandError(gettext(
3615
u"%s\nCommit refused.") % (e,))
3617
def run(self, message=None, file=None, verbose=False, selected_list=None,
3618
unchanged=False, strict=False, local=False, fixes=None, bugs=None,
3619
author=None, show_diff=False, exclude=None, commit_time=None,
3622
from .commit import (
3625
from .errors import (
3629
from .msgeditor import (
3630
edit_commit_message_encoded,
3631
generate_commit_message_template,
3632
make_commit_message_template_encoded,
3636
commit_stamp = offset = None
3637
if commit_time is not None:
3639
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3640
except ValueError as e:
3641
raise errors.BzrCommandError(gettext(
3642
"Could not parse --commit-time: " + str(e)))
3646
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3647
if selected_list == ['']:
3648
# workaround - commit of root of tree should be exactly the same
3649
# as just default commit in that tree, and succeed even though
3650
# selected-file merge commit is not done yet
3657
bug_property = bugtracker.encode_fixes_bug_urls(
3659
self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
3660
self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
3662
properties[u'bugs'] = bug_property
3664
if local and not tree.branch.get_bound_location():
3665
raise errors.LocalRequiresBoundBranch()
3667
if message is not None:
3669
file_exists = osutils.lexists(message)
3670
except UnicodeError:
3671
# The commit message contains unicode characters that can't be
3672
# represented in the filesystem encoding, so that can't be a
3677
'The commit message is a file name: "%(f)s".\n'
3678
'(use --file "%(f)s" to take commit message from that file)'
3680
ui.ui_factory.show_warning(warning_msg)
3682
message = message.replace('\r\n', '\n')
3683
message = message.replace('\r', '\n')
3685
raise errors.BzrCommandError(gettext(
3686
"please specify either --message or --file"))
3688
def get_message(commit_obj):
3689
"""Callback to get commit message"""
3691
with open(file, 'rb') as f:
3692
my_message = f.read().decode(osutils.get_user_encoding())
3693
elif message is not None:
3694
my_message = message
3696
# No message supplied: make one up.
3697
# text is the status of the tree
3698
text = make_commit_message_template_encoded(tree,
3699
selected_list, diff=show_diff,
3700
output_encoding=osutils.get_user_encoding())
3701
# start_message is the template generated from hooks
3702
# XXX: Warning - looks like hooks return unicode,
3703
# make_commit_message_template_encoded returns user encoding.
3704
# We probably want to be using edit_commit_message instead to
3706
my_message = set_commit_message(commit_obj)
3707
if my_message is None:
3708
start_message = generate_commit_message_template(
3710
if start_message is not None:
3711
start_message = start_message.encode(
3712
osutils.get_user_encoding())
3713
my_message = edit_commit_message_encoded(text,
3714
start_message=start_message)
3715
if my_message is None:
3716
raise errors.BzrCommandError(gettext("please specify a commit"
3717
" message with either --message or --file"))
3718
if my_message == "":
3719
raise errors.BzrCommandError(gettext("Empty commit message specified."
3720
" Please specify a commit message with either"
3721
" --message or --file or leave a blank message"
3722
" with --message \"\"."))
3725
# The API permits a commit with a filter of [] to mean 'select nothing'
3726
# but the command line should not do that.
3727
if not selected_list:
3728
selected_list = None
3730
tree.commit(message_callback=get_message,
3731
specific_files=selected_list,
3732
allow_pointless=unchanged, strict=strict, local=local,
3733
reporter=None, verbose=verbose, revprops=properties,
3734
authors=author, timestamp=commit_stamp,
3736
exclude=tree.safe_relpath_files(exclude),
3738
except PointlessCommit:
3739
raise errors.BzrCommandError(gettext("No changes to commit."
3740
" Please 'brz add' the files you want to commit, or use"
3741
" --unchanged to force an empty commit."))
3742
except ConflictsInTree:
3743
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3744
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3746
except StrictCommitFailed:
3747
raise errors.BzrCommandError(gettext("Commit refused because there are"
3748
" unknown files in the working tree."))
3749
except errors.BoundBranchOutOfDate as e:
3750
e.extra_help = (gettext("\n"
3751
'To commit to master branch, run update and then commit.\n'
3752
'You can also pass --local to commit to continue working '
3757
class cmd_check(Command):
3758
__doc__ = """Validate working tree structure, branch consistency and repository history.
3760
This command checks various invariants about branch and repository storage
3761
to detect data corruption or brz bugs.
3763
The working tree and branch checks will only give output if a problem is
3764
detected. The output fields of the repository check are:
3767
This is just the number of revisions checked. It doesn't
3771
This is just the number of versionedfiles checked. It
3772
doesn't indicate a problem.
3774
unreferenced ancestors
3775
Texts that are ancestors of other texts, but
3776
are not properly referenced by the revision ancestry. This is a
3777
subtle problem that Bazaar can work around.
3780
This is the total number of unique file contents
3781
seen in the checked revisions. It does not indicate a problem.
3784
This is the total number of repeated texts seen
3785
in the checked revisions. Texts can be repeated when their file
3786
entries are modified, but the file contents are not. It does not
3789
If no restrictions are specified, all Bazaar data that is found at the given
3790
location will be checked.
3794
Check the tree and branch at 'foo'::
3796
brz check --tree --branch foo
3798
Check only the repository at 'bar'::
3800
brz check --repo bar
3802
Check everything at 'baz'::
3807
_see_also = ['reconcile']
3808
takes_args = ['path?']
3809
takes_options = ['verbose',
3810
Option('branch', help="Check the branch related to the"
3811
" current directory."),
3812
Option('repo', help="Check the repository related to the"
3813
" current directory."),
3814
Option('tree', help="Check the working tree related to"
3815
" the current directory.")]
3817
def run(self, path=None, verbose=False, branch=False, repo=False,
3819
from .check import check_dwim
3822
if not branch and not repo and not tree:
3823
branch = repo = tree = True
3824
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3827
class cmd_upgrade(Command):
3828
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3830
When the default format has changed after a major new release of
3831
Bazaar, you may be informed during certain operations that you
3832
should upgrade. Upgrading to a newer format may improve performance
3833
or make new features available. It may however limit interoperability
3834
with older repositories or with older versions of Bazaar.
3836
If you wish to upgrade to a particular format rather than the
3837
current default, that can be specified using the --format option.
3838
As a consequence, you can use the upgrade command this way to
3839
"downgrade" to an earlier format, though some conversions are
3840
a one way process (e.g. changing from the 1.x default to the
3841
2.x default) so downgrading is not always possible.
3843
A backup.bzr.~#~ directory is created at the start of the conversion
3844
process (where # is a number). By default, this is left there on
3845
completion. If the conversion fails, delete the new .bzr directory
3846
and rename this one back in its place. Use the --clean option to ask
3847
for the backup.bzr directory to be removed on successful conversion.
3848
Alternatively, you can delete it by hand if everything looks good
3851
If the location given is a shared repository, dependent branches
3852
are also converted provided the repository converts successfully.
3853
If the conversion of a branch fails, remaining branches are still
3856
For more information on upgrades, see the Bazaar Upgrade Guide,
3857
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3860
_see_also = ['check', 'reconcile', 'formats']
3861
takes_args = ['url?']
3863
RegistryOption('format',
3864
help='Upgrade to a specific format. See "brz help'
3865
' formats" for details.',
3866
lazy_registry=('breezy.controldir', 'format_registry'),
3867
converter=lambda name: controldir.format_registry.make_controldir(
3869
value_switches=True, title='Branch format'),
3871
help='Remove the backup.bzr directory if successful.'),
3873
help="Show what would be done, but don't actually do anything."),
3876
def run(self, url='.', format=None, clean=False, dry_run=False):
3877
from .upgrade import upgrade
3878
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3880
if len(exceptions) == 1:
3881
# Compatibility with historical behavior
3887
class cmd_whoami(Command):
3888
__doc__ = """Show or set brz user id.
3891
Show the email of the current user::
3895
Set the current user::
3897
brz whoami "Frank Chu <fchu@example.com>"
3899
takes_options = ['directory',
3901
help='Display email address only.'),
3903
help='Set identity for the current branch instead of '
3906
takes_args = ['name?']
3907
encoding_type = 'replace'
3910
def run(self, email=False, branch=False, name=None, directory=None):
3912
if directory is None:
3913
# use branch if we're inside one; otherwise global config
3915
c = Branch.open_containing(u'.')[0].get_config_stack()
3916
except errors.NotBranchError:
3917
c = _mod_config.GlobalStack()
3919
c = Branch.open(directory).get_config_stack()
3920
identity = c.get('email')
3922
self.outf.write(_mod_config.extract_email_address(identity)
3925
self.outf.write(identity + '\n')
3929
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3932
# display a warning if an email address isn't included in the given name.
3934
_mod_config.extract_email_address(name)
3935
except _mod_config.NoEmailInUsername:
3936
warning('"%s" does not seem to contain an email address. '
3937
'This is allowed, but not recommended.', name)
3939
# use global config unless --branch given
3941
if directory is None:
3942
c = Branch.open_containing(u'.')[0].get_config_stack()
3944
b = Branch.open(directory)
3945
self.add_cleanup(b.lock_write().unlock)
3946
c = b.get_config_stack()
3948
c = _mod_config.GlobalStack()
3949
c.set('email', name)
3952
class cmd_nick(Command):
3953
__doc__ = """Print or set the branch nickname.
3955
If unset, the colocated branch name is used for colocated branches, and
3956
the branch directory name is used for other branches. To print the
3957
current nickname, execute with no argument.
3959
Bound branches use the nickname of its master branch unless it is set
3963
_see_also = ['info']
3964
takes_args = ['nickname?']
3965
takes_options = ['directory']
3967
def run(self, nickname=None, directory=u'.'):
3968
branch = Branch.open_containing(directory)[0]
3969
if nickname is None:
3970
self.printme(branch)
3972
branch.nick = nickname
3975
def printme(self, branch):
3976
self.outf.write('%s\n' % branch.nick)
3979
class cmd_alias(Command):
3980
__doc__ = """Set/unset and display aliases.
3983
Show the current aliases::
3987
Show the alias specified for 'll'::
3991
Set an alias for 'll'::
3993
brz alias ll="log --line -r-10..-1"
3995
To remove an alias for 'll'::
3997
brz alias --remove ll
4000
takes_args = ['name?']
4002
Option('remove', help='Remove the alias.'),
4005
def run(self, name=None, remove=False):
4007
self.remove_alias(name)
4009
self.print_aliases()
4011
equal_pos = name.find('=')
4013
self.print_alias(name)
4015
self.set_alias(name[:equal_pos], name[equal_pos + 1:])
4017
def remove_alias(self, alias_name):
4018
if alias_name is None:
4019
raise errors.BzrCommandError(gettext(
4020
'brz alias --remove expects an alias to remove.'))
4021
# If alias is not found, print something like:
4022
# unalias: foo: not found
4023
c = _mod_config.GlobalConfig()
4024
c.unset_alias(alias_name)
4027
def print_aliases(self):
4028
"""Print out the defined aliases in a similar format to bash."""
4029
aliases = _mod_config.GlobalConfig().get_aliases()
4030
for key, value in sorted(viewitems(aliases)):
4031
self.outf.write('brz alias %s="%s"\n' % (key, value))
4034
def print_alias(self, alias_name):
4035
from .commands import get_alias
4036
alias = get_alias(alias_name)
4038
self.outf.write("brz alias: %s: not found\n" % alias_name)
4041
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
4043
def set_alias(self, alias_name, alias_command):
4044
"""Save the alias in the global config."""
4045
c = _mod_config.GlobalConfig()
4046
c.set_alias(alias_name, alias_command)
4049
class cmd_selftest(Command):
4050
__doc__ = """Run internal test suite.
4052
If arguments are given, they are regular expressions that say which tests
4053
should run. Tests matching any expression are run, and other tests are
4056
Alternatively if --first is given, matching tests are run first and then
4057
all other tests are run. This is useful if you have been working in a
4058
particular area, but want to make sure nothing else was broken.
4060
If --exclude is given, tests that match that regular expression are
4061
excluded, regardless of whether they match --first or not.
4063
To help catch accidential dependencies between tests, the --randomize
4064
option is useful. In most cases, the argument used is the word 'now'.
4065
Note that the seed used for the random number generator is displayed
4066
when this option is used. The seed can be explicitly passed as the
4067
argument to this option if required. This enables reproduction of the
4068
actual ordering used if and when an order sensitive problem is encountered.
4070
If --list-only is given, the tests that would be run are listed. This is
4071
useful when combined with --first, --exclude and/or --randomize to
4072
understand their impact. The test harness reports "Listed nn tests in ..."
4073
instead of "Ran nn tests in ..." when list mode is enabled.
4075
If the global option '--no-plugins' is given, plugins are not loaded
4076
before running the selftests. This has two effects: features provided or
4077
modified by plugins will not be tested, and tests provided by plugins will
4080
Tests that need working space on disk use a common temporary directory,
4081
typically inside $TMPDIR or /tmp.
4083
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4084
into a pdb postmortem session.
4086
The --coverage=DIRNAME global option produces a report with covered code
4090
Run only tests relating to 'ignore'::
4094
Disable plugins and list tests as they're run::
4096
brz --no-plugins selftest -v
4098
# NB: this is used from the class without creating an instance, which is
4099
# why it does not have a self parameter.
4101
def get_transport_type(typestring):
4102
"""Parse and return a transport specifier."""
4103
if typestring == "sftp":
4104
from .tests import stub_sftp
4105
return stub_sftp.SFTPAbsoluteServer
4106
elif typestring == "memory":
4107
from .tests import test_server
4108
return memory.MemoryServer
4109
elif typestring == "fakenfs":
4110
from .tests import test_server
4111
return test_server.FakeNFSServer
4112
msg = "No known transport type %s. Supported types are: sftp\n" %\
4114
raise errors.BzrCommandError(msg)
4117
takes_args = ['testspecs*']
4118
takes_options = ['verbose',
4120
help='Stop when one test fails.',
4124
help='Use a different transport by default '
4125
'throughout the test suite.',
4126
type=get_transport_type),
4128
help='Run the benchmarks rather than selftests.',
4130
Option('lsprof-timed',
4131
help='Generate lsprof output for benchmarked'
4132
' sections of code.'),
4133
Option('lsprof-tests',
4134
help='Generate lsprof output for each test.'),
4136
help='Run all tests, but run specified tests first.',
4140
help='List the tests instead of running them.'),
4141
RegistryOption('parallel',
4142
help="Run the test suite in parallel.",
4144
'breezy.tests', 'parallel_registry'),
4145
value_switches=False,
4147
Option('randomize', type=text_type, argname="SEED",
4148
help='Randomize the order of tests using the given'
4149
' seed or "now" for the current time.'),
4150
ListOption('exclude', type=text_type, argname="PATTERN",
4152
help='Exclude tests that match this regular'
4155
help='Output test progress via subunit v1.'),
4157
help='Output test progress via subunit v2.'),
4158
Option('strict', help='Fail on missing dependencies or '
4160
Option('load-list', type=text_type, argname='TESTLISTFILE',
4161
help='Load a test id list from a text file.'),
4162
ListOption('debugflag', type=text_type, short_name='E',
4163
help='Turn on a selftest debug flag.'),
4164
ListOption('starting-with', type=text_type, argname='TESTID',
4165
param_name='starting_with', short_name='s',
4166
help='Load only the tests starting with TESTID.'),
4168
help="By default we disable fsync and fdatasync"
4169
" while running the test suite.")
4171
encoding_type = 'replace'
4174
Command.__init__(self)
4175
self.additional_selftest_args = {}
4177
def run(self, testspecs_list=None, verbose=False, one=False,
4178
transport=None, benchmark=None,
4180
first=False, list_only=False,
4181
randomize=None, exclude=None, strict=False,
4182
load_list=None, debugflag=None, starting_with=None, subunit1=False,
4183
subunit2=False, parallel=None, lsprof_tests=False, sync=False):
4185
# During selftest, disallow proxying, as it can cause severe
4186
# performance penalties and is only needed for thread
4187
# safety. The selftest command is assumed to not use threads
4188
# too heavily. The call should be as early as possible, as
4189
# error reporting for past duplicate imports won't have useful
4191
if sys.version_info[0] < 3:
4192
# TODO(pad.lv/1696545): Allow proxying on Python 3, since
4193
# disallowing it currently leads to failures in many places.
4194
lazy_import.disallow_proxying()
4199
raise errors.BzrCommandError("tests not available. Install the "
4200
"breezy tests to run the breezy testsuite.")
4202
if testspecs_list is not None:
4203
pattern = '|'.join(testspecs_list)
4208
from .tests import SubUnitBzrRunnerv1
4210
raise errors.BzrCommandError(gettext(
4211
"subunit not available. subunit needs to be installed "
4212
"to use --subunit."))
4213
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
4214
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4215
# stdout, which would corrupt the subunit stream.
4216
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4217
# following code can be deleted when it's sufficiently deployed
4218
# -- vila/mgz 20100514
4219
if (sys.platform == "win32"
4220
and getattr(sys.stdout, 'fileno', None) is not None):
4222
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4225
from .tests import SubUnitBzrRunnerv2
4227
raise errors.BzrCommandError(gettext(
4228
"subunit not available. subunit "
4229
"needs to be installed to use --subunit2."))
4230
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
4233
self.additional_selftest_args.setdefault(
4234
'suite_decorators', []).append(parallel)
4236
raise errors.BzrCommandError(gettext(
4237
"--benchmark is no longer supported from brz 2.2; "
4238
"use bzr-usertest instead"))
4239
test_suite_factory = None
4241
exclude_pattern = None
4243
exclude_pattern = '(' + '|'.join(exclude) + ')'
4245
self._disable_fsync()
4246
selftest_kwargs = {"verbose": verbose,
4248
"stop_on_failure": one,
4249
"transport": transport,
4250
"test_suite_factory": test_suite_factory,
4251
"lsprof_timed": lsprof_timed,
4252
"lsprof_tests": lsprof_tests,
4253
"matching_tests_first": first,
4254
"list_only": list_only,
4255
"random_seed": randomize,
4256
"exclude_pattern": exclude_pattern,
4258
"load_list": load_list,
4259
"debug_flags": debugflag,
4260
"starting_with": starting_with
4262
selftest_kwargs.update(self.additional_selftest_args)
4264
# Make deprecation warnings visible, unless -Werror is set
4265
cleanup = symbol_versioning.activate_deprecation_warnings(
4268
result = tests.selftest(**selftest_kwargs)
4271
return int(not result)
4273
def _disable_fsync(self):
4274
"""Change the 'os' functionality to not synchronize."""
4275
self._orig_fsync = getattr(os, 'fsync', None)
4276
if self._orig_fsync is not None:
4277
os.fsync = lambda filedes: None
4278
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4279
if self._orig_fdatasync is not None:
4280
os.fdatasync = lambda filedes: None
4283
class cmd_version(Command):
4284
__doc__ = """Show version of brz."""
4286
encoding_type = 'replace'
4288
Option("short", help="Print just the version number."),
4292
def run(self, short=False):
4293
from .version import show_version
4295
self.outf.write(breezy.version_string + '\n')
4297
show_version(to_file=self.outf)
4300
class cmd_rocks(Command):
4301
__doc__ = """Statement of optimism."""
4307
self.outf.write(gettext("It sure does!\n"))
4310
class cmd_find_merge_base(Command):
4311
__doc__ = """Find and print a base revision for merging two branches."""
4312
# TODO: Options to specify revisions on either side, as if
4313
# merging only part of the history.
4314
takes_args = ['branch', 'other']
4318
def run(self, branch, other):
4319
from .revision import ensure_null
4321
branch1 = Branch.open_containing(branch)[0]
4322
branch2 = Branch.open_containing(other)[0]
4323
self.add_cleanup(branch1.lock_read().unlock)
4324
self.add_cleanup(branch2.lock_read().unlock)
4325
last1 = ensure_null(branch1.last_revision())
4326
last2 = ensure_null(branch2.last_revision())
4328
graph = branch1.repository.get_graph(branch2.repository)
4329
base_rev_id = graph.find_unique_lca(last1, last2)
4331
self.outf.write(gettext('merge base is revision %s\n') %
4332
base_rev_id.decode('utf-8'))
4335
class cmd_merge(Command):
4336
__doc__ = """Perform a three-way merge.
4338
The source of the merge can be specified either in the form of a branch,
4339
or in the form of a path to a file containing a merge directive generated
4340
with brz send. If neither is specified, the default is the upstream branch
4341
or the branch most recently merged using --remember. The source of the
4342
merge may also be specified in the form of a path to a file in another
4343
branch: in this case, only the modifications to that file are merged into
4344
the current working tree.
4346
When merging from a branch, by default brz will try to merge in all new
4347
work from the other branch, automatically determining an appropriate base
4348
revision. If this fails, you may need to give an explicit base.
4350
To pick a different ending revision, pass "--revision OTHER". brz will
4351
try to merge in all new work up to and including revision OTHER.
4353
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4354
through OTHER, excluding BASE but including OTHER, will be merged. If this
4355
causes some revisions to be skipped, i.e. if the destination branch does
4356
not already contain revision BASE, such a merge is commonly referred to as
4357
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4358
cherrypicks. The changes look like a normal commit, and the history of the
4359
changes from the other branch is not stored in the commit.
4361
Revision numbers are always relative to the source branch.
4363
Merge will do its best to combine the changes in two branches, but there
4364
are some kinds of problems only a human can fix. When it encounters those,
4365
it will mark a conflict. A conflict means that you need to fix something,
4366
before you can commit.
4368
Use brz resolve when you have fixed a problem. See also brz conflicts.
4370
If there is no default branch set, the first merge will set it (use
4371
--no-remember to avoid setting it). After that, you can omit the branch
4372
to use the default. To change the default, use --remember. The value will
4373
only be saved if the remote location can be accessed.
4375
The results of the merge are placed into the destination working
4376
directory, where they can be reviewed (with brz diff), tested, and then
4377
committed to record the result of the merge.
4379
merge refuses to run if there are any uncommitted changes, unless
4380
--force is given. If --force is given, then the changes from the source
4381
will be merged with the current working tree, including any uncommitted
4382
changes in the tree. The --force option can also be used to create a
4383
merge revision which has more than two parents.
4385
If one would like to merge changes from the working tree of the other
4386
branch without merging any committed revisions, the --uncommitted option
4389
To select only some changes to merge, use "merge -i", which will prompt
4390
you to apply each diff hunk and file change, similar to "shelve".
4393
To merge all new revisions from brz.dev::
4395
brz merge ../brz.dev
4397
To merge changes up to and including revision 82 from brz.dev::
4399
brz merge -r 82 ../brz.dev
4401
To merge the changes introduced by 82, without previous changes::
4403
brz merge -r 81..82 ../brz.dev
4405
To apply a merge directive contained in /tmp/merge::
4407
brz merge /tmp/merge
4409
To create a merge revision with three parents from two branches
4410
feature1a and feature1b:
4412
brz merge ../feature1a
4413
brz merge ../feature1b --force
4414
brz commit -m 'revision with three parents'
4417
encoding_type = 'exact'
4418
_see_also = ['update', 'remerge', 'status-flags', 'send']
4419
takes_args = ['location?']
4424
help='Merge even if the destination tree has uncommitted changes.'),
4428
Option('show-base', help="Show base revision text in "
4430
Option('uncommitted', help='Apply uncommitted changes'
4431
' from a working copy, instead of branch changes.'),
4432
Option('pull', help='If the destination is already'
4433
' completely merged into the source, pull from the'
4434
' source rather than merging. When this happens,'
4435
' you do not need to commit the result.'),
4436
custom_help('directory',
4437
help='Branch to merge into, '
4438
'rather than the one containing the working directory.'),
4439
Option('preview', help='Instead of merging, show a diff of the'
4441
Option('interactive', help='Select changes interactively.',
4445
def run(self, location=None, revision=None, force=False,
4446
merge_type=None, show_base=False, reprocess=None, remember=None,
4447
uncommitted=False, pull=False,
4452
if merge_type is None:
4453
merge_type = _mod_merge.Merge3Merger
4455
if directory is None:
4457
possible_transports = []
4459
allow_pending = True
4460
verified = 'inapplicable'
4462
tree = WorkingTree.open_containing(directory)[0]
4463
if tree.branch.last_revision() == _mod_revision.NULL_REVISION:
4464
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4465
'https://bugs.launchpad.net/bzr/+bug/308562'))
4467
# die as quickly as possible if there are uncommitted changes
4469
if tree.has_changes():
4470
raise errors.UncommittedChanges(tree)
4472
view_info = _get_view_info_for_change_reporter(tree)
4473
change_reporter = delta._ChangeReporter(
4474
unversioned_filter=tree.is_ignored, view_info=view_info)
4475
pb = ui.ui_factory.nested_progress_bar()
4476
self.add_cleanup(pb.finished)
4477
self.add_cleanup(tree.lock_write().unlock)
4478
if location is not None:
4480
mergeable = bundle.read_mergeable_from_url(location,
4481
possible_transports=possible_transports)
4482
except errors.NotABundle:
4486
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4487
' with bundles or merge directives.'))
4489
if revision is not None:
4490
raise errors.BzrCommandError(gettext(
4491
'Cannot use -r with merge directives or bundles'))
4492
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4495
if merger is None and uncommitted:
4496
if revision is not None and len(revision) > 0:
4497
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4498
' --revision at the same time.'))
4499
merger = self.get_merger_from_uncommitted(tree, location, None)
4500
allow_pending = False
4503
merger, allow_pending = self._get_merger_from_branch(tree,
4504
location, revision, remember, possible_transports, None)
4506
merger.merge_type = merge_type
4507
merger.reprocess = reprocess
4508
merger.show_base = show_base
4509
self.sanity_check_merger(merger)
4510
if (merger.base_rev_id == merger.other_rev_id and
4511
merger.other_rev_id is not None):
4512
# check if location is a nonexistent file (and not a branch) to
4513
# disambiguate the 'Nothing to do'
4514
if merger.interesting_files:
4515
if not merger.other_tree.has_filename(
4516
merger.interesting_files[0]):
4517
note(gettext("merger: ") + str(merger))
4518
raise errors.PathsDoNotExist([location])
4519
note(gettext('Nothing to do.'))
4521
if pull and not preview:
4522
if merger.interesting_files is not None:
4523
raise errors.BzrCommandError(
4524
gettext('Cannot pull individual files'))
4525
if (merger.base_rev_id == tree.last_revision()):
4526
result = tree.pull(merger.other_branch, False,
4527
merger.other_rev_id)
4528
result.report(self.outf)
4530
if merger.this_basis is None:
4531
raise errors.BzrCommandError(gettext(
4532
"This branch has no commits."
4533
" (perhaps you would prefer 'brz pull')"))
4535
return self._do_preview(merger)
4537
return self._do_interactive(merger)
4539
return self._do_merge(merger, change_reporter, allow_pending,
4542
def _get_preview(self, merger):
4543
tree_merger = merger.make_merger()
4544
tt = tree_merger.make_preview_transform()
4545
self.add_cleanup(tt.finalize)
4546
result_tree = tt.get_preview_tree()
4549
def _do_preview(self, merger):
4550
from .diff import show_diff_trees
4551
result_tree = self._get_preview(merger)
4552
path_encoding = osutils.get_diff_header_encoding()
4553
show_diff_trees(merger.this_tree, result_tree, self.outf,
4554
old_label='', new_label='',
4555
path_encoding=path_encoding)
4557
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4558
merger.change_reporter = change_reporter
4559
conflict_count = merger.do_merge()
4561
merger.set_pending()
4562
if verified == 'failed':
4563
warning('Preview patch does not match changes')
4564
if conflict_count != 0:
4569
def _do_interactive(self, merger):
4570
"""Perform an interactive merge.
4572
This works by generating a preview tree of the merge, then using
4573
Shelver to selectively remove the differences between the working tree
4574
and the preview tree.
4576
from . import shelf_ui
4577
result_tree = self._get_preview(merger)
4578
writer = breezy.option.diff_writer_registry.get()
4579
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4580
reporter=shelf_ui.ApplyReporter(),
4581
diff_writer=writer(self.outf))
4587
def sanity_check_merger(self, merger):
4588
if (merger.show_base and
4589
merger.merge_type is not _mod_merge.Merge3Merger):
4590
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4591
" merge type. %s") % merger.merge_type)
4592
if merger.reprocess is None:
4593
if merger.show_base:
4594
merger.reprocess = False
4596
# Use reprocess if the merger supports it
4597
merger.reprocess = merger.merge_type.supports_reprocess
4598
if merger.reprocess and not merger.merge_type.supports_reprocess:
4599
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4600
" for merge type %s.") %
4602
if merger.reprocess and merger.show_base:
4603
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4606
if (merger.merge_type.requires_file_merge_plan and
4607
(not getattr(merger.this_tree, 'plan_file_merge', None) or
4608
not getattr(merger.other_tree, 'plan_file_merge', None) or
4609
(merger.base_tree is not None and
4610
not getattr(merger.base_tree, 'plan_file_merge', None)))):
4611
raise errors.BzrCommandError(
4612
gettext('Plan file merge unsupported: '
4613
'Merge type incompatible with tree formats.'))
4615
def _get_merger_from_branch(self, tree, location, revision, remember,
4616
possible_transports, pb):
4617
"""Produce a merger from a location, assuming it refers to a branch."""
4618
# find the branch locations
4619
other_loc, user_location = self._select_branch_location(tree, location,
4621
if revision is not None and len(revision) == 2:
4622
base_loc, _unused = self._select_branch_location(tree,
4623
location, revision, 0)
4625
base_loc = other_loc
4627
other_branch, other_path = Branch.open_containing(other_loc,
4628
possible_transports)
4629
if base_loc == other_loc:
4630
base_branch = other_branch
4632
base_branch, base_path = Branch.open_containing(base_loc,
4633
possible_transports)
4634
# Find the revision ids
4635
other_revision_id = None
4636
base_revision_id = None
4637
if revision is not None:
4638
if len(revision) >= 1:
4639
other_revision_id = revision[-1].as_revision_id(other_branch)
4640
if len(revision) == 2:
4641
base_revision_id = revision[0].as_revision_id(base_branch)
4642
if other_revision_id is None:
4643
other_revision_id = _mod_revision.ensure_null(
4644
other_branch.last_revision())
4645
# Remember where we merge from. We need to remember if:
4646
# - user specify a location (and we don't merge from the parent
4648
# - user ask to remember or there is no previous location set to merge
4649
# from and user didn't ask to *not* remember
4650
if (user_location is not None
4652
(remember is None and
4653
tree.branch.get_submit_branch() is None)))):
4654
tree.branch.set_submit_branch(other_branch.base)
4655
# Merge tags (but don't set them in the master branch yet, the user
4656
# might revert this merge). Commit will propagate them.
4657
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4658
merger = _mod_merge.Merger.from_revision_ids(tree,
4659
other_revision_id, base_revision_id, other_branch, base_branch)
4660
if other_path != '':
4661
allow_pending = False
4662
merger.interesting_files = [other_path]
4664
allow_pending = True
4665
return merger, allow_pending
4667
def get_merger_from_uncommitted(self, tree, location, pb):
4668
"""Get a merger for uncommitted changes.
4670
:param tree: The tree the merger should apply to.
4671
:param location: The location containing uncommitted changes.
4672
:param pb: The progress bar to use for showing progress.
4674
location = self._select_branch_location(tree, location)[0]
4675
other_tree, other_path = WorkingTree.open_containing(location)
4676
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4677
if other_path != '':
4678
merger.interesting_files = [other_path]
4681
def _select_branch_location(self, tree, user_location, revision=None,
4683
"""Select a branch location, according to possible inputs.
4685
If provided, branches from ``revision`` are preferred. (Both
4686
``revision`` and ``index`` must be supplied.)
4688
Otherwise, the ``location`` parameter is used. If it is None, then the
4689
``submit`` or ``parent`` location is used, and a note is printed.
4691
:param tree: The working tree to select a branch for merging into
4692
:param location: The location entered by the user
4693
:param revision: The revision parameter to the command
4694
:param index: The index to use for the revision parameter. Negative
4695
indices are permitted.
4696
:return: (selected_location, user_location). The default location
4697
will be the user-entered location.
4699
if (revision is not None and index is not None
4700
and revision[index] is not None):
4701
branch = revision[index].get_branch()
4702
if branch is not None:
4703
return branch, branch
4704
if user_location is None:
4705
location = self._get_remembered(tree, 'Merging from')
4707
location = user_location
4708
return location, user_location
4710
def _get_remembered(self, tree, verb_string):
4711
"""Use tree.branch's parent if none was supplied.
4713
Report if the remembered location was used.
4715
stored_location = tree.branch.get_submit_branch()
4716
stored_location_type = "submit"
4717
if stored_location is None:
4718
stored_location = tree.branch.get_parent()
4719
stored_location_type = "parent"
4720
mutter("%s", stored_location)
4721
if stored_location is None:
4722
raise errors.BzrCommandError(
4723
gettext("No location specified or remembered"))
4724
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4725
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4726
stored_location_type, display_url))
4727
return stored_location
4730
class cmd_remerge(Command):
4731
__doc__ = """Redo a merge.
4733
Use this if you want to try a different merge technique while resolving
4734
conflicts. Some merge techniques are better than others, and remerge
4735
lets you try different ones on different files.
4737
The options for remerge have the same meaning and defaults as the ones for
4738
merge. The difference is that remerge can (only) be run when there is a
4739
pending merge, and it lets you specify particular files.
4742
Re-do the merge of all conflicted files, and show the base text in
4743
conflict regions, in addition to the usual THIS and OTHER texts::
4745
brz remerge --show-base
4747
Re-do the merge of "foobar", using the weave merge algorithm, with
4748
additional processing to reduce the size of conflict regions::
4750
brz remerge --merge-type weave --reprocess foobar
4752
takes_args = ['file*']
4757
help="Show base revision text in conflicts."),
4760
def run(self, file_list=None, merge_type=None, show_base=False,
4762
from .conflicts import restore
4763
if merge_type is None:
4764
merge_type = _mod_merge.Merge3Merger
4765
tree, file_list = WorkingTree.open_containing_paths(file_list)
4766
self.add_cleanup(tree.lock_write().unlock)
4767
parents = tree.get_parent_ids()
4768
if len(parents) != 2:
4769
raise errors.BzrCommandError(
4770
gettext("Sorry, remerge only works after normal"
4771
" merges. Not cherrypicking or multi-merges."))
4772
interesting_files = None
4774
conflicts = tree.conflicts()
4775
if file_list is not None:
4776
interesting_files = set()
4777
for filename in file_list:
4778
if not tree.is_versioned(filename):
4779
raise errors.NotVersionedError(filename)
4780
interesting_files.add(filename)
4781
if tree.kind(filename) != "directory":
4784
for path, ie in tree.iter_entries_by_dir(
4785
specific_files=[filename]):
4786
interesting_files.add(path)
4787
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4789
# Remerge only supports resolving contents conflicts
4790
allowed_conflicts = ('text conflict', 'contents conflict')
4791
restore_files = [c.path for c in conflicts
4792
if c.typestring in allowed_conflicts]
4793
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
4794
tree.set_conflicts(ConflictList(new_conflicts))
4795
if file_list is not None:
4796
restore_files = file_list
4797
for filename in restore_files:
4799
restore(tree.abspath(filename))
4800
except errors.NotConflicted:
4802
# Disable pending merges, because the file texts we are remerging
4803
# have not had those merges performed. If we use the wrong parents
4804
# list, we imply that the working tree text has seen and rejected
4805
# all the changes from the other tree, when in fact those changes
4806
# have not yet been seen.
4807
tree.set_parent_ids(parents[:1])
4809
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4810
merger.interesting_files = interesting_files
4811
merger.merge_type = merge_type
4812
merger.show_base = show_base
4813
merger.reprocess = reprocess
4814
conflicts = merger.do_merge()
4816
tree.set_parent_ids(parents)
4823
class cmd_revert(Command):
4825
Set files in the working tree back to the contents of a previous revision.
4827
Giving a list of files will revert only those files. Otherwise, all files
4828
will be reverted. If the revision is not specified with '--revision', the
4829
working tree basis revision is used. A revert operation affects only the
4830
working tree, not any revision history like the branch and repository or
4831
the working tree basis revision.
4833
To remove only some changes, without reverting to a prior version, use
4834
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4835
will remove the changes introduced by the second last commit (-2), without
4836
affecting the changes introduced by the last commit (-1). To remove
4837
certain changes on a hunk-by-hunk basis, see the shelve command.
4838
To update the branch to a specific revision or the latest revision and
4839
update the working tree accordingly while preserving local changes, see the
4842
Uncommitted changes to files that are reverted will be discarded.
4843
Howver, by default, any files that have been manually changed will be
4844
backed up first. (Files changed only by merge are not backed up.) Backup
4845
files have '.~#~' appended to their name, where # is a number.
4847
When you provide files, you can use their current pathname or the pathname
4848
from the target revision. So you can use revert to "undelete" a file by
4849
name. If you name a directory, all the contents of that directory will be
4852
If you have newly added files since the target revision, they will be
4853
removed. If the files to be removed have been changed, backups will be
4854
created as above. Directories containing unknown files will not be
4857
The working tree contains a list of revisions that have been merged but
4858
not yet committed. These revisions will be included as additional parents
4859
of the next commit. Normally, using revert clears that list as well as
4860
reverting the files. If any files are specified, revert leaves the list
4861
of uncommitted merges alone and reverts only the files. Use ``brz revert
4862
.`` in the tree root to revert all files but keep the recorded merges,
4863
and ``brz revert --forget-merges`` to clear the pending merge list without
4864
reverting any files.
4866
Using "brz revert --forget-merges", it is possible to apply all of the
4867
changes from a branch in a single revision. To do this, perform the merge
4868
as desired. Then doing revert with the "--forget-merges" option will keep
4869
the content of the tree as it was, but it will clear the list of pending
4870
merges. The next commit will then contain all of the changes that are
4871
present in the other branch, but without any other parent revisions.
4872
Because this technique forgets where these changes originated, it may
4873
cause additional conflicts on later merges involving the same source and
4877
_see_also = ['cat', 'export', 'merge', 'shelve']
4880
Option('no-backup', "Do not save backups of reverted files."),
4881
Option('forget-merges',
4882
'Remove pending merge marker, without changing any files.'),
4884
takes_args = ['file*']
4886
def run(self, revision=None, no_backup=False, file_list=None,
4887
forget_merges=None):
4888
tree, file_list = WorkingTree.open_containing_paths(file_list)
4889
self.add_cleanup(tree.lock_tree_write().unlock)
4891
tree.set_parent_ids(tree.get_parent_ids()[:1])
4893
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4896
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4897
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4898
tree.revert(file_list, rev_tree, not no_backup, None,
4899
report_changes=True)
4902
class cmd_assert_fail(Command):
4903
__doc__ = """Test reporting of assertion failures"""
4904
# intended just for use in testing
4909
raise AssertionError("always fails")
4912
class cmd_help(Command):
4913
__doc__ = """Show help on a command or other topic.
4916
_see_also = ['topics']
4918
Option('long', 'Show help on all commands.'),
4920
takes_args = ['topic?']
4921
aliases = ['?', '--help', '-?', '-h']
4924
def run(self, topic=None, long=False):
4926
if topic is None and long:
4928
breezy.help.help(topic)
4931
class cmd_shell_complete(Command):
4932
__doc__ = """Show appropriate completions for context.
4934
For a list of all available commands, say 'brz shell-complete'.
4936
takes_args = ['context?']
4941
def run(self, context=None):
4942
from . import shellcomplete
4943
shellcomplete.shellcomplete(context)
4946
class cmd_missing(Command):
4947
__doc__ = """Show unmerged/unpulled revisions between two branches.
4949
OTHER_BRANCH may be local or remote.
4951
To filter on a range of revisions, you can use the command -r begin..end
4952
-r revision requests a specific revision, -r ..end or -r begin.. are
4956
1 - some missing revisions
4957
0 - no missing revisions
4961
Determine the missing revisions between this and the branch at the
4962
remembered pull location::
4966
Determine the missing revisions between this and another branch::
4968
brz missing http://server/branch
4970
Determine the missing revisions up to a specific revision on the other
4973
brz missing -r ..-10
4975
Determine the missing revisions up to a specific revision on this
4978
brz missing --my-revision ..-10
4981
_see_also = ['merge', 'pull']
4982
takes_args = ['other_branch?']
4985
Option('reverse', 'Reverse the order of revisions.'),
4987
'Display changes in the local branch only.'),
4988
Option('this', 'Same as --mine-only.'),
4989
Option('theirs-only',
4990
'Display changes in the remote branch only.'),
4991
Option('other', 'Same as --theirs-only.'),
4995
custom_help('revision',
4996
help='Filter on other branch revisions (inclusive). '
4997
'See "help revisionspec" for details.'),
4998
Option('my-revision',
4999
type=_parse_revision_str,
5000
help='Filter on local branch revisions (inclusive). '
5001
'See "help revisionspec" for details.'),
5002
Option('include-merged',
5003
'Show all revisions in addition to the mainline ones.'),
5004
Option('include-merges', hidden=True,
5005
help='Historical alias for --include-merged.'),
5007
encoding_type = 'replace'
5010
def run(self, other_branch=None, reverse=False, mine_only=False,
5012
log_format=None, long=False, short=False, line=False,
5013
show_ids=False, verbose=False, this=False, other=False,
5014
include_merged=None, revision=None, my_revision=None,
5016
from breezy.missing import find_unmerged, iter_log_revisions
5022
if include_merged is None:
5023
include_merged = False
5028
# TODO: We should probably check that we don't have mine-only and
5029
# theirs-only set, but it gets complicated because we also have
5030
# this and other which could be used.
5037
local_branch = Branch.open_containing(directory)[0]
5038
self.add_cleanup(local_branch.lock_read().unlock)
5040
parent = local_branch.get_parent()
5041
if other_branch is None:
5042
other_branch = parent
5043
if other_branch is None:
5044
raise errors.BzrCommandError(gettext("No peer location known"
5046
display_url = urlutils.unescape_for_display(parent,
5048
message(gettext("Using saved parent location: {0}\n").format(
5051
remote_branch = Branch.open(other_branch)
5052
if remote_branch.base == local_branch.base:
5053
remote_branch = local_branch
5055
self.add_cleanup(remote_branch.lock_read().unlock)
5057
local_revid_range = _revision_range_to_revid_range(
5058
_get_revision_range(my_revision, local_branch,
5061
remote_revid_range = _revision_range_to_revid_range(
5062
_get_revision_range(revision,
5063
remote_branch, self.name()))
5065
local_extra, remote_extra = find_unmerged(
5066
local_branch, remote_branch, restrict,
5067
backward=not reverse,
5068
include_merged=include_merged,
5069
local_revid_range=local_revid_range,
5070
remote_revid_range=remote_revid_range)
5072
if log_format is None:
5073
registry = log.log_formatter_registry
5074
log_format = registry.get_default(local_branch)
5075
lf = log_format(to_file=self.outf,
5077
show_timezone='original')
5080
if local_extra and not theirs_only:
5081
message(ngettext("You have %d extra revision:\n",
5082
"You have %d extra revisions:\n",
5086
if local_branch.supports_tags():
5087
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5088
for revision in iter_log_revisions(local_extra,
5089
local_branch.repository,
5092
lf.log_revision(revision)
5093
printed_local = True
5096
printed_local = False
5098
if remote_extra and not mine_only:
5099
if printed_local is True:
5101
message(ngettext("You are missing %d revision:\n",
5102
"You are missing %d revisions:\n",
5103
len(remote_extra)) %
5105
if remote_branch.supports_tags():
5106
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5107
for revision in iter_log_revisions(remote_extra,
5108
remote_branch.repository,
5111
lf.log_revision(revision)
5114
if mine_only and not local_extra:
5115
# We checked local, and found nothing extra
5116
message(gettext('This branch has no new revisions.\n'))
5117
elif theirs_only and not remote_extra:
5118
# We checked remote, and found nothing extra
5119
message(gettext('Other branch has no new revisions.\n'))
5120
elif not (mine_only or theirs_only or local_extra or
5122
# We checked both branches, and neither one had extra
5124
message(gettext("Branches are up to date.\n"))
5126
if not status_code and parent is None and other_branch is not None:
5127
self.add_cleanup(local_branch.lock_write().unlock)
5128
# handle race conditions - a parent might be set while we run.
5129
if local_branch.get_parent() is None:
5130
local_branch.set_parent(remote_branch.base)
5134
class cmd_pack(Command):
5135
__doc__ = """Compress the data within a repository.
5137
This operation compresses the data within a bazaar repository. As
5138
bazaar supports automatic packing of repository, this operation is
5139
normally not required to be done manually.
5141
During the pack operation, bazaar takes a backup of existing repository
5142
data, i.e. pack files. This backup is eventually removed by bazaar
5143
automatically when it is safe to do so. To save disk space by removing
5144
the backed up pack files, the --clean-obsolete-packs option may be
5147
Warning: If you use --clean-obsolete-packs and your machine crashes
5148
during or immediately after repacking, you may be left with a state
5149
where the deletion has been written to disk but the new packs have not
5150
been. In this case the repository may be unusable.
5153
_see_also = ['repositories']
5154
takes_args = ['branch_or_repo?']
5156
Option('clean-obsolete-packs',
5157
'Delete obsolete packs to save disk space.'),
5160
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5161
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5163
branch = dir.open_branch()
5164
repository = branch.repository
5165
except errors.NotBranchError:
5166
repository = dir.open_repository()
5167
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5170
class cmd_plugins(Command):
5171
__doc__ = """List the installed plugins.
5173
This command displays the list of installed plugins including
5174
version of plugin and a short description of each.
5176
--verbose shows the path where each plugin is located.
5178
A plugin is an external component for Bazaar that extends the
5179
revision control system, by adding or replacing code in Bazaar.
5180
Plugins can do a variety of things, including overriding commands,
5181
adding new commands, providing additional network transports and
5182
customizing log output.
5184
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5185
for further information on plugins including where to find them and how to
5186
install them. Instructions are also provided there on how to write new
5187
plugins using the Python programming language.
5189
takes_options = ['verbose']
5192
def run(self, verbose=False):
5193
from . import plugin
5194
# Don't give writelines a generator as some codecs don't like that
5195
self.outf.writelines(
5196
list(plugin.describe_plugins(show_paths=verbose)))
5199
class cmd_testament(Command):
5200
__doc__ = """Show testament (signing-form) of a revision."""
5203
Option('long', help='Produce long-format testament.'),
5205
help='Produce a strict-format testament.')]
5206
takes_args = ['branch?']
5207
encoding_type = 'exact'
5210
def run(self, branch=u'.', revision=None, long=False, strict=False):
5211
from .testament import Testament, StrictTestament
5213
testament_class = StrictTestament
5215
testament_class = Testament
5217
b = Branch.open_containing(branch)[0]
5219
b = Branch.open(branch)
5220
self.add_cleanup(b.lock_read().unlock)
5221
if revision is None:
5222
rev_id = b.last_revision()
5224
rev_id = revision[0].as_revision_id(b)
5225
t = testament_class.from_revision(b.repository, rev_id)
5227
self.outf.writelines(t.as_text_lines())
5229
self.outf.write(t.as_short_text())
5232
class cmd_annotate(Command):
5233
__doc__ = """Show the origin of each line in a file.
5235
This prints out the given file with an annotation on the left side
5236
indicating which revision, author and date introduced the change.
5238
If the origin is the same for a run of consecutive lines, it is
5239
shown only at the top, unless the --all option is given.
5241
# TODO: annotate directories; showing when each file was last changed
5242
# TODO: if the working copy is modified, show annotations on that
5243
# with new uncommitted lines marked
5244
aliases = ['ann', 'blame', 'praise']
5245
takes_args = ['filename']
5246
takes_options = [Option('all', help='Show annotations on all lines.'),
5247
Option('long', help='Show commit date in annotations.'),
5252
encoding_type = 'exact'
5255
def run(self, filename, all=False, long=False, revision=None,
5256
show_ids=False, directory=None):
5257
from .annotate import (
5260
wt, branch, relpath = \
5261
_open_directory_or_containing_tree_or_branch(filename, directory)
5263
self.add_cleanup(wt.lock_read().unlock)
5265
self.add_cleanup(branch.lock_read().unlock)
5266
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5267
self.add_cleanup(tree.lock_read().unlock)
5268
if wt is not None and revision is None:
5269
file_id = wt.path2id(relpath)
5271
file_id = tree.path2id(relpath)
5273
raise errors.NotVersionedError(filename)
5274
if wt is not None and revision is None:
5275
# If there is a tree and we're not annotating historical
5276
# versions, annotate the working tree's content.
5277
annotate_file_tree(wt, relpath, self.outf, long, all,
5280
annotate_file_tree(tree, relpath, self.outf, long, all,
5281
show_ids=show_ids, branch=branch)
5284
class cmd_re_sign(Command):
5285
__doc__ = """Create a digital signature for an existing revision."""
5286
# TODO be able to replace existing ones.
5288
hidden = True # is this right ?
5289
takes_args = ['revision_id*']
5290
takes_options = ['directory', 'revision']
5292
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5293
if revision_id_list is not None and revision is not None:
5294
raise errors.BzrCommandError(
5295
gettext('You can only supply one of revision_id or --revision'))
5296
if revision_id_list is None and revision is None:
5297
raise errors.BzrCommandError(
5298
gettext('You must supply either --revision or a revision_id'))
5299
b = WorkingTree.open_containing(directory)[0].branch
5300
self.add_cleanup(b.lock_write().unlock)
5301
return self._run(b, revision_id_list, revision)
5303
def _run(self, b, revision_id_list, revision):
5304
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5305
if revision_id_list is not None:
5306
b.repository.start_write_group()
5308
for revision_id in revision_id_list:
5309
revision_id = cache_utf8.encode(revision_id)
5310
b.repository.sign_revision(revision_id, gpg_strategy)
5311
except BaseException:
5312
b.repository.abort_write_group()
5315
b.repository.commit_write_group()
5316
elif revision is not None:
5317
if len(revision) == 1:
5318
revno, rev_id = revision[0].in_history(b)
5319
b.repository.start_write_group()
5321
b.repository.sign_revision(rev_id, gpg_strategy)
5322
except BaseException:
5323
b.repository.abort_write_group()
5326
b.repository.commit_write_group()
5327
elif len(revision) == 2:
5328
# are they both on rh- if so we can walk between them
5329
# might be nice to have a range helper for arbitrary
5330
# revision paths. hmm.
5331
from_revno, from_revid = revision[0].in_history(b)
5332
to_revno, to_revid = revision[1].in_history(b)
5333
if to_revid is None:
5334
to_revno = b.revno()
5335
if from_revno is None or to_revno is None:
5336
raise errors.BzrCommandError(
5337
gettext('Cannot sign a range of non-revision-history revisions'))
5338
b.repository.start_write_group()
5340
for revno in range(from_revno, to_revno + 1):
5341
b.repository.sign_revision(b.get_rev_id(revno),
5343
except BaseException:
5344
b.repository.abort_write_group()
5347
b.repository.commit_write_group()
5349
raise errors.BzrCommandError(
5350
gettext('Please supply either one revision, or a range.'))
5353
class cmd_bind(Command):
5354
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5355
If no branch is supplied, rebind to the last bound location.
5357
Once converted into a checkout, commits must succeed on the master branch
5358
before they will be applied to the local branch.
5360
Bound branches use the nickname of its master branch unless it is set
5361
locally, in which case binding will update the local nickname to be
5365
_see_also = ['checkouts', 'unbind']
5366
takes_args = ['location?']
5367
takes_options = ['directory']
5369
def run(self, location=None, directory=u'.'):
5370
b, relpath = Branch.open_containing(directory)
5371
if location is None:
5373
location = b.get_old_bound_location()
5374
except errors.UpgradeRequired:
5375
raise errors.BzrCommandError(
5376
gettext('No location supplied. '
5377
'This format does not remember old locations.'))
5379
if location is None:
5380
if b.get_bound_location() is not None:
5381
raise errors.BzrCommandError(
5382
gettext('Branch is already bound'))
5384
raise errors.BzrCommandError(
5385
gettext('No location supplied'
5386
' and no previous location known'))
5387
b_other = Branch.open(location)
5390
except errors.DivergedBranches:
5391
raise errors.BzrCommandError(
5392
gettext('These branches have diverged.'
5393
' Try merging, and then bind again.'))
5394
if b.get_config().has_explicit_nickname():
5395
b.nick = b_other.nick
5398
class cmd_unbind(Command):
5399
__doc__ = """Convert the current checkout into a regular branch.
5401
After unbinding, the local branch is considered independent and subsequent
5402
commits will be local only.
5405
_see_also = ['checkouts', 'bind']
5407
takes_options = ['directory']
5409
def run(self, directory=u'.'):
5410
b, relpath = Branch.open_containing(directory)
5412
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5415
class cmd_uncommit(Command):
5416
__doc__ = """Remove the last committed revision.
5418
--verbose will print out what is being removed.
5419
--dry-run will go through all the motions, but not actually
5422
If --revision is specified, uncommit revisions to leave the branch at the
5423
specified revision. For example, "brz uncommit -r 15" will leave the
5424
branch at revision 15.
5426
Uncommit leaves the working tree ready for a new commit. The only change
5427
it may make is to restore any pending merges that were present before
5431
# TODO: jam 20060108 Add an option to allow uncommit to remove
5432
# unreferenced information in 'branch-as-repository' branches.
5433
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5434
# information in shared branches as well.
5435
_see_also = ['commit']
5436
takes_options = ['verbose', 'revision',
5437
Option('dry-run', help='Don\'t actually make changes.'),
5438
Option('force', help='Say yes to all questions.'),
5440
help='Keep tags that point to removed revisions.'),
5442
help="Only remove the commits from the local "
5443
"branch when in a checkout."
5446
takes_args = ['location?']
5448
encoding_type = 'replace'
5450
def run(self, location=None, dry_run=False, verbose=False,
5451
revision=None, force=False, local=False, keep_tags=False):
5452
if location is None:
5454
control, relpath = controldir.ControlDir.open_containing(location)
5456
tree = control.open_workingtree()
5458
except (errors.NoWorkingTree, errors.NotLocalUrl):
5460
b = control.open_branch()
5462
if tree is not None:
5463
self.add_cleanup(tree.lock_write().unlock)
5465
self.add_cleanup(b.lock_write().unlock)
5466
return self._run(b, tree, dry_run, verbose, revision, force,
5469
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5471
from .log import log_formatter, show_log
5472
from .uncommit import uncommit
5474
last_revno, last_rev_id = b.last_revision_info()
5477
if revision is None:
5479
rev_id = last_rev_id
5481
# 'brz uncommit -r 10' actually means uncommit
5482
# so that the final tree is at revno 10.
5483
# but breezy.uncommit.uncommit() actually uncommits
5484
# the revisions that are supplied.
5485
# So we need to offset it by one
5486
revno = revision[0].in_history(b).revno + 1
5487
if revno <= last_revno:
5488
rev_id = b.get_rev_id(revno)
5490
if rev_id is None or _mod_revision.is_null(rev_id):
5491
self.outf.write(gettext('No revisions to uncommit.\n'))
5494
lf = log_formatter('short',
5496
show_timezone='original')
5501
direction='forward',
5502
start_revision=revno,
5503
end_revision=last_revno)
5506
self.outf.write(gettext('Dry-run, pretending to remove'
5507
' the above revisions.\n'))
5510
gettext('The above revision(s) will be removed.\n'))
5513
if not ui.ui_factory.confirm_action(
5514
gettext(u'Uncommit these revisions'),
5515
'breezy.builtins.uncommit',
5517
self.outf.write(gettext('Canceled\n'))
5520
mutter('Uncommitting from {%s} to {%s}',
5521
last_rev_id, rev_id)
5522
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5523
revno=revno, local=local, keep_tags=keep_tags)
5525
gettext('You can restore the old tip by running:\n'
5526
' brz pull . -r revid:%s\n')
5527
% last_rev_id.decode('utf-8'))
5530
class cmd_break_lock(Command):
5531
__doc__ = """Break a dead lock.
5533
This command breaks a lock on a repository, branch, working directory or
5536
CAUTION: Locks should only be broken when you are sure that the process
5537
holding the lock has been stopped.
5539
You can get information on what locks are open via the 'brz info
5540
[location]' command.
5544
brz break-lock brz+ssh://example.com/brz/foo
5545
brz break-lock --conf ~/.bazaar
5548
takes_args = ['location?']
5551
help='LOCATION is the directory where the config lock is.'),
5553
help='Do not ask for confirmation before breaking the lock.'),
5556
def run(self, location=None, config=False, force=False):
5557
if location is None:
5560
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5562
{'breezy.lockdir.break': True})
5564
conf = _mod_config.LockableConfig(file_name=location)
5567
control, relpath = controldir.ControlDir.open_containing(location)
5569
control.break_lock()
5570
except NotImplementedError:
5574
class cmd_wait_until_signalled(Command):
5575
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5577
This just prints a line to signal when it is ready, then blocks on stdin.
5583
self.outf.write("running\n")
5585
sys.stdin.readline()
5588
class cmd_serve(Command):
5589
__doc__ = """Run the brz server."""
5591
aliases = ['server']
5595
help='Serve on stdin/out for use from inetd or sshd.'),
5596
RegistryOption('protocol',
5597
help="Protocol to serve.",
5598
lazy_registry=('breezy.transport',
5599
'transport_server_registry'),
5600
value_switches=True),
5602
help='Listen for connections on nominated address.',
5605
help='Listen for connections on nominated port. Passing 0 as '
5606
'the port number will result in a dynamically allocated '
5607
'port. The default port depends on the protocol.',
5609
custom_help('directory',
5610
help='Serve contents of this directory.'),
5611
Option('allow-writes',
5612
help='By default the server is a readonly server. Supplying '
5613
'--allow-writes enables write access to the contents of '
5614
'the served directory and below. Note that ``brz serve`` '
5615
'does not perform authentication, so unless some form of '
5616
'external authentication is arranged supplying this '
5617
'option leads to global uncontrolled write access to your '
5620
Option('client-timeout', type=float,
5621
help='Override the default idle client timeout (5min).'),
5624
def run(self, listen=None, port=None, inet=False, directory=None,
5625
allow_writes=False, protocol=None, client_timeout=None):
5626
from . import transport
5627
if directory is None:
5628
directory = osutils.getcwd()
5629
if protocol is None:
5630
protocol = transport.transport_server_registry.get()
5631
url = transport.location_to_url(directory)
5632
if not allow_writes:
5633
url = 'readonly+' + url
5634
t = transport.get_transport_from_url(url)
5635
protocol(t, listen, port, inet, client_timeout)
5638
class cmd_join(Command):
5639
__doc__ = """Combine a tree into its containing tree.
5641
This command requires the target tree to be in a rich-root format.
5643
The TREE argument should be an independent tree, inside another tree, but
5644
not part of it. (Such trees can be produced by "brz split", but also by
5645
running "brz branch" with the target inside a tree.)
5647
The result is a combined tree, with the subtree no longer an independent
5648
part. This is marked as a merge of the subtree into the containing tree,
5649
and all history is preserved.
5652
_see_also = ['split']
5653
takes_args = ['tree']
5655
Option('reference', help='Join by reference.', hidden=True),
5658
def run(self, tree, reference=False):
5659
from breezy.mutabletree import BadReferenceTarget
5660
sub_tree = WorkingTree.open(tree)
5661
parent_dir = osutils.dirname(sub_tree.basedir)
5662
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5663
repo = containing_tree.branch.repository
5664
if not repo.supports_rich_root():
5665
raise errors.BzrCommandError(gettext(
5666
"Can't join trees because %s doesn't support rich root data.\n"
5667
"You can use brz upgrade on the repository.")
5671
containing_tree.add_reference(sub_tree)
5672
except BadReferenceTarget as e:
5673
# XXX: Would be better to just raise a nicely printable
5674
# exception from the real origin. Also below. mbp 20070306
5675
raise errors.BzrCommandError(
5676
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5679
containing_tree.subsume(sub_tree)
5680
except errors.BadSubsumeSource as e:
5681
raise errors.BzrCommandError(
5682
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5685
class cmd_split(Command):
5686
__doc__ = """Split a subdirectory of a tree into a separate tree.
5688
This command will produce a target tree in a format that supports
5689
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5690
converted into earlier formats like 'dirstate-tags'.
5692
The TREE argument should be a subdirectory of a working tree. That
5693
subdirectory will be converted into an independent tree, with its own
5694
branch. Commits in the top-level tree will not apply to the new subtree.
5697
_see_also = ['join']
5698
takes_args = ['tree']
5700
def run(self, tree):
5701
containing_tree, subdir = WorkingTree.open_containing(tree)
5702
if not containing_tree.is_versioned(subdir):
5703
raise errors.NotVersionedError(subdir)
5705
containing_tree.extract(subdir)
5706
except errors.RootNotRich:
5707
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5710
class cmd_merge_directive(Command):
5711
__doc__ = """Generate a merge directive for auto-merge tools.
5713
A directive requests a merge to be performed, and also provides all the
5714
information necessary to do so. This means it must either include a
5715
revision bundle, or the location of a branch containing the desired
5718
A submit branch (the location to merge into) must be supplied the first
5719
time the command is issued. After it has been supplied once, it will
5720
be remembered as the default.
5722
A public branch is optional if a revision bundle is supplied, but required
5723
if --diff or --plain is specified. It will be remembered as the default
5724
after the first use.
5727
takes_args = ['submit_branch?', 'public_branch?']
5731
_see_also = ['send']
5735
RegistryOption.from_kwargs(
5737
'The type of patch to include in the directive.',
5739
value_switches=True,
5741
bundle='Bazaar revision bundle (default).',
5742
diff='Normal unified diff.',
5743
plain='No patch, just directive.'),
5744
Option('sign', help='GPG-sign the directive.'), 'revision',
5745
Option('mail-to', type=text_type,
5746
help='Instead of printing the directive, email to this '
5748
Option('message', type=text_type, short_name='m',
5749
help='Message to use when committing this merge.')
5752
encoding_type = 'exact'
5754
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5755
sign=False, revision=None, mail_to=None, message=None,
5757
from .revision import ensure_null, NULL_REVISION
5758
include_patch, include_bundle = {
5759
'plain': (False, False),
5760
'diff': (True, False),
5761
'bundle': (True, True),
5763
branch = Branch.open(directory)
5764
stored_submit_branch = branch.get_submit_branch()
5765
if submit_branch is None:
5766
submit_branch = stored_submit_branch
5768
if stored_submit_branch is None:
5769
branch.set_submit_branch(submit_branch)
5770
if submit_branch is None:
5771
submit_branch = branch.get_parent()
5772
if submit_branch is None:
5773
raise errors.BzrCommandError(
5774
gettext('No submit branch specified or known'))
5776
stored_public_branch = branch.get_public_branch()
5777
if public_branch is None:
5778
public_branch = stored_public_branch
5779
elif stored_public_branch is None:
5780
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5781
branch.set_public_branch(public_branch)
5782
if not include_bundle and public_branch is None:
5783
raise errors.BzrCommandError(
5784
gettext('No public branch specified or known'))
5785
base_revision_id = None
5786
if revision is not None:
5787
if len(revision) > 2:
5788
raise errors.BzrCommandError(
5789
gettext('brz merge-directive takes '
5790
'at most two one revision identifiers'))
5791
revision_id = revision[-1].as_revision_id(branch)
5792
if len(revision) == 2:
5793
base_revision_id = revision[0].as_revision_id(branch)
5795
revision_id = branch.last_revision()
5796
revision_id = ensure_null(revision_id)
5797
if revision_id == NULL_REVISION:
5798
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5799
directive = merge_directive.MergeDirective2.from_objects(
5800
branch.repository, revision_id, time.time(),
5801
osutils.local_time_offset(), submit_branch,
5802
public_branch=public_branch, include_patch=include_patch,
5803
include_bundle=include_bundle, message=message,
5804
base_revision_id=base_revision_id)
5807
self.outf.write(directive.to_signed(branch))
5809
self.outf.writelines(directive.to_lines())
5811
message = directive.to_email(mail_to, branch, sign)
5812
s = SMTPConnection(branch.get_config_stack())
5813
s.send_email(message)
5816
class cmd_send(Command):
5817
__doc__ = """Mail or create a merge-directive for submitting changes.
5819
A merge directive provides many things needed for requesting merges:
5821
* A machine-readable description of the merge to perform
5823
* An optional patch that is a preview of the changes requested
5825
* An optional bundle of revision data, so that the changes can be applied
5826
directly from the merge directive, without retrieving data from a
5829
`brz send` creates a compact data set that, when applied using brz
5830
merge, has the same effect as merging from the source branch.
5832
By default the merge directive is self-contained and can be applied to any
5833
branch containing submit_branch in its ancestory without needing access to
5836
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5837
revisions, but only a structured request to merge from the
5838
public_location. In that case the public_branch is needed and it must be
5839
up-to-date and accessible to the recipient. The public_branch is always
5840
included if known, so that people can check it later.
5842
The submit branch defaults to the parent of the source branch, but can be
5843
overridden. Both submit branch and public branch will be remembered in
5844
branch.conf the first time they are used for a particular branch. The
5845
source branch defaults to that containing the working directory, but can
5846
be changed using --from.
5848
Both the submit branch and the public branch follow the usual behavior with
5849
respect to --remember: If there is no default location set, the first send
5850
will set it (use --no-remember to avoid setting it). After that, you can
5851
omit the location to use the default. To change the default, use
5852
--remember. The value will only be saved if the location can be accessed.
5854
In order to calculate those changes, brz must analyse the submit branch.
5855
Therefore it is most efficient for the submit branch to be a local mirror.
5856
If a public location is known for the submit_branch, that location is used
5857
in the merge directive.
5859
The default behaviour is to send the merge directive by mail, unless -o is
5860
given, in which case it is sent to a file.
5862
Mail is sent using your preferred mail program. This should be transparent
5863
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5864
If the preferred client can't be found (or used), your editor will be used.
5866
To use a specific mail program, set the mail_client configuration option.
5867
Supported values for specific clients are "claws", "evolution", "kmail",
5868
"mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options
5869
are "default", "editor", "emacsclient", "mapi", and "xdg-email". Plugins
5870
may also add supported clients.
5872
If mail is being sent, a to address is required. This can be supplied
5873
either on the commandline, by setting the submit_to configuration
5874
option in the branch itself or the child_submit_to configuration option
5875
in the submit branch.
5877
The merge directives created by brz send may be applied using brz merge or
5878
brz pull by specifying a file containing a merge directive as the location.
5880
brz send makes extensive use of public locations to map local locations into
5881
URLs that can be used by other people. See `brz help configuration` to
5882
set them, and use `brz info` to display them.
5885
encoding_type = 'exact'
5887
_see_also = ['merge', 'pull']
5889
takes_args = ['submit_branch?', 'public_branch?']
5893
help='Do not include a bundle in the merge directive.'),
5894
Option('no-patch', help='Do not include a preview patch in the merge'
5897
help='Remember submit and public branch.'),
5899
help='Branch to generate the submission from, '
5900
'rather than the one containing the working directory.',
5903
Option('output', short_name='o',
5904
help='Write merge directive to this file or directory; '
5905
'use - for stdout.',
5908
help='Refuse to send if there are uncommitted changes in'
5909
' the working tree, --no-strict disables the check.'),
5910
Option('mail-to', help='Mail the request to this address.',
5914
Option('body', help='Body for the email.', type=text_type),
5915
RegistryOption('format',
5916
help='Use the specified output format.',
5917
lazy_registry=('breezy.send', 'format_registry')),
5920
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5921
no_patch=False, revision=None, remember=None, output=None,
5922
format=None, mail_to=None, message=None, body=None,
5923
strict=None, **kwargs):
5924
from .send import send
5925
return send(submit_branch, revision, public_branch, remember,
5926
format, no_bundle, no_patch, output,
5927
kwargs.get('from', '.'), mail_to, message, body,
5932
class cmd_bundle_revisions(cmd_send):
5933
__doc__ = """Create a merge-directive for submitting changes.
5935
A merge directive provides many things needed for requesting merges:
5937
* A machine-readable description of the merge to perform
5939
* An optional patch that is a preview of the changes requested
5941
* An optional bundle of revision data, so that the changes can be applied
5942
directly from the merge directive, without retrieving data from a
5945
If --no-bundle is specified, then public_branch is needed (and must be
5946
up-to-date), so that the receiver can perform the merge using the
5947
public_branch. The public_branch is always included if known, so that
5948
people can check it later.
5950
The submit branch defaults to the parent, but can be overridden. Both
5951
submit branch and public branch will be remembered if supplied.
5953
If a public_branch is known for the submit_branch, that public submit
5954
branch is used in the merge instructions. This means that a local mirror
5955
can be used as your actual submit branch, once you have set public_branch
5961
help='Do not include a bundle in the merge directive.'),
5962
Option('no-patch', help='Do not include a preview patch in the merge'
5965
help='Remember submit and public branch.'),
5967
help='Branch to generate the submission from, '
5968
'rather than the one containing the working directory.',
5971
Option('output', short_name='o', help='Write directive to this file.',
5974
help='Refuse to bundle revisions if there are uncommitted'
5975
' changes in the working tree, --no-strict disables the check.'),
5977
RegistryOption('format',
5978
help='Use the specified output format.',
5979
lazy_registry=('breezy.send', 'format_registry')),
5981
aliases = ['bundle']
5983
_see_also = ['send', 'merge']
5987
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5988
no_patch=False, revision=None, remember=False, output=None,
5989
format=None, strict=None, **kwargs):
5992
from .send import send
5993
return send(submit_branch, revision, public_branch, remember,
5994
format, no_bundle, no_patch, output,
5995
kwargs.get('from', '.'), None, None, None,
5996
self.outf, strict=strict)
5999
class cmd_tag(Command):
6000
__doc__ = """Create, remove or modify a tag naming a revision.
6002
Tags give human-meaningful names to revisions. Commands that take a -r
6003
(--revision) option can be given -rtag:X, where X is any previously
6006
Tags are stored in the branch. Tags are copied from one branch to another
6007
along when you branch, push, pull or merge.
6009
It is an error to give a tag name that already exists unless you pass
6010
--force, in which case the tag is moved to point to the new revision.
6012
To rename a tag (change the name but keep it on the same revsion), run ``brz
6013
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
6015
If no tag name is specified it will be determined through the
6016
'automatic_tag_name' hook. This can e.g. be used to automatically tag
6017
upstream releases by reading configure.ac. See ``brz help hooks`` for
6021
_see_also = ['commit', 'tags']
6022
takes_args = ['tag_name?']
6025
help='Delete this tag rather than placing it.',
6027
custom_help('directory',
6028
help='Branch in which to place the tag.'),
6030
help='Replace existing tags.',
6035
def run(self, tag_name=None,
6041
branch, relpath = Branch.open_containing(directory)
6042
self.add_cleanup(branch.lock_write().unlock)
6044
if tag_name is None:
6045
raise errors.BzrCommandError(
6046
gettext("No tag specified to delete."))
6047
branch.tags.delete_tag(tag_name)
6048
note(gettext('Deleted tag %s.') % tag_name)
6051
if len(revision) != 1:
6052
raise errors.BzrCommandError(gettext(
6053
"Tags can only be placed on a single revision, "
6055
revision_id = revision[0].as_revision_id(branch)
6057
revision_id = branch.last_revision()
6058
if tag_name is None:
6059
tag_name = branch.automatic_tag_name(revision_id)
6060
if tag_name is None:
6061
raise errors.BzrCommandError(gettext(
6062
"Please specify a tag name."))
6064
existing_target = branch.tags.lookup_tag(tag_name)
6065
except errors.NoSuchTag:
6066
existing_target = None
6067
if not force and existing_target not in (None, revision_id):
6068
raise errors.TagAlreadyExists(tag_name)
6069
if existing_target == revision_id:
6070
note(gettext('Tag %s already exists for that revision.') % tag_name)
6072
branch.tags.set_tag(tag_name, revision_id)
6073
if existing_target is None:
6074
note(gettext('Created tag %s.') % tag_name)
6076
note(gettext('Updated tag %s.') % tag_name)
6079
class cmd_tags(Command):
6080
__doc__ = """List tags.
6082
This command shows a table of tag names and the revisions they reference.
6087
custom_help('directory',
6088
help='Branch whose tags should be displayed.'),
6089
RegistryOption('sort',
6090
'Sort tags by different criteria.', title='Sorting',
6091
lazy_registry=('breezy.tag', 'tag_sort_methods')
6098
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6099
from .tag import tag_sort_methods
6100
branch, relpath = Branch.open_containing(directory)
6102
tags = list(viewitems(branch.tags.get_tag_dict()))
6106
self.add_cleanup(branch.lock_read().unlock)
6108
# Restrict to the specified range
6109
tags = self._tags_for_range(branch, revision)
6111
sort = tag_sort_methods.get()
6114
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6115
for index, (tag, revid) in enumerate(tags):
6117
revno = branch.revision_id_to_dotted_revno(revid)
6118
if isinstance(revno, tuple):
6119
revno = '.'.join(map(str, revno))
6120
except (errors.NoSuchRevision,
6121
errors.GhostRevisionsHaveNoRevno,
6122
errors.UnsupportedOperation):
6123
# Bad tag data/merges can lead to tagged revisions
6124
# which are not in this branch. Fail gracefully ...
6126
tags[index] = (tag, revno)
6128
tags = [(tag, revid.decode('utf-8')) for (tag, revid) in tags]
6130
for tag, revspec in tags:
6131
self.outf.write('%-20s %s\n' % (tag, revspec))
6133
def _tags_for_range(self, branch, revision):
6134
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6135
revid1, revid2 = rev1.rev_id, rev2.rev_id
6136
# _get_revision_range will always set revid2 if it's not specified.
6137
# If revid1 is None, it means we want to start from the branch
6138
# origin which is always a valid ancestor. If revid1 == revid2, the
6139
# ancestry check is useless.
6140
if revid1 and revid1 != revid2:
6141
# FIXME: We really want to use the same graph than
6142
# branch.iter_merge_sorted_revisions below, but this is not
6143
# easily available -- vila 2011-09-23
6144
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6145
# We don't want to output anything in this case...
6147
# only show revisions between revid1 and revid2 (inclusive)
6148
tagged_revids = branch.tags.get_reverse_tag_dict()
6150
for r in branch.iter_merge_sorted_revisions(
6151
start_revision_id=revid2, stop_revision_id=revid1,
6152
stop_rule='include'):
6153
revid_tags = tagged_revids.get(r[0], None)
6155
found.extend([(tag, r[0]) for tag in revid_tags])
6159
class cmd_reconfigure(Command):
6160
__doc__ = """Reconfigure the type of a brz directory.
6162
A target configuration must be specified.
6164
For checkouts, the bind-to location will be auto-detected if not specified.
6165
The order of preference is
6166
1. For a lightweight checkout, the current bound location.
6167
2. For branches that used to be checkouts, the previously-bound location.
6168
3. The push location.
6169
4. The parent location.
6170
If none of these is available, --bind-to must be specified.
6173
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6174
takes_args = ['location?']
6176
RegistryOption.from_kwargs(
6179
help='The relation between branch and tree.',
6180
value_switches=True, enum_switch=False,
6181
branch='Reconfigure to be an unbound branch with no working tree.',
6182
tree='Reconfigure to be an unbound branch with a working tree.',
6183
checkout='Reconfigure to be a bound branch with a working tree.',
6184
lightweight_checkout='Reconfigure to be a lightweight'
6185
' checkout (with no local history).',
6187
RegistryOption.from_kwargs(
6189
title='Repository type',
6190
help='Location fo the repository.',
6191
value_switches=True, enum_switch=False,
6192
standalone='Reconfigure to be a standalone branch '
6193
'(i.e. stop using shared repository).',
6194
use_shared='Reconfigure to use a shared repository.',
6196
RegistryOption.from_kwargs(
6198
title='Trees in Repository',
6199
help='Whether new branches in the repository have trees.',
6200
value_switches=True, enum_switch=False,
6201
with_trees='Reconfigure repository to create '
6202
'working trees on branches by default.',
6203
with_no_trees='Reconfigure repository to not create '
6204
'working trees on branches by default.'
6206
Option('bind-to', help='Branch to bind checkout to.', type=text_type),
6208
help='Perform reconfiguration even if local changes'
6210
Option('stacked-on',
6211
help='Reconfigure a branch to be stacked on another branch.',
6215
help='Reconfigure a branch to be unstacked. This '
6216
'may require copying substantial data into it.',
6220
def run(self, location=None, bind_to=None, force=False,
6221
tree_type=None, repository_type=None, repository_trees=None,
6222
stacked_on=None, unstacked=None):
6223
directory = controldir.ControlDir.open(location)
6224
if stacked_on and unstacked:
6225
raise errors.BzrCommandError(
6226
gettext("Can't use both --stacked-on and --unstacked"))
6227
elif stacked_on is not None:
6228
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6230
reconfigure.ReconfigureUnstacked().apply(directory)
6231
# At the moment you can use --stacked-on and a different
6232
# reconfiguration shape at the same time; there seems no good reason
6234
if (tree_type is None and
6235
repository_type is None and
6236
repository_trees is None):
6237
if stacked_on or unstacked:
6240
raise errors.BzrCommandError(gettext('No target configuration '
6242
reconfiguration = None
6243
if tree_type == 'branch':
6244
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6245
elif tree_type == 'tree':
6246
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6247
elif tree_type == 'checkout':
6248
reconfiguration = reconfigure.Reconfigure.to_checkout(
6250
elif tree_type == 'lightweight-checkout':
6251
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6254
reconfiguration.apply(force)
6255
reconfiguration = None
6256
if repository_type == 'use-shared':
6257
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6258
elif repository_type == 'standalone':
6259
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6261
reconfiguration.apply(force)
6262
reconfiguration = None
6263
if repository_trees == 'with-trees':
6264
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6266
elif repository_trees == 'with-no-trees':
6267
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6270
reconfiguration.apply(force)
6271
reconfiguration = None
6274
class cmd_switch(Command):
6275
__doc__ = """Set the branch of a checkout and update.
6277
For lightweight checkouts, this changes the branch being referenced.
6278
For heavyweight checkouts, this checks that there are no local commits
6279
versus the current bound branch, then it makes the local branch a mirror
6280
of the new location and binds to it.
6282
In both cases, the working tree is updated and uncommitted changes
6283
are merged. The user can commit or revert these as they desire.
6285
Pending merges need to be committed or reverted before using switch.
6287
The path to the branch to switch to can be specified relative to the parent
6288
directory of the current branch. For example, if you are currently in a
6289
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6292
Bound branches use the nickname of its master branch unless it is set
6293
locally, in which case switching will update the local nickname to be
6297
takes_args = ['to_location?']
6298
takes_options = ['directory',
6300
help='Switch even if local commits will be lost.'),
6302
Option('create-branch', short_name='b',
6303
help='Create the target branch from this one before'
6304
' switching to it.'),
6306
help='Store and restore uncommitted changes in the'
6310
def run(self, to_location=None, force=False, create_branch=False,
6311
revision=None, directory=u'.', store=False):
6312
from . import switch
6313
tree_location = directory
6314
revision = _get_one_revision('switch', revision)
6315
possible_transports = []
6316
control_dir = controldir.ControlDir.open_containing(tree_location,
6317
possible_transports=possible_transports)[0]
6318
if to_location is None:
6319
if revision is None:
6320
raise errors.BzrCommandError(gettext('You must supply either a'
6321
' revision or a location'))
6322
to_location = tree_location
6324
branch = control_dir.open_branch(
6325
possible_transports=possible_transports)
6326
had_explicit_nick = branch.get_config().has_explicit_nickname()
6327
except errors.NotBranchError:
6329
had_explicit_nick = False
6332
raise errors.BzrCommandError(
6333
gettext('cannot create branch without source branch'))
6334
to_location = lookup_new_sibling_branch(
6335
control_dir, to_location,
6336
possible_transports=possible_transports)
6337
if revision is not None:
6338
revision = revision.as_revision_id(branch)
6339
to_branch = branch.controldir.sprout(
6341
possible_transports=possible_transports,
6342
revision_id=revision,
6343
source_branch=branch).open_branch()
6346
to_branch = Branch.open(to_location,
6347
possible_transports=possible_transports)
6348
except errors.NotBranchError:
6349
to_branch = open_sibling_branch(
6350
control_dir, to_location,
6351
possible_transports=possible_transports)
6352
if revision is not None:
6353
revision = revision.as_revision_id(to_branch)
6355
switch.switch(control_dir, to_branch, force, revision_id=revision,
6356
store_uncommitted=store)
6357
except controldir.BranchReferenceLoop:
6358
raise errors.BzrCommandError(
6359
gettext('switching would create a branch reference loop. '
6360
'Use the "bzr up" command to switch to a '
6361
'different revision.'))
6362
if had_explicit_nick:
6363
branch = control_dir.open_branch() # get the new branch!
6364
branch.nick = to_branch.nick
6365
note(gettext('Switched to branch: %s'),
6366
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6369
class cmd_view(Command):
6370
__doc__ = """Manage filtered views.
6372
Views provide a mask over the tree so that users can focus on
6373
a subset of a tree when doing their work. After creating a view,
6374
commands that support a list of files - status, diff, commit, etc -
6375
effectively have that list of files implicitly given each time.
6376
An explicit list of files can still be given but those files
6377
must be within the current view.
6379
In most cases, a view has a short life-span: it is created to make
6380
a selected change and is deleted once that change is committed.
6381
At other times, you may wish to create one or more named views
6382
and switch between them.
6384
To disable the current view without deleting it, you can switch to
6385
the pseudo view called ``off``. This can be useful when you need
6386
to see the whole tree for an operation or two (e.g. merge) but
6387
want to switch back to your view after that.
6390
To define the current view::
6392
brz view file1 dir1 ...
6394
To list the current view::
6398
To delete the current view::
6402
To disable the current view without deleting it::
6404
brz view --switch off
6406
To define a named view and switch to it::
6408
brz view --name view-name file1 dir1 ...
6410
To list a named view::
6412
brz view --name view-name
6414
To delete a named view::
6416
brz view --name view-name --delete
6418
To switch to a named view::
6420
brz view --switch view-name
6422
To list all views defined::
6426
To delete all views::
6428
brz view --delete --all
6432
takes_args = ['file*']
6435
help='Apply list or delete action to all views.',
6438
help='Delete the view.',
6441
help='Name of the view to define, list or delete.',
6445
help='Name of the view to switch to.',
6450
def run(self, file_list,
6456
tree, file_list = WorkingTree.open_containing_paths(file_list,
6458
current_view, view_dict = tree.views.get_view_info()
6463
raise errors.BzrCommandError(gettext(
6464
"Both --delete and a file list specified"))
6466
raise errors.BzrCommandError(gettext(
6467
"Both --delete and --switch specified"))
6469
tree.views.set_view_info(None, {})
6470
self.outf.write(gettext("Deleted all views.\n"))
6472
raise errors.BzrCommandError(
6473
gettext("No current view to delete"))
6475
tree.views.delete_view(name)
6476
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6479
raise errors.BzrCommandError(gettext(
6480
"Both --switch and a file list specified"))
6482
raise errors.BzrCommandError(gettext(
6483
"Both --switch and --all specified"))
6484
elif switch == 'off':
6485
if current_view is None:
6486
raise errors.BzrCommandError(
6487
gettext("No current view to disable"))
6488
tree.views.set_view_info(None, view_dict)
6489
self.outf.write(gettext("Disabled '%s' view.\n") %
6492
tree.views.set_view_info(switch, view_dict)
6493
view_str = views.view_display_str(tree.views.lookup_view())
6495
gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6498
self.outf.write(gettext('Views defined:\n'))
6499
for view in sorted(view_dict):
6500
if view == current_view:
6504
view_str = views.view_display_str(view_dict[view])
6505
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6507
self.outf.write(gettext('No views defined.\n'))
6510
# No name given and no current view set
6513
raise errors.BzrCommandError(gettext(
6514
"Cannot change the 'off' pseudo view"))
6515
tree.views.set_view(name, sorted(file_list))
6516
view_str = views.view_display_str(tree.views.lookup_view())
6518
gettext("Using '{0}' view: {1}\n").format(name, view_str))
6522
# No name given and no current view set
6523
self.outf.write(gettext('No current view.\n'))
6525
view_str = views.view_display_str(tree.views.lookup_view(name))
6527
gettext("'{0}' view is: {1}\n").format(name, view_str))
6530
class cmd_hooks(Command):
6531
__doc__ = """Show hooks."""
6536
for hook_key in sorted(hooks.known_hooks.keys()):
6537
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6538
self.outf.write("%s:\n" % type(some_hooks).__name__)
6539
for hook_name, hook_point in sorted(some_hooks.items()):
6540
self.outf.write(" %s:\n" % (hook_name,))
6541
found_hooks = list(hook_point)
6543
for hook in found_hooks:
6544
self.outf.write(" %s\n" %
6545
(some_hooks.get_hook_name(hook),))
6547
self.outf.write(gettext(" <no hooks installed>\n"))
6550
class cmd_remove_branch(Command):
6551
__doc__ = """Remove a branch.
6553
This will remove the branch from the specified location but
6554
will keep any working tree or repository in place.
6558
Remove the branch at repo/trunk::
6560
brz remove-branch repo/trunk
6564
takes_args = ["location?"]
6566
takes_options = ['directory',
6567
Option('force', help='Remove branch even if it is the active branch.')]
6569
aliases = ["rmbranch"]
6571
def run(self, directory=None, location=None, force=False):
6572
br = open_nearby_branch(near=directory, location=location)
6573
if not force and br.controldir.has_workingtree():
6575
active_branch = br.controldir.open_branch(name="")
6576
except errors.NotBranchError:
6577
active_branch = None
6578
if (active_branch is not None and
6579
br.control_url == active_branch.control_url):
6580
raise errors.BzrCommandError(
6581
gettext("Branch is active. Use --force to remove it."))
6582
br.controldir.destroy_branch(br.name)
6585
class cmd_shelve(Command):
6586
__doc__ = """Temporarily set aside some changes from the current tree.
6588
Shelve allows you to temporarily put changes you've made "on the shelf",
6589
ie. out of the way, until a later time when you can bring them back from
6590
the shelf with the 'unshelve' command. The changes are stored alongside
6591
your working tree, and so they aren't propagated along with your branch nor
6592
will they survive its deletion.
6594
If shelve --list is specified, previously-shelved changes are listed.
6596
Shelve is intended to help separate several sets of changes that have
6597
been inappropriately mingled. If you just want to get rid of all changes
6598
and you don't need to restore them later, use revert. If you want to
6599
shelve all text changes at once, use shelve --all.
6601
If filenames are specified, only the changes to those files will be
6602
shelved. Other files will be left untouched.
6604
If a revision is specified, changes since that revision will be shelved.
6606
You can put multiple items on the shelf, and by default, 'unshelve' will
6607
restore the most recently shelved changes.
6609
For complicated changes, it is possible to edit the changes in a separate
6610
editor program to decide what the file remaining in the working copy
6611
should look like. To do this, add the configuration option
6613
change_editor = PROGRAM @new_path @old_path
6615
where @new_path is replaced with the path of the new version of the
6616
file and @old_path is replaced with the path of the old version of
6617
the file. The PROGRAM should save the new file with the desired
6618
contents of the file in the working tree.
6622
takes_args = ['file*']
6627
Option('all', help='Shelve all changes.'),
6629
RegistryOption('writer', 'Method to use for writing diffs.',
6630
breezy.option.diff_writer_registry,
6631
value_switches=True, enum_switch=False),
6633
Option('list', help='List shelved changes.'),
6635
help='Destroy removed changes instead of shelving them.'),
6637
_see_also = ['unshelve', 'configuration']
6639
def run(self, revision=None, all=False, file_list=None, message=None,
6640
writer=None, list=False, destroy=False, directory=None):
6642
return self.run_for_list(directory=directory)
6643
from .shelf_ui import Shelver
6645
writer = breezy.option.diff_writer_registry.get()
6647
shelver = Shelver.from_args(writer(self.outf), revision, all,
6648
file_list, message, destroy=destroy, directory=directory)
6653
except errors.UserAbort:
6656
def run_for_list(self, directory=None):
6657
if directory is None:
6659
tree = WorkingTree.open_containing(directory)[0]
6660
self.add_cleanup(tree.lock_read().unlock)
6661
manager = tree.get_shelf_manager()
6662
shelves = manager.active_shelves()
6663
if len(shelves) == 0:
6664
note(gettext('No shelved changes.'))
6666
for shelf_id in reversed(shelves):
6667
message = manager.get_metadata(shelf_id).get(b'message')
6669
message = '<no message>'
6670
self.outf.write('%3d: %s\n' % (shelf_id, message))
6674
class cmd_unshelve(Command):
6675
__doc__ = """Restore shelved changes.
6677
By default, the most recently shelved changes are restored. However if you
6678
specify a shelf by id those changes will be restored instead. This works
6679
best when the changes don't depend on each other.
6682
takes_args = ['shelf_id?']
6685
RegistryOption.from_kwargs(
6686
'action', help="The action to perform.",
6687
enum_switch=False, value_switches=True,
6688
apply="Apply changes and remove from the shelf.",
6689
dry_run="Show changes, but do not apply or remove them.",
6690
preview="Instead of unshelving the changes, show the diff that "
6691
"would result from unshelving.",
6692
delete_only="Delete changes without applying them.",
6693
keep="Apply changes but don't delete them.",
6696
_see_also = ['shelve']
6698
def run(self, shelf_id=None, action='apply', directory=u'.'):
6699
from .shelf_ui import Unshelver
6700
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6704
unshelver.tree.unlock()
6707
class cmd_clean_tree(Command):
6708
__doc__ = """Remove unwanted files from working tree.
6710
By default, only unknown files, not ignored files, are deleted. Versioned
6711
files are never deleted.
6713
Another class is 'detritus', which includes files emitted by brz during
6714
normal operations and selftests. (The value of these files decreases with
6717
If no options are specified, unknown files are deleted. Otherwise, option
6718
flags are respected, and may be combined.
6720
To check what clean-tree will do, use --dry-run.
6722
takes_options = ['directory',
6723
Option('ignored', help='Delete all ignored files.'),
6724
Option('detritus', help='Delete conflict files, merge and revert'
6725
' backups, and failed selftest dirs.'),
6727
help='Delete files unknown to brz (default).'),
6728
Option('dry-run', help='Show files to delete instead of'
6730
Option('force', help='Do not prompt before deleting.')]
6732
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6733
force=False, directory=u'.'):
6734
from .clean_tree import clean_tree
6735
if not (unknown or ignored or detritus):
6739
clean_tree(directory, unknown=unknown, ignored=ignored,
6740
detritus=detritus, dry_run=dry_run, no_prompt=force)
6743
class cmd_reference(Command):
6744
__doc__ = """list, view and set branch locations for nested trees.
6746
If no arguments are provided, lists the branch locations for nested trees.
6747
If one argument is provided, display the branch location for that tree.
6748
If two arguments are provided, set the branch location for that tree.
6753
takes_args = ['path?', 'location?']
6755
Option('force-unversioned',
6756
help='Set reference even if path is not versioned.'),
6759
def run(self, path=None, location=None, force_unversioned=False):
6761
if path is not None:
6763
tree, branch, relpath = (
6764
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6765
if path is not None:
6768
tree = branch.basis_tree()
6770
info = viewitems(branch._get_all_reference_info())
6771
self._display_reference_info(tree, branch, info)
6773
if not tree.is_versioned(path) and not force_unversioned:
6774
raise errors.NotVersionedError(path)
6775
if location is None:
6776
info = [(path, branch.get_reference_info(path))]
6777
self._display_reference_info(tree, branch, info)
6779
branch.set_reference_info(
6780
path, location, file_id=tree.path2id(path))
6782
def _display_reference_info(self, tree, branch, info):
6784
for path, (location, file_id) in info:
6785
ref_list.append((path, location))
6786
for path, location in sorted(ref_list):
6787
self.outf.write('%s %s\n' % (path, location))
6790
class cmd_export_pot(Command):
6791
__doc__ = """Export command helps and error messages in po format."""
6794
takes_options = [Option('plugin',
6795
help='Export help text from named command '
6796
'(defaults to all built in commands).',
6798
Option('include-duplicates',
6799
help='Output multiple copies of the same msgid '
6800
'string if it appears more than once.'),
6803
def run(self, plugin=None, include_duplicates=False):
6804
from .export_pot import export_pot
6805
export_pot(self.outf, plugin, include_duplicates)
6808
class cmd_import(Command):
6809
__doc__ = """Import sources from a directory, tarball or zip file
6811
This command will import a directory, tarball or zip file into a bzr
6812
tree, replacing any versioned files already present. If a directory is
6813
specified, it is used as the target. If the directory does not exist, or
6814
is not versioned, it is created.
6816
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6818
If the tarball or zip has a single root directory, that directory is
6819
stripped when extracting the tarball. This is not done for directories.
6822
takes_args = ['source', 'tree?']
6824
def run(self, source, tree=None):
6825
from .upstream_import import do_import
6826
do_import(source, tree)
6829
class cmd_link_tree(Command):
6830
__doc__ = """Hardlink matching files to another tree.
6832
Only files with identical content and execute bit will be linked.
6835
takes_args = ['location']
6837
def run(self, location):
6838
from .transform import link_tree
6839
target_tree = WorkingTree.open_containing(".")[0]
6840
source_tree = WorkingTree.open(location)
6841
with target_tree.lock_write(), source_tree.lock_read():
6842
link_tree(target_tree, source_tree)
6845
class cmd_fetch_ghosts(Command):
6846
__doc__ = """Attempt to retrieve ghosts from another branch.
6848
If the other branch is not supplied, the last-pulled branch is used.
6852
aliases = ['fetch-missing']
6853
takes_args = ['branch?']
6854
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6856
def run(self, branch=None, no_fix=False):
6857
from .fetch_ghosts import GhostFetcher
6858
installed, failed = GhostFetcher.from_cmdline(branch).run()
6859
if len(installed) > 0:
6860
self.outf.write("Installed:\n")
6861
for rev in installed:
6862
self.outf.write(rev.decode('utf-8') + "\n")
6864
self.outf.write("Still missing:\n")
6866
self.outf.write(rev.decode('utf-8') + "\n")
6867
if not no_fix and len(installed) > 0:
6868
cmd_reconcile().run(".")
6871
def _register_lazy_builtins():
6872
# register lazy builtins from other modules; called at startup and should
6873
# be only called once.
6874
for (name, aliases, module_name) in [
6875
('cmd_bisect', [], 'breezy.bisect'),
6876
('cmd_bundle_info', [], 'breezy.bundle.commands'),
6877
('cmd_config', [], 'breezy.config'),
6878
('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
6879
('cmd_version_info', [], 'breezy.cmd_version_info'),
6880
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
6881
('cmd_conflicts', [], 'breezy.conflicts'),
6882
('cmd_ping', [], 'breezy.bzr.smart.ping'),
6883
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
6884
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
6885
('cmd_test_script', [], 'breezy.cmd_test_script'),
6887
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
