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(control_dir,
121
possible_transports=possible_transports)
122
# Perhaps the target control dir supports colocated branches?
124
root = controldir.ControlDir.open(this_url,
125
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(this_url,
153
{"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(location,
170
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
189
return Branch.open(location,
190
possible_transports=possible_transports)
191
except errors.NotBranchError:
193
cdir = controldir.ControlDir.open(near,
194
possible_transports=possible_transports)
195
return open_sibling_branch(cdir, location,
196
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(reference,
214
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(repo.user_url,
226
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") % view_str)
259
return tree, file_list
262
def _get_one_revision(command_name, revisions):
263
if revisions is None:
265
if len(revisions) != 1:
266
raise errors.BzrCommandError(gettext(
267
'brz %s --revision takes exactly one revision identifier') % (
272
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
273
"""Get a revision tree. Not suitable for commands that change the tree.
275
Specifically, the basis tree in dirstate trees is coupled to the dirstate
276
and doing a commit/uncommit/pull will at best fail due to changing the
279
If tree is passed in, it should be already locked, for lifetime management
280
of the trees internal cached state.
284
if revisions is None:
286
rev_tree = tree.basis_tree()
288
rev_tree = branch.basis_tree()
290
revision = _get_one_revision(command_name, revisions)
291
rev_tree = revision.as_tree(branch)
295
def _get_view_info_for_change_reporter(tree):
296
"""Get the view information from a tree for change reporting."""
299
current_view = tree.views.get_view_info()[0]
300
if current_view is not None:
301
view_info = (current_view, tree.views.lookup_view())
302
except views.ViewsNotSupported:
307
def _open_directory_or_containing_tree_or_branch(filename, directory):
308
"""Open the tree or branch containing the specified file, unless
309
the --directory option is used to specify a different branch."""
310
if directory is not None:
311
return (None, Branch.open(directory), filename)
312
return controldir.ControlDir.open_containing_tree_or_branch(filename)
315
# TODO: Make sure no commands unconditionally use the working directory as a
316
# branch. If a filename argument is used, the first of them should be used to
317
# specify the branch. (Perhaps this can be factored out into some kind of
318
# Argument class, representing a file in a branch, where the first occurrence
321
class cmd_status(Command):
322
__doc__ = """Display status summary.
324
This reports on versioned and unknown files, reporting them
325
grouped by state. Possible states are:
328
Versioned in the working copy but not in the previous revision.
331
Versioned in the previous revision but removed or deleted
335
Path of this file changed from the previous revision;
336
the text may also have changed. This includes files whose
337
parent directory was renamed.
340
Text has changed since the previous revision.
343
File kind has been changed (e.g. from file to directory).
346
Not versioned and not matching an ignore pattern.
348
Additionally for directories, symlinks and files with a changed
349
executable bit, Bazaar indicates their type using a trailing
350
character: '/', '@' or '*' respectively. These decorations can be
351
disabled using the '--no-classify' option.
353
To see ignored files use 'brz ignored'. For details on the
354
changes to file texts, use 'brz diff'.
356
Note that --short or -S gives status flags for each item, similar
357
to Subversion's status command. To get output similar to svn -q,
360
If no arguments are specified, the status of the entire working
361
directory is shown. Otherwise, only the status of the specified
362
files or directories is reported. If a directory is given, status
363
is reported for everything inside that directory.
365
Before merges are committed, the pending merge tip revisions are
366
shown. To see all pending merge revisions, use the -v option.
367
To skip the display of pending merge information altogether, use
368
the no-pending option or specify a file/directory.
370
To compare the working directory to a specific revision, pass a
371
single revision to the revision argument.
373
To see which files have changed in a specific revision, or between
374
two revisions, pass a revision range to the revision argument.
375
This will produce the same results as calling 'brz diff --summarize'.
378
# TODO: --no-recurse/-N, --recurse options
380
takes_args = ['file*']
381
takes_options = ['show-ids', 'revision', 'change', 'verbose',
382
Option('short', help='Use short status indicators.',
384
Option('versioned', help='Only show versioned files.',
386
Option('no-pending', help='Don\'t show pending merges.',
388
Option('no-classify',
389
help='Do not mark object type using indicator.',
392
aliases = ['st', 'stat']
394
encoding_type = 'replace'
395
_see_also = ['diff', 'revert', 'status-flags']
398
def run(self, show_ids=False, file_list=None, revision=None, short=False,
399
versioned=False, no_pending=False, verbose=False,
401
from .status import show_tree_status
403
if revision and len(revision) > 2:
404
raise errors.BzrCommandError(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(gettext('You must supply either'
452
' --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(gettext('Repository %r does not support '
459
'access to raw revision texts'))
461
with b.repository.lock_read():
462
# TODO: jam 20060112 should cat-revision always output utf-8?
463
if revision_id is not None:
464
revision_id = cache_utf8.encode(revision_id)
466
self.print_revision(revisions, revision_id)
467
except errors.NoSuchRevision:
468
msg = gettext("The repository {0} contains no revision {1}.").format(
469
b.repository.base, revision_id.decode('utf-8'))
470
raise errors.BzrCommandError(msg)
471
elif revision is not None:
474
raise errors.BzrCommandError(
475
gettext('You cannot specify a NULL revision.'))
476
rev_id = rev.as_revision_id(b)
477
self.print_revision(revisions, rev_id)
480
class cmd_remove_tree(Command):
481
__doc__ = """Remove the working tree from a given branch/checkout.
483
Since a lightweight checkout is little more than a working tree
484
this will refuse to run against one.
486
To re-create the working tree, use "brz checkout".
488
_see_also = ['checkout', 'working-trees']
489
takes_args = ['location*']
492
help='Remove the working tree even if it has '
493
'uncommitted or shelved changes.'),
496
def run(self, location_list, force=False):
497
if not location_list:
498
location_list = ['.']
500
for location in location_list:
501
d = controldir.ControlDir.open(location)
504
working = d.open_workingtree()
505
except errors.NoWorkingTree:
506
raise errors.BzrCommandError(gettext("No working tree to remove"))
507
except errors.NotLocalUrl:
508
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
509
" of a remote path"))
511
if (working.has_changes()):
512
raise errors.UncommittedChanges(working)
513
if working.get_shelf_manager().last_shelf() is not None:
514
raise errors.ShelvedChanges(working)
516
if working.user_url != working.branch.user_url:
517
raise errors.BzrCommandError(gettext("You cannot remove the working tree"
518
" from a lightweight checkout"))
520
d.destroy_workingtree()
523
class cmd_repair_workingtree(Command):
524
__doc__ = """Reset the working tree state file.
526
This is not meant to be used normally, but more as a way to recover from
527
filesystem corruption, etc. This rebuilds the working inventory back to a
528
'known good' state. Any new modifications (adding a file, renaming, etc)
529
will be lost, though modified files will still be detected as such.
531
Most users will want something more like "brz revert" or "brz update"
532
unless the state file has become corrupted.
534
By default this attempts to recover the current state by looking at the
535
headers of the state file. If the state file is too corrupted to even do
536
that, you can supply --revision to force the state of the tree.
539
takes_options = ['revision', 'directory',
541
help='Reset the tree even if it doesn\'t appear to be'
546
def run(self, revision=None, directory='.', force=False):
547
tree, _ = WorkingTree.open_containing(directory)
548
self.add_cleanup(tree.lock_tree_write().unlock)
552
except errors.BzrError:
553
pass # There seems to be a real error here, so we'll reset
556
raise errors.BzrCommandError(gettext(
557
'The tree does not appear to be corrupt. You probably'
558
' want "brz revert" instead. Use "--force" if you are'
559
' sure you want to reset the working tree.'))
563
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
565
tree.reset_state(revision_ids)
566
except errors.BzrError:
567
if revision_ids is None:
568
extra = (gettext(', the header appears corrupt, try passing -r -1'
569
' to set the state to the last commit'))
572
raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
575
class cmd_revno(Command):
576
__doc__ = """Show current revision number.
578
This is equal to the number of revisions on this branch.
582
takes_args = ['location?']
584
Option('tree', help='Show revno of working tree.'),
589
def run(self, tree=False, location=u'.', revision=None):
590
if revision is not None and tree:
591
raise errors.BzrCommandError(gettext("--tree and --revision can "
592
"not be used together"))
596
wt = WorkingTree.open_containing(location)[0]
597
self.add_cleanup(wt.lock_read().unlock)
598
except (errors.NoWorkingTree, errors.NotLocalUrl):
599
raise errors.NoWorkingTree(location)
601
revid = wt.last_revision()
603
b = Branch.open_containing(location)[0]
604
self.add_cleanup(b.lock_read().unlock)
606
if len(revision) != 1:
607
raise errors.BzrCommandError(gettext(
608
"Revision numbers only make sense for single "
609
"revisions, not ranges"))
610
revid = revision[0].as_revision_id(b)
612
revid = b.last_revision()
614
revno_t = b.revision_id_to_dotted_revno(revid)
615
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
617
revno = ".".join(str(n) for n in revno_t)
619
self.outf.write(revno + '\n')
622
class cmd_revision_info(Command):
623
__doc__ = """Show revision number and revision id for a given revision identifier.
626
takes_args = ['revision_info*']
629
custom_help('directory',
630
help='Branch to examine, '
631
'rather than the one containing the working directory.'),
632
Option('tree', help='Show revno of working tree.'),
636
def run(self, revision=None, directory=u'.', tree=False,
637
revision_info_list=[]):
640
wt = WorkingTree.open_containing(directory)[0]
642
self.add_cleanup(wt.lock_read().unlock)
643
except (errors.NoWorkingTree, errors.NotLocalUrl):
645
b = Branch.open_containing(directory)[0]
646
self.add_cleanup(b.lock_read().unlock)
648
if revision is not None:
649
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
650
if revision_info_list is not None:
651
for rev_str in revision_info_list:
652
rev_spec = RevisionSpec.from_string(rev_str)
653
revision_ids.append(rev_spec.as_revision_id(b))
654
# No arguments supplied, default to the last revision
655
if len(revision_ids) == 0:
658
raise errors.NoWorkingTree(directory)
659
revision_ids.append(wt.last_revision())
661
revision_ids.append(b.last_revision())
665
for revision_id in revision_ids:
667
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
668
revno = '.'.join(str(i) for i in dotted_revno)
669
except errors.NoSuchRevision:
671
maxlen = max(maxlen, len(revno))
672
revinfos.append((revno, revision_id))
675
for revno, revid in revinfos:
676
self.outf.write('%*s %s\n' % (maxlen, revno, revid.decode('utf-8')))
679
class cmd_add(Command):
680
__doc__ = """Add specified files or directories.
682
In non-recursive mode, all the named items are added, regardless
683
of whether they were previously ignored. A warning is given if
684
any of the named files are already versioned.
686
In recursive mode (the default), files are treated the same way
687
but the behaviour for directories is different. Directories that
688
are already versioned do not give a warning. All directories,
689
whether already versioned or not, are searched for files or
690
subdirectories that are neither versioned or ignored, and these
691
are added. This search proceeds recursively into versioned
692
directories. If no names are given '.' is assumed.
694
A warning will be printed when nested trees are encountered,
695
unless they are explicitly ignored.
697
Therefore simply saying 'brz add' will version all files that
698
are currently unknown.
700
Adding a file whose parent directory is not versioned will
701
implicitly add the parent, and so on up to the root. This means
702
you should never need to explicitly add a directory, they'll just
703
get added when you add a file in the directory.
705
--dry-run will show which files would be added, but not actually
708
--file-ids-from will try to use the file ids from the supplied path.
709
It looks up ids trying to find a matching parent directory with the
710
same filename, and then by pure path. This option is rarely needed
711
but can be useful when adding the same logical file into two
712
branches that will be merged later (without showing the two different
713
adds as a conflict). It is also useful when merging another project
714
into a subdirectory of this one.
716
Any files matching patterns in the ignore list will not be added
717
unless they are explicitly mentioned.
719
In recursive mode, files larger than the configuration option
720
add.maximum_file_size will be skipped. Named items are never skipped due
723
takes_args = ['file*']
726
help="Don't recursively add the contents of directories.",
729
help="Show what would be done, but don't actually do anything."),
731
Option('file-ids-from',
733
help='Lookup file ids from this tree.'),
735
encoding_type = 'replace'
736
_see_also = ['remove', 'ignore']
738
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
743
if file_ids_from is not None:
745
base_tree, base_path = WorkingTree.open_containing(
747
except errors.NoWorkingTree:
748
base_branch, base_path = Branch.open_containing(
750
base_tree = base_branch.basis_tree()
752
action = breezy.add.AddFromBaseAction(base_tree, base_path,
753
to_file=self.outf, should_print=(not is_quiet()))
755
action = breezy.add.AddWithSkipLargeAction(to_file=self.outf,
756
should_print=(not is_quiet()))
759
self.add_cleanup(base_tree.lock_read().unlock)
760
tree, file_list = tree_files_for_add(file_list)
761
added, ignored = tree.smart_add(file_list, not
762
no_recurse, action=action, save=not dry_run)
766
for glob in sorted(ignored):
767
for path in ignored[glob]:
769
gettext("ignored {0} matching \"{1}\"\n").format(
773
class cmd_mkdir(Command):
774
__doc__ = """Create a new versioned directory.
776
This is equivalent to creating the directory and then adding it.
779
takes_args = ['dir+']
783
help='No error if existing, make parent directories as needed.',
787
encoding_type = 'replace'
790
def add_file_with_parents(cls, wt, relpath):
791
if wt.is_versioned(relpath):
793
cls.add_file_with_parents(wt, osutils.dirname(relpath))
797
def add_file_single(cls, wt, relpath):
800
def run(self, dir_list, parents=False):
802
add_file = self.add_file_with_parents
804
add_file = self.add_file_single
806
wt, relpath = WorkingTree.open_containing(dir)
811
if e.errno != errno.EEXIST:
815
add_file(wt, relpath)
817
self.outf.write(gettext('added %s\n') % dir)
820
class cmd_relpath(Command):
821
__doc__ = """Show path of a file relative to root"""
823
takes_args = ['filename']
827
def run(self, filename):
828
# TODO: jam 20050106 Can relpath return a munged path if
829
# sys.stdout encoding cannot represent it?
830
tree, relpath = WorkingTree.open_containing(filename)
831
self.outf.write(relpath)
832
self.outf.write('\n')
835
class cmd_inventory(Command):
836
__doc__ = """Show inventory of the current working copy or a revision.
838
It is possible to limit the output to a particular entry
839
type using the --kind option. For example: --kind file.
841
It is also possible to restrict the list of files to a specific
842
set. For example: brz inventory --show-ids this/file
851
help='List entries of a particular kind: file, directory, symlink.',
854
takes_args = ['file*']
857
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
858
if kind and kind not in ['file', 'directory', 'symlink']:
859
raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
861
revision = _get_one_revision('inventory', revision)
862
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
863
self.add_cleanup(work_tree.lock_read().unlock)
864
if revision is not None:
865
tree = revision.as_tree(work_tree.branch)
867
extra_trees = [work_tree]
868
self.add_cleanup(tree.lock_read().unlock)
873
self.add_cleanup(tree.lock_read().unlock)
874
if file_list is not None:
875
paths = tree.find_related_paths_across_trees(
876
file_list, extra_trees, require_versioned=True)
877
# find_ids_across_trees may include some paths that don't
879
entries = tree.iter_entries_by_dir(specific_files=paths)
881
entries = tree.iter_entries_by_dir()
883
for path, entry in sorted(entries):
884
if kind and kind != entry.kind:
889
self.outf.write('%-50s %s\n' % (path, entry.file_id.decode('utf-8')))
891
self.outf.write(path)
892
self.outf.write('\n')
895
class cmd_cp(Command):
896
__doc__ = """Copy a file.
899
brz cp OLDNAME NEWNAME
901
brz cp SOURCE... DESTINATION
903
If the last argument is a versioned directory, all the other names
904
are copied into it. Otherwise, there must be exactly two arguments
905
and the file is copied to a new name.
907
Files cannot be copied between branches. Only files can be copied
911
takes_args = ['names*']
914
encoding_type = 'replace'
916
def run(self, names_list):
917
if names_list is None:
919
if len(names_list) < 2:
920
raise errors.BzrCommandError(gettext("missing file argument"))
921
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
922
for file_name in rel_names[0:-1]:
924
raise errors.BzrCommandError(gettext("can not copy root of branch"))
925
self.add_cleanup(tree.lock_tree_write().unlock)
926
into_existing = osutils.isdir(names_list[-1])
927
if not into_existing:
929
(src, dst) = rel_names
931
raise errors.BzrCommandError(gettext('to copy multiple files the'
932
' destination must be a versioned'
936
pairs = [(n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
937
for n in rel_names[:-1]]
939
for src, dst in pairs:
941
src_kind = tree.stored_kind(src)
942
except errors.NoSuchFile:
943
raise errors.BzrCommandError(
944
gettext('Could not copy %s => %s: %s is not versioned.')
947
raise errors.BzrCommandError(
948
gettext('Could not copy %s => %s . %s is not versioned\\.'
950
if src_kind == 'directory':
951
raise errors.BzrCommandError(
952
gettext('Could not copy %s => %s . %s is a directory.'
954
dst_parent = osutils.split(dst)[0]
957
dst_parent_kind = tree.stored_kind(dst_parent)
958
except errors.NoSuchFile:
959
raise errors.BzrCommandError(
960
gettext('Could not copy %s => %s: %s is not versioned.')
961
% (src, dst, dst_parent))
962
if dst_parent_kind != 'directory':
963
raise errors.BzrCommandError(
964
gettext('Could not copy to %s: %s is not a directory.')
965
% (dst_parent, dst_parent))
967
tree.copy_one(src, dst)
970
class cmd_mv(Command):
971
__doc__ = """Move or rename a file.
974
brz mv OLDNAME NEWNAME
976
brz mv SOURCE... DESTINATION
978
If the last argument is a versioned directory, all the other names
979
are moved into it. Otherwise, there must be exactly two arguments
980
and the file is changed to a new name.
982
If OLDNAME does not exist on the filesystem but is versioned and
983
NEWNAME does exist on the filesystem but is not versioned, mv
984
assumes that the file has been manually moved and only updates
985
its internal inventory to reflect that change.
986
The same is valid when moving many SOURCE files to a DESTINATION.
988
Files cannot be moved between branches.
991
takes_args = ['names*']
992
takes_options = [Option("after", help="Move only the brz identifier"
993
" of the file, because the file has already been moved."),
994
Option('auto', help='Automatically guess renames.'),
995
Option('dry-run', help='Avoid making changes when guessing renames.'),
997
aliases = ['move', 'rename']
998
encoding_type = 'replace'
1000
def run(self, names_list, after=False, auto=False, dry_run=False):
1002
return self.run_auto(names_list, after, dry_run)
1004
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1005
if names_list is None:
1007
if len(names_list) < 2:
1008
raise errors.BzrCommandError(gettext("missing file argument"))
1009
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
1010
for file_name in rel_names[0:-1]:
1012
raise errors.BzrCommandError(gettext("can not move root of branch"))
1013
self.add_cleanup(tree.lock_tree_write().unlock)
1014
self._run(tree, names_list, rel_names, after)
1016
def run_auto(self, names_list, after, dry_run):
1017
if names_list is not None and len(names_list) > 1:
1018
raise errors.BzrCommandError(gettext('Only one path may be specified to'
1021
raise errors.BzrCommandError(gettext('--after cannot be specified with'
1023
work_tree, file_list = WorkingTree.open_containing_paths(
1024
names_list, default_directory='.')
1025
self.add_cleanup(work_tree.lock_tree_write().unlock)
1026
rename_map.RenameMap.guess_renames(
1027
work_tree.basis_tree(), work_tree, dry_run)
1029
def _run(self, tree, names_list, rel_names, after):
1030
into_existing = osutils.isdir(names_list[-1])
1031
if into_existing and len(names_list) == 2:
1033
# a. case-insensitive filesystem and change case of dir
1034
# b. move directory after the fact (if the source used to be
1035
# a directory, but now doesn't exist in the working tree
1036
# and the target is an existing directory, just rename it)
1037
if (not tree.case_sensitive
1038
and rel_names[0].lower() == rel_names[1].lower()):
1039
into_existing = False
1041
# 'fix' the case of a potential 'from'
1042
from_path = tree.get_canonical_path(rel_names[0])
1043
if (not osutils.lexists(names_list[0]) and
1044
tree.is_versioned(from_path) and
1045
tree.stored_kind(from_path) == "directory"):
1046
into_existing = False
1049
# move into existing directory
1050
# All entries reference existing inventory items, so fix them up
1051
# for cicp file-systems.
1052
rel_names = list(tree.get_canonical_paths(rel_names))
1053
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1055
self.outf.write("%s => %s\n" % (src, dest))
1057
if len(names_list) != 2:
1058
raise errors.BzrCommandError(gettext('to mv multiple files the'
1059
' destination must be a versioned'
1062
# for cicp file-systems: the src references an existing inventory
1064
src = tree.get_canonical_path(rel_names[0])
1065
# Find the canonical version of the destination: In all cases, the
1066
# parent of the target must be in the inventory, so we fetch the
1067
# canonical version from there (we do not always *use* the
1068
# canonicalized tail portion - we may be attempting to rename the
1070
canon_dest = tree.get_canonical_path(rel_names[1])
1071
dest_parent = osutils.dirname(canon_dest)
1072
spec_tail = osutils.basename(rel_names[1])
1073
# For a CICP file-system, we need to avoid creating 2 inventory
1074
# entries that differ only by case. So regardless of the case
1075
# we *want* to use (ie, specified by the user or the file-system),
1076
# we must always choose to use the case of any existing inventory
1077
# items. The only exception to this is when we are attempting a
1078
# case-only rename (ie, canonical versions of src and dest are
1080
dest_id = tree.path2id(canon_dest)
1081
if dest_id is None or tree.path2id(src) == dest_id:
1082
# No existing item we care about, so work out what case we
1083
# are actually going to use.
1085
# If 'after' is specified, the tail must refer to a file on disk.
1087
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
1089
# pathjoin with an empty tail adds a slash, which breaks
1091
dest_parent_fq = tree.basedir
1093
dest_tail = osutils.canonical_relpath(
1095
osutils.pathjoin(dest_parent_fq, spec_tail))
1097
# not 'after', so case as specified is used
1098
dest_tail = spec_tail
1100
# Use the existing item so 'mv' fails with AlreadyVersioned.
1101
dest_tail = os.path.basename(canon_dest)
1102
dest = osutils.pathjoin(dest_parent, dest_tail)
1103
mutter("attempting to move %s => %s", src, dest)
1104
tree.rename_one(src, dest, after=after)
1106
self.outf.write("%s => %s\n" % (src, dest))
1109
class cmd_pull(Command):
1110
__doc__ = """Turn this branch into a mirror of another branch.
1112
By default, this command only works on branches that have not diverged.
1113
Branches are considered diverged if the destination branch's most recent
1114
commit is one that has not been merged (directly or indirectly) into the
1117
If branches have diverged, you can use 'brz merge' to integrate the changes
1118
from one into the other. Once one branch has merged, the other should
1119
be able to pull it again.
1121
If you want to replace your local changes and just want your branch to
1122
match the remote one, use pull --overwrite. This will work even if the two
1123
branches have diverged.
1125
If there is no default location set, the first pull will set it (use
1126
--no-remember to avoid setting it). After that, you can omit the
1127
location to use the default. To change the default, use --remember. The
1128
value will only be saved if the remote location can be accessed.
1130
The --verbose option will display the revisions pulled using the log_format
1131
configuration option. You can use a different format by overriding it with
1132
-Olog_format=<other_format>.
1134
Note: The location can be specified either in the form of a branch,
1135
or in the form of a path to a file containing a merge directive generated
1139
_see_also = ['push', 'update', 'status-flags', 'send']
1140
takes_options = ['remember', 'overwrite', 'revision',
1141
custom_help('verbose',
1142
help='Show logs of pulled revisions.'),
1143
custom_help('directory',
1144
help='Branch to pull into, '
1145
'rather than the one containing the working directory.'),
1147
help="Perform a local pull in a bound "
1148
"branch. Local pulls are not applied to "
1149
"the master branch."
1152
help="Show base revision text in conflicts."),
1153
Option('overwrite-tags',
1154
help="Overwrite tags only."),
1156
takes_args = ['location?']
1157
encoding_type = 'replace'
1159
def run(self, location=None, remember=None, overwrite=False,
1160
revision=None, verbose=False,
1161
directory=None, local=False,
1162
show_base=False, overwrite_tags=False):
1165
overwrite = ["history", "tags"]
1166
elif overwrite_tags:
1167
overwrite = ["tags"]
1170
# FIXME: too much stuff is in the command class
1173
if directory is None:
1176
tree_to = WorkingTree.open_containing(directory)[0]
1177
branch_to = tree_to.branch
1178
self.add_cleanup(tree_to.lock_write().unlock)
1179
except errors.NoWorkingTree:
1181
branch_to = Branch.open_containing(directory)[0]
1182
self.add_cleanup(branch_to.lock_write().unlock)
1184
warning(gettext("No working tree, ignoring --show-base"))
1186
if local and not branch_to.get_bound_location():
1187
raise errors.LocalRequiresBoundBranch()
1189
possible_transports = []
1190
if location is not None:
1192
mergeable = bundle.read_mergeable_from_url(location,
1193
possible_transports=possible_transports)
1194
except errors.NotABundle:
1197
stored_loc = branch_to.get_parent()
1198
if location is None:
1199
if stored_loc is None:
1200
raise errors.BzrCommandError(gettext("No pull location known or"
1203
display_url = urlutils.unescape_for_display(stored_loc,
1206
self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
1207
location = stored_loc
1209
revision = _get_one_revision('pull', revision)
1210
if mergeable is not None:
1211
if revision is not None:
1212
raise errors.BzrCommandError(gettext(
1213
'Cannot use -r with merge directives or bundles'))
1214
mergeable.install_revisions(branch_to.repository)
1215
base_revision_id, revision_id, verified = \
1216
mergeable.get_merge_request(branch_to.repository)
1217
branch_from = branch_to
1219
branch_from = Branch.open(location,
1220
possible_transports=possible_transports)
1221
self.add_cleanup(branch_from.lock_read().unlock)
1222
# Remembers if asked explicitly or no previous location is set
1224
or (remember is None and branch_to.get_parent() is None)):
1225
# FIXME: This shouldn't be done before the pull
1226
# succeeds... -- vila 2012-01-02
1227
branch_to.set_parent(branch_from.base)
1229
if revision is not None:
1230
revision_id = revision.as_revision_id(branch_from)
1232
if tree_to is not None:
1233
view_info = _get_view_info_for_change_reporter(tree_to)
1234
change_reporter = delta._ChangeReporter(
1235
unversioned_filter=tree_to.is_ignored,
1236
view_info=view_info)
1237
result = tree_to.pull(
1238
branch_from, overwrite, revision_id, change_reporter,
1239
local=local, show_base=show_base)
1241
result = branch_to.pull(
1242
branch_from, overwrite, revision_id, local=local)
1244
result.report(self.outf)
1245
if verbose and result.old_revid != result.new_revid:
1246
log.show_branch_change(
1247
branch_to, self.outf, result.old_revno,
1249
if getattr(result, 'tag_conflicts', None):
1255
class cmd_push(Command):
1256
__doc__ = """Update a mirror of this branch.
1258
The target branch will not have its working tree populated because this
1259
is both expensive, and is not supported on remote file systems.
1261
Some smart servers or protocols *may* put the working tree in place in
1264
This command only works on branches that have not diverged. Branches are
1265
considered diverged if the destination branch's most recent commit is one
1266
that has not been merged (directly or indirectly) by the source branch.
1268
If branches have diverged, you can use 'brz push --overwrite' to replace
1269
the other branch completely, discarding its unmerged changes.
1271
If you want to ensure you have the different changes in the other branch,
1272
do a merge (see brz help merge) from the other branch, and commit that.
1273
After that you will be able to do a push without '--overwrite'.
1275
If there is no default push location set, the first push will set it (use
1276
--no-remember to avoid setting it). After that, you can omit the
1277
location to use the default. To change the default, use --remember. The
1278
value will only be saved if the remote location can be accessed.
1280
The --verbose option will display the revisions pushed using the log_format
1281
configuration option. You can use a different format by overriding it with
1282
-Olog_format=<other_format>.
1285
_see_also = ['pull', 'update', 'working-trees']
1286
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1287
Option('create-prefix',
1288
help='Create the path leading up to the branch '
1289
'if it does not already exist.'),
1290
custom_help('directory',
1291
help='Branch to push from, '
1292
'rather than the one containing the working directory.'),
1293
Option('use-existing-dir',
1294
help='By default push will fail if the target'
1295
' directory exists, but does not already'
1296
' have a control directory. This flag will'
1297
' allow push to proceed.'),
1299
help='Create a stacked branch that references the public location '
1300
'of the parent branch.'),
1301
Option('stacked-on',
1302
help='Create a stacked branch that refers to another branch '
1303
'for the commit history. Only the work not present in the '
1304
'referenced branch is included in the branch created.',
1307
help='Refuse to push if there are uncommitted changes in'
1308
' the working tree, --no-strict disables the check.'),
1310
help="Don't populate the working tree, even for protocols"
1311
" that support it."),
1312
Option('overwrite-tags',
1313
help="Overwrite tags only."),
1314
Option('lossy', help="Allow lossy push, i.e. dropping metadata "
1315
"that can't be represented in the target.")
1317
takes_args = ['location?']
1318
encoding_type = 'replace'
1320
def run(self, location=None, remember=None, overwrite=False,
1321
create_prefix=False, verbose=False, revision=None,
1322
use_existing_dir=False, directory=None, stacked_on=None,
1323
stacked=False, strict=None, no_tree=False,
1324
overwrite_tags=False, lossy=False):
1325
from .push import _show_push_branch
1328
overwrite = ["history", "tags"]
1329
elif overwrite_tags:
1330
overwrite = ["tags"]
1334
if directory is None:
1336
# Get the source branch
1338
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1339
# Get the tip's revision_id
1340
revision = _get_one_revision('push', revision)
1341
if revision is not None:
1342
revision_id = revision.in_history(br_from).rev_id
1345
if tree is not None and revision_id is None:
1346
tree.check_changed_or_out_of_date(
1347
strict, 'push_strict',
1348
more_error='Use --no-strict to force the push.',
1349
more_warning='Uncommitted changes will not be pushed.')
1350
# Get the stacked_on branch, if any
1351
if stacked_on is not None:
1352
stacked_on = urlutils.normalize_url(stacked_on)
1354
parent_url = br_from.get_parent()
1356
parent = Branch.open(parent_url)
1357
stacked_on = parent.get_public_branch()
1359
# I considered excluding non-http url's here, thus forcing
1360
# 'public' branches only, but that only works for some
1361
# users, so it's best to just depend on the user spotting an
1362
# error by the feedback given to them. RBC 20080227.
1363
stacked_on = parent_url
1365
raise errors.BzrCommandError(gettext(
1366
"Could not determine branch to refer to."))
1368
# Get the destination location
1369
if location is None:
1370
stored_loc = br_from.get_push_location()
1371
if stored_loc is None:
1372
parent_loc = br_from.get_parent()
1374
raise errors.BzrCommandError(gettext(
1375
"No push location known or specified. To push to the "
1376
"parent branch (at %s), use 'brz push :parent'." %
1377
urlutils.unescape_for_display(parent_loc,
1378
self.outf.encoding)))
1380
raise errors.BzrCommandError(gettext(
1381
"No push location known or specified."))
1383
display_url = urlutils.unescape_for_display(stored_loc,
1385
note(gettext("Using saved push location: %s") % display_url)
1386
location = stored_loc
1388
_show_push_branch(br_from, revision_id, location, self.outf,
1389
verbose=verbose, overwrite=overwrite, remember=remember,
1390
stacked_on=stacked_on, create_prefix=create_prefix,
1391
use_existing_dir=use_existing_dir, no_tree=no_tree,
1395
class cmd_branch(Command):
1396
__doc__ = """Create a new branch that is a copy of an existing branch.
1398
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1399
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1400
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1401
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1402
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1405
To retrieve the branch as of a particular revision, supply the --revision
1406
parameter, as in "branch foo/bar -r 5".
1409
_see_also = ['checkout']
1410
takes_args = ['from_location', 'to_location?']
1411
takes_options = ['revision',
1412
Option('hardlink', help='Hard-link working tree files where possible.'),
1413
Option('files-from', type=text_type,
1414
help="Get file contents from this tree."),
1416
help="Create a branch without a working-tree."),
1418
help="Switch the checkout in the current directory "
1419
"to the new branch."),
1421
help='Create a stacked branch referring to the source branch. '
1422
'The new branch will depend on the availability of the source '
1423
'branch for all operations.'),
1424
Option('standalone',
1425
help='Do not use a shared repository, even if available.'),
1426
Option('use-existing-dir',
1427
help='By default branch will fail if the target'
1428
' directory exists, but does not already'
1429
' have a control directory. This flag will'
1430
' allow branch to proceed.'),
1432
help="Bind new branch to from location."),
1435
def run(self, from_location, to_location=None, revision=None,
1436
hardlink=False, stacked=False, standalone=False, no_tree=False,
1437
use_existing_dir=False, switch=False, bind=False,
1439
from breezy import switch as _mod_switch
1440
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1442
if not (hardlink or files_from):
1443
# accelerator_tree is usually slower because you have to read N
1444
# files (no readahead, lots of seeks, etc), but allow the user to
1445
# explicitly request it
1446
accelerator_tree = None
1447
if files_from is not None and files_from != from_location:
1448
accelerator_tree = WorkingTree.open(files_from)
1449
revision = _get_one_revision('branch', revision)
1450
self.add_cleanup(br_from.lock_read().unlock)
1451
if revision is not None:
1452
revision_id = revision.as_revision_id(br_from)
1454
# FIXME - wt.last_revision, fallback to branch, fall back to
1455
# None or perhaps NULL_REVISION to mean copy nothing
1457
revision_id = br_from.last_revision()
1458
if to_location is None:
1459
to_location = urlutils.derive_to_location(from_location)
1460
to_transport = transport.get_transport(to_location)
1462
to_transport.mkdir('.')
1463
except errors.FileExists:
1465
to_dir = controldir.ControlDir.open_from_transport(
1467
except errors.NotBranchError:
1468
if not use_existing_dir:
1469
raise errors.BzrCommandError(gettext('Target directory "%s" '
1470
'already exists.') % to_location)
1475
to_dir.open_branch()
1476
except errors.NotBranchError:
1479
raise errors.AlreadyBranchError(to_location)
1480
except errors.NoSuchFile:
1481
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1487
# preserve whatever source format we have.
1488
to_dir = br_from.controldir.sprout(
1489
to_transport.base, revision_id,
1490
possible_transports=[to_transport],
1491
accelerator_tree=accelerator_tree, hardlink=hardlink,
1492
stacked=stacked, force_new_repo=standalone,
1493
create_tree_if_local=not no_tree, source_branch=br_from)
1494
branch = to_dir.open_branch(
1495
possible_transports=[
1496
br_from.controldir.root_transport, to_transport])
1497
except errors.NoSuchRevision:
1498
to_transport.delete_tree('.')
1499
msg = gettext("The branch {0} has no revision {1}.").format(
1500
from_location, revision)
1501
raise errors.BzrCommandError(msg)
1504
to_repo = to_dir.open_repository()
1505
except errors.NoRepositoryPresent:
1506
to_repo = to_dir.create_repository()
1507
to_repo.fetch(br_from.repository, revision_id=revision_id)
1508
branch = br_from.sprout(to_dir, revision_id=revision_id)
1509
br_from.tags.merge_to(branch.tags)
1511
# If the source branch is stacked, the new branch may
1512
# be stacked whether we asked for that explicitly or not.
1513
# We therefore need a try/except here and not just 'if stacked:'
1515
note(gettext('Created new stacked branch referring to %s.') %
1516
branch.get_stacked_on_url())
1517
except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
1518
errors.UnstackableRepositoryFormat) as e:
1519
revno = branch.revno()
1520
if revno is not None:
1521
note(ngettext('Branched %d revision.', 'Branched %d revisions.',
1522
branch.revno()) % revno)
1524
note(gettext('Created new branch.'))
1526
# Bind to the parent
1527
parent_branch = Branch.open(from_location)
1528
branch.bind(parent_branch)
1529
note(gettext('New branch bound to %s') % from_location)
1531
# Switch to the new branch
1532
wt, _ = WorkingTree.open_containing('.')
1533
_mod_switch.switch(wt.controldir, branch)
1534
note(gettext('Switched to branch: %s'),
1535
urlutils.unescape_for_display(branch.base, 'utf-8'))
1538
class cmd_branches(Command):
1539
__doc__ = """List the branches available at the current location.
1541
This command will print the names of all the branches at the current
1545
takes_args = ['location?']
1547
Option('recursive', short_name='R',
1548
help='Recursively scan for branches rather than '
1549
'just looking in the specified location.')]
1551
def run(self, location=".", recursive=False):
1553
t = transport.get_transport(location)
1554
if not t.listable():
1555
raise errors.BzrCommandError(
1556
"Can't scan this type of location.")
1557
for b in controldir.ControlDir.find_branches(t):
1558
self.outf.write("%s\n" % urlutils.unescape_for_display(
1559
urlutils.relative_url(t.base, b.base),
1560
self.outf.encoding).rstrip("/"))
1562
dir = controldir.ControlDir.open_containing(location)[0]
1564
active_branch = dir.open_branch(name="")
1565
except errors.NotBranchError:
1566
active_branch = None
1568
for name, branch in iter_sibling_branches(dir):
1571
active = (active_branch is not None and
1572
active_branch.user_url == branch.user_url)
1573
names[name] = active
1574
# Only mention the current branch explicitly if it's not
1575
# one of the colocated branches
1576
if not any(viewvalues(names)) and active_branch is not None:
1577
self.outf.write("* %s\n" % gettext("(default)"))
1578
for name in sorted(names):
1579
active = names[name]
1584
self.outf.write("%s %s\n" % (
1585
prefix, (name if PY3 else name.encode(self.outf.encoding))))
1588
class cmd_checkout(Command):
1589
__doc__ = """Create a new checkout of an existing branch.
1591
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1592
the branch found in '.'. This is useful if you have removed the working tree
1593
or if it was never created - i.e. if you pushed the branch to its current
1594
location using SFTP.
1596
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1597
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1598
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1599
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1600
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1603
To retrieve the branch as of a particular revision, supply the --revision
1604
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1605
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1609
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1610
takes_args = ['branch_location?', 'to_location?']
1611
takes_options = ['revision',
1612
Option('lightweight',
1613
help="Perform a lightweight checkout. Lightweight "
1614
"checkouts depend on access to the branch for "
1615
"every operation. Normal checkouts can perform "
1616
"common operations like diff and status without "
1617
"such access, and also support local commits."
1619
Option('files-from', type=text_type,
1620
help="Get file contents from this tree."),
1622
help='Hard-link working tree files where possible.'
1627
def run(self, branch_location=None, to_location=None, revision=None,
1628
lightweight=False, files_from=None, hardlink=False):
1629
if branch_location is None:
1630
branch_location = osutils.getcwd()
1631
to_location = branch_location
1632
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1634
if not (hardlink or files_from):
1635
# accelerator_tree is usually slower because you have to read N
1636
# files (no readahead, lots of seeks, etc), but allow the user to
1637
# explicitly request it
1638
accelerator_tree = None
1639
revision = _get_one_revision('checkout', revision)
1640
if files_from is not None and files_from != branch_location:
1641
accelerator_tree = WorkingTree.open(files_from)
1642
if revision is not None:
1643
revision_id = revision.as_revision_id(source)
1646
if to_location is None:
1647
to_location = urlutils.derive_to_location(branch_location)
1648
# if the source and to_location are the same,
1649
# and there is no working tree,
1650
# then reconstitute a branch
1651
if (osutils.abspath(to_location) ==
1652
osutils.abspath(branch_location)):
1654
source.controldir.open_workingtree()
1655
except errors.NoWorkingTree:
1656
source.controldir.create_workingtree(revision_id)
1658
source.create_checkout(to_location, revision_id, lightweight,
1659
accelerator_tree, hardlink)
1662
class cmd_renames(Command):
1663
__doc__ = """Show list of renamed files.
1665
# TODO: Option to show renames between two historical versions.
1667
# TODO: Only show renames under dir, rather than in the whole branch.
1668
_see_also = ['status']
1669
takes_args = ['dir?']
1672
def run(self, dir=u'.'):
1673
tree = WorkingTree.open_containing(dir)[0]
1674
self.add_cleanup(tree.lock_read().unlock)
1675
old_tree = tree.basis_tree()
1676
self.add_cleanup(old_tree.lock_read().unlock)
1678
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1679
for f, paths, c, v, p, n, k, e in iterator:
1680
if paths[0] == paths[1]:
1684
renames.append(paths)
1686
for old_name, new_name in renames:
1687
self.outf.write("%s => %s\n" % (old_name, new_name))
1690
class cmd_update(Command):
1691
__doc__ = """Update a working tree to a new revision.
1693
This will perform a merge of the destination revision (the tip of the
1694
branch, or the specified revision) into the working tree, and then make
1695
that revision the basis revision for the working tree.
1697
You can use this to visit an older revision, or to update a working tree
1698
that is out of date from its branch.
1700
If there are any uncommitted changes in the tree, they will be carried
1701
across and remain as uncommitted changes after the update. To discard
1702
these changes, use 'brz revert'. The uncommitted changes may conflict
1703
with the changes brought in by the change in basis revision.
1705
If the tree's branch is bound to a master branch, brz will also update
1706
the branch from the master.
1708
You cannot update just a single file or directory, because each Bazaar
1709
working tree has just a single basis revision. If you want to restore a
1710
file that has been removed locally, use 'brz revert' instead of 'brz
1711
update'. If you want to restore a file to its state in a previous
1712
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1713
out the old content of that file to a new location.
1715
The 'dir' argument, if given, must be the location of the root of a
1716
working tree to update. By default, the working tree that contains the
1717
current working directory is used.
1720
_see_also = ['pull', 'working-trees', 'status-flags']
1721
takes_args = ['dir?']
1722
takes_options = ['revision',
1724
help="Show base revision text in conflicts."),
1728
def run(self, dir=None, revision=None, show_base=None):
1729
if revision is not None and len(revision) != 1:
1730
raise errors.BzrCommandError(gettext(
1731
"brz update --revision takes exactly one revision"))
1733
tree = WorkingTree.open_containing('.')[0]
1735
tree, relpath = WorkingTree.open_containing(dir)
1738
raise errors.BzrCommandError(gettext(
1739
"brz update can only update a whole tree, "
1740
"not a file or subdirectory"))
1741
branch = tree.branch
1742
possible_transports = []
1743
master = branch.get_master_branch(
1744
possible_transports=possible_transports)
1745
if master is not None:
1746
branch_location = master.base
1749
branch_location = tree.branch.base
1750
tree.lock_tree_write()
1751
self.add_cleanup(tree.unlock)
1752
# get rid of the final '/' and be ready for display
1753
branch_location = urlutils.unescape_for_display(
1754
branch_location.rstrip('/'),
1756
existing_pending_merges = tree.get_parent_ids()[1:]
1760
# may need to fetch data into a heavyweight checkout
1761
# XXX: this may take some time, maybe we should display a
1763
old_tip = branch.update(possible_transports)
1764
if revision is not None:
1765
revision_id = revision[0].as_revision_id(branch)
1767
revision_id = branch.last_revision()
1768
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1769
revno = branch.revision_id_to_dotted_revno(revision_id)
1770
note(gettext("Tree is up to date at revision {0} of branch {1}"
1771
).format('.'.join(map(str, revno)), branch_location))
1773
view_info = _get_view_info_for_change_reporter(tree)
1774
change_reporter = delta._ChangeReporter(
1775
unversioned_filter=tree.is_ignored,
1776
view_info=view_info)
1778
conflicts = tree.update(
1780
possible_transports=possible_transports,
1781
revision=revision_id,
1783
show_base=show_base)
1784
except errors.NoSuchRevision as e:
1785
raise errors.BzrCommandError(gettext(
1786
"branch has no revision %s\n"
1787
"brz update --revision only works"
1788
" for a revision in the branch history")
1790
revno = tree.branch.revision_id_to_dotted_revno(
1791
_mod_revision.ensure_null(tree.last_revision()))
1792
note(gettext('Updated to revision {0} of branch {1}').format(
1793
'.'.join(map(str, revno)), branch_location))
1794
parent_ids = tree.get_parent_ids()
1795
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1796
note(gettext('Your local commits will now show as pending merges with '
1797
"'brz status', and can be committed with 'brz commit'."))
1804
class cmd_info(Command):
1805
__doc__ = """Show information about a working tree, branch or repository.
1807
This command will show all known locations and formats associated to the
1808
tree, branch or repository.
1810
In verbose mode, statistical information is included with each report.
1811
To see extended statistic information, use a verbosity level of 2 or
1812
higher by specifying the verbose option multiple times, e.g. -vv.
1814
Branches and working trees will also report any missing revisions.
1818
Display information on the format and related locations:
1822
Display the above together with extended format information and
1823
basic statistics (like the number of files in the working tree and
1824
number of revisions in the branch and repository):
1828
Display the above together with number of committers to the branch:
1832
_see_also = ['revno', 'working-trees', 'repositories']
1833
takes_args = ['location?']
1834
takes_options = ['verbose']
1835
encoding_type = 'replace'
1838
def run(self, location=None, verbose=False):
1840
noise_level = get_verbosity_level()
1843
from .info import show_bzrdir_info
1844
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1845
verbose=noise_level, outfile=self.outf)
1848
class cmd_remove(Command):
1849
__doc__ = """Remove files or directories.
1851
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1852
delete them if they can easily be recovered using revert otherwise they
1853
will be backed up (adding an extension of the form .~#~). If no options or
1854
parameters are given Bazaar will scan for files that are being tracked by
1855
Bazaar but missing in your tree and stop tracking them for you.
1857
takes_args = ['file*']
1858
takes_options = ['verbose',
1859
Option('new', help='Only remove files that have never been committed.'),
1860
RegistryOption.from_kwargs('file-deletion-strategy',
1861
'The file deletion mode to be used.',
1862
title='Deletion Strategy', value_switches=True, enum_switch=False,
1863
safe='Backup changed files (default).',
1864
keep='Delete from brz but leave the working copy.',
1865
no_backup='Don\'t backup changed files.'),
1867
aliases = ['rm', 'del']
1868
encoding_type = 'replace'
1870
def run(self, file_list, verbose=False, new=False,
1871
file_deletion_strategy='safe'):
1873
tree, file_list = WorkingTree.open_containing_paths(file_list)
1875
if file_list is not None:
1876
file_list = [f for f in file_list]
1878
self.add_cleanup(tree.lock_write().unlock)
1879
# Heuristics should probably all move into tree.remove_smart or
1882
added = tree.changes_from(tree.basis_tree(),
1883
specific_files=file_list).added
1884
file_list = sorted([f[0] for f in added], reverse=True)
1885
if len(file_list) == 0:
1886
raise errors.BzrCommandError(gettext('No matching files.'))
1887
elif file_list is None:
1888
# missing files show up in iter_changes(basis) as
1889
# versioned-with-no-kind.
1891
for change in tree.iter_changes(tree.basis_tree()):
1892
# Find paths in the working tree that have no kind:
1893
if change[1][1] is not None and change[6][1] is None:
1894
missing.append(change[1][1])
1895
file_list = sorted(missing, reverse=True)
1896
file_deletion_strategy = 'keep'
1897
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1898
keep_files=file_deletion_strategy=='keep',
1899
force=(file_deletion_strategy=='no-backup'))
1902
class cmd_file_id(Command):
1903
__doc__ = """Print file_id of a particular file or directory.
1905
The file_id is assigned when the file is first added and remains the
1906
same through all revisions where the file exists, even when it is
1911
_see_also = ['inventory', 'ls']
1912
takes_args = ['filename']
1915
def run(self, filename):
1916
tree, relpath = WorkingTree.open_containing(filename)
1917
file_id = tree.path2id(relpath)
1919
raise errors.NotVersionedError(filename)
1921
self.outf.write(file_id.decode('utf-8') + '\n')
1924
class cmd_file_path(Command):
1925
__doc__ = """Print path of file_ids to a file or directory.
1927
This prints one line for each directory down to the target,
1928
starting at the branch root.
1932
takes_args = ['filename']
1935
def run(self, filename):
1936
tree, relpath = WorkingTree.open_containing(filename)
1937
fid = tree.path2id(relpath)
1939
raise errors.NotVersionedError(filename)
1940
segments = osutils.splitpath(relpath)
1941
for pos in range(1, len(segments) + 1):
1942
path = osutils.joinpath(segments[:pos])
1943
self.outf.write("%s\n" % tree.path2id(path))
1946
class cmd_reconcile(Command):
1947
__doc__ = """Reconcile brz metadata in a branch.
1949
This can correct data mismatches that may have been caused by
1950
previous ghost operations or brz upgrades. You should only
1951
need to run this command if 'brz check' or a brz developer
1952
advises you to run it.
1954
If a second branch is provided, cross-branch reconciliation is
1955
also attempted, which will check that data like the tree root
1956
id which was not present in very early brz versions is represented
1957
correctly in both branches.
1959
At the same time it is run it may recompress data resulting in
1960
a potential saving in disk space or performance gain.
1962
The branch *MUST* be on a listable system such as local disk or sftp.
1965
_see_also = ['check']
1966
takes_args = ['branch?']
1968
Option('canonicalize-chks',
1969
help='Make sure CHKs are in canonical form (repairs '
1974
def run(self, branch=".", canonicalize_chks=False):
1975
from .reconcile import reconcile
1976
dir = controldir.ControlDir.open(branch)
1977
reconcile(dir, canonicalize_chks=canonicalize_chks)
1980
class cmd_revision_history(Command):
1981
__doc__ = """Display the list of revision ids on a branch."""
1984
takes_args = ['location?']
1989
def run(self, location="."):
1990
branch = Branch.open_containing(location)[0]
1991
self.add_cleanup(branch.lock_read().unlock)
1992
graph = branch.repository.get_graph()
1993
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
1994
[_mod_revision.NULL_REVISION]))
1995
for revid in reversed(history):
1996
self.outf.write(revid)
1997
self.outf.write('\n')
2000
class cmd_ancestry(Command):
2001
__doc__ = """List all revisions merged into this branch."""
2003
_see_also = ['log', 'revision-history']
2004
takes_args = ['location?']
2009
def run(self, location="."):
2011
wt = WorkingTree.open_containing(location)[0]
2012
except errors.NoWorkingTree:
2013
b = Branch.open(location)
2014
last_revision = b.last_revision()
2017
last_revision = wt.last_revision()
2019
self.add_cleanup(b.repository.lock_read().unlock)
2020
graph = b.repository.get_graph()
2021
revisions = [revid for revid, parents in
2022
graph.iter_ancestry([last_revision])]
2023
for revision_id in reversed(revisions):
2024
if _mod_revision.is_null(revision_id):
2026
self.outf.write(revision_id.decode('utf-8') + '\n')
2029
class cmd_init(Command):
2030
__doc__ = """Make a directory into a versioned branch.
2032
Use this to create an empty branch, or before importing an
2035
If there is a repository in a parent directory of the location, then
2036
the history of the branch will be stored in the repository. Otherwise
2037
init creates a standalone branch which carries its own history
2038
in the .bzr directory.
2040
If there is already a branch at the location but it has no working tree,
2041
the tree can be populated with 'brz checkout'.
2043
Recipe for importing a tree of files::
2049
brz commit -m "imported project"
2052
_see_also = ['init-repository', 'branch', 'checkout']
2053
takes_args = ['location?']
2055
Option('create-prefix',
2056
help='Create the path leading up to the branch '
2057
'if it does not already exist.'),
2058
RegistryOption('format',
2059
help='Specify a format for this branch. '
2060
'See "help formats" for a full list.',
2061
lazy_registry=('breezy.controldir', 'format_registry'),
2062
converter=lambda name: controldir.format_registry.make_controldir(name),
2063
value_switches=True,
2064
title="Branch format",
2066
Option('append-revisions-only',
2067
help='Never change revnos or the existing log.'
2068
' Append revisions to it only.'),
2070
'Create a branch without a working tree.')
2072
def run(self, location=None, format=None, append_revisions_only=False,
2073
create_prefix=False, no_tree=False):
2075
format = controldir.format_registry.make_controldir('default')
2076
if location is None:
2079
to_transport = transport.get_transport(location)
2081
# The path has to exist to initialize a
2082
# branch inside of it.
2083
# Just using os.mkdir, since I don't
2084
# believe that we want to create a bunch of
2085
# locations if the user supplies an extended path
2087
to_transport.ensure_base()
2088
except errors.NoSuchFile:
2089
if not create_prefix:
2090
raise errors.BzrCommandError(gettext("Parent directory of %s"
2092
"\nYou may supply --create-prefix to create all"
2093
" leading parent directories.")
2095
to_transport.create_prefix()
2098
a_controldir = controldir.ControlDir.open_from_transport(to_transport)
2099
except errors.NotBranchError:
2100
# really a NotBzrDir error...
2101
create_branch = controldir.ControlDir.create_branch_convenience
2103
force_new_tree = False
2105
force_new_tree = None
2106
branch = create_branch(to_transport.base, format=format,
2107
possible_transports=[to_transport],
2108
force_new_tree=force_new_tree)
2109
a_controldir = branch.controldir
2111
from .transport.local import LocalTransport
2112
if a_controldir.has_branch():
2113
if (isinstance(to_transport, LocalTransport)
2114
and not a_controldir.has_workingtree()):
2115
raise errors.BranchExistsWithoutWorkingTree(location)
2116
raise errors.AlreadyBranchError(location)
2117
branch = a_controldir.create_branch()
2118
if not no_tree and not a_controldir.has_workingtree():
2119
a_controldir.create_workingtree()
2120
if append_revisions_only:
2122
branch.set_append_revisions_only(True)
2123
except errors.UpgradeRequired:
2124
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2125
' to append-revisions-only. Try --default.'))
2127
from .info import describe_layout, describe_format
2129
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2130
except (errors.NoWorkingTree, errors.NotLocalUrl):
2132
repository = branch.repository
2133
layout = describe_layout(repository, branch, tree).lower()
2134
format = describe_format(a_controldir, repository, branch, tree)
2135
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2137
if repository.is_shared():
2138
#XXX: maybe this can be refactored into transport.path_or_url()
2139
url = repository.controldir.root_transport.external_url()
2141
url = urlutils.local_path_from_url(url)
2142
except urlutils.InvalidURL:
2144
self.outf.write(gettext("Using shared repository: %s\n") % url)
2147
class cmd_init_repository(Command):
2148
__doc__ = """Create a shared repository for branches to share storage space.
2150
New branches created under the repository directory will store their
2151
revisions in the repository, not in the branch directory. For branches
2152
with shared history, this reduces the amount of storage needed and
2153
speeds up the creation of new branches.
2155
If the --no-trees option is given then the branches in the repository
2156
will not have working trees by default. They will still exist as
2157
directories on disk, but they will not have separate copies of the
2158
files at a certain revision. This can be useful for repositories that
2159
store branches which are interacted with through checkouts or remote
2160
branches, such as on a server.
2163
Create a shared repository holding just branches::
2165
brz init-repo --no-trees repo
2168
Make a lightweight checkout elsewhere::
2170
brz checkout --lightweight repo/trunk trunk-checkout
2175
_see_also = ['init', 'branch', 'checkout', 'repositories']
2176
takes_args = ["location"]
2177
takes_options = [RegistryOption('format',
2178
help='Specify a format for this repository. See'
2179
' "brz help formats" for details.',
2180
lazy_registry=('breezy.controldir', 'format_registry'),
2181
converter=lambda name: controldir.format_registry.make_controldir(name),
2182
value_switches=True, title='Repository format'),
2184
help='Branches in the repository will default to'
2185
' not having a working tree.'),
2187
aliases = ["init-repo"]
2189
def run(self, location, format=None, no_trees=False):
2191
format = controldir.format_registry.make_controldir('default')
2193
if location is None:
2196
to_transport = transport.get_transport(location)
2198
if format.fixed_components:
2199
repo_format_name = None
2201
repo_format_name = format.repository_format.get_format_string()
2203
(repo, newdir, require_stacking, repository_policy) = (
2204
format.initialize_on_transport_ex(to_transport,
2205
create_prefix=True, make_working_trees=not no_trees,
2206
shared_repo=True, force_new_repo=True,
2207
use_existing_dir=True,
2208
repo_format_name=repo_format_name))
2210
from .info import show_bzrdir_info
2211
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2214
class cmd_diff(Command):
2215
__doc__ = """Show differences in the working tree, between revisions or branches.
2217
If no arguments are given, all changes for the current tree are listed.
2218
If files are given, only the changes in those files are listed.
2219
Remote and multiple branches can be compared by using the --old and
2220
--new options. If not provided, the default for both is derived from
2221
the first argument, if any, or the current tree if no arguments are
2224
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2225
produces patches suitable for "patch -p1".
2227
Note that when using the -r argument with a range of revisions, the
2228
differences are computed between the two specified revisions. That
2229
is, the command does not show the changes introduced by the first
2230
revision in the range. This differs from the interpretation of
2231
revision ranges used by "brz log" which includes the first revision
2236
2 - unrepresentable changes
2241
Shows the difference in the working tree versus the last commit::
2245
Difference between the working tree and revision 1::
2249
Difference between revision 3 and revision 1::
2253
Difference between revision 3 and revision 1 for branch xxx::
2257
The changes introduced by revision 2 (equivalent to -r1..2)::
2261
To see the changes introduced by revision X::
2265
Note that in the case of a merge, the -c option shows the changes
2266
compared to the left hand parent. To see the changes against
2267
another parent, use::
2269
brz diff -r<chosen_parent>..X
2271
The changes between the current revision and the previous revision
2272
(equivalent to -c-1 and -r-2..-1)
2276
Show just the differences for file NEWS::
2280
Show the differences in working tree xxx for file NEWS::
2284
Show the differences from branch xxx to this working tree:
2288
Show the differences between two branches for file NEWS::
2290
brz diff --old xxx --new yyy NEWS
2292
Same as 'brz diff' but prefix paths with old/ and new/::
2294
brz diff --prefix old/:new/
2296
Show the differences using a custom diff program with options::
2298
brz diff --using /usr/bin/diff --diff-options -wu
2300
_see_also = ['status']
2301
takes_args = ['file*']
2303
Option('diff-options', type=text_type,
2304
help='Pass these options to the external diff program.'),
2305
Option('prefix', type=text_type,
2307
help='Set prefixes added to old and new filenames, as '
2308
'two values separated by a colon. (eg "old/:new/").'),
2310
help='Branch/tree to compare from.',
2314
help='Branch/tree to compare to.',
2320
help='Use this command to compare files.',
2323
RegistryOption('format',
2325
help='Diff format to use.',
2326
lazy_registry=('breezy.diff', 'format_registry'),
2327
title='Diff format'),
2329
help='How many lines of context to show.',
2333
aliases = ['di', 'dif']
2334
encoding_type = 'exact'
2337
def run(self, revision=None, file_list=None, diff_options=None,
2338
prefix=None, old=None, new=None, using=None, format=None,
2340
from .diff import (get_trees_and_branches_to_diff_locked,
2347
elif prefix == u'1' or prefix is None:
2350
elif u':' in prefix:
2351
old_label, new_label = prefix.split(u":")
2353
raise errors.BzrCommandError(gettext(
2354
'--prefix expects two values separated by a colon'
2355
' (eg "old/:new/")'))
2357
if revision and len(revision) > 2:
2358
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2359
' one or two revision specifiers'))
2361
if using is not None and format is not None:
2362
raise errors.BzrCommandError(gettext(
2363
'{0} and {1} are mutually exclusive').format(
2364
'--using', '--format'))
2366
(old_tree, new_tree,
2367
old_branch, new_branch,
2368
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2369
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2370
# GNU diff on Windows uses ANSI encoding for filenames
2371
path_encoding = osutils.get_diff_header_encoding()
2372
return show_diff_trees(old_tree, new_tree, self.outf,
2373
specific_files=specific_files,
2374
external_diff_options=diff_options,
2375
old_label=old_label, new_label=new_label,
2376
extra_trees=extra_trees,
2377
path_encoding=path_encoding,
2378
using=using, context=context,
2382
class cmd_deleted(Command):
2383
__doc__ = """List files deleted in the working tree.
2385
# TODO: Show files deleted since a previous revision, or
2386
# between two revisions.
2387
# TODO: Much more efficient way to do this: read in new
2388
# directories with readdir, rather than stating each one. Same
2389
# level of effort but possibly much less IO. (Or possibly not,
2390
# if the directories are very large...)
2391
_see_also = ['status', 'ls']
2392
takes_options = ['directory', 'show-ids']
2395
def run(self, show_ids=False, directory=u'.'):
2396
tree = WorkingTree.open_containing(directory)[0]
2397
self.add_cleanup(tree.lock_read().unlock)
2398
old = tree.basis_tree()
2399
self.add_cleanup(old.lock_read().unlock)
2400
for path, ie in old.iter_entries_by_dir():
2401
if not tree.has_id(ie.file_id):
2402
self.outf.write(path)
2404
self.outf.write(' ')
2405
self.outf.write(ie.file_id)
2406
self.outf.write('\n')
2409
class cmd_modified(Command):
2410
__doc__ = """List files modified in working tree.
2414
_see_also = ['status', 'ls']
2415
takes_options = ['directory', 'null']
2418
def run(self, null=False, directory=u'.'):
2419
tree = WorkingTree.open_containing(directory)[0]
2420
self.add_cleanup(tree.lock_read().unlock)
2421
td = tree.changes_from(tree.basis_tree())
2423
for path, id, kind, text_modified, meta_modified in td.modified:
2425
self.outf.write(path + '\0')
2427
self.outf.write(osutils.quotefn(path) + '\n')
2430
class cmd_added(Command):
2431
__doc__ = """List files added in working tree.
2435
_see_also = ['status', 'ls']
2436
takes_options = ['directory', 'null']
2439
def run(self, null=False, directory=u'.'):
2440
wt = WorkingTree.open_containing(directory)[0]
2441
self.add_cleanup(wt.lock_read().unlock)
2442
basis = wt.basis_tree()
2443
self.add_cleanup(basis.lock_read().unlock)
2444
for path in wt.all_versioned_paths():
2445
if basis.has_filename(path):
2449
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2452
self.outf.write(path + '\0')
2454
self.outf.write(osutils.quotefn(path) + '\n')
2457
class cmd_root(Command):
2458
__doc__ = """Show the tree root directory.
2460
The root is the nearest enclosing directory with a .bzr control
2463
takes_args = ['filename?']
2466
def run(self, filename=None):
2467
"""Print the branch root."""
2468
tree = WorkingTree.open_containing(filename)[0]
2469
self.outf.write(tree.basedir + '\n')
2472
def _parse_limit(limitstring):
2474
return int(limitstring)
2476
msg = gettext("The limit argument must be an integer.")
2477
raise errors.BzrCommandError(msg)
2480
def _parse_levels(s):
2484
msg = gettext("The levels argument must be an integer.")
2485
raise errors.BzrCommandError(msg)
2488
class cmd_log(Command):
2489
__doc__ = """Show historical log for a branch or subset of a branch.
2491
log is brz's default tool for exploring the history of a branch.
2492
The branch to use is taken from the first parameter. If no parameters
2493
are given, the branch containing the working directory is logged.
2494
Here are some simple examples::
2496
brz log log the current branch
2497
brz log foo.py log a file in its branch
2498
brz log http://server/branch log a branch on a server
2500
The filtering, ordering and information shown for each revision can
2501
be controlled as explained below. By default, all revisions are
2502
shown sorted (topologically) so that newer revisions appear before
2503
older ones and descendants always appear before ancestors. If displayed,
2504
merged revisions are shown indented under the revision in which they
2509
The log format controls how information about each revision is
2510
displayed. The standard log formats are called ``long``, ``short``
2511
and ``line``. The default is long. See ``brz help log-formats``
2512
for more details on log formats.
2514
The following options can be used to control what information is
2517
-l N display a maximum of N revisions
2518
-n N display N levels of revisions (0 for all, 1 for collapsed)
2519
-v display a status summary (delta) for each revision
2520
-p display a diff (patch) for each revision
2521
--show-ids display revision-ids (and file-ids), not just revnos
2523
Note that the default number of levels to display is a function of the
2524
log format. If the -n option is not used, the standard log formats show
2525
just the top level (mainline).
2527
Status summaries are shown using status flags like A, M, etc. To see
2528
the changes explained using words like ``added`` and ``modified``
2529
instead, use the -vv option.
2533
To display revisions from oldest to newest, use the --forward option.
2534
In most cases, using this option will have little impact on the total
2535
time taken to produce a log, though --forward does not incrementally
2536
display revisions like --reverse does when it can.
2538
:Revision filtering:
2540
The -r option can be used to specify what revision or range of revisions
2541
to filter against. The various forms are shown below::
2543
-rX display revision X
2544
-rX.. display revision X and later
2545
-r..Y display up to and including revision Y
2546
-rX..Y display from X to Y inclusive
2548
See ``brz help revisionspec`` for details on how to specify X and Y.
2549
Some common examples are given below::
2551
-r-1 show just the tip
2552
-r-10.. show the last 10 mainline revisions
2553
-rsubmit:.. show what's new on this branch
2554
-rancestor:path.. show changes since the common ancestor of this
2555
branch and the one at location path
2556
-rdate:yesterday.. show changes since yesterday
2558
When logging a range of revisions using -rX..Y, log starts at
2559
revision Y and searches back in history through the primary
2560
("left-hand") parents until it finds X. When logging just the
2561
top level (using -n1), an error is reported if X is not found
2562
along the way. If multi-level logging is used (-n0), X may be
2563
a nested merge revision and the log will be truncated accordingly.
2567
If parameters are given and the first one is not a branch, the log
2568
will be filtered to show only those revisions that changed the
2569
nominated files or directories.
2571
Filenames are interpreted within their historical context. To log a
2572
deleted file, specify a revision range so that the file existed at
2573
the end or start of the range.
2575
Historical context is also important when interpreting pathnames of
2576
renamed files/directories. Consider the following example:
2578
* revision 1: add tutorial.txt
2579
* revision 2: modify tutorial.txt
2580
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2584
* ``brz log guide.txt`` will log the file added in revision 1
2586
* ``brz log tutorial.txt`` will log the new file added in revision 3
2588
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2589
the original file in revision 2.
2591
* ``brz log -r2 -p guide.txt`` will display an error message as there
2592
was no file called guide.txt in revision 2.
2594
Renames are always followed by log. By design, there is no need to
2595
explicitly ask for this (and no way to stop logging a file back
2596
until it was last renamed).
2600
The --match option can be used for finding revisions that match a
2601
regular expression in a commit message, committer, author or bug.
2602
Specifying the option several times will match any of the supplied
2603
expressions. --match-author, --match-bugs, --match-committer and
2604
--match-message can be used to only match a specific field.
2608
GUI tools and IDEs are often better at exploring history than command
2609
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2610
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2611
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2612
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2614
You may find it useful to add the aliases below to ``breezy.conf``::
2618
top = log -l10 --line
2621
``brz tip`` will then show the latest revision while ``brz top``
2622
will show the last 10 mainline revisions. To see the details of a
2623
particular revision X, ``brz show -rX``.
2625
If you are interested in looking deeper into a particular merge X,
2626
use ``brz log -n0 -rX``.
2628
``brz log -v`` on a branch with lots of history is currently
2629
very slow. A fix for this issue is currently under development.
2630
With or without that fix, it is recommended that a revision range
2631
be given when using the -v option.
2633
brz has a generic full-text matching plugin, brz-search, that can be
2634
used to find revisions matching user names, commit messages, etc.
2635
Among other features, this plugin can find all revisions containing
2636
a list of words but not others.
2638
When exploring non-mainline history on large projects with deep
2639
history, the performance of log can be greatly improved by installing
2640
the historycache plugin. This plugin buffers historical information
2641
trading disk space for faster speed.
2643
takes_args = ['file*']
2644
_see_also = ['log-formats', 'revisionspec']
2647
help='Show from oldest to newest.'),
2649
custom_help('verbose',
2650
help='Show files changed in each revision.'),
2654
type=breezy.option._parse_revision_str,
2656
help='Show just the specified revision.'
2657
' See also "help revisionspec".'),
2659
RegistryOption('authors',
2660
'What names to list as authors - first, all or committer.',
2662
lazy_registry=('breezy.log', 'author_list_registry'),
2666
help='Number of levels to display - 0 for all, 1 for flat.',
2668
type=_parse_levels),
2670
help='Show revisions whose message matches this '
2671
'regular expression.',
2676
help='Limit the output to the first N revisions.',
2681
help='Show changes made in each revision as a patch.'),
2682
Option('include-merged',
2683
help='Show merged revisions like --levels 0 does.'),
2684
Option('include-merges', hidden=True,
2685
help='Historical alias for --include-merged.'),
2686
Option('omit-merges',
2687
help='Do not report commits with more than one parent.'),
2688
Option('exclude-common-ancestry',
2689
help='Display only the revisions that are not part'
2690
' of both ancestries (require -rX..Y).'
2692
Option('signatures',
2693
help='Show digital signature validity.'),
2696
help='Show revisions whose properties match this '
2699
ListOption('match-message',
2700
help='Show revisions whose message matches this '
2703
ListOption('match-committer',
2704
help='Show revisions whose committer matches this '
2707
ListOption('match-author',
2708
help='Show revisions whose authors match this '
2711
ListOption('match-bugs',
2712
help='Show revisions whose bugs match this '
2716
encoding_type = 'replace'
2719
def run(self, file_list=None, timezone='original',
2730
include_merged=None,
2732
exclude_common_ancestry=False,
2736
match_committer=None,
2743
make_log_request_dict,
2744
_get_info_for_log_files,
2746
direction = (forward and 'forward') or 'reverse'
2747
if include_merged is None:
2748
include_merged = False
2749
if (exclude_common_ancestry
2750
and (revision is None or len(revision) != 2)):
2751
raise errors.BzrCommandError(gettext(
2752
'--exclude-common-ancestry requires -r with two revisions'))
2757
raise errors.BzrCommandError(gettext(
2758
'{0} and {1} are mutually exclusive').format(
2759
'--levels', '--include-merged'))
2761
if change is not None:
2763
raise errors.RangeInChangeOption()
2764
if revision is not None:
2765
raise errors.BzrCommandError(gettext(
2766
'{0} and {1} are mutually exclusive').format(
2767
'--revision', '--change'))
2772
filter_by_dir = False
2774
# find the file ids to log and check for directory filtering
2775
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2776
revision, file_list, self.add_cleanup)
2777
for relpath, file_id, kind in file_info_list:
2779
raise errors.BzrCommandError(gettext(
2780
"Path unknown at end or start of revision range: %s") %
2782
# If the relpath is the top of the tree, we log everything
2787
file_ids.append(file_id)
2788
filter_by_dir = filter_by_dir or (
2789
kind in ['directory', 'tree-reference'])
2792
# FIXME ? log the current subdir only RBC 20060203
2793
if revision is not None \
2794
and len(revision) > 0 and revision[0].get_branch():
2795
location = revision[0].get_branch()
2798
dir, relpath = controldir.ControlDir.open_containing(location)
2799
b = dir.open_branch()
2800
self.add_cleanup(b.lock_read().unlock)
2801
rev1, rev2 = _get_revision_range(revision, b, self.name())
2803
if b.get_config_stack().get('validate_signatures_in_log'):
2807
if not gpg.GPGStrategy.verify_signatures_available():
2808
raise errors.GpgmeNotInstalled(None)
2810
# Decide on the type of delta & diff filtering to use
2811
# TODO: add an --all-files option to make this configurable & consistent
2819
diff_type = 'partial'
2823
# Build the log formatter
2824
if log_format is None:
2825
log_format = log.log_formatter_registry.get_default(b)
2826
# Make a non-encoding output to include the diffs - bug 328007
2827
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2828
lf = log_format(show_ids=show_ids, to_file=self.outf,
2829
to_exact_file=unencoded_output,
2830
show_timezone=timezone,
2831
delta_format=get_verbosity_level(),
2833
show_advice=levels is None,
2834
author_list_handler=authors)
2836
# Choose the algorithm for doing the logging. It's annoying
2837
# having multiple code paths like this but necessary until
2838
# the underlying repository format is faster at generating
2839
# deltas or can provide everything we need from the indices.
2840
# The default algorithm - match-using-deltas - works for
2841
# multiple files and directories and is faster for small
2842
# amounts of history (200 revisions say). However, it's too
2843
# slow for logging a single file in a repository with deep
2844
# history, i.e. > 10K revisions. In the spirit of "do no
2845
# evil when adding features", we continue to use the
2846
# original algorithm - per-file-graph - for the "single
2847
# file that isn't a directory without showing a delta" case.
2848
partial_history = revision and b.repository._format.supports_chks
2849
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2850
or delta_type or partial_history)
2854
match_dict[''] = match
2856
match_dict['message'] = match_message
2858
match_dict['committer'] = match_committer
2860
match_dict['author'] = match_author
2862
match_dict['bugs'] = match_bugs
2864
# Build the LogRequest and execute it
2865
if len(file_ids) == 0:
2867
rqst = make_log_request_dict(
2868
direction=direction, specific_fileids=file_ids,
2869
start_revision=rev1, end_revision=rev2, limit=limit,
2870
message_search=message, delta_type=delta_type,
2871
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2872
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2873
signature=signatures, omit_merges=omit_merges,
2875
Logger(b, rqst).show(lf)
2878
def _get_revision_range(revisionspec_list, branch, command_name):
2879
"""Take the input of a revision option and turn it into a revision range.
2881
It returns RevisionInfo objects which can be used to obtain the rev_id's
2882
of the desired revisions. It does some user input validations.
2884
if revisionspec_list is None:
2887
elif len(revisionspec_list) == 1:
2888
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2889
elif len(revisionspec_list) == 2:
2890
start_spec = revisionspec_list[0]
2891
end_spec = revisionspec_list[1]
2892
if end_spec.get_branch() != start_spec.get_branch():
2893
# b is taken from revision[0].get_branch(), and
2894
# show_log will use its revision_history. Having
2895
# different branches will lead to weird behaviors.
2896
raise errors.BzrCommandError(gettext(
2897
"brz %s doesn't accept two revisions in different"
2898
" branches.") % command_name)
2899
if start_spec.spec is None:
2900
# Avoid loading all the history.
2901
rev1 = RevisionInfo(branch, None, None)
2903
rev1 = start_spec.in_history(branch)
2904
# Avoid loading all of history when we know a missing
2905
# end of range means the last revision ...
2906
if end_spec.spec is None:
2907
last_revno, last_revision_id = branch.last_revision_info()
2908
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2910
rev2 = end_spec.in_history(branch)
2912
raise errors.BzrCommandError(gettext(
2913
'brz %s --revision takes one or two values.') % command_name)
2917
def _revision_range_to_revid_range(revision_range):
2920
if revision_range[0] is not None:
2921
rev_id1 = revision_range[0].rev_id
2922
if revision_range[1] is not None:
2923
rev_id2 = revision_range[1].rev_id
2924
return rev_id1, rev_id2
2927
def get_log_format(long=False, short=False, line=False, default='long'):
2928
log_format = default
2932
log_format = 'short'
2938
class cmd_touching_revisions(Command):
2939
__doc__ = """Return revision-ids which affected a particular file.
2941
A more user-friendly interface is "brz log FILE".
2945
takes_args = ["filename"]
2948
def run(self, filename):
2949
tree, relpath = WorkingTree.open_containing(filename)
2950
with tree.lock_read():
2951
touching_revs = log.find_touching_revisions(
2952
tree.branch.repository, tree.branch.last_revision(), tree, relpath)
2953
for revno, revision_id, what in reversed(list(touching_revs)):
2954
self.outf.write("%6d %s\n" % (revno, what))
2957
class cmd_ls(Command):
2958
__doc__ = """List files in a tree.
2961
_see_also = ['status', 'cat']
2962
takes_args = ['path?']
2966
Option('recursive', short_name='R',
2967
help='Recurse into subdirectories.'),
2969
help='Print paths relative to the root of the branch.'),
2970
Option('unknown', short_name='u',
2971
help='Print unknown files.'),
2972
Option('versioned', help='Print versioned files.',
2974
Option('ignored', short_name='i',
2975
help='Print ignored files.'),
2976
Option('kind', short_name='k',
2977
help=('List entries of a particular kind: file, '
2978
'directory, symlink, tree-reference.'),
2985
def run(self, revision=None, verbose=False,
2986
recursive=False, from_root=False,
2987
unknown=False, versioned=False, ignored=False,
2988
null=False, kind=None, show_ids=False, path=None, directory=None):
2990
if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
2991
raise errors.BzrCommandError(gettext('invalid kind specified'))
2993
if verbose and null:
2994
raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2995
all = not (unknown or versioned or ignored)
2997
selection = {'I':ignored, '?':unknown, 'V':versioned}
3003
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3006
tree, branch, relpath = \
3007
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3009
# Calculate the prefix to use
3013
prefix = relpath + '/'
3014
elif fs_path != '.' and not fs_path.endswith('/'):
3015
prefix = fs_path + '/'
3017
if revision is not None or tree is None:
3018
tree = _get_one_revision_tree('ls', revision, branch=branch)
3021
if isinstance(tree, WorkingTree) and tree.supports_views():
3022
view_files = tree.views.lookup_view()
3025
view_str = views.view_display_str(view_files)
3026
note(gettext("Ignoring files outside view. View is %s") % view_str)
3028
self.add_cleanup(tree.lock_read().unlock)
3029
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3030
from_dir=relpath, recursive=recursive):
3031
# Apply additional masking
3032
if not all and not selection[fc]:
3034
if kind is not None and fkind != kind:
3039
fullpath = osutils.pathjoin(relpath, fp)
3042
views.check_path_in_view(tree, fullpath)
3043
except views.FileOutsideView:
3048
fp = osutils.pathjoin(prefix, fp)
3049
kindch = entry.kind_character()
3050
outstring = fp + kindch
3051
ui.ui_factory.clear_term()
3053
outstring = '%-8s %s' % (fc, outstring)
3054
if show_ids and fid is not None:
3055
outstring = "%-50s %s" % (outstring, fid.decode('utf-8'))
3056
self.outf.write(outstring + '\n')
3058
self.outf.write(fp + '\0')
3061
self.outf.write(fid.decode('utf-8'))
3062
self.outf.write('\0')
3067
my_id = fid.decode('utf-8')
3070
self.outf.write('%-50s %s\n' % (outstring, my_id))
3072
self.outf.write(outstring + '\n')
3075
class cmd_unknowns(Command):
3076
__doc__ = """List unknown files.
3081
takes_options = ['directory']
3084
def run(self, directory=u'.'):
3085
for f in WorkingTree.open_containing(directory)[0].unknowns():
3086
self.outf.write(osutils.quotefn(f) + '\n')
3089
class cmd_ignore(Command):
3090
__doc__ = """Ignore specified files or patterns.
3092
See ``brz help patterns`` for details on the syntax of patterns.
3094
If a .bzrignore file does not exist, the ignore command
3095
will create one and add the specified files or patterns to the newly
3096
created file. The ignore command will also automatically add the
3097
.bzrignore file to be versioned. Creating a .bzrignore file without
3098
the use of the ignore command will require an explicit add command.
3100
To remove patterns from the ignore list, edit the .bzrignore file.
3101
After adding, editing or deleting that file either indirectly by
3102
using this command or directly by using an editor, be sure to commit
3105
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3106
the global ignore file can be found in the application data directory as
3107
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3108
Global ignores are not touched by this command. The global ignore file
3109
can be edited directly using an editor.
3111
Patterns prefixed with '!' are exceptions to ignore patterns and take
3112
precedence over regular ignores. Such exceptions are used to specify
3113
files that should be versioned which would otherwise be ignored.
3115
Patterns prefixed with '!!' act as regular ignore patterns, but have
3116
precedence over the '!' exception patterns.
3120
* Ignore patterns containing shell wildcards must be quoted from
3123
* Ignore patterns starting with "#" act as comments in the ignore file.
3124
To ignore patterns that begin with that character, use the "RE:" prefix.
3127
Ignore the top level Makefile::
3129
brz ignore ./Makefile
3131
Ignore .class files in all directories...::
3133
brz ignore "*.class"
3135
...but do not ignore "special.class"::
3137
brz ignore "!special.class"
3139
Ignore files whose name begins with the "#" character::
3143
Ignore .o files under the lib directory::
3145
brz ignore "lib/**/*.o"
3147
Ignore .o files under the lib directory::
3149
brz ignore "RE:lib/.*\\.o"
3151
Ignore everything but the "debian" toplevel directory::
3153
brz ignore "RE:(?!debian/).*"
3155
Ignore everything except the "local" toplevel directory,
3156
but always ignore autosave files ending in ~, even under local/::
3159
brz ignore "!./local"
3163
_see_also = ['status', 'ignored', 'patterns']
3164
takes_args = ['name_pattern*']
3165
takes_options = ['directory',
3166
Option('default-rules',
3167
help='Display the default ignore rules that brz uses.')
3170
def run(self, name_pattern_list=None, default_rules=None,
3172
from breezy import ignores
3173
if default_rules is not None:
3174
# dump the default rules and exit
3175
for pattern in ignores.USER_DEFAULTS:
3176
self.outf.write("%s\n" % pattern)
3178
if not name_pattern_list:
3179
raise errors.BzrCommandError(gettext("ignore requires at least one "
3180
"NAME_PATTERN or --default-rules."))
3181
name_pattern_list = [globbing.normalize_pattern(p)
3182
for p in name_pattern_list]
3184
bad_patterns_count = 0
3185
for p in name_pattern_list:
3186
if not globbing.Globster.is_pattern_valid(p):
3187
bad_patterns_count += 1
3188
bad_patterns += ('\n %s' % p)
3190
msg = (ngettext('Invalid ignore pattern found. %s',
3191
'Invalid ignore patterns found. %s',
3192
bad_patterns_count) % bad_patterns)
3193
ui.ui_factory.show_error(msg)
3194
raise lazy_regex.InvalidPattern('')
3195
for name_pattern in name_pattern_list:
3196
if (name_pattern[0] == '/' or
3197
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3198
raise errors.BzrCommandError(gettext(
3199
"NAME_PATTERN should not be an absolute path"))
3200
tree, relpath = WorkingTree.open_containing(directory)
3201
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3202
ignored = globbing.Globster(name_pattern_list)
3204
self.add_cleanup(tree.lock_read().unlock)
3205
for entry in tree.list_files():
3209
if ignored.match(filename):
3210
matches.append(filename)
3211
if len(matches) > 0:
3212
self.outf.write(gettext("Warning: the following files are version "
3213
"controlled and match your ignore pattern:\n%s"
3214
"\nThese files will continue to be version controlled"
3215
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3218
class cmd_ignored(Command):
3219
__doc__ = """List ignored files and the patterns that matched them.
3221
List all the ignored files and the ignore pattern that caused the file to
3224
Alternatively, to list just the files::
3229
encoding_type = 'replace'
3230
_see_also = ['ignore', 'ls']
3231
takes_options = ['directory']
3234
def run(self, directory=u'.'):
3235
tree = WorkingTree.open_containing(directory)[0]
3236
self.add_cleanup(tree.lock_read().unlock)
3237
for path, file_class, kind, file_id, entry in tree.list_files():
3238
if file_class != 'I':
3240
## XXX: Slightly inefficient since this was already calculated
3241
pat = tree.is_ignored(path)
3242
self.outf.write('%-50s %s\n' % (path, pat))
3245
class cmd_lookup_revision(Command):
3246
__doc__ = """Lookup the revision-id from a revision-number
3249
brz lookup-revision 33
3252
takes_args = ['revno']
3253
takes_options = ['directory']
3256
def run(self, revno, directory=u'.'):
3260
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3262
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3263
self.outf.write("%s\n" % revid.decode('utf-8'))
3266
class cmd_export(Command):
3267
__doc__ = """Export current or past revision to a destination directory or archive.
3269
If no revision is specified this exports the last committed revision.
3271
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3272
given, try to find the format with the extension. If no extension
3273
is found exports to a directory (equivalent to --format=dir).
3275
If root is supplied, it will be used as the root directory inside
3276
container formats (tar, zip, etc). If it is not supplied it will default
3277
to the exported filename. The root option has no effect for 'dir' format.
3279
If branch is omitted then the branch containing the current working
3280
directory will be used.
3282
Note: Export of tree with non-ASCII filenames to zip is not supported.
3284
================= =========================
3285
Supported formats Autodetected by extension
3286
================= =========================
3289
tbz2 .tar.bz2, .tbz2
3292
================= =========================
3295
encoding_type = 'exact'
3296
takes_args = ['dest', 'branch_or_subdir?']
3297
takes_options = ['directory',
3299
help="Type of file to export to.",
3302
Option('filters', help='Apply content filters to export the '
3303
'convenient form.'),
3306
help="Name of the root directory inside the exported file."),
3307
Option('per-file-timestamps',
3308
help='Set modification time of files to that of the last '
3309
'revision in which it was changed.'),
3310
Option('uncommitted',
3311
help='Export the working tree contents rather than that of the '
3315
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3316
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3318
from .export import export, guess_format, get_root_name
3320
if branch_or_subdir is None:
3321
branch_or_subdir = directory
3323
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3325
if tree is not None:
3326
self.add_cleanup(tree.lock_read().unlock)
3330
raise errors.BzrCommandError(
3331
gettext("--uncommitted requires a working tree"))
3334
export_tree = _get_one_revision_tree(
3335
'export', revision, branch=b,
3339
format = guess_format(dest)
3342
root = get_root_name(dest)
3344
if not per_file_timestamps:
3345
force_mtime = time.time()
3350
from breezy.filter_tree import ContentFilterTree
3351
export_tree = ContentFilterTree(
3352
export_tree, export_tree._content_filter_stack)
3355
export(export_tree, dest, format, root, subdir,
3356
per_file_timestamps=per_file_timestamps)
3357
except errors.NoSuchExportFormat as e:
3358
raise errors.BzrCommandError(
3359
gettext('Unsupported export format: %s') % e.format)
3362
class cmd_cat(Command):
3363
__doc__ = """Write the contents of a file as of a given revision to standard output.
3365
If no revision is nominated, the last revision is used.
3367
Note: Take care to redirect standard output when using this command on a
3372
takes_options = ['directory',
3373
Option('name-from-revision', help='The path name in the old tree.'),
3374
Option('filters', help='Apply content filters to display the '
3375
'convenience form.'),
3378
takes_args = ['filename']
3379
encoding_type = 'exact'
3382
def run(self, filename, revision=None, name_from_revision=False,
3383
filters=False, directory=None):
3384
if revision is not None and len(revision) != 1:
3385
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3386
" one revision specifier"))
3387
tree, branch, relpath = \
3388
_open_directory_or_containing_tree_or_branch(filename, directory)
3389
self.add_cleanup(branch.lock_read().unlock)
3390
return self._run(tree, branch, relpath, filename, revision,
3391
name_from_revision, filters)
3393
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3397
tree = b.basis_tree()
3398
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3399
self.add_cleanup(rev_tree.lock_read().unlock)
3401
old_file_id = rev_tree.path2id(relpath)
3403
# TODO: Split out this code to something that generically finds the
3404
# best id for a path across one or more trees; it's like
3405
# find_ids_across_trees but restricted to find just one. -- mbp
3407
if name_from_revision:
3408
# Try in revision if requested
3409
if old_file_id is None:
3410
raise errors.BzrCommandError(gettext(
3411
"{0!r} is not present in revision {1}").format(
3412
filename, rev_tree.get_revision_id()))
3414
actual_file_id = old_file_id
3416
cur_file_id = tree.path2id(relpath)
3417
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3418
actual_file_id = cur_file_id
3419
elif old_file_id is not None:
3420
actual_file_id = old_file_id
3422
raise errors.BzrCommandError(gettext(
3423
"{0!r} is not present in revision {1}").format(
3424
filename, rev_tree.get_revision_id()))
3425
relpath = rev_tree.id2path(actual_file_id)
3427
from .filter_tree import ContentFilterTree
3428
filter_tree = ContentFilterTree(rev_tree,
3429
rev_tree._content_filter_stack)
3430
fileobj = filter_tree.get_file(relpath)
3432
fileobj = rev_tree.get_file(relpath)
3433
shutil.copyfileobj(fileobj, self.outf)
3437
class cmd_local_time_offset(Command):
3438
__doc__ = """Show the offset in seconds from GMT to local time."""
3443
self.outf.write("%s\n" % osutils.local_time_offset())
3447
class cmd_commit(Command):
3448
__doc__ = """Commit changes into a new revision.
3450
An explanatory message needs to be given for each commit. This is
3451
often done by using the --message option (getting the message from the
3452
command line) or by using the --file option (getting the message from
3453
a file). If neither of these options is given, an editor is opened for
3454
the user to enter the message. To see the changed files in the
3455
boilerplate text loaded into the editor, use the --show-diff option.
3457
By default, the entire tree is committed and the person doing the
3458
commit is assumed to be the author. These defaults can be overridden
3463
If selected files are specified, only changes to those files are
3464
committed. If a directory is specified then the directory and
3465
everything within it is committed.
3467
When excludes are given, they take precedence over selected files.
3468
For example, to commit only changes within foo, but not changes
3471
brz commit foo -x foo/bar
3473
A selective commit after a merge is not yet supported.
3477
If the author of the change is not the same person as the committer,
3478
you can specify the author's name using the --author option. The
3479
name should be in the same format as a committer-id, e.g.
3480
"John Doe <jdoe@example.com>". If there is more than one author of
3481
the change you can specify the option multiple times, once for each
3486
A common mistake is to forget to add a new file or directory before
3487
running the commit command. The --strict option checks for unknown
3488
files and aborts the commit if any are found. More advanced pre-commit
3489
checks can be implemented by defining hooks. See ``brz help hooks``
3494
If you accidentially commit the wrong changes or make a spelling
3495
mistake in the commit message say, you can use the uncommit command
3496
to undo it. See ``brz help uncommit`` for details.
3498
Hooks can also be configured to run after a commit. This allows you
3499
to trigger updates to external systems like bug trackers. The --fixes
3500
option can be used to record the association between a revision and
3501
one or more bugs. See ``brz help bugs`` for details.
3504
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3505
takes_args = ['selected*']
3507
ListOption('exclude', type=text_type, short_name='x',
3508
help="Do not consider changes made to a given path."),
3509
Option('message', type=text_type,
3511
help="Description of the new revision."),
3514
help='Commit even if nothing has changed.'),
3515
Option('file', type=text_type,
3518
help='Take commit message from this file.'),
3520
help="Refuse to commit if there are unknown "
3521
"files in the working tree."),
3522
Option('commit-time', type=text_type,
3523
help="Manually set a commit time using commit date "
3524
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3525
ListOption('bugs', type=text_type,
3526
help="Link to a related bug. (see \"brz help bugs\")."),
3527
ListOption('fixes', type=text_type,
3528
help="Mark a bug as being fixed by this revision "
3529
"(see \"brz help bugs\")."),
3530
ListOption('author', type=text_type,
3531
help="Set the author's name, if it's different "
3532
"from the committer."),
3534
help="Perform a local commit in a bound "
3535
"branch. Local commits are not pushed to "
3536
"the master branch until a normal commit "
3539
Option('show-diff', short_name='p',
3540
help='When no message is supplied, show the diff along'
3541
' with the status summary in the message editor.'),
3543
help='When committing to a foreign version control '
3544
'system do not push data that can not be natively '
3547
aliases = ['ci', 'checkin']
3549
def _iter_bug_urls(self, bugs, branch, status):
3550
default_bugtracker = None
3551
# Configure the properties for bug fixing attributes.
3553
tokens = bug.split(':')
3554
if len(tokens) == 1:
3555
if default_bugtracker is None:
3556
branch_config = branch.get_config_stack()
3557
default_bugtracker = branch_config.get(
3559
if default_bugtracker is None:
3560
raise errors.BzrCommandError(gettext(
3561
"No tracker specified for bug %s. Use the form "
3562
"'tracker:id' or specify a default bug tracker "
3563
"using the `bugtracker` option.\nSee "
3564
"\"brz help bugs\" for more information on this "
3565
"feature. Commit refused.") % bug)
3566
tag = default_bugtracker
3568
elif len(tokens) != 2:
3569
raise errors.BzrCommandError(gettext(
3570
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3571
"See \"brz help bugs\" for more information on this "
3572
"feature.\nCommit refused.") % bug)
3574
tag, bug_id = tokens
3576
yield bugtracker.get_bug_url(tag, branch, bug_id), status
3577
except bugtracker.UnknownBugTrackerAbbreviation:
3578
raise errors.BzrCommandError(gettext(
3579
'Unrecognized bug %s. Commit refused.') % bug)
3580
except bugtracker.MalformedBugIdentifier as e:
3581
raise errors.BzrCommandError(gettext(
3582
u"%s\nCommit refused.") % (e,))
3584
def run(self, message=None, file=None, verbose=False, selected_list=None,
3585
unchanged=False, strict=False, local=False, fixes=None, bugs=None,
3586
author=None, show_diff=False, exclude=None, commit_time=None,
3589
from .commit import (
3592
from .errors import (
3596
from .msgeditor import (
3597
edit_commit_message_encoded,
3598
generate_commit_message_template,
3599
make_commit_message_template_encoded,
3603
commit_stamp = offset = None
3604
if commit_time is not None:
3606
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3607
except ValueError as e:
3608
raise errors.BzrCommandError(gettext(
3609
"Could not parse --commit-time: " + str(e)))
3613
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3614
if selected_list == ['']:
3615
# workaround - commit of root of tree should be exactly the same
3616
# as just default commit in that tree, and succeed even though
3617
# selected-file merge commit is not done yet
3624
bug_property = bugtracker.encode_fixes_bug_urls(
3626
self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
3627
self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
3629
properties[u'bugs'] = bug_property
3631
if local and not tree.branch.get_bound_location():
3632
raise errors.LocalRequiresBoundBranch()
3634
if message is not None:
3636
file_exists = osutils.lexists(message)
3637
except UnicodeError:
3638
# The commit message contains unicode characters that can't be
3639
# represented in the filesystem encoding, so that can't be a
3644
'The commit message is a file name: "%(f)s".\n'
3645
'(use --file "%(f)s" to take commit message from that file)'
3647
ui.ui_factory.show_warning(warning_msg)
3649
message = message.replace('\r\n', '\n')
3650
message = message.replace('\r', '\n')
3652
raise errors.BzrCommandError(gettext(
3653
"please specify either --message or --file"))
3655
def get_message(commit_obj):
3656
"""Callback to get commit message"""
3658
with open(file, 'rb') as f:
3659
my_message = f.read().decode(osutils.get_user_encoding())
3660
elif message is not None:
3661
my_message = message
3663
# No message supplied: make one up.
3664
# text is the status of the tree
3665
text = make_commit_message_template_encoded(tree,
3666
selected_list, diff=show_diff,
3667
output_encoding=osutils.get_user_encoding())
3668
# start_message is the template generated from hooks
3669
# XXX: Warning - looks like hooks return unicode,
3670
# make_commit_message_template_encoded returns user encoding.
3671
# We probably want to be using edit_commit_message instead to
3673
my_message = set_commit_message(commit_obj)
3674
if my_message is None:
3675
start_message = generate_commit_message_template(commit_obj)
3676
if start_message is not None:
3677
start_message = start_message.encode(
3678
osutils.get_user_encoding())
3679
my_message = edit_commit_message_encoded(text,
3680
start_message=start_message)
3681
if my_message is None:
3682
raise errors.BzrCommandError(gettext("please specify a commit"
3683
" message with either --message or --file"))
3684
if my_message == "":
3685
raise errors.BzrCommandError(gettext("Empty commit message specified."
3686
" Please specify a commit message with either"
3687
" --message or --file or leave a blank message"
3688
" with --message \"\"."))
3691
# The API permits a commit with a filter of [] to mean 'select nothing'
3692
# but the command line should not do that.
3693
if not selected_list:
3694
selected_list = None
3696
tree.commit(message_callback=get_message,
3697
specific_files=selected_list,
3698
allow_pointless=unchanged, strict=strict, local=local,
3699
reporter=None, verbose=verbose, revprops=properties,
3700
authors=author, timestamp=commit_stamp,
3702
exclude=tree.safe_relpath_files(exclude),
3704
except PointlessCommit:
3705
raise errors.BzrCommandError(gettext("No changes to commit."
3706
" Please 'brz add' the files you want to commit, or use"
3707
" --unchanged to force an empty commit."))
3708
except ConflictsInTree:
3709
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3710
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3712
except StrictCommitFailed:
3713
raise errors.BzrCommandError(gettext("Commit refused because there are"
3714
" unknown files in the working tree."))
3715
except errors.BoundBranchOutOfDate as e:
3716
e.extra_help = (gettext("\n"
3717
'To commit to master branch, run update and then commit.\n'
3718
'You can also pass --local to commit to continue working '
3723
class cmd_check(Command):
3724
__doc__ = """Validate working tree structure, branch consistency and repository history.
3726
This command checks various invariants about branch and repository storage
3727
to detect data corruption or brz bugs.
3729
The working tree and branch checks will only give output if a problem is
3730
detected. The output fields of the repository check are:
3733
This is just the number of revisions checked. It doesn't
3737
This is just the number of versionedfiles checked. It
3738
doesn't indicate a problem.
3740
unreferenced ancestors
3741
Texts that are ancestors of other texts, but
3742
are not properly referenced by the revision ancestry. This is a
3743
subtle problem that Bazaar can work around.
3746
This is the total number of unique file contents
3747
seen in the checked revisions. It does not indicate a problem.
3750
This is the total number of repeated texts seen
3751
in the checked revisions. Texts can be repeated when their file
3752
entries are modified, but the file contents are not. It does not
3755
If no restrictions are specified, all Bazaar data that is found at the given
3756
location will be checked.
3760
Check the tree and branch at 'foo'::
3762
brz check --tree --branch foo
3764
Check only the repository at 'bar'::
3766
brz check --repo bar
3768
Check everything at 'baz'::
3773
_see_also = ['reconcile']
3774
takes_args = ['path?']
3775
takes_options = ['verbose',
3776
Option('branch', help="Check the branch related to the"
3777
" current directory."),
3778
Option('repo', help="Check the repository related to the"
3779
" current directory."),
3780
Option('tree', help="Check the working tree related to"
3781
" the current directory.")]
3783
def run(self, path=None, verbose=False, branch=False, repo=False,
3785
from .check import check_dwim
3788
if not branch and not repo and not tree:
3789
branch = repo = tree = True
3790
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3793
class cmd_upgrade(Command):
3794
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3796
When the default format has changed after a major new release of
3797
Bazaar, you may be informed during certain operations that you
3798
should upgrade. Upgrading to a newer format may improve performance
3799
or make new features available. It may however limit interoperability
3800
with older repositories or with older versions of Bazaar.
3802
If you wish to upgrade to a particular format rather than the
3803
current default, that can be specified using the --format option.
3804
As a consequence, you can use the upgrade command this way to
3805
"downgrade" to an earlier format, though some conversions are
3806
a one way process (e.g. changing from the 1.x default to the
3807
2.x default) so downgrading is not always possible.
3809
A backup.bzr.~#~ directory is created at the start of the conversion
3810
process (where # is a number). By default, this is left there on
3811
completion. If the conversion fails, delete the new .bzr directory
3812
and rename this one back in its place. Use the --clean option to ask
3813
for the backup.bzr directory to be removed on successful conversion.
3814
Alternatively, you can delete it by hand if everything looks good
3817
If the location given is a shared repository, dependent branches
3818
are also converted provided the repository converts successfully.
3819
If the conversion of a branch fails, remaining branches are still
3822
For more information on upgrades, see the Bazaar Upgrade Guide,
3823
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3826
_see_also = ['check', 'reconcile', 'formats']
3827
takes_args = ['url?']
3829
RegistryOption('format',
3830
help='Upgrade to a specific format. See "brz help'
3831
' formats" for details.',
3832
lazy_registry=('breezy.controldir', 'format_registry'),
3833
converter=lambda name: controldir.format_registry.make_controldir(name),
3834
value_switches=True, title='Branch format'),
3836
help='Remove the backup.bzr directory if successful.'),
3838
help="Show what would be done, but don't actually do anything."),
3841
def run(self, url='.', format=None, clean=False, dry_run=False):
3842
from .upgrade import upgrade
3843
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3845
if len(exceptions) == 1:
3846
# Compatibility with historical behavior
3852
class cmd_whoami(Command):
3853
__doc__ = """Show or set brz user id.
3856
Show the email of the current user::
3860
Set the current user::
3862
brz whoami "Frank Chu <fchu@example.com>"
3864
takes_options = [ 'directory',
3866
help='Display email address only.'),
3868
help='Set identity for the current branch instead of '
3871
takes_args = ['name?']
3872
encoding_type = 'replace'
3875
def run(self, email=False, branch=False, name=None, directory=None):
3877
if directory is None:
3878
# use branch if we're inside one; otherwise global config
3880
c = Branch.open_containing(u'.')[0].get_config_stack()
3881
except errors.NotBranchError:
3882
c = _mod_config.GlobalStack()
3884
c = Branch.open(directory).get_config_stack()
3885
identity = c.get('email')
3887
self.outf.write(_mod_config.extract_email_address(identity)
3890
self.outf.write(identity + '\n')
3894
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3897
# display a warning if an email address isn't included in the given name.
3899
_mod_config.extract_email_address(name)
3900
except _mod_config.NoEmailInUsername as e:
3901
warning('"%s" does not seem to contain an email address. '
3902
'This is allowed, but not recommended.', name)
3904
# use global config unless --branch given
3906
if directory is None:
3907
c = Branch.open_containing(u'.')[0].get_config_stack()
3909
b = Branch.open(directory)
3910
self.add_cleanup(b.lock_write().unlock)
3911
c = b.get_config_stack()
3913
c = _mod_config.GlobalStack()
3914
c.set('email', name)
3917
class cmd_nick(Command):
3918
__doc__ = """Print or set the branch nickname.
3920
If unset, the colocated branch name is used for colocated branches, and
3921
the branch directory name is used for other branches. To print the
3922
current nickname, execute with no argument.
3924
Bound branches use the nickname of its master branch unless it is set
3928
_see_also = ['info']
3929
takes_args = ['nickname?']
3930
takes_options = ['directory']
3932
def run(self, nickname=None, directory=u'.'):
3933
branch = Branch.open_containing(directory)[0]
3934
if nickname is None:
3935
self.printme(branch)
3937
branch.nick = nickname
3940
def printme(self, branch):
3941
self.outf.write('%s\n' % branch.nick)
3944
class cmd_alias(Command):
3945
__doc__ = """Set/unset and display aliases.
3948
Show the current aliases::
3952
Show the alias specified for 'll'::
3956
Set an alias for 'll'::
3958
brz alias ll="log --line -r-10..-1"
3960
To remove an alias for 'll'::
3962
brz alias --remove ll
3965
takes_args = ['name?']
3967
Option('remove', help='Remove the alias.'),
3970
def run(self, name=None, remove=False):
3972
self.remove_alias(name)
3974
self.print_aliases()
3976
equal_pos = name.find('=')
3978
self.print_alias(name)
3980
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3982
def remove_alias(self, alias_name):
3983
if alias_name is None:
3984
raise errors.BzrCommandError(gettext(
3985
'brz alias --remove expects an alias to remove.'))
3986
# If alias is not found, print something like:
3987
# unalias: foo: not found
3988
c = _mod_config.GlobalConfig()
3989
c.unset_alias(alias_name)
3992
def print_aliases(self):
3993
"""Print out the defined aliases in a similar format to bash."""
3994
aliases = _mod_config.GlobalConfig().get_aliases()
3995
for key, value in sorted(viewitems(aliases)):
3996
self.outf.write('brz alias %s="%s"\n' % (key, value))
3999
def print_alias(self, alias_name):
4000
from .commands import get_alias
4001
alias = get_alias(alias_name)
4003
self.outf.write("brz alias: %s: not found\n" % alias_name)
4006
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
4008
def set_alias(self, alias_name, alias_command):
4009
"""Save the alias in the global config."""
4010
c = _mod_config.GlobalConfig()
4011
c.set_alias(alias_name, alias_command)
4014
class cmd_selftest(Command):
4015
__doc__ = """Run internal test suite.
4017
If arguments are given, they are regular expressions that say which tests
4018
should run. Tests matching any expression are run, and other tests are
4021
Alternatively if --first is given, matching tests are run first and then
4022
all other tests are run. This is useful if you have been working in a
4023
particular area, but want to make sure nothing else was broken.
4025
If --exclude is given, tests that match that regular expression are
4026
excluded, regardless of whether they match --first or not.
4028
To help catch accidential dependencies between tests, the --randomize
4029
option is useful. In most cases, the argument used is the word 'now'.
4030
Note that the seed used for the random number generator is displayed
4031
when this option is used. The seed can be explicitly passed as the
4032
argument to this option if required. This enables reproduction of the
4033
actual ordering used if and when an order sensitive problem is encountered.
4035
If --list-only is given, the tests that would be run are listed. This is
4036
useful when combined with --first, --exclude and/or --randomize to
4037
understand their impact. The test harness reports "Listed nn tests in ..."
4038
instead of "Ran nn tests in ..." when list mode is enabled.
4040
If the global option '--no-plugins' is given, plugins are not loaded
4041
before running the selftests. This has two effects: features provided or
4042
modified by plugins will not be tested, and tests provided by plugins will
4045
Tests that need working space on disk use a common temporary directory,
4046
typically inside $TMPDIR or /tmp.
4048
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4049
into a pdb postmortem session.
4051
The --coverage=DIRNAME global option produces a report with covered code
4055
Run only tests relating to 'ignore'::
4059
Disable plugins and list tests as they're run::
4061
brz --no-plugins selftest -v
4063
# NB: this is used from the class without creating an instance, which is
4064
# why it does not have a self parameter.
4065
def get_transport_type(typestring):
4066
"""Parse and return a transport specifier."""
4067
if typestring == "sftp":
4068
from .tests import stub_sftp
4069
return stub_sftp.SFTPAbsoluteServer
4070
elif typestring == "memory":
4071
from .tests import test_server
4072
return memory.MemoryServer
4073
elif typestring == "fakenfs":
4074
from .tests import test_server
4075
return test_server.FakeNFSServer
4076
msg = "No known transport type %s. Supported types are: sftp\n" %\
4078
raise errors.BzrCommandError(msg)
4081
takes_args = ['testspecs*']
4082
takes_options = ['verbose',
4084
help='Stop when one test fails.',
4088
help='Use a different transport by default '
4089
'throughout the test suite.',
4090
type=get_transport_type),
4092
help='Run the benchmarks rather than selftests.',
4094
Option('lsprof-timed',
4095
help='Generate lsprof output for benchmarked'
4096
' sections of code.'),
4097
Option('lsprof-tests',
4098
help='Generate lsprof output for each test.'),
4100
help='Run all tests, but run specified tests first.',
4104
help='List the tests instead of running them.'),
4105
RegistryOption('parallel',
4106
help="Run the test suite in parallel.",
4107
lazy_registry=('breezy.tests', 'parallel_registry'),
4108
value_switches=False,
4110
Option('randomize', type=text_type, argname="SEED",
4111
help='Randomize the order of tests using the given'
4112
' seed or "now" for the current time.'),
4113
ListOption('exclude', type=text_type, argname="PATTERN",
4115
help='Exclude tests that match this regular'
4118
help='Output test progress via subunit v1.'),
4120
help='Output test progress via subunit v2.'),
4121
Option('strict', help='Fail on missing dependencies or '
4123
Option('load-list', type=text_type, argname='TESTLISTFILE',
4124
help='Load a test id list from a text file.'),
4125
ListOption('debugflag', type=text_type, short_name='E',
4126
help='Turn on a selftest debug flag.'),
4127
ListOption('starting-with', type=text_type, argname='TESTID',
4128
param_name='starting_with', short_name='s',
4130
'Load only the tests starting with TESTID.'),
4132
help="By default we disable fsync and fdatasync"
4133
" while running the test suite.")
4135
encoding_type = 'replace'
4138
Command.__init__(self)
4139
self.additional_selftest_args = {}
4141
def run(self, testspecs_list=None, verbose=False, one=False,
4142
transport=None, benchmark=None,
4144
first=False, list_only=False,
4145
randomize=None, exclude=None, strict=False,
4146
load_list=None, debugflag=None, starting_with=None, subunit1=False,
4147
subunit2=False, parallel=None, lsprof_tests=False, sync=False):
4149
# During selftest, disallow proxying, as it can cause severe
4150
# performance penalties and is only needed for thread
4151
# safety. The selftest command is assumed to not use threads
4152
# too heavily. The call should be as early as possible, as
4153
# error reporting for past duplicate imports won't have useful
4155
if sys.version_info[0] < 3:
4156
# TODO(pad.lv/1696545): Allow proxying on Python 3, since
4157
# disallowing it currently leads to failures in many places.
4158
lazy_import.disallow_proxying()
4163
raise errors.BzrCommandError("tests not available. Install the "
4164
"breezy tests to run the breezy testsuite.")
4166
if testspecs_list is not None:
4167
pattern = '|'.join(testspecs_list)
4172
from .tests import SubUnitBzrRunnerv1
4174
raise errors.BzrCommandError(gettext(
4175
"subunit not available. subunit needs to be installed "
4176
"to use --subunit."))
4177
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
4178
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4179
# stdout, which would corrupt the subunit stream.
4180
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4181
# following code can be deleted when it's sufficiently deployed
4182
# -- vila/mgz 20100514
4183
if (sys.platform == "win32"
4184
and getattr(sys.stdout, 'fileno', None) is not None):
4186
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4189
from .tests import SubUnitBzrRunnerv2
4191
raise errors.BzrCommandError(gettext(
4192
"subunit not available. subunit "
4193
"needs to be installed to use --subunit2."))
4194
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
4197
self.additional_selftest_args.setdefault(
4198
'suite_decorators', []).append(parallel)
4200
raise errors.BzrCommandError(gettext(
4201
"--benchmark is no longer supported from brz 2.2; "
4202
"use bzr-usertest instead"))
4203
test_suite_factory = None
4205
exclude_pattern = None
4207
exclude_pattern = '(' + '|'.join(exclude) + ')'
4209
self._disable_fsync()
4210
selftest_kwargs = {"verbose": verbose,
4212
"stop_on_failure": one,
4213
"transport": transport,
4214
"test_suite_factory": test_suite_factory,
4215
"lsprof_timed": lsprof_timed,
4216
"lsprof_tests": lsprof_tests,
4217
"matching_tests_first": first,
4218
"list_only": list_only,
4219
"random_seed": randomize,
4220
"exclude_pattern": exclude_pattern,
4222
"load_list": load_list,
4223
"debug_flags": debugflag,
4224
"starting_with": starting_with
4226
selftest_kwargs.update(self.additional_selftest_args)
4228
# Make deprecation warnings visible, unless -Werror is set
4229
cleanup = symbol_versioning.activate_deprecation_warnings(
4232
result = tests.selftest(**selftest_kwargs)
4235
return int(not result)
4237
def _disable_fsync(self):
4238
"""Change the 'os' functionality to not synchronize."""
4239
self._orig_fsync = getattr(os, 'fsync', None)
4240
if self._orig_fsync is not None:
4241
os.fsync = lambda filedes: None
4242
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4243
if self._orig_fdatasync is not None:
4244
os.fdatasync = lambda filedes: None
4247
class cmd_version(Command):
4248
__doc__ = """Show version of brz."""
4250
encoding_type = 'replace'
4252
Option("short", help="Print just the version number."),
4256
def run(self, short=False):
4257
from .version import show_version
4259
self.outf.write(breezy.version_string + '\n')
4261
show_version(to_file=self.outf)
4264
class cmd_rocks(Command):
4265
__doc__ = """Statement of optimism."""
4271
self.outf.write(gettext("It sure does!\n"))
4274
class cmd_find_merge_base(Command):
4275
__doc__ = """Find and print a base revision for merging two branches."""
4276
# TODO: Options to specify revisions on either side, as if
4277
# merging only part of the history.
4278
takes_args = ['branch', 'other']
4282
def run(self, branch, other):
4283
from .revision import ensure_null
4285
branch1 = Branch.open_containing(branch)[0]
4286
branch2 = Branch.open_containing(other)[0]
4287
self.add_cleanup(branch1.lock_read().unlock)
4288
self.add_cleanup(branch2.lock_read().unlock)
4289
last1 = ensure_null(branch1.last_revision())
4290
last2 = ensure_null(branch2.last_revision())
4292
graph = branch1.repository.get_graph(branch2.repository)
4293
base_rev_id = graph.find_unique_lca(last1, last2)
4295
self.outf.write(gettext('merge base is revision %s\n') %
4296
base_rev_id.decode('utf-8'))
4299
class cmd_merge(Command):
4300
__doc__ = """Perform a three-way merge.
4302
The source of the merge can be specified either in the form of a branch,
4303
or in the form of a path to a file containing a merge directive generated
4304
with brz send. If neither is specified, the default is the upstream branch
4305
or the branch most recently merged using --remember. The source of the
4306
merge may also be specified in the form of a path to a file in another
4307
branch: in this case, only the modifications to that file are merged into
4308
the current working tree.
4310
When merging from a branch, by default brz will try to merge in all new
4311
work from the other branch, automatically determining an appropriate base
4312
revision. If this fails, you may need to give an explicit base.
4314
To pick a different ending revision, pass "--revision OTHER". brz will
4315
try to merge in all new work up to and including revision OTHER.
4317
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4318
through OTHER, excluding BASE but including OTHER, will be merged. If this
4319
causes some revisions to be skipped, i.e. if the destination branch does
4320
not already contain revision BASE, such a merge is commonly referred to as
4321
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4322
cherrypicks. The changes look like a normal commit, and the history of the
4323
changes from the other branch is not stored in the commit.
4325
Revision numbers are always relative to the source branch.
4327
Merge will do its best to combine the changes in two branches, but there
4328
are some kinds of problems only a human can fix. When it encounters those,
4329
it will mark a conflict. A conflict means that you need to fix something,
4330
before you can commit.
4332
Use brz resolve when you have fixed a problem. See also brz conflicts.
4334
If there is no default branch set, the first merge will set it (use
4335
--no-remember to avoid setting it). After that, you can omit the branch
4336
to use the default. To change the default, use --remember. The value will
4337
only be saved if the remote location can be accessed.
4339
The results of the merge are placed into the destination working
4340
directory, where they can be reviewed (with brz diff), tested, and then
4341
committed to record the result of the merge.
4343
merge refuses to run if there are any uncommitted changes, unless
4344
--force is given. If --force is given, then the changes from the source
4345
will be merged with the current working tree, including any uncommitted
4346
changes in the tree. The --force option can also be used to create a
4347
merge revision which has more than two parents.
4349
If one would like to merge changes from the working tree of the other
4350
branch without merging any committed revisions, the --uncommitted option
4353
To select only some changes to merge, use "merge -i", which will prompt
4354
you to apply each diff hunk and file change, similar to "shelve".
4357
To merge all new revisions from brz.dev::
4359
brz merge ../brz.dev
4361
To merge changes up to and including revision 82 from brz.dev::
4363
brz merge -r 82 ../brz.dev
4365
To merge the changes introduced by 82, without previous changes::
4367
brz merge -r 81..82 ../brz.dev
4369
To apply a merge directive contained in /tmp/merge::
4371
brz merge /tmp/merge
4373
To create a merge revision with three parents from two branches
4374
feature1a and feature1b:
4376
brz merge ../feature1a
4377
brz merge ../feature1b --force
4378
brz commit -m 'revision with three parents'
4381
encoding_type = 'exact'
4382
_see_also = ['update', 'remerge', 'status-flags', 'send']
4383
takes_args = ['location?']
4388
help='Merge even if the destination tree has uncommitted changes.'),
4392
Option('show-base', help="Show base revision text in "
4394
Option('uncommitted', help='Apply uncommitted changes'
4395
' from a working copy, instead of branch changes.'),
4396
Option('pull', help='If the destination is already'
4397
' completely merged into the source, pull from the'
4398
' source rather than merging. When this happens,'
4399
' you do not need to commit the result.'),
4400
custom_help('directory',
4401
help='Branch to merge into, '
4402
'rather than the one containing the working directory.'),
4403
Option('preview', help='Instead of merging, show a diff of the'
4405
Option('interactive', help='Select changes interactively.',
4409
def run(self, location=None, revision=None, force=False,
4410
merge_type=None, show_base=False, reprocess=None, remember=None,
4411
uncommitted=False, pull=False,
4416
if merge_type is None:
4417
merge_type = _mod_merge.Merge3Merger
4419
if directory is None:
4421
possible_transports = []
4423
allow_pending = True
4424
verified = 'inapplicable'
4426
tree = WorkingTree.open_containing(directory)[0]
4427
if tree.branch.last_revision() == _mod_revision.NULL_REVISION:
4428
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4429
'https://bugs.launchpad.net/bzr/+bug/308562'))
4431
# die as quickly as possible if there are uncommitted changes
4433
if tree.has_changes():
4434
raise errors.UncommittedChanges(tree)
4436
view_info = _get_view_info_for_change_reporter(tree)
4437
change_reporter = delta._ChangeReporter(
4438
unversioned_filter=tree.is_ignored, view_info=view_info)
4439
pb = ui.ui_factory.nested_progress_bar()
4440
self.add_cleanup(pb.finished)
4441
self.add_cleanup(tree.lock_write().unlock)
4442
if location is not None:
4444
mergeable = bundle.read_mergeable_from_url(location,
4445
possible_transports=possible_transports)
4446
except errors.NotABundle:
4450
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4451
' with bundles or merge directives.'))
4453
if revision is not None:
4454
raise errors.BzrCommandError(gettext(
4455
'Cannot use -r with merge directives or bundles'))
4456
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4459
if merger is None and uncommitted:
4460
if revision is not None and len(revision) > 0:
4461
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4462
' --revision at the same time.'))
4463
merger = self.get_merger_from_uncommitted(tree, location, None)
4464
allow_pending = False
4467
merger, allow_pending = self._get_merger_from_branch(tree,
4468
location, revision, remember, possible_transports, None)
4470
merger.merge_type = merge_type
4471
merger.reprocess = reprocess
4472
merger.show_base = show_base
4473
self.sanity_check_merger(merger)
4474
if (merger.base_rev_id == merger.other_rev_id and
4475
merger.other_rev_id is not None):
4476
# check if location is a nonexistent file (and not a branch) to
4477
# disambiguate the 'Nothing to do'
4478
if merger.interesting_files:
4479
if not merger.other_tree.has_filename(
4480
merger.interesting_files[0]):
4481
note(gettext("merger: ") + str(merger))
4482
raise errors.PathsDoNotExist([location])
4483
note(gettext('Nothing to do.'))
4485
if pull and not preview:
4486
if merger.interesting_files is not None:
4487
raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4488
if (merger.base_rev_id == tree.last_revision()):
4489
result = tree.pull(merger.other_branch, False,
4490
merger.other_rev_id)
4491
result.report(self.outf)
4493
if merger.this_basis is None:
4494
raise errors.BzrCommandError(gettext(
4495
"This branch has no commits."
4496
" (perhaps you would prefer 'brz pull')"))
4498
return self._do_preview(merger)
4500
return self._do_interactive(merger)
4502
return self._do_merge(merger, change_reporter, allow_pending,
4505
def _get_preview(self, merger):
4506
tree_merger = merger.make_merger()
4507
tt = tree_merger.make_preview_transform()
4508
self.add_cleanup(tt.finalize)
4509
result_tree = tt.get_preview_tree()
4512
def _do_preview(self, merger):
4513
from .diff import show_diff_trees
4514
result_tree = self._get_preview(merger)
4515
path_encoding = osutils.get_diff_header_encoding()
4516
show_diff_trees(merger.this_tree, result_tree, self.outf,
4517
old_label='', new_label='',
4518
path_encoding=path_encoding)
4520
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4521
merger.change_reporter = change_reporter
4522
conflict_count = merger.do_merge()
4524
merger.set_pending()
4525
if verified == 'failed':
4526
warning('Preview patch does not match changes')
4527
if conflict_count != 0:
4532
def _do_interactive(self, merger):
4533
"""Perform an interactive merge.
4535
This works by generating a preview tree of the merge, then using
4536
Shelver to selectively remove the differences between the working tree
4537
and the preview tree.
4539
from . import shelf_ui
4540
result_tree = self._get_preview(merger)
4541
writer = breezy.option.diff_writer_registry.get()
4542
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4543
reporter=shelf_ui.ApplyReporter(),
4544
diff_writer=writer(self.outf))
4550
def sanity_check_merger(self, merger):
4551
if (merger.show_base and
4552
not merger.merge_type is _mod_merge.Merge3Merger):
4553
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4554
" merge type. %s") % merger.merge_type)
4555
if merger.reprocess is None:
4556
if merger.show_base:
4557
merger.reprocess = False
4559
# Use reprocess if the merger supports it
4560
merger.reprocess = merger.merge_type.supports_reprocess
4561
if merger.reprocess and not merger.merge_type.supports_reprocess:
4562
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4563
" for merge type %s.") %
4565
if merger.reprocess and merger.show_base:
4566
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4569
if (merger.merge_type.requires_file_merge_plan and
4570
(not getattr(merger.this_tree, 'plan_file_merge', None) or
4571
not getattr(merger.other_tree, 'plan_file_merge', None) or
4572
(merger.base_tree is not None and
4573
not getattr(merger.base_tree, 'plan_file_merge', None)))):
4574
raise errors.BzrCommandError(
4575
gettext('Plan file merge unsupported: '
4576
'Merge type incompatible with tree formats.'))
4578
def _get_merger_from_branch(self, tree, location, revision, remember,
4579
possible_transports, pb):
4580
"""Produce a merger from a location, assuming it refers to a branch."""
4581
# find the branch locations
4582
other_loc, user_location = self._select_branch_location(tree, location,
4584
if revision is not None and len(revision) == 2:
4585
base_loc, _unused = self._select_branch_location(tree,
4586
location, revision, 0)
4588
base_loc = other_loc
4590
other_branch, other_path = Branch.open_containing(other_loc,
4591
possible_transports)
4592
if base_loc == other_loc:
4593
base_branch = other_branch
4595
base_branch, base_path = Branch.open_containing(base_loc,
4596
possible_transports)
4597
# Find the revision ids
4598
other_revision_id = None
4599
base_revision_id = None
4600
if revision is not None:
4601
if len(revision) >= 1:
4602
other_revision_id = revision[-1].as_revision_id(other_branch)
4603
if len(revision) == 2:
4604
base_revision_id = revision[0].as_revision_id(base_branch)
4605
if other_revision_id is None:
4606
other_revision_id = _mod_revision.ensure_null(
4607
other_branch.last_revision())
4608
# Remember where we merge from. We need to remember if:
4609
# - user specify a location (and we don't merge from the parent
4611
# - user ask to remember or there is no previous location set to merge
4612
# from and user didn't ask to *not* remember
4613
if (user_location is not None
4615
or (remember is None
4616
and tree.branch.get_submit_branch() is None)))):
4617
tree.branch.set_submit_branch(other_branch.base)
4618
# Merge tags (but don't set them in the master branch yet, the user
4619
# might revert this merge). Commit will propagate them.
4620
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4621
merger = _mod_merge.Merger.from_revision_ids(tree,
4622
other_revision_id, base_revision_id, other_branch, base_branch)
4623
if other_path != '':
4624
allow_pending = False
4625
merger.interesting_files = [other_path]
4627
allow_pending = True
4628
return merger, allow_pending
4630
def get_merger_from_uncommitted(self, tree, location, pb):
4631
"""Get a merger for uncommitted changes.
4633
:param tree: The tree the merger should apply to.
4634
:param location: The location containing uncommitted changes.
4635
:param pb: The progress bar to use for showing progress.
4637
location = self._select_branch_location(tree, location)[0]
4638
other_tree, other_path = WorkingTree.open_containing(location)
4639
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4640
if other_path != '':
4641
merger.interesting_files = [other_path]
4644
def _select_branch_location(self, tree, user_location, revision=None,
4646
"""Select a branch location, according to possible inputs.
4648
If provided, branches from ``revision`` are preferred. (Both
4649
``revision`` and ``index`` must be supplied.)
4651
Otherwise, the ``location`` parameter is used. If it is None, then the
4652
``submit`` or ``parent`` location is used, and a note is printed.
4654
:param tree: The working tree to select a branch for merging into
4655
:param location: The location entered by the user
4656
:param revision: The revision parameter to the command
4657
:param index: The index to use for the revision parameter. Negative
4658
indices are permitted.
4659
:return: (selected_location, user_location). The default location
4660
will be the user-entered location.
4662
if (revision is not None and index is not None
4663
and revision[index] is not None):
4664
branch = revision[index].get_branch()
4665
if branch is not None:
4666
return branch, branch
4667
if user_location is None:
4668
location = self._get_remembered(tree, 'Merging from')
4670
location = user_location
4671
return location, user_location
4673
def _get_remembered(self, tree, verb_string):
4674
"""Use tree.branch's parent if none was supplied.
4676
Report if the remembered location was used.
4678
stored_location = tree.branch.get_submit_branch()
4679
stored_location_type = "submit"
4680
if stored_location is None:
4681
stored_location = tree.branch.get_parent()
4682
stored_location_type = "parent"
4683
mutter("%s", stored_location)
4684
if stored_location is None:
4685
raise errors.BzrCommandError(gettext("No location specified or remembered"))
4686
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4687
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4688
stored_location_type, display_url))
4689
return stored_location
4692
class cmd_remerge(Command):
4693
__doc__ = """Redo a merge.
4695
Use this if you want to try a different merge technique while resolving
4696
conflicts. Some merge techniques are better than others, and remerge
4697
lets you try different ones on different files.
4699
The options for remerge have the same meaning and defaults as the ones for
4700
merge. The difference is that remerge can (only) be run when there is a
4701
pending merge, and it lets you specify particular files.
4704
Re-do the merge of all conflicted files, and show the base text in
4705
conflict regions, in addition to the usual THIS and OTHER texts::
4707
brz remerge --show-base
4709
Re-do the merge of "foobar", using the weave merge algorithm, with
4710
additional processing to reduce the size of conflict regions::
4712
brz remerge --merge-type weave --reprocess foobar
4714
takes_args = ['file*']
4719
help="Show base revision text in conflicts."),
4722
def run(self, file_list=None, merge_type=None, show_base=False,
4724
from .conflicts import restore
4725
if merge_type is None:
4726
merge_type = _mod_merge.Merge3Merger
4727
tree, file_list = WorkingTree.open_containing_paths(file_list)
4728
self.add_cleanup(tree.lock_write().unlock)
4729
parents = tree.get_parent_ids()
4730
if len(parents) != 2:
4731
raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4732
" merges. Not cherrypicking or"
4734
repository = tree.branch.repository
4735
interesting_files = None
4737
conflicts = tree.conflicts()
4738
if file_list is not None:
4739
interesting_files = set()
4740
for filename in file_list:
4741
if not tree.is_versioned(filename):
4742
raise errors.NotVersionedError(filename)
4743
interesting_files.add(filename)
4744
if tree.kind(filename) != "directory":
4747
for path, ie in tree.iter_entries_by_dir(specific_files=[filename]):
4748
interesting_files.add(path)
4749
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4751
# Remerge only supports resolving contents conflicts
4752
allowed_conflicts = ('text conflict', 'contents conflict')
4753
restore_files = [c.path for c in conflicts
4754
if c.typestring in allowed_conflicts]
4755
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
4756
tree.set_conflicts(ConflictList(new_conflicts))
4757
if file_list is not None:
4758
restore_files = file_list
4759
for filename in restore_files:
4761
restore(tree.abspath(filename))
4762
except errors.NotConflicted:
4764
# Disable pending merges, because the file texts we are remerging
4765
# have not had those merges performed. If we use the wrong parents
4766
# list, we imply that the working tree text has seen and rejected
4767
# all the changes from the other tree, when in fact those changes
4768
# have not yet been seen.
4769
tree.set_parent_ids(parents[:1])
4771
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4772
merger.interesting_files = interesting_files
4773
merger.merge_type = merge_type
4774
merger.show_base = show_base
4775
merger.reprocess = reprocess
4776
conflicts = merger.do_merge()
4778
tree.set_parent_ids(parents)
4785
class cmd_revert(Command):
4787
Set files in the working tree back to the contents of a previous revision.
4789
Giving a list of files will revert only those files. Otherwise, all files
4790
will be reverted. If the revision is not specified with '--revision', the
4791
working tree basis revision is used. A revert operation affects only the
4792
working tree, not any revision history like the branch and repository or
4793
the working tree basis revision.
4795
To remove only some changes, without reverting to a prior version, use
4796
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4797
will remove the changes introduced by the second last commit (-2), without
4798
affecting the changes introduced by the last commit (-1). To remove
4799
certain changes on a hunk-by-hunk basis, see the shelve command.
4800
To update the branch to a specific revision or the latest revision and
4801
update the working tree accordingly while preserving local changes, see the
4804
Uncommitted changes to files that are reverted will be discarded.
4805
Howver, by default, any files that have been manually changed will be
4806
backed up first. (Files changed only by merge are not backed up.) Backup
4807
files have '.~#~' appended to their name, where # is a number.
4809
When you provide files, you can use their current pathname or the pathname
4810
from the target revision. So you can use revert to "undelete" a file by
4811
name. If you name a directory, all the contents of that directory will be
4814
If you have newly added files since the target revision, they will be
4815
removed. If the files to be removed have been changed, backups will be
4816
created as above. Directories containing unknown files will not be
4819
The working tree contains a list of revisions that have been merged but
4820
not yet committed. These revisions will be included as additional parents
4821
of the next commit. Normally, using revert clears that list as well as
4822
reverting the files. If any files are specified, revert leaves the list
4823
of uncommitted merges alone and reverts only the files. Use ``brz revert
4824
.`` in the tree root to revert all files but keep the recorded merges,
4825
and ``brz revert --forget-merges`` to clear the pending merge list without
4826
reverting any files.
4828
Using "brz revert --forget-merges", it is possible to apply all of the
4829
changes from a branch in a single revision. To do this, perform the merge
4830
as desired. Then doing revert with the "--forget-merges" option will keep
4831
the content of the tree as it was, but it will clear the list of pending
4832
merges. The next commit will then contain all of the changes that are
4833
present in the other branch, but without any other parent revisions.
4834
Because this technique forgets where these changes originated, it may
4835
cause additional conflicts on later merges involving the same source and
4839
_see_also = ['cat', 'export', 'merge', 'shelve']
4842
Option('no-backup', "Do not save backups of reverted files."),
4843
Option('forget-merges',
4844
'Remove pending merge marker, without changing any files.'),
4846
takes_args = ['file*']
4848
def run(self, revision=None, no_backup=False, file_list=None,
4849
forget_merges=None):
4850
tree, file_list = WorkingTree.open_containing_paths(file_list)
4851
self.add_cleanup(tree.lock_tree_write().unlock)
4853
tree.set_parent_ids(tree.get_parent_ids()[:1])
4855
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4858
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4859
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4860
tree.revert(file_list, rev_tree, not no_backup, None,
4861
report_changes=True)
4864
class cmd_assert_fail(Command):
4865
__doc__ = """Test reporting of assertion failures"""
4866
# intended just for use in testing
4871
raise AssertionError("always fails")
4874
class cmd_help(Command):
4875
__doc__ = """Show help on a command or other topic.
4878
_see_also = ['topics']
4880
Option('long', 'Show help on all commands.'),
4882
takes_args = ['topic?']
4883
aliases = ['?', '--help', '-?', '-h']
4886
def run(self, topic=None, long=False):
4888
if topic is None and long:
4890
breezy.help.help(topic)
4893
class cmd_shell_complete(Command):
4894
__doc__ = """Show appropriate completions for context.
4896
For a list of all available commands, say 'brz shell-complete'.
4898
takes_args = ['context?']
4903
def run(self, context=None):
4904
from . import shellcomplete
4905
shellcomplete.shellcomplete(context)
4908
class cmd_missing(Command):
4909
__doc__ = """Show unmerged/unpulled revisions between two branches.
4911
OTHER_BRANCH may be local or remote.
4913
To filter on a range of revisions, you can use the command -r begin..end
4914
-r revision requests a specific revision, -r ..end or -r begin.. are
4918
1 - some missing revisions
4919
0 - no missing revisions
4923
Determine the missing revisions between this and the branch at the
4924
remembered pull location::
4928
Determine the missing revisions between this and another branch::
4930
brz missing http://server/branch
4932
Determine the missing revisions up to a specific revision on the other
4935
brz missing -r ..-10
4937
Determine the missing revisions up to a specific revision on this
4940
brz missing --my-revision ..-10
4943
_see_also = ['merge', 'pull']
4944
takes_args = ['other_branch?']
4947
Option('reverse', 'Reverse the order of revisions.'),
4949
'Display changes in the local branch only.'),
4950
Option('this', 'Same as --mine-only.'),
4951
Option('theirs-only',
4952
'Display changes in the remote branch only.'),
4953
Option('other', 'Same as --theirs-only.'),
4957
custom_help('revision',
4958
help='Filter on other branch revisions (inclusive). '
4959
'See "help revisionspec" for details.'),
4960
Option('my-revision',
4961
type=_parse_revision_str,
4962
help='Filter on local branch revisions (inclusive). '
4963
'See "help revisionspec" for details.'),
4964
Option('include-merged',
4965
'Show all revisions in addition to the mainline ones.'),
4966
Option('include-merges', hidden=True,
4967
help='Historical alias for --include-merged.'),
4969
encoding_type = 'replace'
4972
def run(self, other_branch=None, reverse=False, mine_only=False,
4974
log_format=None, long=False, short=False, line=False,
4975
show_ids=False, verbose=False, this=False, other=False,
4976
include_merged=None, revision=None, my_revision=None,
4978
from breezy.missing import find_unmerged, iter_log_revisions
4984
if include_merged is None:
4985
include_merged = False
4990
# TODO: We should probably check that we don't have mine-only and
4991
# theirs-only set, but it gets complicated because we also have
4992
# this and other which could be used.
4999
local_branch = Branch.open_containing(directory)[0]
5000
self.add_cleanup(local_branch.lock_read().unlock)
5002
parent = local_branch.get_parent()
5003
if other_branch is None:
5004
other_branch = parent
5005
if other_branch is None:
5006
raise errors.BzrCommandError(gettext("No peer location known"
5008
display_url = urlutils.unescape_for_display(parent,
5010
message(gettext("Using saved parent location: {0}\n").format(
5013
remote_branch = Branch.open(other_branch)
5014
if remote_branch.base == local_branch.base:
5015
remote_branch = local_branch
5017
self.add_cleanup(remote_branch.lock_read().unlock)
5019
local_revid_range = _revision_range_to_revid_range(
5020
_get_revision_range(my_revision, local_branch,
5023
remote_revid_range = _revision_range_to_revid_range(
5024
_get_revision_range(revision,
5025
remote_branch, self.name()))
5027
local_extra, remote_extra = find_unmerged(
5028
local_branch, remote_branch, restrict,
5029
backward=not reverse,
5030
include_merged=include_merged,
5031
local_revid_range=local_revid_range,
5032
remote_revid_range=remote_revid_range)
5034
if log_format is None:
5035
registry = log.log_formatter_registry
5036
log_format = registry.get_default(local_branch)
5037
lf = log_format(to_file=self.outf,
5039
show_timezone='original')
5042
if local_extra and not theirs_only:
5043
message(ngettext("You have %d extra revision:\n",
5044
"You have %d extra revisions:\n",
5048
if local_branch.supports_tags():
5049
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5050
for revision in iter_log_revisions(local_extra,
5051
local_branch.repository,
5054
lf.log_revision(revision)
5055
printed_local = True
5058
printed_local = False
5060
if remote_extra and not mine_only:
5061
if printed_local is True:
5063
message(ngettext("You are missing %d revision:\n",
5064
"You are missing %d revisions:\n",
5065
len(remote_extra)) %
5067
if remote_branch.supports_tags():
5068
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5069
for revision in iter_log_revisions(remote_extra,
5070
remote_branch.repository,
5073
lf.log_revision(revision)
5076
if mine_only and not local_extra:
5077
# We checked local, and found nothing extra
5078
message(gettext('This branch has no new revisions.\n'))
5079
elif theirs_only and not remote_extra:
5080
# We checked remote, and found nothing extra
5081
message(gettext('Other branch has no new revisions.\n'))
5082
elif not (mine_only or theirs_only or local_extra or
5084
# We checked both branches, and neither one had extra
5086
message(gettext("Branches are up to date.\n"))
5088
if not status_code and parent is None and other_branch is not None:
5089
self.add_cleanup(local_branch.lock_write().unlock)
5090
# handle race conditions - a parent might be set while we run.
5091
if local_branch.get_parent() is None:
5092
local_branch.set_parent(remote_branch.base)
5096
class cmd_pack(Command):
5097
__doc__ = """Compress the data within a repository.
5099
This operation compresses the data within a bazaar repository. As
5100
bazaar supports automatic packing of repository, this operation is
5101
normally not required to be done manually.
5103
During the pack operation, bazaar takes a backup of existing repository
5104
data, i.e. pack files. This backup is eventually removed by bazaar
5105
automatically when it is safe to do so. To save disk space by removing
5106
the backed up pack files, the --clean-obsolete-packs option may be
5109
Warning: If you use --clean-obsolete-packs and your machine crashes
5110
during or immediately after repacking, you may be left with a state
5111
where the deletion has been written to disk but the new packs have not
5112
been. In this case the repository may be unusable.
5115
_see_also = ['repositories']
5116
takes_args = ['branch_or_repo?']
5118
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
5121
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5122
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5124
branch = dir.open_branch()
5125
repository = branch.repository
5126
except errors.NotBranchError:
5127
repository = dir.open_repository()
5128
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5131
class cmd_plugins(Command):
5132
__doc__ = """List the installed plugins.
5134
This command displays the list of installed plugins including
5135
version of plugin and a short description of each.
5137
--verbose shows the path where each plugin is located.
5139
A plugin is an external component for Bazaar that extends the
5140
revision control system, by adding or replacing code in Bazaar.
5141
Plugins can do a variety of things, including overriding commands,
5142
adding new commands, providing additional network transports and
5143
customizing log output.
5145
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5146
for further information on plugins including where to find them and how to
5147
install them. Instructions are also provided there on how to write new
5148
plugins using the Python programming language.
5150
takes_options = ['verbose']
5153
def run(self, verbose=False):
5154
from . import plugin
5155
# Don't give writelines a generator as some codecs don't like that
5156
self.outf.writelines(
5157
list(plugin.describe_plugins(show_paths=verbose)))
5160
class cmd_testament(Command):
5161
__doc__ = """Show testament (signing-form) of a revision."""
5164
Option('long', help='Produce long-format testament.'),
5166
help='Produce a strict-format testament.')]
5167
takes_args = ['branch?']
5168
encoding_type = 'exact'
5170
def run(self, branch=u'.', revision=None, long=False, strict=False):
5171
from .testament import Testament, StrictTestament
5173
testament_class = StrictTestament
5175
testament_class = Testament
5177
b = Branch.open_containing(branch)[0]
5179
b = Branch.open(branch)
5180
self.add_cleanup(b.lock_read().unlock)
5181
if revision is None:
5182
rev_id = b.last_revision()
5184
rev_id = revision[0].as_revision_id(b)
5185
t = testament_class.from_revision(b.repository, rev_id)
5187
self.outf.writelines(t.as_text_lines())
5189
self.outf.write(t.as_short_text())
5192
class cmd_annotate(Command):
5193
__doc__ = """Show the origin of each line in a file.
5195
This prints out the given file with an annotation on the left side
5196
indicating which revision, author and date introduced the change.
5198
If the origin is the same for a run of consecutive lines, it is
5199
shown only at the top, unless the --all option is given.
5201
# TODO: annotate directories; showing when each file was last changed
5202
# TODO: if the working copy is modified, show annotations on that
5203
# with new uncommitted lines marked
5204
aliases = ['ann', 'blame', 'praise']
5205
takes_args = ['filename']
5206
takes_options = [Option('all', help='Show annotations on all lines.'),
5207
Option('long', help='Show commit date in annotations.'),
5212
encoding_type = 'exact'
5215
def run(self, filename, all=False, long=False, revision=None,
5216
show_ids=False, directory=None):
5217
from .annotate import (
5220
wt, branch, relpath = \
5221
_open_directory_or_containing_tree_or_branch(filename, directory)
5223
self.add_cleanup(wt.lock_read().unlock)
5225
self.add_cleanup(branch.lock_read().unlock)
5226
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5227
self.add_cleanup(tree.lock_read().unlock)
5228
if wt is not None and revision is None:
5229
file_id = wt.path2id(relpath)
5231
file_id = tree.path2id(relpath)
5233
raise errors.NotVersionedError(filename)
5234
if wt is not None and revision is None:
5235
# If there is a tree and we're not annotating historical
5236
# versions, annotate the working tree's content.
5237
annotate_file_tree(wt, relpath, self.outf, long, all,
5240
annotate_file_tree(tree, relpath, self.outf, long, all,
5241
show_ids=show_ids, branch=branch)
5244
class cmd_re_sign(Command):
5245
__doc__ = """Create a digital signature for an existing revision."""
5246
# TODO be able to replace existing ones.
5248
hidden = True # is this right ?
5249
takes_args = ['revision_id*']
5250
takes_options = ['directory', 'revision']
5252
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5253
if revision_id_list is not None and revision is not None:
5254
raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
5255
if revision_id_list is None and revision is None:
5256
raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
5257
b = WorkingTree.open_containing(directory)[0].branch
5258
self.add_cleanup(b.lock_write().unlock)
5259
return self._run(b, revision_id_list, revision)
5261
def _run(self, b, revision_id_list, revision):
5262
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5263
if revision_id_list is not None:
5264
b.repository.start_write_group()
5266
for revision_id in revision_id_list:
5267
revision_id = cache_utf8.encode(revision_id)
5268
b.repository.sign_revision(revision_id, gpg_strategy)
5270
b.repository.abort_write_group()
5273
b.repository.commit_write_group()
5274
elif revision is not None:
5275
if len(revision) == 1:
5276
revno, rev_id = revision[0].in_history(b)
5277
b.repository.start_write_group()
5279
b.repository.sign_revision(rev_id, gpg_strategy)
5281
b.repository.abort_write_group()
5284
b.repository.commit_write_group()
5285
elif len(revision) == 2:
5286
# are they both on rh- if so we can walk between them
5287
# might be nice to have a range helper for arbitrary
5288
# revision paths. hmm.
5289
from_revno, from_revid = revision[0].in_history(b)
5290
to_revno, to_revid = revision[1].in_history(b)
5291
if to_revid is None:
5292
to_revno = b.revno()
5293
if from_revno is None or to_revno is None:
5294
raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
5295
b.repository.start_write_group()
5297
for revno in range(from_revno, to_revno + 1):
5298
b.repository.sign_revision(b.get_rev_id(revno),
5301
b.repository.abort_write_group()
5304
b.repository.commit_write_group()
5306
raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
5309
class cmd_bind(Command):
5310
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5311
If no branch is supplied, rebind to the last bound location.
5313
Once converted into a checkout, commits must succeed on the master branch
5314
before they will be applied to the local branch.
5316
Bound branches use the nickname of its master branch unless it is set
5317
locally, in which case binding will update the local nickname to be
5321
_see_also = ['checkouts', 'unbind']
5322
takes_args = ['location?']
5323
takes_options = ['directory']
5325
def run(self, location=None, directory=u'.'):
5326
b, relpath = Branch.open_containing(directory)
5327
if location is None:
5329
location = b.get_old_bound_location()
5330
except errors.UpgradeRequired:
5331
raise errors.BzrCommandError(gettext('No location supplied. '
5332
'This format does not remember old locations.'))
5334
if location is None:
5335
if b.get_bound_location() is not None:
5336
raise errors.BzrCommandError(
5337
gettext('Branch is already bound'))
5339
raise errors.BzrCommandError(
5340
gettext('No location supplied'
5341
' and no previous location known'))
5342
b_other = Branch.open(location)
5345
except errors.DivergedBranches:
5346
raise errors.BzrCommandError(gettext('These branches have diverged.'
5347
' Try merging, and then bind again.'))
5348
if b.get_config().has_explicit_nickname():
5349
b.nick = b_other.nick
5352
class cmd_unbind(Command):
5353
__doc__ = """Convert the current checkout into a regular branch.
5355
After unbinding, the local branch is considered independent and subsequent
5356
commits will be local only.
5359
_see_also = ['checkouts', 'bind']
5361
takes_options = ['directory']
5363
def run(self, directory=u'.'):
5364
b, relpath = Branch.open_containing(directory)
5366
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5369
class cmd_uncommit(Command):
5370
__doc__ = """Remove the last committed revision.
5372
--verbose will print out what is being removed.
5373
--dry-run will go through all the motions, but not actually
5376
If --revision is specified, uncommit revisions to leave the branch at the
5377
specified revision. For example, "brz uncommit -r 15" will leave the
5378
branch at revision 15.
5380
Uncommit leaves the working tree ready for a new commit. The only change
5381
it may make is to restore any pending merges that were present before
5385
# TODO: jam 20060108 Add an option to allow uncommit to remove
5386
# unreferenced information in 'branch-as-repository' branches.
5387
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5388
# information in shared branches as well.
5389
_see_also = ['commit']
5390
takes_options = ['verbose', 'revision',
5391
Option('dry-run', help='Don\'t actually make changes.'),
5392
Option('force', help='Say yes to all questions.'),
5394
help='Keep tags that point to removed revisions.'),
5396
help="Only remove the commits from the local branch"
5397
" when in a checkout."
5400
takes_args = ['location?']
5402
encoding_type = 'replace'
5404
def run(self, location=None, dry_run=False, verbose=False,
5405
revision=None, force=False, local=False, keep_tags=False):
5406
if location is None:
5408
control, relpath = controldir.ControlDir.open_containing(location)
5410
tree = control.open_workingtree()
5412
except (errors.NoWorkingTree, errors.NotLocalUrl):
5414
b = control.open_branch()
5416
if tree is not None:
5417
self.add_cleanup(tree.lock_write().unlock)
5419
self.add_cleanup(b.lock_write().unlock)
5420
return self._run(b, tree, dry_run, verbose, revision, force,
5423
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5425
from .log import log_formatter, show_log
5426
from .uncommit import uncommit
5428
last_revno, last_rev_id = b.last_revision_info()
5431
if revision is None:
5433
rev_id = last_rev_id
5435
# 'brz uncommit -r 10' actually means uncommit
5436
# so that the final tree is at revno 10.
5437
# but breezy.uncommit.uncommit() actually uncommits
5438
# the revisions that are supplied.
5439
# So we need to offset it by one
5440
revno = revision[0].in_history(b).revno + 1
5441
if revno <= last_revno:
5442
rev_id = b.get_rev_id(revno)
5444
if rev_id is None or _mod_revision.is_null(rev_id):
5445
self.outf.write(gettext('No revisions to uncommit.\n'))
5448
lf = log_formatter('short',
5450
show_timezone='original')
5455
direction='forward',
5456
start_revision=revno,
5457
end_revision=last_revno)
5460
self.outf.write(gettext('Dry-run, pretending to remove'
5461
' the above revisions.\n'))
5463
self.outf.write(gettext('The above revision(s) will be removed.\n'))
5466
if not ui.ui_factory.confirm_action(
5467
gettext(u'Uncommit these revisions'),
5468
'breezy.builtins.uncommit',
5470
self.outf.write(gettext('Canceled\n'))
5473
mutter('Uncommitting from {%s} to {%s}',
5474
last_rev_id, rev_id)
5475
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5476
revno=revno, local=local, keep_tags=keep_tags)
5477
self.outf.write(gettext('You can restore the old tip by running:\n'
5478
' brz pull . -r revid:%s\n') % last_rev_id.decode('utf-8'))
5481
class cmd_break_lock(Command):
5482
__doc__ = """Break a dead lock.
5484
This command breaks a lock on a repository, branch, working directory or
5487
CAUTION: Locks should only be broken when you are sure that the process
5488
holding the lock has been stopped.
5490
You can get information on what locks are open via the 'brz info
5491
[location]' command.
5495
brz break-lock brz+ssh://example.com/brz/foo
5496
brz break-lock --conf ~/.bazaar
5499
takes_args = ['location?']
5502
help='LOCATION is the directory where the config lock is.'),
5504
help='Do not ask for confirmation before breaking the lock.'),
5507
def run(self, location=None, config=False, force=False):
5508
if location is None:
5511
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5513
{'breezy.lockdir.break': True})
5515
conf = _mod_config.LockableConfig(file_name=location)
5518
control, relpath = controldir.ControlDir.open_containing(location)
5520
control.break_lock()
5521
except NotImplementedError:
5525
class cmd_wait_until_signalled(Command):
5526
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5528
This just prints a line to signal when it is ready, then blocks on stdin.
5534
self.outf.write("running\n")
5536
sys.stdin.readline()
5539
class cmd_serve(Command):
5540
__doc__ = """Run the brz server."""
5542
aliases = ['server']
5546
help='Serve on stdin/out for use from inetd or sshd.'),
5547
RegistryOption('protocol',
5548
help="Protocol to serve.",
5549
lazy_registry=('breezy.transport', 'transport_server_registry'),
5550
value_switches=True),
5552
help='Listen for connections on nominated address.', type=text_type),
5554
help='Listen for connections on nominated port. Passing 0 as '
5555
'the port number will result in a dynamically allocated '
5556
'port. The default port depends on the protocol.',
5558
custom_help('directory',
5559
help='Serve contents of this directory.'),
5560
Option('allow-writes',
5561
help='By default the server is a readonly server. Supplying '
5562
'--allow-writes enables write access to the contents of '
5563
'the served directory and below. Note that ``brz serve`` '
5564
'does not perform authentication, so unless some form of '
5565
'external authentication is arranged supplying this '
5566
'option leads to global uncontrolled write access to your '
5569
Option('client-timeout', type=float,
5570
help='Override the default idle client timeout (5min).'),
5573
def run(self, listen=None, port=None, inet=False, directory=None,
5574
allow_writes=False, protocol=None, client_timeout=None):
5575
from . import transport
5576
if directory is None:
5577
directory = osutils.getcwd()
5578
if protocol is None:
5579
protocol = transport.transport_server_registry.get()
5580
url = transport.location_to_url(directory)
5581
if not allow_writes:
5582
url = 'readonly+' + url
5583
t = transport.get_transport_from_url(url)
5584
protocol(t, listen, port, inet, client_timeout)
5587
class cmd_join(Command):
5588
__doc__ = """Combine a tree into its containing tree.
5590
This command requires the target tree to be in a rich-root format.
5592
The TREE argument should be an independent tree, inside another tree, but
5593
not part of it. (Such trees can be produced by "brz split", but also by
5594
running "brz branch" with the target inside a tree.)
5596
The result is a combined tree, with the subtree no longer an independent
5597
part. This is marked as a merge of the subtree into the containing tree,
5598
and all history is preserved.
5601
_see_also = ['split']
5602
takes_args = ['tree']
5604
Option('reference', help='Join by reference.', hidden=True),
5607
def run(self, tree, reference=False):
5608
from breezy.mutabletree import BadReferenceTarget
5609
sub_tree = WorkingTree.open(tree)
5610
parent_dir = osutils.dirname(sub_tree.basedir)
5611
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5612
repo = containing_tree.branch.repository
5613
if not repo.supports_rich_root():
5614
raise errors.BzrCommandError(gettext(
5615
"Can't join trees because %s doesn't support rich root data.\n"
5616
"You can use brz upgrade on the repository.")
5620
containing_tree.add_reference(sub_tree)
5621
except BadReferenceTarget as e:
5622
# XXX: Would be better to just raise a nicely printable
5623
# exception from the real origin. Also below. mbp 20070306
5624
raise errors.BzrCommandError(
5625
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5628
containing_tree.subsume(sub_tree)
5629
except errors.BadSubsumeSource as e:
5630
raise errors.BzrCommandError(
5631
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5634
class cmd_split(Command):
5635
__doc__ = """Split a subdirectory of a tree into a separate tree.
5637
This command will produce a target tree in a format that supports
5638
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5639
converted into earlier formats like 'dirstate-tags'.
5641
The TREE argument should be a subdirectory of a working tree. That
5642
subdirectory will be converted into an independent tree, with its own
5643
branch. Commits in the top-level tree will not apply to the new subtree.
5646
_see_also = ['join']
5647
takes_args = ['tree']
5649
def run(self, tree):
5650
containing_tree, subdir = WorkingTree.open_containing(tree)
5651
if not containing_tree.is_versioned(subdir):
5652
raise errors.NotVersionedError(subdir)
5654
containing_tree.extract(subdir)
5655
except errors.RootNotRich:
5656
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5659
class cmd_merge_directive(Command):
5660
__doc__ = """Generate a merge directive for auto-merge tools.
5662
A directive requests a merge to be performed, and also provides all the
5663
information necessary to do so. This means it must either include a
5664
revision bundle, or the location of a branch containing the desired
5667
A submit branch (the location to merge into) must be supplied the first
5668
time the command is issued. After it has been supplied once, it will
5669
be remembered as the default.
5671
A public branch is optional if a revision bundle is supplied, but required
5672
if --diff or --plain is specified. It will be remembered as the default
5673
after the first use.
5676
takes_args = ['submit_branch?', 'public_branch?']
5680
_see_also = ['send']
5684
RegistryOption.from_kwargs('patch-type',
5685
'The type of patch to include in the directive.',
5687
value_switches=True,
5689
bundle='Bazaar revision bundle (default).',
5690
diff='Normal unified diff.',
5691
plain='No patch, just directive.'),
5692
Option('sign', help='GPG-sign the directive.'), 'revision',
5693
Option('mail-to', type=text_type,
5694
help='Instead of printing the directive, email to this address.'),
5695
Option('message', type=text_type, short_name='m',
5696
help='Message to use when committing this merge.')
5699
encoding_type = 'exact'
5701
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5702
sign=False, revision=None, mail_to=None, message=None,
5704
from .revision import ensure_null, NULL_REVISION
5705
include_patch, include_bundle = {
5706
'plain': (False, False),
5707
'diff': (True, False),
5708
'bundle': (True, True),
5710
branch = Branch.open(directory)
5711
stored_submit_branch = branch.get_submit_branch()
5712
if submit_branch is None:
5713
submit_branch = stored_submit_branch
5715
if stored_submit_branch is None:
5716
branch.set_submit_branch(submit_branch)
5717
if submit_branch is None:
5718
submit_branch = branch.get_parent()
5719
if submit_branch is None:
5720
raise errors.BzrCommandError(gettext('No submit branch specified or known'))
5722
stored_public_branch = branch.get_public_branch()
5723
if public_branch is None:
5724
public_branch = stored_public_branch
5725
elif stored_public_branch is None:
5726
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5727
branch.set_public_branch(public_branch)
5728
if not include_bundle and public_branch is None:
5729
raise errors.BzrCommandError(gettext('No public branch specified or'
5731
base_revision_id = None
5732
if revision is not None:
5733
if len(revision) > 2:
5734
raise errors.BzrCommandError(gettext('brz merge-directive takes '
5735
'at most two one revision identifiers'))
5736
revision_id = revision[-1].as_revision_id(branch)
5737
if len(revision) == 2:
5738
base_revision_id = revision[0].as_revision_id(branch)
5740
revision_id = branch.last_revision()
5741
revision_id = ensure_null(revision_id)
5742
if revision_id == NULL_REVISION:
5743
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5744
directive = merge_directive.MergeDirective2.from_objects(
5745
branch.repository, revision_id, time.time(),
5746
osutils.local_time_offset(), submit_branch,
5747
public_branch=public_branch, include_patch=include_patch,
5748
include_bundle=include_bundle, message=message,
5749
base_revision_id=base_revision_id)
5752
self.outf.write(directive.to_signed(branch))
5754
self.outf.writelines(directive.to_lines())
5756
message = directive.to_email(mail_to, branch, sign)
5757
s = SMTPConnection(branch.get_config_stack())
5758
s.send_email(message)
5761
class cmd_send(Command):
5762
__doc__ = """Mail or create a merge-directive for submitting changes.
5764
A merge directive provides many things needed for requesting merges:
5766
* A machine-readable description of the merge to perform
5768
* An optional patch that is a preview of the changes requested
5770
* An optional bundle of revision data, so that the changes can be applied
5771
directly from the merge directive, without retrieving data from a
5774
`brz send` creates a compact data set that, when applied using brz
5775
merge, has the same effect as merging from the source branch.
5777
By default the merge directive is self-contained and can be applied to any
5778
branch containing submit_branch in its ancestory without needing access to
5781
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5782
revisions, but only a structured request to merge from the
5783
public_location. In that case the public_branch is needed and it must be
5784
up-to-date and accessible to the recipient. The public_branch is always
5785
included if known, so that people can check it later.
5787
The submit branch defaults to the parent of the source branch, but can be
5788
overridden. Both submit branch and public branch will be remembered in
5789
branch.conf the first time they are used for a particular branch. The
5790
source branch defaults to that containing the working directory, but can
5791
be changed using --from.
5793
Both the submit branch and the public branch follow the usual behavior with
5794
respect to --remember: If there is no default location set, the first send
5795
will set it (use --no-remember to avoid setting it). After that, you can
5796
omit the location to use the default. To change the default, use
5797
--remember. The value will only be saved if the location can be accessed.
5799
In order to calculate those changes, brz must analyse the submit branch.
5800
Therefore it is most efficient for the submit branch to be a local mirror.
5801
If a public location is known for the submit_branch, that location is used
5802
in the merge directive.
5804
The default behaviour is to send the merge directive by mail, unless -o is
5805
given, in which case it is sent to a file.
5807
Mail is sent using your preferred mail program. This should be transparent
5808
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5809
If the preferred client can't be found (or used), your editor will be used.
5811
To use a specific mail program, set the mail_client configuration option.
5812
Supported values for specific clients are "claws", "evolution", "kmail",
5813
"mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options
5814
are "default", "editor", "emacsclient", "mapi", and "xdg-email". Plugins
5815
may also add supported clients.
5817
If mail is being sent, a to address is required. This can be supplied
5818
either on the commandline, by setting the submit_to configuration
5819
option in the branch itself or the child_submit_to configuration option
5820
in the submit branch.
5822
The merge directives created by brz send may be applied using brz merge or
5823
brz pull by specifying a file containing a merge directive as the location.
5825
brz send makes extensive use of public locations to map local locations into
5826
URLs that can be used by other people. See `brz help configuration` to
5827
set them, and use `brz info` to display them.
5830
encoding_type = 'exact'
5832
_see_also = ['merge', 'pull']
5834
takes_args = ['submit_branch?', 'public_branch?']
5838
help='Do not include a bundle in the merge directive.'),
5839
Option('no-patch', help='Do not include a preview patch in the merge'
5842
help='Remember submit and public branch.'),
5844
help='Branch to generate the submission from, '
5845
'rather than the one containing the working directory.',
5848
Option('output', short_name='o',
5849
help='Write merge directive to this file or directory; '
5850
'use - for stdout.',
5853
help='Refuse to send if there are uncommitted changes in'
5854
' the working tree, --no-strict disables the check.'),
5855
Option('mail-to', help='Mail the request to this address.',
5859
Option('body', help='Body for the email.', type=text_type),
5860
RegistryOption('format',
5861
help='Use the specified output format.',
5862
lazy_registry=('breezy.send', 'format_registry')),
5865
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5866
no_patch=False, revision=None, remember=None, output=None,
5867
format=None, mail_to=None, message=None, body=None,
5868
strict=None, **kwargs):
5869
from .send import send
5870
return send(submit_branch, revision, public_branch, remember,
5871
format, no_bundle, no_patch, output,
5872
kwargs.get('from', '.'), mail_to, message, body,
5877
class cmd_bundle_revisions(cmd_send):
5878
__doc__ = """Create a merge-directive for submitting changes.
5880
A merge directive provides many things needed for requesting merges:
5882
* A machine-readable description of the merge to perform
5884
* An optional patch that is a preview of the changes requested
5886
* An optional bundle of revision data, so that the changes can be applied
5887
directly from the merge directive, without retrieving data from a
5890
If --no-bundle is specified, then public_branch is needed (and must be
5891
up-to-date), so that the receiver can perform the merge using the
5892
public_branch. The public_branch is always included if known, so that
5893
people can check it later.
5895
The submit branch defaults to the parent, but can be overridden. Both
5896
submit branch and public branch will be remembered if supplied.
5898
If a public_branch is known for the submit_branch, that public submit
5899
branch is used in the merge instructions. This means that a local mirror
5900
can be used as your actual submit branch, once you have set public_branch
5906
help='Do not include a bundle in the merge directive.'),
5907
Option('no-patch', help='Do not include a preview patch in the merge'
5910
help='Remember submit and public branch.'),
5912
help='Branch to generate the submission from, '
5913
'rather than the one containing the working directory.',
5916
Option('output', short_name='o', help='Write directive to this file.',
5919
help='Refuse to bundle revisions if there are uncommitted'
5920
' changes in the working tree, --no-strict disables the check.'),
5922
RegistryOption('format',
5923
help='Use the specified output format.',
5924
lazy_registry=('breezy.send', 'format_registry')),
5926
aliases = ['bundle']
5928
_see_also = ['send', 'merge']
5932
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5933
no_patch=False, revision=None, remember=False, output=None,
5934
format=None, strict=None, **kwargs):
5937
from .send import send
5938
return send(submit_branch, revision, public_branch, remember,
5939
format, no_bundle, no_patch, output,
5940
kwargs.get('from', '.'), None, None, None,
5941
self.outf, strict=strict)
5944
class cmd_tag(Command):
5945
__doc__ = """Create, remove or modify a tag naming a revision.
5947
Tags give human-meaningful names to revisions. Commands that take a -r
5948
(--revision) option can be given -rtag:X, where X is any previously
5951
Tags are stored in the branch. Tags are copied from one branch to another
5952
along when you branch, push, pull or merge.
5954
It is an error to give a tag name that already exists unless you pass
5955
--force, in which case the tag is moved to point to the new revision.
5957
To rename a tag (change the name but keep it on the same revsion), run ``brz
5958
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
5960
If no tag name is specified it will be determined through the
5961
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5962
upstream releases by reading configure.ac. See ``brz help hooks`` for
5966
_see_also = ['commit', 'tags']
5967
takes_args = ['tag_name?']
5970
help='Delete this tag rather than placing it.',
5972
custom_help('directory',
5973
help='Branch in which to place the tag.'),
5975
help='Replace existing tags.',
5980
def run(self, tag_name=None,
5986
branch, relpath = Branch.open_containing(directory)
5987
self.add_cleanup(branch.lock_write().unlock)
5989
if tag_name is None:
5990
raise errors.BzrCommandError(gettext("No tag specified to delete."))
5991
branch.tags.delete_tag(tag_name)
5992
note(gettext('Deleted tag %s.') % tag_name)
5995
if len(revision) != 1:
5996
raise errors.BzrCommandError(gettext(
5997
"Tags can only be placed on a single revision, "
5999
revision_id = revision[0].as_revision_id(branch)
6001
revision_id = branch.last_revision()
6002
if tag_name is None:
6003
tag_name = branch.automatic_tag_name(revision_id)
6004
if tag_name is None:
6005
raise errors.BzrCommandError(gettext(
6006
"Please specify a tag name."))
6008
existing_target = branch.tags.lookup_tag(tag_name)
6009
except errors.NoSuchTag:
6010
existing_target = None
6011
if not force and existing_target not in (None, revision_id):
6012
raise errors.TagAlreadyExists(tag_name)
6013
if existing_target == revision_id:
6014
note(gettext('Tag %s already exists for that revision.') % tag_name)
6016
branch.tags.set_tag(tag_name, revision_id)
6017
if existing_target is None:
6018
note(gettext('Created tag %s.') % tag_name)
6020
note(gettext('Updated tag %s.') % tag_name)
6023
class cmd_tags(Command):
6024
__doc__ = """List tags.
6026
This command shows a table of tag names and the revisions they reference.
6031
custom_help('directory',
6032
help='Branch whose tags should be displayed.'),
6033
RegistryOption('sort',
6034
'Sort tags by different criteria.', title='Sorting',
6035
lazy_registry=('breezy.tag', 'tag_sort_methods')
6042
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6043
from .tag import tag_sort_methods
6044
branch, relpath = Branch.open_containing(directory)
6046
tags = list(viewitems(branch.tags.get_tag_dict()))
6050
self.add_cleanup(branch.lock_read().unlock)
6052
# Restrict to the specified range
6053
tags = self._tags_for_range(branch, revision)
6055
sort = tag_sort_methods.get()
6058
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6059
for index, (tag, revid) in enumerate(tags):
6061
revno = branch.revision_id_to_dotted_revno(revid)
6062
if isinstance(revno, tuple):
6063
revno = '.'.join(map(str, revno))
6064
except (errors.NoSuchRevision,
6065
errors.GhostRevisionsHaveNoRevno,
6066
errors.UnsupportedOperation):
6067
# Bad tag data/merges can lead to tagged revisions
6068
# which are not in this branch. Fail gracefully ...
6070
tags[index] = (tag, revno)
6072
tags = [(tag, revid.decode('utf-8')) for (tag, revid) in tags]
6074
for tag, revspec in tags:
6075
self.outf.write('%-20s %s\n' % (tag, revspec))
6077
def _tags_for_range(self, branch, revision):
6078
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6079
revid1, revid2 = rev1.rev_id, rev2.rev_id
6080
# _get_revision_range will always set revid2 if it's not specified.
6081
# If revid1 is None, it means we want to start from the branch
6082
# origin which is always a valid ancestor. If revid1 == revid2, the
6083
# ancestry check is useless.
6084
if revid1 and revid1 != revid2:
6085
# FIXME: We really want to use the same graph than
6086
# branch.iter_merge_sorted_revisions below, but this is not
6087
# easily available -- vila 2011-09-23
6088
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6089
# We don't want to output anything in this case...
6091
# only show revisions between revid1 and revid2 (inclusive)
6092
tagged_revids = branch.tags.get_reverse_tag_dict()
6094
for r in branch.iter_merge_sorted_revisions(
6095
start_revision_id=revid2, stop_revision_id=revid1,
6096
stop_rule='include'):
6097
revid_tags = tagged_revids.get(r[0], None)
6099
found.extend([(tag, r[0]) for tag in revid_tags])
6103
class cmd_reconfigure(Command):
6104
__doc__ = """Reconfigure the type of a brz directory.
6106
A target configuration must be specified.
6108
For checkouts, the bind-to location will be auto-detected if not specified.
6109
The order of preference is
6110
1. For a lightweight checkout, the current bound location.
6111
2. For branches that used to be checkouts, the previously-bound location.
6112
3. The push location.
6113
4. The parent location.
6114
If none of these is available, --bind-to must be specified.
6117
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6118
takes_args = ['location?']
6120
RegistryOption.from_kwargs(
6123
help='The relation between branch and tree.',
6124
value_switches=True, enum_switch=False,
6125
branch='Reconfigure to be an unbound branch with no working tree.',
6126
tree='Reconfigure to be an unbound branch with a working tree.',
6127
checkout='Reconfigure to be a bound branch with a working tree.',
6128
lightweight_checkout='Reconfigure to be a lightweight'
6129
' checkout (with no local history).',
6131
RegistryOption.from_kwargs(
6133
title='Repository type',
6134
help='Location fo the repository.',
6135
value_switches=True, enum_switch=False,
6136
standalone='Reconfigure to be a standalone branch '
6137
'(i.e. stop using shared repository).',
6138
use_shared='Reconfigure to use a shared repository.',
6140
RegistryOption.from_kwargs(
6142
title='Trees in Repository',
6143
help='Whether new branches in the repository have trees.',
6144
value_switches=True, enum_switch=False,
6145
with_trees='Reconfigure repository to create '
6146
'working trees on branches by default.',
6147
with_no_trees='Reconfigure repository to not create '
6148
'working trees on branches by default.'
6150
Option('bind-to', help='Branch to bind checkout to.', type=text_type),
6152
help='Perform reconfiguration even if local changes'
6154
Option('stacked-on',
6155
help='Reconfigure a branch to be stacked on another branch.',
6159
help='Reconfigure a branch to be unstacked. This '
6160
'may require copying substantial data into it.',
6164
def run(self, location=None, bind_to=None, force=False,
6165
tree_type=None, repository_type=None, repository_trees=None,
6166
stacked_on=None, unstacked=None):
6167
directory = controldir.ControlDir.open(location)
6168
if stacked_on and unstacked:
6169
raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
6170
elif stacked_on is not None:
6171
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6173
reconfigure.ReconfigureUnstacked().apply(directory)
6174
# At the moment you can use --stacked-on and a different
6175
# reconfiguration shape at the same time; there seems no good reason
6177
if (tree_type is None and
6178
repository_type is None and
6179
repository_trees is None):
6180
if stacked_on or unstacked:
6183
raise errors.BzrCommandError(gettext('No target configuration '
6185
reconfiguration = None
6186
if tree_type == 'branch':
6187
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6188
elif tree_type == 'tree':
6189
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6190
elif tree_type == 'checkout':
6191
reconfiguration = reconfigure.Reconfigure.to_checkout(
6193
elif tree_type == 'lightweight-checkout':
6194
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6197
reconfiguration.apply(force)
6198
reconfiguration = None
6199
if repository_type == 'use-shared':
6200
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6201
elif repository_type == 'standalone':
6202
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6204
reconfiguration.apply(force)
6205
reconfiguration = None
6206
if repository_trees == 'with-trees':
6207
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6209
elif repository_trees == 'with-no-trees':
6210
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6213
reconfiguration.apply(force)
6214
reconfiguration = None
6217
class cmd_switch(Command):
6218
__doc__ = """Set the branch of a checkout and update.
6220
For lightweight checkouts, this changes the branch being referenced.
6221
For heavyweight checkouts, this checks that there are no local commits
6222
versus the current bound branch, then it makes the local branch a mirror
6223
of the new location and binds to it.
6225
In both cases, the working tree is updated and uncommitted changes
6226
are merged. The user can commit or revert these as they desire.
6228
Pending merges need to be committed or reverted before using switch.
6230
The path to the branch to switch to can be specified relative to the parent
6231
directory of the current branch. For example, if you are currently in a
6232
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6235
Bound branches use the nickname of its master branch unless it is set
6236
locally, in which case switching will update the local nickname to be
6240
takes_args = ['to_location?']
6241
takes_options = ['directory',
6243
help='Switch even if local commits will be lost.'),
6245
Option('create-branch', short_name='b',
6246
help='Create the target branch from this one before'
6247
' switching to it.'),
6249
help='Store and restore uncommitted changes in the'
6253
def run(self, to_location=None, force=False, create_branch=False,
6254
revision=None, directory=u'.', store=False):
6255
from . import switch
6256
tree_location = directory
6257
revision = _get_one_revision('switch', revision)
6258
possible_transports = []
6259
control_dir = controldir.ControlDir.open_containing(tree_location,
6260
possible_transports=possible_transports)[0]
6261
if to_location is None:
6262
if revision is None:
6263
raise errors.BzrCommandError(gettext('You must supply either a'
6264
' revision or a location'))
6265
to_location = tree_location
6267
branch = control_dir.open_branch(
6268
possible_transports=possible_transports)
6269
had_explicit_nick = branch.get_config().has_explicit_nickname()
6270
except errors.NotBranchError:
6272
had_explicit_nick = False
6275
raise errors.BzrCommandError(
6276
gettext('cannot create branch without source branch'))
6277
to_location = lookup_new_sibling_branch(control_dir, to_location,
6278
possible_transports=possible_transports)
6279
if revision is not None:
6280
revision = revision.as_revision_id(branch)
6281
to_branch = branch.controldir.sprout(to_location,
6282
possible_transports=possible_transports,
6283
revision_id=revision,
6284
source_branch=branch).open_branch()
6287
to_branch = Branch.open(to_location,
6288
possible_transports=possible_transports)
6289
except errors.NotBranchError:
6290
to_branch = open_sibling_branch(control_dir, to_location,
6291
possible_transports=possible_transports)
6292
if revision is not None:
6293
revision = revision.as_revision_id(to_branch)
6295
switch.switch(control_dir, to_branch, force, revision_id=revision,
6296
store_uncommitted=store)
6297
except controldir.BranchReferenceLoop:
6298
raise errors.BzrCommandError(
6299
gettext('switching would create a branch reference loop. '
6300
'Use the "bzr up" command to switch to a '
6301
'different revision.'))
6302
if had_explicit_nick:
6303
branch = control_dir.open_branch() #get the new branch!
6304
branch.nick = to_branch.nick
6305
note(gettext('Switched to branch: %s'),
6306
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6310
class cmd_view(Command):
6311
__doc__ = """Manage filtered views.
6313
Views provide a mask over the tree so that users can focus on
6314
a subset of a tree when doing their work. After creating a view,
6315
commands that support a list of files - status, diff, commit, etc -
6316
effectively have that list of files implicitly given each time.
6317
An explicit list of files can still be given but those files
6318
must be within the current view.
6320
In most cases, a view has a short life-span: it is created to make
6321
a selected change and is deleted once that change is committed.
6322
At other times, you may wish to create one or more named views
6323
and switch between them.
6325
To disable the current view without deleting it, you can switch to
6326
the pseudo view called ``off``. This can be useful when you need
6327
to see the whole tree for an operation or two (e.g. merge) but
6328
want to switch back to your view after that.
6331
To define the current view::
6333
brz view file1 dir1 ...
6335
To list the current view::
6339
To delete the current view::
6343
To disable the current view without deleting it::
6345
brz view --switch off
6347
To define a named view and switch to it::
6349
brz view --name view-name file1 dir1 ...
6351
To list a named view::
6353
brz view --name view-name
6355
To delete a named view::
6357
brz view --name view-name --delete
6359
To switch to a named view::
6361
brz view --switch view-name
6363
To list all views defined::
6367
To delete all views::
6369
brz view --delete --all
6373
takes_args = ['file*']
6376
help='Apply list or delete action to all views.',
6379
help='Delete the view.',
6382
help='Name of the view to define, list or delete.',
6386
help='Name of the view to switch to.',
6391
def run(self, file_list,
6397
tree, file_list = WorkingTree.open_containing_paths(file_list,
6399
current_view, view_dict = tree.views.get_view_info()
6404
raise errors.BzrCommandError(gettext(
6405
"Both --delete and a file list specified"))
6407
raise errors.BzrCommandError(gettext(
6408
"Both --delete and --switch specified"))
6410
tree.views.set_view_info(None, {})
6411
self.outf.write(gettext("Deleted all views.\n"))
6413
raise errors.BzrCommandError(gettext("No current view to delete"))
6415
tree.views.delete_view(name)
6416
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6419
raise errors.BzrCommandError(gettext(
6420
"Both --switch and a file list specified"))
6422
raise errors.BzrCommandError(gettext(
6423
"Both --switch and --all specified"))
6424
elif switch == 'off':
6425
if current_view is None:
6426
raise errors.BzrCommandError(gettext("No current view to disable"))
6427
tree.views.set_view_info(None, view_dict)
6428
self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6430
tree.views.set_view_info(switch, view_dict)
6431
view_str = views.view_display_str(tree.views.lookup_view())
6432
self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6435
self.outf.write(gettext('Views defined:\n'))
6436
for view in sorted(view_dict):
6437
if view == current_view:
6441
view_str = views.view_display_str(view_dict[view])
6442
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6444
self.outf.write(gettext('No views defined.\n'))
6447
# No name given and no current view set
6450
raise errors.BzrCommandError(gettext(
6451
"Cannot change the 'off' pseudo view"))
6452
tree.views.set_view(name, sorted(file_list))
6453
view_str = views.view_display_str(tree.views.lookup_view())
6454
self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6458
# No name given and no current view set
6459
self.outf.write(gettext('No current view.\n'))
6461
view_str = views.view_display_str(tree.views.lookup_view(name))
6462
self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6465
class cmd_hooks(Command):
6466
__doc__ = """Show hooks."""
6471
for hook_key in sorted(hooks.known_hooks.keys()):
6472
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6473
self.outf.write("%s:\n" % type(some_hooks).__name__)
6474
for hook_name, hook_point in sorted(some_hooks.items()):
6475
self.outf.write(" %s:\n" % (hook_name,))
6476
found_hooks = list(hook_point)
6478
for hook in found_hooks:
6479
self.outf.write(" %s\n" %
6480
(some_hooks.get_hook_name(hook),))
6482
self.outf.write(gettext(" <no hooks installed>\n"))
6485
class cmd_remove_branch(Command):
6486
__doc__ = """Remove a branch.
6488
This will remove the branch from the specified location but
6489
will keep any working tree or repository in place.
6493
Remove the branch at repo/trunk::
6495
brz remove-branch repo/trunk
6499
takes_args = ["location?"]
6501
takes_options = ['directory',
6502
Option('force', help='Remove branch even if it is the active branch.')]
6504
aliases = ["rmbranch"]
6506
def run(self, directory=None, location=None, force=False):
6507
br = open_nearby_branch(near=directory, location=location)
6508
if not force and br.controldir.has_workingtree():
6510
active_branch = br.controldir.open_branch(name="")
6511
except errors.NotBranchError:
6512
active_branch = None
6513
if (active_branch is not None and
6514
br.control_url == active_branch.control_url):
6515
raise errors.BzrCommandError(
6516
gettext("Branch is active. Use --force to remove it."))
6517
br.controldir.destroy_branch(br.name)
6520
class cmd_shelve(Command):
6521
__doc__ = """Temporarily set aside some changes from the current tree.
6523
Shelve allows you to temporarily put changes you've made "on the shelf",
6524
ie. out of the way, until a later time when you can bring them back from
6525
the shelf with the 'unshelve' command. The changes are stored alongside
6526
your working tree, and so they aren't propagated along with your branch nor
6527
will they survive its deletion.
6529
If shelve --list is specified, previously-shelved changes are listed.
6531
Shelve is intended to help separate several sets of changes that have
6532
been inappropriately mingled. If you just want to get rid of all changes
6533
and you don't need to restore them later, use revert. If you want to
6534
shelve all text changes at once, use shelve --all.
6536
If filenames are specified, only the changes to those files will be
6537
shelved. Other files will be left untouched.
6539
If a revision is specified, changes since that revision will be shelved.
6541
You can put multiple items on the shelf, and by default, 'unshelve' will
6542
restore the most recently shelved changes.
6544
For complicated changes, it is possible to edit the changes in a separate
6545
editor program to decide what the file remaining in the working copy
6546
should look like. To do this, add the configuration option
6548
change_editor = PROGRAM @new_path @old_path
6550
where @new_path is replaced with the path of the new version of the
6551
file and @old_path is replaced with the path of the old version of
6552
the file. The PROGRAM should save the new file with the desired
6553
contents of the file in the working tree.
6557
takes_args = ['file*']
6562
Option('all', help='Shelve all changes.'),
6564
RegistryOption('writer', 'Method to use for writing diffs.',
6565
breezy.option.diff_writer_registry,
6566
value_switches=True, enum_switch=False),
6568
Option('list', help='List shelved changes.'),
6570
help='Destroy removed changes instead of shelving them.'),
6572
_see_also = ['unshelve', 'configuration']
6574
def run(self, revision=None, all=False, file_list=None, message=None,
6575
writer=None, list=False, destroy=False, directory=None):
6577
return self.run_for_list(directory=directory)
6578
from .shelf_ui import Shelver
6580
writer = breezy.option.diff_writer_registry.get()
6582
shelver = Shelver.from_args(writer(self.outf), revision, all,
6583
file_list, message, destroy=destroy, directory=directory)
6588
except errors.UserAbort:
6591
def run_for_list(self, directory=None):
6592
if directory is None:
6594
tree = WorkingTree.open_containing(directory)[0]
6595
self.add_cleanup(tree.lock_read().unlock)
6596
manager = tree.get_shelf_manager()
6597
shelves = manager.active_shelves()
6598
if len(shelves) == 0:
6599
note(gettext('No shelved changes.'))
6601
for shelf_id in reversed(shelves):
6602
message = manager.get_metadata(shelf_id).get(b'message')
6604
message = '<no message>'
6605
self.outf.write('%3d: %s\n' % (shelf_id, message))
6609
class cmd_unshelve(Command):
6610
__doc__ = """Restore shelved changes.
6612
By default, the most recently shelved changes are restored. However if you
6613
specify a shelf by id those changes will be restored instead. This works
6614
best when the changes don't depend on each other.
6617
takes_args = ['shelf_id?']
6620
RegistryOption.from_kwargs(
6621
'action', help="The action to perform.",
6622
enum_switch=False, value_switches=True,
6623
apply="Apply changes and remove from the shelf.",
6624
dry_run="Show changes, but do not apply or remove them.",
6625
preview="Instead of unshelving the changes, show the diff that "
6626
"would result from unshelving.",
6627
delete_only="Delete changes without applying them.",
6628
keep="Apply changes but don't delete them.",
6631
_see_also = ['shelve']
6633
def run(self, shelf_id=None, action='apply', directory=u'.'):
6634
from .shelf_ui import Unshelver
6635
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6639
unshelver.tree.unlock()
6642
class cmd_clean_tree(Command):
6643
__doc__ = """Remove unwanted files from working tree.
6645
By default, only unknown files, not ignored files, are deleted. Versioned
6646
files are never deleted.
6648
Another class is 'detritus', which includes files emitted by brz during
6649
normal operations and selftests. (The value of these files decreases with
6652
If no options are specified, unknown files are deleted. Otherwise, option
6653
flags are respected, and may be combined.
6655
To check what clean-tree will do, use --dry-run.
6657
takes_options = ['directory',
6658
Option('ignored', help='Delete all ignored files.'),
6659
Option('detritus', help='Delete conflict files, merge and revert'
6660
' backups, and failed selftest dirs.'),
6662
help='Delete files unknown to brz (default).'),
6663
Option('dry-run', help='Show files to delete instead of'
6665
Option('force', help='Do not prompt before deleting.')]
6667
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6668
force=False, directory=u'.'):
6669
from .clean_tree import clean_tree
6670
if not (unknown or ignored or detritus):
6674
clean_tree(directory, unknown=unknown, ignored=ignored,
6675
detritus=detritus, dry_run=dry_run, no_prompt=force)
6678
class cmd_reference(Command):
6679
__doc__ = """list, view and set branch locations for nested trees.
6681
If no arguments are provided, lists the branch locations for nested trees.
6682
If one argument is provided, display the branch location for that tree.
6683
If two arguments are provided, set the branch location for that tree.
6688
takes_args = ['path?', 'location?']
6690
Option('force-unversioned',
6691
help='Set reference even if path is not versioned.'),
6694
def run(self, path=None, location=None, force_unversioned=False):
6696
if path is not None:
6698
tree, branch, relpath =(
6699
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6700
if path is not None:
6703
tree = branch.basis_tree()
6705
info = viewitems(branch._get_all_reference_info())
6706
self._display_reference_info(tree, branch, info)
6708
if not tree.is_versioned(path) and not force_unversioned:
6709
raise errors.NotVersionedError(path)
6710
if location is None:
6711
info = [(path, branch.get_reference_info(path))]
6712
self._display_reference_info(tree, branch, info)
6714
branch.set_reference_info(
6715
path, location, file_id=tree.path2id(path))
6717
def _display_reference_info(self, tree, branch, info):
6719
for path, (location, file_id) in info:
6720
ref_list.append((path, location))
6721
for path, location in sorted(ref_list):
6722
self.outf.write('%s %s\n' % (path, location))
6725
class cmd_export_pot(Command):
6726
__doc__ = """Export command helps and error messages in po format."""
6729
takes_options = [Option('plugin',
6730
help='Export help text from named command '\
6731
'(defaults to all built in commands).',
6733
Option('include-duplicates',
6734
help='Output multiple copies of the same msgid '
6735
'string if it appears more than once.'),
6738
def run(self, plugin=None, include_duplicates=False):
6739
from .export_pot import export_pot
6740
export_pot(self.outf, plugin, include_duplicates)
6743
class cmd_import(Command):
6744
__doc__ = """Import sources from a directory, tarball or zip file
6746
This command will import a directory, tarball or zip file into a bzr
6747
tree, replacing any versioned files already present. If a directory is
6748
specified, it is used as the target. If the directory does not exist, or
6749
is not versioned, it is created.
6751
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6753
If the tarball or zip has a single root directory, that directory is
6754
stripped when extracting the tarball. This is not done for directories.
6757
takes_args = ['source', 'tree?']
6759
def run(self, source, tree=None):
6760
from .upstream_import import do_import
6761
do_import(source, tree)
6764
class cmd_link_tree(Command):
6765
__doc__ = """Hardlink matching files to another tree.
6767
Only files with identical content and execute bit will be linked.
6770
takes_args = ['location']
6772
def run(self, location):
6773
from .transform import link_tree
6774
target_tree = WorkingTree.open_containing(".")[0]
6775
source_tree = WorkingTree.open(location)
6776
with target_tree.lock_write(), source_tree.lock_read():
6777
link_tree(target_tree, source_tree)
6780
class cmd_fetch_ghosts(Command):
6781
__doc__ = """Attempt to retrieve ghosts from another branch.
6783
If the other branch is not supplied, the last-pulled branch is used.
6787
aliases = ['fetch-missing']
6788
takes_args = ['branch?']
6789
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6791
def run(self, branch=None, no_fix=False):
6792
from .fetch_ghosts import GhostFetcher
6793
installed, failed = GhostFetcher.from_cmdline(branch).run()
6794
if len(installed) > 0:
6795
self.outf.write("Installed:\n")
6796
for rev in installed:
6797
self.outf.write(rev.decode('utf-8') + "\n")
6799
self.outf.write("Still missing:\n")
6801
self.outf.write(rev.decode('utf-8') + "\n")
6802
if not no_fix and len(installed) > 0:
6803
cmd_reconcile().run(".")
6806
def _register_lazy_builtins():
6807
# register lazy builtins from other modules; called at startup and should
6808
# be only called once.
6809
for (name, aliases, module_name) in [
6810
('cmd_bisect', [], 'breezy.bisect'),
6811
('cmd_bundle_info', [], 'breezy.bundle.commands'),
6812
('cmd_config', [], 'breezy.config'),
6813
('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
6814
('cmd_version_info', [], 'breezy.cmd_version_info'),
6815
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
6816
('cmd_conflicts', [], 'breezy.conflicts'),
6817
('cmd_ping', [], 'breezy.bzr.smart.ping'),
6818
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
6819
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
6820
('cmd_test_script', [], 'breezy.cmd_test_script'),
6822
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
