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,
62
from breezy.branch import Branch
63
from breezy.conflicts import ConflictList
64
from breezy.transport import memory
65
from breezy.smtp_connection import SMTPConnection
66
from breezy.workingtree import WorkingTree
67
from breezy.i18n import gettext, ngettext
70
from .commands import (
72
builtin_command_registry,
82
from .revisionspec import (
92
from .trace import mutter, note, warning, is_quiet, get_verbosity_level
95
def _get_branch_location(control_dir, possible_transports=None):
96
"""Return location of branch for this control dir."""
98
target = control_dir.get_branch_reference()
99
except errors.NotBranchError:
100
return control_dir.root_transport.base
101
if target is not None:
103
this_branch = control_dir.open_branch(
104
possible_transports=possible_transports)
105
# This may be a heavy checkout, where we want the master branch
106
master_location = this_branch.get_bound_location()
107
if master_location is not None:
108
return master_location
109
# If not, use a local sibling
110
return this_branch.base
113
def _is_colocated(control_dir, possible_transports=None):
114
"""Check if the branch in control_dir is colocated.
116
:param control_dir: Control directory
117
:return: Tuple with boolean indicating whether the branch is colocated
118
and the full URL to the actual branch
120
# This path is meant to be relative to the existing branch
121
this_url = _get_branch_location(
122
control_dir, possible_transports=possible_transports)
123
# Perhaps the target control dir supports colocated branches?
125
root = controldir.ControlDir.open(
126
this_url, possible_transports=possible_transports)
127
except errors.NotBranchError:
128
return (False, this_url)
131
control_dir.open_workingtree()
132
except (errors.NoWorkingTree, errors.NotLocalUrl):
133
return (False, this_url)
136
root._format.colocated_branches and
137
control_dir.control_url == root.control_url,
141
def lookup_new_sibling_branch(control_dir, location, possible_transports=None):
142
"""Lookup the location for a new sibling branch.
144
:param control_dir: Control directory to find sibling branches from
145
:param location: Name of the new branch
146
:return: Full location to the new branch
148
location = directory_service.directories.dereference(location)
149
if '/' not in location and '\\' not in location:
150
(colocated, this_url) = _is_colocated(control_dir, possible_transports)
153
return urlutils.join_segment_parameters(
154
this_url, {"branch": urlutils.escape(location)})
156
return urlutils.join(this_url, '..', urlutils.escape(location))
160
def open_sibling_branch(control_dir, location, possible_transports=None):
161
"""Open a branch, possibly a sibling of another.
163
:param control_dir: Control directory relative to which to lookup the
165
:param location: Location to look up
166
:return: branch to open
169
# Perhaps it's a colocated branch?
170
return control_dir.open_branch(
171
location, possible_transports=possible_transports)
172
except (errors.NotBranchError, errors.NoColocatedBranchSupport):
173
this_url = _get_branch_location(control_dir)
176
this_url, '..', urlutils.escape(location)))
179
def open_nearby_branch(near=None, location=None, possible_transports=None):
180
"""Open a nearby branch.
182
:param near: Optional location of container from which to open branch
183
:param location: Location of the branch
184
:return: Branch instance
191
location, possible_transports=possible_transports)
192
except errors.NotBranchError:
194
cdir = controldir.ControlDir.open(
195
near, possible_transports=possible_transports)
196
return open_sibling_branch(
197
cdir, location, possible_transports=possible_transports)
200
def iter_sibling_branches(control_dir, possible_transports=None):
201
"""Iterate over the siblings of a branch.
203
:param control_dir: Control directory for which to look up the siblings
204
:return: Iterator over tuples with branch name and branch object
207
reference = control_dir.get_branch_reference()
208
except errors.NotBranchError:
209
# There is no active branch, just return the colocated branches.
210
for name, branch in viewitems(control_dir.get_branches()):
213
if reference is not None:
214
ref_branch = Branch.open(
215
reference, possible_transports=possible_transports)
218
if ref_branch is None or ref_branch.name:
219
if ref_branch is not None:
220
control_dir = ref_branch.controldir
221
for name, branch in viewitems(control_dir.get_branches()):
224
repo = ref_branch.controldir.find_repository()
225
for branch in repo.find_branches(using=True):
226
name = urlutils.relative_url(
227
repo.user_url, branch.user_url).rstrip("/")
231
def tree_files_for_add(file_list):
233
Return a tree and list of absolute paths from a file list.
235
Similar to tree_files, but add handles files a bit differently, so it a
236
custom implementation. In particular, MutableTreeTree.smart_add expects
237
absolute paths, which it immediately converts to relative paths.
239
# FIXME Would be nice to just return the relative paths like
240
# internal_tree_files does, but there are a large number of unit tests
241
# that assume the current interface to mutabletree.smart_add
243
tree, relpath = WorkingTree.open_containing(file_list[0])
244
if tree.supports_views():
245
view_files = tree.views.lookup_view()
247
for filename in file_list:
248
if not osutils.is_inside_any(view_files, filename):
249
raise views.FileOutsideView(filename, view_files)
250
file_list = file_list[:]
251
file_list[0] = tree.abspath(relpath)
253
tree = WorkingTree.open_containing(u'.')[0]
254
if tree.supports_views():
255
view_files = tree.views.lookup_view()
257
file_list = view_files
258
view_str = views.view_display_str(view_files)
259
note(gettext("Ignoring files outside view. View is %s"),
261
return tree, file_list
264
def _get_one_revision(command_name, revisions):
265
if revisions is None:
267
if len(revisions) != 1:
268
raise errors.BzrCommandError(gettext(
269
'brz %s --revision takes exactly one revision identifier') % (
274
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
275
"""Get a revision tree. Not suitable for commands that change the tree.
277
Specifically, the basis tree in dirstate trees is coupled to the dirstate
278
and doing a commit/uncommit/pull will at best fail due to changing the
281
If tree is passed in, it should be already locked, for lifetime management
282
of the trees internal cached state.
286
if revisions is None:
288
rev_tree = tree.basis_tree()
290
rev_tree = branch.basis_tree()
292
revision = _get_one_revision(command_name, revisions)
293
rev_tree = revision.as_tree(branch)
297
def _get_view_info_for_change_reporter(tree):
298
"""Get the view information from a tree for change reporting."""
301
current_view = tree.views.get_view_info()[0]
302
if current_view is not None:
303
view_info = (current_view, tree.views.lookup_view())
304
except views.ViewsNotSupported:
309
def _open_directory_or_containing_tree_or_branch(filename, directory):
310
"""Open the tree or branch containing the specified file, unless
311
the --directory option is used to specify a different branch."""
312
if directory is not None:
313
return (None, Branch.open(directory), filename)
314
return controldir.ControlDir.open_containing_tree_or_branch(filename)
317
# TODO: Make sure no commands unconditionally use the working directory as a
318
# branch. If a filename argument is used, the first of them should be used to
319
# specify the branch. (Perhaps this can be factored out into some kind of
320
# Argument class, representing a file in a branch, where the first occurrence
323
class cmd_status(Command):
324
__doc__ = """Display status summary.
326
This reports on versioned and unknown files, reporting them
327
grouped by state. Possible states are:
330
Versioned in the working copy but not in the previous revision.
333
Versioned in the previous revision but removed or deleted
337
Path of this file changed from the previous revision;
338
the text may also have changed. This includes files whose
339
parent directory was renamed.
342
Text has changed since the previous revision.
345
File kind has been changed (e.g. from file to directory).
348
Not versioned and not matching an ignore pattern.
350
Additionally for directories, symlinks and files with a changed
351
executable bit, Bazaar indicates their type using a trailing
352
character: '/', '@' or '*' respectively. These decorations can be
353
disabled using the '--no-classify' option.
355
To see ignored files use 'brz ignored'. For details on the
356
changes to file texts, use 'brz diff'.
358
Note that --short or -S gives status flags for each item, similar
359
to Subversion's status command. To get output similar to svn -q,
362
If no arguments are specified, the status of the entire working
363
directory is shown. Otherwise, only the status of the specified
364
files or directories is reported. If a directory is given, status
365
is reported for everything inside that directory.
367
Before merges are committed, the pending merge tip revisions are
368
shown. To see all pending merge revisions, use the -v option.
369
To skip the display of pending merge information altogether, use
370
the no-pending option or specify a file/directory.
372
To compare the working directory to a specific revision, pass a
373
single revision to the revision argument.
375
To see which files have changed in a specific revision, or between
376
two revisions, pass a revision range to the revision argument.
377
This will produce the same results as calling 'brz diff --summarize'.
380
# TODO: --no-recurse/-N, --recurse options
382
takes_args = ['file*']
383
takes_options = ['show-ids', 'revision', 'change', 'verbose',
384
Option('short', help='Use short status indicators.',
386
Option('versioned', help='Only show versioned files.',
388
Option('no-pending', help='Don\'t show pending merges.'),
389
Option('no-classify',
390
help='Do not mark object type using indicator.'),
392
aliases = ['st', 'stat']
394
encoding_type = 'replace'
395
_see_also = ['diff', 'revert', 'status-flags']
398
def run(self, show_ids=False, file_list=None, revision=None, short=False,
399
versioned=False, no_pending=False, verbose=False,
401
from .status import show_tree_status
403
if revision and len(revision) > 2:
404
raise errors.BzrCommandError(
405
gettext('brz status --revision takes exactly'
406
' one or two revision specifiers'))
408
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
409
# Avoid asking for specific files when that is not needed.
410
if relfile_list == ['']:
412
# Don't disable pending merges for full trees other than '.'.
413
if file_list == ['.']:
415
# A specific path within a tree was given.
416
elif relfile_list is not None:
418
show_tree_status(tree, show_ids=show_ids,
419
specific_files=relfile_list, revision=revision,
420
to_file=self.outf, short=short, versioned=versioned,
421
show_pending=(not no_pending), verbose=verbose,
422
classify=not no_classify)
425
class cmd_cat_revision(Command):
426
__doc__ = """Write out metadata for a revision.
428
The revision to print can either be specified by a specific
429
revision identifier, or you can use --revision.
433
takes_args = ['revision_id?']
434
takes_options = ['directory', 'revision']
435
# cat-revision is more for frontends so should be exact
438
def print_revision(self, revisions, revid):
439
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
440
record = next(stream)
441
if record.storage_kind == 'absent':
442
raise errors.NoSuchRevision(revisions, revid)
443
revtext = record.get_bytes_as('fulltext')
444
self.outf.write(revtext.decode('utf-8'))
447
def run(self, revision_id=None, revision=None, directory=u'.'):
448
if revision_id is not None and revision is not None:
449
raise errors.BzrCommandError(gettext('You can only supply one of'
450
' revision_id or --revision'))
451
if revision_id is None and revision is None:
452
raise errors.BzrCommandError(
453
gettext('You must supply either --revision or a revision_id'))
455
b = controldir.ControlDir.open_containing_tree_or_branch(directory)[1]
457
revisions = b.repository.revisions
458
if revisions is None:
459
raise errors.BzrCommandError(
460
gettext('Repository %r does not support '
461
'access to raw revision texts'))
463
with b.repository.lock_read():
464
# TODO: jam 20060112 should cat-revision always output utf-8?
465
if revision_id is not None:
466
revision_id = cache_utf8.encode(revision_id)
468
self.print_revision(revisions, revision_id)
469
except errors.NoSuchRevision:
471
"The repository {0} contains no revision {1}.").format(
472
b.repository.base, revision_id.decode('utf-8'))
473
raise errors.BzrCommandError(msg)
474
elif revision is not None:
477
raise errors.BzrCommandError(
478
gettext('You cannot specify a NULL revision.'))
479
rev_id = rev.as_revision_id(b)
480
self.print_revision(revisions, rev_id)
483
class cmd_remove_tree(Command):
484
__doc__ = """Remove the working tree from a given branch/checkout.
486
Since a lightweight checkout is little more than a working tree
487
this will refuse to run against one.
489
To re-create the working tree, use "brz checkout".
491
_see_also = ['checkout', 'working-trees']
492
takes_args = ['location*']
495
help='Remove the working tree even if it has '
496
'uncommitted or shelved changes.'),
499
def run(self, location_list, force=False):
500
if not location_list:
501
location_list = ['.']
503
for location in location_list:
504
d = controldir.ControlDir.open(location)
507
working = d.open_workingtree()
508
except errors.NoWorkingTree:
509
raise errors.BzrCommandError(
510
gettext("No working tree to remove"))
511
except errors.NotLocalUrl:
512
raise errors.BzrCommandError(
513
gettext("You cannot remove the working tree"
514
" of a remote path"))
516
if (working.has_changes()):
517
raise errors.UncommittedChanges(working)
518
if working.get_shelf_manager().last_shelf() is not None:
519
raise errors.ShelvedChanges(working)
521
if working.user_url != working.branch.user_url:
522
raise errors.BzrCommandError(
523
gettext("You cannot remove the working tree"
524
" from a lightweight checkout"))
526
d.destroy_workingtree()
529
class cmd_repair_workingtree(Command):
530
__doc__ = """Reset the working tree state file.
532
This is not meant to be used normally, but more as a way to recover from
533
filesystem corruption, etc. This rebuilds the working inventory back to a
534
'known good' state. Any new modifications (adding a file, renaming, etc)
535
will be lost, though modified files will still be detected as such.
537
Most users will want something more like "brz revert" or "brz update"
538
unless the state file has become corrupted.
540
By default this attempts to recover the current state by looking at the
541
headers of the state file. If the state file is too corrupted to even do
542
that, you can supply --revision to force the state of the tree.
546
'revision', 'directory',
548
help='Reset the tree even if it doesn\'t appear to be'
553
def run(self, revision=None, directory='.', force=False):
554
tree, _ = WorkingTree.open_containing(directory)
555
self.add_cleanup(tree.lock_tree_write().unlock)
559
except errors.BzrError:
560
pass # There seems to be a real error here, so we'll reset
563
raise errors.BzrCommandError(gettext(
564
'The tree does not appear to be corrupt. You probably'
565
' want "brz revert" instead. Use "--force" if you are'
566
' sure you want to reset the working tree.'))
570
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
572
tree.reset_state(revision_ids)
573
except errors.BzrError:
574
if revision_ids is None:
575
extra = gettext(', the header appears corrupt, try passing '
576
'-r -1 to set the state to the last commit')
579
raise errors.BzrCommandError(
580
gettext('failed to reset the tree state{0}').format(extra))
583
class cmd_revno(Command):
584
__doc__ = """Show current revision number.
586
This is equal to the number of revisions on this branch.
590
takes_args = ['location?']
592
Option('tree', help='Show revno of working tree.'),
597
def run(self, tree=False, location=u'.', revision=None):
598
if revision is not None and tree:
599
raise errors.BzrCommandError(
600
gettext("--tree and --revision can not be used together"))
604
wt = WorkingTree.open_containing(location)[0]
605
self.add_cleanup(wt.lock_read().unlock)
606
except (errors.NoWorkingTree, errors.NotLocalUrl):
607
raise errors.NoWorkingTree(location)
609
revid = wt.last_revision()
611
b = Branch.open_containing(location)[0]
612
self.add_cleanup(b.lock_read().unlock)
614
if len(revision) != 1:
615
raise errors.BzrCommandError(gettext(
616
"Revision numbers only make sense for single "
617
"revisions, not ranges"))
618
revid = revision[0].as_revision_id(b)
620
revid = b.last_revision()
622
revno_t = b.revision_id_to_dotted_revno(revid)
623
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
625
revno = ".".join(str(n) for n in revno_t)
627
self.outf.write(revno + '\n')
630
class cmd_revision_info(Command):
631
__doc__ = """Show revision number and revision id for a given revision identifier.
634
takes_args = ['revision_info*']
637
custom_help('directory', help='Branch to examine, '
638
'rather than the one containing the working directory.'),
639
Option('tree', help='Show revno of working tree.'),
643
def run(self, revision=None, directory=u'.', tree=False,
644
revision_info_list=[]):
647
wt = WorkingTree.open_containing(directory)[0]
649
self.add_cleanup(wt.lock_read().unlock)
650
except (errors.NoWorkingTree, errors.NotLocalUrl):
652
b = Branch.open_containing(directory)[0]
653
self.add_cleanup(b.lock_read().unlock)
655
if revision is not None:
656
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
657
if revision_info_list is not None:
658
for rev_str in revision_info_list:
659
rev_spec = RevisionSpec.from_string(rev_str)
660
revision_ids.append(rev_spec.as_revision_id(b))
661
# No arguments supplied, default to the last revision
662
if len(revision_ids) == 0:
665
raise errors.NoWorkingTree(directory)
666
revision_ids.append(wt.last_revision())
668
revision_ids.append(b.last_revision())
672
for revision_id in revision_ids:
674
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
675
revno = '.'.join(str(i) for i in dotted_revno)
676
except errors.NoSuchRevision:
678
maxlen = max(maxlen, len(revno))
679
revinfos.append((revno, revision_id))
682
for revno, revid in revinfos:
684
'%*s %s\n' % (maxlen, revno, revid.decode('utf-8')))
687
class cmd_add(Command):
688
__doc__ = """Add specified files or directories.
690
In non-recursive mode, all the named items are added, regardless
691
of whether they were previously ignored. A warning is given if
692
any of the named files are already versioned.
694
In recursive mode (the default), files are treated the same way
695
but the behaviour for directories is different. Directories that
696
are already versioned do not give a warning. All directories,
697
whether already versioned or not, are searched for files or
698
subdirectories that are neither versioned or ignored, and these
699
are added. This search proceeds recursively into versioned
700
directories. If no names are given '.' is assumed.
702
A warning will be printed when nested trees are encountered,
703
unless they are explicitly ignored.
705
Therefore simply saying 'brz add' will version all files that
706
are currently unknown.
708
Adding a file whose parent directory is not versioned will
709
implicitly add the parent, and so on up to the root. This means
710
you should never need to explicitly add a directory, they'll just
711
get added when you add a file in the directory.
713
--dry-run will show which files would be added, but not actually
716
--file-ids-from will try to use the file ids from the supplied path.
717
It looks up ids trying to find a matching parent directory with the
718
same filename, and then by pure path. This option is rarely needed
719
but can be useful when adding the same logical file into two
720
branches that will be merged later (without showing the two different
721
adds as a conflict). It is also useful when merging another project
722
into a subdirectory of this one.
724
Any files matching patterns in the ignore list will not be added
725
unless they are explicitly mentioned.
727
In recursive mode, files larger than the configuration option
728
add.maximum_file_size will be skipped. Named items are never skipped due
731
takes_args = ['file*']
734
help="Don't recursively add the contents of directories.",
737
help="Show what would be done, but don't actually do "
740
Option('file-ids-from',
742
help='Lookup file ids from this tree.'),
744
encoding_type = 'replace'
745
_see_also = ['remove', 'ignore']
747
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
752
if file_ids_from is not None:
754
base_tree, base_path = WorkingTree.open_containing(
756
except errors.NoWorkingTree:
757
base_branch, base_path = Branch.open_containing(
759
base_tree = base_branch.basis_tree()
761
action = breezy.add.AddFromBaseAction(
762
base_tree, base_path, to_file=self.outf,
763
should_print=(not is_quiet()))
765
action = breezy.add.AddWithSkipLargeAction(
766
to_file=self.outf, should_print=(not is_quiet()))
769
self.add_cleanup(base_tree.lock_read().unlock)
770
tree, file_list = tree_files_for_add(file_list)
771
added, ignored = tree.smart_add(
772
file_list, not no_recurse, action=action, save=not dry_run)
776
for glob in sorted(ignored):
777
for path in ignored[glob]:
779
gettext("ignored {0} matching \"{1}\"\n").format(
783
class cmd_mkdir(Command):
784
__doc__ = """Create a new versioned directory.
786
This is equivalent to creating the directory and then adding it.
789
takes_args = ['dir+']
793
help='No error if existing, make parent directories as needed.',
797
encoding_type = 'replace'
800
def add_file_with_parents(cls, wt, relpath):
801
if wt.is_versioned(relpath):
803
cls.add_file_with_parents(wt, osutils.dirname(relpath))
807
def add_file_single(cls, wt, relpath):
810
def run(self, dir_list, parents=False):
812
add_file = self.add_file_with_parents
814
add_file = self.add_file_single
816
wt, relpath = WorkingTree.open_containing(dir)
821
if e.errno != errno.EEXIST:
825
add_file(wt, relpath)
827
self.outf.write(gettext('added %s\n') % dir)
830
class cmd_relpath(Command):
831
__doc__ = """Show path of a file relative to root"""
833
takes_args = ['filename']
837
def run(self, filename):
838
# TODO: jam 20050106 Can relpath return a munged path if
839
# sys.stdout encoding cannot represent it?
840
tree, relpath = WorkingTree.open_containing(filename)
841
self.outf.write(relpath)
842
self.outf.write('\n')
845
class cmd_inventory(Command):
846
__doc__ = """Show inventory of the current working copy or a revision.
848
It is possible to limit the output to a particular entry
849
type using the --kind option. For example: --kind file.
851
It is also possible to restrict the list of files to a specific
852
set. For example: brz inventory --show-ids this/file
861
help='List entries of a particular kind: file, directory, '
865
takes_args = ['file*']
868
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
869
if kind and kind not in ['file', 'directory', 'symlink']:
870
raise errors.BzrCommandError(
871
gettext('invalid kind %r specified') % (kind,))
873
revision = _get_one_revision('inventory', revision)
874
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
875
self.add_cleanup(work_tree.lock_read().unlock)
876
if revision is not None:
877
tree = revision.as_tree(work_tree.branch)
879
extra_trees = [work_tree]
880
self.add_cleanup(tree.lock_read().unlock)
885
self.add_cleanup(tree.lock_read().unlock)
886
if file_list is not None:
887
paths = tree.find_related_paths_across_trees(
888
file_list, extra_trees, require_versioned=True)
889
# find_ids_across_trees may include some paths that don't
891
entries = tree.iter_entries_by_dir(specific_files=paths)
893
entries = tree.iter_entries_by_dir()
895
for path, entry in sorted(entries):
896
if kind and kind != entry.kind:
901
self.outf.write('%-50s %s\n' % (
902
path, entry.file_id.decode('utf-8')))
904
self.outf.write(path)
905
self.outf.write('\n')
908
class cmd_cp(Command):
909
__doc__ = """Copy a file.
912
brz cp OLDNAME NEWNAME
914
brz cp SOURCE... DESTINATION
916
If the last argument is a versioned directory, all the other names
917
are copied into it. Otherwise, there must be exactly two arguments
918
and the file is copied to a new name.
920
Files cannot be copied between branches. Only files can be copied
924
takes_args = ['names*']
927
encoding_type = 'replace'
929
def run(self, names_list):
930
if names_list is None:
932
if len(names_list) < 2:
933
raise errors.BzrCommandError(gettext("missing file argument"))
934
tree, rel_names = WorkingTree.open_containing_paths(
935
names_list, canonicalize=False)
936
for file_name in rel_names[0:-1]:
938
raise errors.BzrCommandError(
939
gettext("can not copy root of branch"))
940
self.add_cleanup(tree.lock_tree_write().unlock)
941
into_existing = osutils.isdir(names_list[-1])
942
if not into_existing:
944
(src, dst) = rel_names
946
raise errors.BzrCommandError(
947
gettext('to copy multiple files the'
948
' destination must be a versioned'
953
(n, osutils.joinpath([rel_names[-1], osutils.basename(n)]))
954
for n in rel_names[:-1]]
956
for src, dst in pairs:
958
src_kind = tree.stored_kind(src)
959
except errors.NoSuchFile:
960
raise errors.BzrCommandError(
961
gettext('Could not copy %s => %s: %s is not versioned.')
964
raise errors.BzrCommandError(
965
gettext('Could not copy %s => %s . %s is not versioned\\.'
967
if src_kind == 'directory':
968
raise errors.BzrCommandError(
969
gettext('Could not copy %s => %s . %s is a directory.'
971
dst_parent = osutils.split(dst)[0]
974
dst_parent_kind = tree.stored_kind(dst_parent)
975
except errors.NoSuchFile:
976
raise errors.BzrCommandError(
977
gettext('Could not copy %s => %s: %s is not versioned.')
978
% (src, dst, dst_parent))
979
if dst_parent_kind != 'directory':
980
raise errors.BzrCommandError(
981
gettext('Could not copy to %s: %s is not a directory.')
982
% (dst_parent, dst_parent))
984
tree.copy_one(src, dst)
987
class cmd_mv(Command):
988
__doc__ = """Move or rename a file.
991
brz mv OLDNAME NEWNAME
993
brz mv SOURCE... DESTINATION
995
If the last argument is a versioned directory, all the other names
996
are moved into it. Otherwise, there must be exactly two arguments
997
and the file is changed to a new name.
999
If OLDNAME does not exist on the filesystem but is versioned and
1000
NEWNAME does exist on the filesystem but is not versioned, mv
1001
assumes that the file has been manually moved and only updates
1002
its internal inventory to reflect that change.
1003
The same is valid when moving many SOURCE files to a DESTINATION.
1005
Files cannot be moved between branches.
1008
takes_args = ['names*']
1009
takes_options = [Option("after", help="Move only the brz identifier"
1010
" of the file, because the file has already been moved."),
1011
Option('auto', help='Automatically guess renames.'),
1013
'dry-run', help='Avoid making changes when guessing renames.'),
1015
aliases = ['move', 'rename']
1016
encoding_type = 'replace'
1018
def run(self, names_list, after=False, auto=False, dry_run=False):
1020
return self.run_auto(names_list, after, dry_run)
1022
raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
1023
if names_list is None:
1025
if len(names_list) < 2:
1026
raise errors.BzrCommandError(gettext("missing file argument"))
1027
tree, rel_names = WorkingTree.open_containing_paths(
1028
names_list, canonicalize=False)
1029
for file_name in rel_names[0:-1]:
1031
raise errors.BzrCommandError(
1032
gettext("can not move root of branch"))
1033
self.add_cleanup(tree.lock_tree_write().unlock)
1034
self._run(tree, names_list, rel_names, after)
1036
def run_auto(self, names_list, after, dry_run):
1037
if names_list is not None and len(names_list) > 1:
1038
raise errors.BzrCommandError(
1039
gettext('Only one path may be specified to --auto.'))
1041
raise errors.BzrCommandError(
1042
gettext('--after cannot be specified with --auto.'))
1043
work_tree, file_list = WorkingTree.open_containing_paths(
1044
names_list, default_directory='.')
1045
self.add_cleanup(work_tree.lock_tree_write().unlock)
1046
rename_map.RenameMap.guess_renames(
1047
work_tree.basis_tree(), work_tree, dry_run)
1049
def _run(self, tree, names_list, rel_names, after):
1050
into_existing = osutils.isdir(names_list[-1])
1051
if into_existing and len(names_list) == 2:
1053
# a. case-insensitive filesystem and change case of dir
1054
# b. move directory after the fact (if the source used to be
1055
# a directory, but now doesn't exist in the working tree
1056
# and the target is an existing directory, just rename it)
1057
if (not tree.case_sensitive
1058
and rel_names[0].lower() == rel_names[1].lower()):
1059
into_existing = False
1061
# 'fix' the case of a potential 'from'
1062
from_path = tree.get_canonical_path(rel_names[0])
1063
if (not osutils.lexists(names_list[0]) and
1064
tree.is_versioned(from_path) and
1065
tree.stored_kind(from_path) == "directory"):
1066
into_existing = False
1069
# move into existing directory
1070
# All entries reference existing inventory items, so fix them up
1071
# for cicp file-systems.
1072
rel_names = list(tree.get_canonical_paths(rel_names))
1073
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
1075
self.outf.write("%s => %s\n" % (src, dest))
1077
if len(names_list) != 2:
1078
raise errors.BzrCommandError(gettext('to mv multiple files the'
1079
' destination must be a versioned'
1082
# for cicp file-systems: the src references an existing inventory
1084
src = tree.get_canonical_path(rel_names[0])
1085
# Find the canonical version of the destination: In all cases, the
1086
# parent of the target must be in the inventory, so we fetch the
1087
# canonical version from there (we do not always *use* the
1088
# canonicalized tail portion - we may be attempting to rename the
1090
canon_dest = tree.get_canonical_path(rel_names[1])
1091
dest_parent = osutils.dirname(canon_dest)
1092
spec_tail = osutils.basename(rel_names[1])
1093
# For a CICP file-system, we need to avoid creating 2 inventory
1094
# entries that differ only by case. So regardless of the case
1095
# we *want* to use (ie, specified by the user or the file-system),
1096
# we must always choose to use the case of any existing inventory
1097
# items. The only exception to this is when we are attempting a
1098
# case-only rename (ie, canonical versions of src and dest are
1100
dest_id = tree.path2id(canon_dest)
1101
if dest_id is None or tree.path2id(src) == dest_id:
1102
# No existing item we care about, so work out what case we
1103
# are actually going to use.
1105
# If 'after' is specified, the tail must refer to a file on disk.
1107
dest_parent_fq = osutils.pathjoin(
1108
tree.basedir, dest_parent)
1110
# pathjoin with an empty tail adds a slash, which breaks
1112
dest_parent_fq = tree.basedir
1114
dest_tail = osutils.canonical_relpath(
1116
osutils.pathjoin(dest_parent_fq, spec_tail))
1118
# not 'after', so case as specified is used
1119
dest_tail = spec_tail
1121
# Use the existing item so 'mv' fails with AlreadyVersioned.
1122
dest_tail = os.path.basename(canon_dest)
1123
dest = osutils.pathjoin(dest_parent, dest_tail)
1124
mutter("attempting to move %s => %s", src, dest)
1125
tree.rename_one(src, dest, after=after)
1127
self.outf.write("%s => %s\n" % (src, dest))
1130
class cmd_pull(Command):
1131
__doc__ = """Turn this branch into a mirror of another branch.
1133
By default, this command only works on branches that have not diverged.
1134
Branches are considered diverged if the destination branch's most recent
1135
commit is one that has not been merged (directly or indirectly) into the
1138
If branches have diverged, you can use 'brz merge' to integrate the changes
1139
from one into the other. Once one branch has merged, the other should
1140
be able to pull it again.
1142
If you want to replace your local changes and just want your branch to
1143
match the remote one, use pull --overwrite. This will work even if the two
1144
branches have diverged.
1146
If there is no default location set, the first pull will set it (use
1147
--no-remember to avoid setting it). After that, you can omit the
1148
location to use the default. To change the default, use --remember. The
1149
value will only be saved if the remote location can be accessed.
1151
The --verbose option will display the revisions pulled using the log_format
1152
configuration option. You can use a different format by overriding it with
1153
-Olog_format=<other_format>.
1155
Note: The location can be specified either in the form of a branch,
1156
or in the form of a path to a file containing a merge directive generated
1160
_see_also = ['push', 'update', 'status-flags', 'send']
1161
takes_options = ['remember', 'overwrite', 'revision',
1162
custom_help('verbose',
1163
help='Show logs of pulled revisions.'),
1164
custom_help('directory',
1165
help='Branch to pull into, '
1166
'rather than the one containing the working directory.'),
1168
help="Perform a local pull in a bound "
1169
"branch. Local pulls are not applied to "
1170
"the master branch."
1173
help="Show base revision text in conflicts."),
1174
Option('overwrite-tags',
1175
help="Overwrite tags only."),
1177
takes_args = ['location?']
1178
encoding_type = 'replace'
1180
def run(self, location=None, remember=None, overwrite=False,
1181
revision=None, verbose=False,
1182
directory=None, local=False,
1183
show_base=False, overwrite_tags=False):
1186
overwrite = ["history", "tags"]
1187
elif overwrite_tags:
1188
overwrite = ["tags"]
1191
# FIXME: too much stuff is in the command class
1194
if directory is None:
1197
tree_to = WorkingTree.open_containing(directory)[0]
1198
branch_to = tree_to.branch
1199
self.add_cleanup(tree_to.lock_write().unlock)
1200
except errors.NoWorkingTree:
1202
branch_to = Branch.open_containing(directory)[0]
1203
self.add_cleanup(branch_to.lock_write().unlock)
1205
warning(gettext("No working tree, ignoring --show-base"))
1207
if local and not branch_to.get_bound_location():
1208
raise errors.LocalRequiresBoundBranch()
1210
possible_transports = []
1211
if location is not None:
1213
mergeable = bundle.read_mergeable_from_url(location,
1214
possible_transports=possible_transports)
1215
except errors.NotABundle:
1218
stored_loc = branch_to.get_parent()
1219
if location is None:
1220
if stored_loc is None:
1221
raise errors.BzrCommandError(gettext("No pull location known or"
1224
display_url = urlutils.unescape_for_display(stored_loc,
1228
gettext("Using saved parent location: %s\n") % display_url)
1229
location = stored_loc
1231
revision = _get_one_revision('pull', revision)
1232
if mergeable is not None:
1233
if revision is not None:
1234
raise errors.BzrCommandError(gettext(
1235
'Cannot use -r with merge directives or bundles'))
1236
mergeable.install_revisions(branch_to.repository)
1237
base_revision_id, revision_id, verified = \
1238
mergeable.get_merge_request(branch_to.repository)
1239
branch_from = branch_to
1241
branch_from = Branch.open(location,
1242
possible_transports=possible_transports)
1243
self.add_cleanup(branch_from.lock_read().unlock)
1244
# Remembers if asked explicitly or no previous location is set
1246
or (remember is None and branch_to.get_parent() is None)):
1247
# FIXME: This shouldn't be done before the pull
1248
# succeeds... -- vila 2012-01-02
1249
branch_to.set_parent(branch_from.base)
1251
if revision is not None:
1252
revision_id = revision.as_revision_id(branch_from)
1254
if tree_to is not None:
1255
view_info = _get_view_info_for_change_reporter(tree_to)
1256
change_reporter = delta._ChangeReporter(
1257
unversioned_filter=tree_to.is_ignored,
1258
view_info=view_info)
1259
result = tree_to.pull(
1260
branch_from, overwrite, revision_id, change_reporter,
1261
local=local, show_base=show_base)
1263
result = branch_to.pull(
1264
branch_from, overwrite, revision_id, local=local)
1266
result.report(self.outf)
1267
if verbose and result.old_revid != result.new_revid:
1268
log.show_branch_change(
1269
branch_to, self.outf, result.old_revno,
1271
if getattr(result, 'tag_conflicts', None):
1277
class cmd_push(Command):
1278
__doc__ = """Update a mirror of this branch.
1280
The target branch will not have its working tree populated because this
1281
is both expensive, and is not supported on remote file systems.
1283
Some smart servers or protocols *may* put the working tree in place in
1286
This command only works on branches that have not diverged. Branches are
1287
considered diverged if the destination branch's most recent commit is one
1288
that has not been merged (directly or indirectly) by the source branch.
1290
If branches have diverged, you can use 'brz push --overwrite' to replace
1291
the other branch completely, discarding its unmerged changes.
1293
If you want to ensure you have the different changes in the other branch,
1294
do a merge (see brz help merge) from the other branch, and commit that.
1295
After that you will be able to do a push without '--overwrite'.
1297
If there is no default push location set, the first push will set it (use
1298
--no-remember to avoid setting it). After that, you can omit the
1299
location to use the default. To change the default, use --remember. The
1300
value will only be saved if the remote location can be accessed.
1302
The --verbose option will display the revisions pushed using the log_format
1303
configuration option. You can use a different format by overriding it with
1304
-Olog_format=<other_format>.
1307
_see_also = ['pull', 'update', 'working-trees']
1308
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1309
Option('create-prefix',
1310
help='Create the path leading up to the branch '
1311
'if it does not already exist.'),
1312
custom_help('directory',
1313
help='Branch to push from, '
1314
'rather than the one containing the working directory.'),
1315
Option('use-existing-dir',
1316
help='By default push will fail if the target'
1317
' directory exists, but does not already'
1318
' have a control directory. This flag will'
1319
' allow push to proceed.'),
1321
help='Create a stacked branch that references the public location '
1322
'of the parent branch.'),
1323
Option('stacked-on',
1324
help='Create a stacked branch that refers to another branch '
1325
'for the commit history. Only the work not present in the '
1326
'referenced branch is included in the branch created.',
1329
help='Refuse to push if there are uncommitted changes in'
1330
' the working tree, --no-strict disables the check.'),
1332
help="Don't populate the working tree, even for protocols"
1333
" that support it."),
1334
Option('overwrite-tags',
1335
help="Overwrite tags only."),
1336
Option('lossy', help="Allow lossy push, i.e. dropping metadata "
1337
"that can't be represented in the target.")
1339
takes_args = ['location?']
1340
encoding_type = 'replace'
1342
def run(self, location=None, remember=None, overwrite=False,
1343
create_prefix=False, verbose=False, revision=None,
1344
use_existing_dir=False, directory=None, stacked_on=None,
1345
stacked=False, strict=None, no_tree=False,
1346
overwrite_tags=False, lossy=False):
1347
from .push import _show_push_branch
1350
overwrite = ["history", "tags"]
1351
elif overwrite_tags:
1352
overwrite = ["tags"]
1356
if directory is None:
1358
# Get the source branch
1360
_unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1361
# Get the tip's revision_id
1362
revision = _get_one_revision('push', revision)
1363
if revision is not None:
1364
revision_id = revision.in_history(br_from).rev_id
1367
if tree is not None and revision_id is None:
1368
tree.check_changed_or_out_of_date(
1369
strict, 'push_strict',
1370
more_error='Use --no-strict to force the push.',
1371
more_warning='Uncommitted changes will not be pushed.')
1372
# Get the stacked_on branch, if any
1373
if stacked_on is not None:
1374
stacked_on = urlutils.normalize_url(stacked_on)
1376
parent_url = br_from.get_parent()
1378
parent = Branch.open(parent_url)
1379
stacked_on = parent.get_public_branch()
1381
# I considered excluding non-http url's here, thus forcing
1382
# 'public' branches only, but that only works for some
1383
# users, so it's best to just depend on the user spotting an
1384
# error by the feedback given to them. RBC 20080227.
1385
stacked_on = parent_url
1387
raise errors.BzrCommandError(gettext(
1388
"Could not determine branch to refer to."))
1390
# Get the destination location
1391
if location is None:
1392
stored_loc = br_from.get_push_location()
1393
if stored_loc is None:
1394
parent_loc = br_from.get_parent()
1396
raise errors.BzrCommandError(gettext(
1397
"No push location known or specified. To push to the "
1398
"parent branch (at %s), use 'brz push :parent'." %
1399
urlutils.unescape_for_display(parent_loc,
1400
self.outf.encoding)))
1402
raise errors.BzrCommandError(gettext(
1403
"No push location known or specified."))
1405
display_url = urlutils.unescape_for_display(stored_loc,
1407
note(gettext("Using saved push location: %s") % display_url)
1408
location = stored_loc
1410
_show_push_branch(br_from, revision_id, location, self.outf,
1411
verbose=verbose, overwrite=overwrite, remember=remember,
1412
stacked_on=stacked_on, create_prefix=create_prefix,
1413
use_existing_dir=use_existing_dir, no_tree=no_tree,
1417
class cmd_branch(Command):
1418
__doc__ = """Create a new branch that is a copy of an existing branch.
1420
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1421
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1422
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1423
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1424
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1427
To retrieve the branch as of a particular revision, supply the --revision
1428
parameter, as in "branch foo/bar -r 5".
1431
_see_also = ['checkout']
1432
takes_args = ['from_location', 'to_location?']
1433
takes_options = ['revision',
1435
'hardlink', help='Hard-link working tree files where possible.'),
1436
Option('files-from', type=text_type,
1437
help="Get file contents from this tree."),
1439
help="Create a branch without a working-tree."),
1441
help="Switch the checkout in the current directory "
1442
"to the new branch."),
1444
help='Create a stacked branch referring to the source branch. '
1445
'The new branch will depend on the availability of the source '
1446
'branch for all operations.'),
1447
Option('standalone',
1448
help='Do not use a shared repository, even if available.'),
1449
Option('use-existing-dir',
1450
help='By default branch will fail if the target'
1451
' directory exists, but does not already'
1452
' have a control directory. This flag will'
1453
' allow branch to proceed.'),
1455
help="Bind new branch to from location."),
1458
def run(self, from_location, to_location=None, revision=None,
1459
hardlink=False, stacked=False, standalone=False, no_tree=False,
1460
use_existing_dir=False, switch=False, bind=False,
1462
from breezy import switch as _mod_switch
1463
accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1465
if not (hardlink or files_from):
1466
# accelerator_tree is usually slower because you have to read N
1467
# files (no readahead, lots of seeks, etc), but allow the user to
1468
# explicitly request it
1469
accelerator_tree = None
1470
if files_from is not None and files_from != from_location:
1471
accelerator_tree = WorkingTree.open(files_from)
1472
revision = _get_one_revision('branch', revision)
1473
self.add_cleanup(br_from.lock_read().unlock)
1474
if revision is not None:
1475
revision_id = revision.as_revision_id(br_from)
1477
# FIXME - wt.last_revision, fallback to branch, fall back to
1478
# None or perhaps NULL_REVISION to mean copy nothing
1480
revision_id = br_from.last_revision()
1481
if to_location is None:
1482
to_location = urlutils.derive_to_location(from_location)
1483
to_transport = transport.get_transport(to_location)
1485
to_transport.mkdir('.')
1486
except errors.FileExists:
1488
to_dir = controldir.ControlDir.open_from_transport(
1490
except errors.NotBranchError:
1491
if not use_existing_dir:
1492
raise errors.BzrCommandError(gettext('Target directory "%s" '
1493
'already exists.') % to_location)
1498
to_dir.open_branch()
1499
except errors.NotBranchError:
1502
raise errors.AlreadyBranchError(to_location)
1503
except errors.NoSuchFile:
1504
raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1510
# preserve whatever source format we have.
1511
to_dir = br_from.controldir.sprout(
1512
to_transport.base, revision_id,
1513
possible_transports=[to_transport],
1514
accelerator_tree=accelerator_tree, hardlink=hardlink,
1515
stacked=stacked, force_new_repo=standalone,
1516
create_tree_if_local=not no_tree, source_branch=br_from)
1517
branch = to_dir.open_branch(
1518
possible_transports=[
1519
br_from.controldir.root_transport, to_transport])
1520
except errors.NoSuchRevision:
1521
to_transport.delete_tree('.')
1522
msg = gettext("The branch {0} has no revision {1}.").format(
1523
from_location, revision)
1524
raise errors.BzrCommandError(msg)
1527
to_repo = to_dir.open_repository()
1528
except errors.NoRepositoryPresent:
1529
to_repo = to_dir.create_repository()
1530
to_repo.fetch(br_from.repository, revision_id=revision_id)
1531
branch = br_from.sprout(to_dir, revision_id=revision_id)
1532
br_from.tags.merge_to(branch.tags)
1534
# If the source branch is stacked, the new branch may
1535
# be stacked whether we asked for that explicitly or not.
1536
# We therefore need a try/except here and not just 'if stacked:'
1538
note(gettext('Created new stacked branch referring to %s.') %
1539
branch.get_stacked_on_url())
1540
except (errors.NotStacked, _mod_branch.UnstackableBranchFormat,
1541
errors.UnstackableRepositoryFormat) as e:
1542
revno = branch.revno()
1543
if revno is not None:
1544
note(ngettext('Branched %d revision.',
1545
'Branched %d revisions.',
1546
branch.revno()) % revno)
1548
note(gettext('Created new branch.'))
1550
# Bind to the parent
1551
parent_branch = Branch.open(from_location)
1552
branch.bind(parent_branch)
1553
note(gettext('New branch bound to %s') % from_location)
1555
# Switch to the new branch
1556
wt, _ = WorkingTree.open_containing('.')
1557
_mod_switch.switch(wt.controldir, branch)
1558
note(gettext('Switched to branch: %s'),
1559
urlutils.unescape_for_display(branch.base, 'utf-8'))
1562
class cmd_branches(Command):
1563
__doc__ = """List the branches available at the current location.
1565
This command will print the names of all the branches at the current
1569
takes_args = ['location?']
1571
Option('recursive', short_name='R',
1572
help='Recursively scan for branches rather than '
1573
'just looking in the specified location.')]
1575
def run(self, location=".", recursive=False):
1577
t = transport.get_transport(location)
1578
if not t.listable():
1579
raise errors.BzrCommandError(
1580
"Can't scan this type of location.")
1581
for b in controldir.ControlDir.find_branches(t):
1582
self.outf.write("%s\n" % urlutils.unescape_for_display(
1583
urlutils.relative_url(t.base, b.base),
1584
self.outf.encoding).rstrip("/"))
1586
dir = controldir.ControlDir.open_containing(location)[0]
1588
active_branch = dir.open_branch(name="")
1589
except errors.NotBranchError:
1590
active_branch = None
1592
for name, branch in iter_sibling_branches(dir):
1595
active = (active_branch is not None and
1596
active_branch.user_url == branch.user_url)
1597
names[name] = active
1598
# Only mention the current branch explicitly if it's not
1599
# one of the colocated branches
1600
if not any(viewvalues(names)) and active_branch is not None:
1601
self.outf.write("* %s\n" % gettext("(default)"))
1602
for name in sorted(names):
1603
active = names[name]
1608
self.outf.write("%s %s\n" % (
1609
prefix, (name if PY3 else name.encode(self.outf.encoding))))
1612
class cmd_checkout(Command):
1613
__doc__ = """Create a new checkout of an existing branch.
1615
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree
1616
for the branch found in '.'. This is useful if you have removed the working
1617
tree or if it was never created - i.e. if you pushed the branch to its
1618
current location using SFTP.
1620
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION
1621
will be used. In other words, "checkout ../foo/bar" will attempt to create
1622
./bar. If the BRANCH_LOCATION has no / or path separator embedded, the
1623
TO_LOCATION is derived from the BRANCH_LOCATION by stripping a leading
1624
scheme or drive identifier, if any. For example, "checkout lp:foo-bar" will
1625
attempt to create ./foo-bar.
1627
To retrieve the branch as of a particular revision, supply the --revision
1628
parameter, as in "checkout foo/bar -r 5". Note that this will be
1629
immediately out of date [so you cannot commit] but it may be useful (i.e.
1630
to examine old code.)
1633
_see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
1634
takes_args = ['branch_location?', 'to_location?']
1635
takes_options = ['revision',
1636
Option('lightweight',
1637
help="Perform a lightweight checkout. Lightweight "
1638
"checkouts depend on access to the branch for "
1639
"every operation. Normal checkouts can perform "
1640
"common operations like diff and status without "
1641
"such access, and also support local commits."
1643
Option('files-from', type=text_type,
1644
help="Get file contents from this tree."),
1646
help='Hard-link working tree files where possible.'
1651
def run(self, branch_location=None, to_location=None, revision=None,
1652
lightweight=False, files_from=None, hardlink=False):
1653
if branch_location is None:
1654
branch_location = osutils.getcwd()
1655
to_location = branch_location
1656
accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1658
if not (hardlink or files_from):
1659
# accelerator_tree is usually slower because you have to read N
1660
# files (no readahead, lots of seeks, etc), but allow the user to
1661
# explicitly request it
1662
accelerator_tree = None
1663
revision = _get_one_revision('checkout', revision)
1664
if files_from is not None and files_from != branch_location:
1665
accelerator_tree = WorkingTree.open(files_from)
1666
if revision is not None:
1667
revision_id = revision.as_revision_id(source)
1670
if to_location is None:
1671
to_location = urlutils.derive_to_location(branch_location)
1672
# if the source and to_location are the same,
1673
# and there is no working tree,
1674
# then reconstitute a branch
1675
if osutils.abspath(to_location) == osutils.abspath(branch_location):
1677
source.controldir.open_workingtree()
1678
except errors.NoWorkingTree:
1679
source.controldir.create_workingtree(revision_id)
1681
source.create_checkout(to_location, revision_id, lightweight,
1682
accelerator_tree, hardlink)
1685
class cmd_renames(Command):
1686
__doc__ = """Show list of renamed files.
1688
# TODO: Option to show renames between two historical versions.
1690
# TODO: Only show renames under dir, rather than in the whole branch.
1691
_see_also = ['status']
1692
takes_args = ['dir?']
1695
def run(self, dir=u'.'):
1696
tree = WorkingTree.open_containing(dir)[0]
1697
self.add_cleanup(tree.lock_read().unlock)
1698
old_tree = tree.basis_tree()
1699
self.add_cleanup(old_tree.lock_read().unlock)
1701
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1702
for f, paths, c, v, p, n, k, e in iterator:
1703
if paths[0] == paths[1]:
1707
renames.append(paths)
1709
for old_name, new_name in renames:
1710
self.outf.write("%s => %s\n" % (old_name, new_name))
1713
class cmd_update(Command):
1714
__doc__ = """Update a working tree to a new revision.
1716
This will perform a merge of the destination revision (the tip of the
1717
branch, or the specified revision) into the working tree, and then make
1718
that revision the basis revision for the working tree.
1720
You can use this to visit an older revision, or to update a working tree
1721
that is out of date from its branch.
1723
If there are any uncommitted changes in the tree, they will be carried
1724
across and remain as uncommitted changes after the update. To discard
1725
these changes, use 'brz revert'. The uncommitted changes may conflict
1726
with the changes brought in by the change in basis revision.
1728
If the tree's branch is bound to a master branch, brz will also update
1729
the branch from the master.
1731
You cannot update just a single file or directory, because each Bazaar
1732
working tree has just a single basis revision. If you want to restore a
1733
file that has been removed locally, use 'brz revert' instead of 'brz
1734
update'. If you want to restore a file to its state in a previous
1735
revision, use 'brz revert' with a '-r' option, or use 'brz cat' to write
1736
out the old content of that file to a new location.
1738
The 'dir' argument, if given, must be the location of the root of a
1739
working tree to update. By default, the working tree that contains the
1740
current working directory is used.
1743
_see_also = ['pull', 'working-trees', 'status-flags']
1744
takes_args = ['dir?']
1745
takes_options = ['revision',
1747
help="Show base revision text in conflicts."),
1751
def run(self, dir=None, revision=None, show_base=None):
1752
if revision is not None and len(revision) != 1:
1753
raise errors.BzrCommandError(gettext(
1754
"brz update --revision takes exactly one revision"))
1756
tree = WorkingTree.open_containing('.')[0]
1758
tree, relpath = WorkingTree.open_containing(dir)
1761
raise errors.BzrCommandError(gettext(
1762
"brz update can only update a whole tree, "
1763
"not a file or subdirectory"))
1764
branch = tree.branch
1765
possible_transports = []
1766
master = branch.get_master_branch(
1767
possible_transports=possible_transports)
1768
if master is not None:
1769
branch_location = master.base
1772
branch_location = tree.branch.base
1773
tree.lock_tree_write()
1774
self.add_cleanup(tree.unlock)
1775
# get rid of the final '/' and be ready for display
1776
branch_location = urlutils.unescape_for_display(
1777
branch_location.rstrip('/'),
1779
existing_pending_merges = tree.get_parent_ids()[1:]
1783
# may need to fetch data into a heavyweight checkout
1784
# XXX: this may take some time, maybe we should display a
1786
old_tip = branch.update(possible_transports)
1787
if revision is not None:
1788
revision_id = revision[0].as_revision_id(branch)
1790
revision_id = branch.last_revision()
1791
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1792
revno = branch.revision_id_to_dotted_revno(revision_id)
1793
note(gettext("Tree is up to date at revision {0} of branch {1}"
1794
).format('.'.join(map(str, revno)), branch_location))
1796
view_info = _get_view_info_for_change_reporter(tree)
1797
change_reporter = delta._ChangeReporter(
1798
unversioned_filter=tree.is_ignored,
1799
view_info=view_info)
1801
conflicts = tree.update(
1803
possible_transports=possible_transports,
1804
revision=revision_id,
1806
show_base=show_base)
1807
except errors.NoSuchRevision as e:
1808
raise errors.BzrCommandError(gettext(
1809
"branch has no revision %s\n"
1810
"brz update --revision only works"
1811
" for a revision in the branch history")
1813
revno = tree.branch.revision_id_to_dotted_revno(
1814
_mod_revision.ensure_null(tree.last_revision()))
1815
note(gettext('Updated to revision {0} of branch {1}').format(
1816
'.'.join(map(str, revno)), branch_location))
1817
parent_ids = tree.get_parent_ids()
1818
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1819
note(gettext('Your local commits will now show as pending merges with '
1820
"'brz status', and can be committed with 'brz commit'."))
1827
class cmd_info(Command):
1828
__doc__ = """Show information about a working tree, branch or repository.
1830
This command will show all known locations and formats associated to the
1831
tree, branch or repository.
1833
In verbose mode, statistical information is included with each report.
1834
To see extended statistic information, use a verbosity level of 2 or
1835
higher by specifying the verbose option multiple times, e.g. -vv.
1837
Branches and working trees will also report any missing revisions.
1841
Display information on the format and related locations:
1845
Display the above together with extended format information and
1846
basic statistics (like the number of files in the working tree and
1847
number of revisions in the branch and repository):
1851
Display the above together with number of committers to the branch:
1855
_see_also = ['revno', 'working-trees', 'repositories']
1856
takes_args = ['location?']
1857
takes_options = ['verbose']
1858
encoding_type = 'replace'
1861
def run(self, location=None, verbose=False):
1863
noise_level = get_verbosity_level()
1866
from .info import show_bzrdir_info
1867
show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1868
verbose=noise_level, outfile=self.outf)
1871
class cmd_remove(Command):
1872
__doc__ = """Remove files or directories.
1874
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1875
delete them if they can easily be recovered using revert otherwise they
1876
will be backed up (adding an extension of the form .~#~). If no options or
1877
parameters are given Bazaar will scan for files that are being tracked by
1878
Bazaar but missing in your tree and stop tracking them for you.
1880
takes_args = ['file*']
1881
takes_options = ['verbose',
1883
'new', help='Only remove files that have never been committed.'),
1884
RegistryOption.from_kwargs('file-deletion-strategy',
1885
'The file deletion mode to be used.',
1886
title='Deletion Strategy', value_switches=True, enum_switch=False,
1887
safe='Backup changed files (default).',
1888
keep='Delete from brz but leave the working copy.',
1889
no_backup='Don\'t backup changed files.'),
1891
aliases = ['rm', 'del']
1892
encoding_type = 'replace'
1894
def run(self, file_list, verbose=False, new=False,
1895
file_deletion_strategy='safe'):
1897
tree, file_list = WorkingTree.open_containing_paths(file_list)
1899
if file_list is not None:
1900
file_list = [f for f in file_list]
1902
self.add_cleanup(tree.lock_write().unlock)
1903
# Heuristics should probably all move into tree.remove_smart or
1906
added = tree.changes_from(tree.basis_tree(),
1907
specific_files=file_list).added
1908
file_list = sorted([f[0] for f in added], reverse=True)
1909
if len(file_list) == 0:
1910
raise errors.BzrCommandError(gettext('No matching files.'))
1911
elif file_list is None:
1912
# missing files show up in iter_changes(basis) as
1913
# versioned-with-no-kind.
1915
for change in tree.iter_changes(tree.basis_tree()):
1916
# Find paths in the working tree that have no kind:
1917
if change[1][1] is not None and change[6][1] is None:
1918
missing.append(change[1][1])
1919
file_list = sorted(missing, reverse=True)
1920
file_deletion_strategy = 'keep'
1921
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1922
keep_files=file_deletion_strategy == 'keep',
1923
force=(file_deletion_strategy == 'no-backup'))
1926
class cmd_file_id(Command):
1927
__doc__ = """Print file_id of a particular file or directory.
1929
The file_id is assigned when the file is first added and remains the
1930
same through all revisions where the file exists, even when it is
1935
_see_also = ['inventory', 'ls']
1936
takes_args = ['filename']
1939
def run(self, filename):
1940
tree, relpath = WorkingTree.open_containing(filename)
1941
file_id = tree.path2id(relpath)
1943
raise errors.NotVersionedError(filename)
1945
self.outf.write(file_id.decode('utf-8') + '\n')
1948
class cmd_file_path(Command):
1949
__doc__ = """Print path of file_ids to a file or directory.
1951
This prints one line for each directory down to the target,
1952
starting at the branch root.
1956
takes_args = ['filename']
1959
def run(self, filename):
1960
tree, relpath = WorkingTree.open_containing(filename)
1961
fid = tree.path2id(relpath)
1963
raise errors.NotVersionedError(filename)
1964
segments = osutils.splitpath(relpath)
1965
for pos in range(1, len(segments) + 1):
1966
path = osutils.joinpath(segments[:pos])
1967
self.outf.write("%s\n" % tree.path2id(path))
1970
class cmd_reconcile(Command):
1971
__doc__ = """Reconcile brz metadata in a branch.
1973
This can correct data mismatches that may have been caused by
1974
previous ghost operations or brz upgrades. You should only
1975
need to run this command if 'brz check' or a brz developer
1976
advises you to run it.
1978
If a second branch is provided, cross-branch reconciliation is
1979
also attempted, which will check that data like the tree root
1980
id which was not present in very early brz versions is represented
1981
correctly in both branches.
1983
At the same time it is run it may recompress data resulting in
1984
a potential saving in disk space or performance gain.
1986
The branch *MUST* be on a listable system such as local disk or sftp.
1989
_see_also = ['check']
1990
takes_args = ['branch?']
1992
Option('canonicalize-chks',
1993
help='Make sure CHKs are in canonical form (repairs '
1998
def run(self, branch=".", canonicalize_chks=False):
1999
from .reconcile import reconcile
2000
dir = controldir.ControlDir.open(branch)
2001
reconcile(dir, canonicalize_chks=canonicalize_chks)
2004
class cmd_revision_history(Command):
2005
__doc__ = """Display the list of revision ids on a branch."""
2008
takes_args = ['location?']
2013
def run(self, location="."):
2014
branch = Branch.open_containing(location)[0]
2015
self.add_cleanup(branch.lock_read().unlock)
2016
graph = branch.repository.get_graph()
2017
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
2018
[_mod_revision.NULL_REVISION]))
2019
for revid in reversed(history):
2020
self.outf.write(revid)
2021
self.outf.write('\n')
2024
class cmd_ancestry(Command):
2025
__doc__ = """List all revisions merged into this branch."""
2027
_see_also = ['log', 'revision-history']
2028
takes_args = ['location?']
2033
def run(self, location="."):
2035
wt = WorkingTree.open_containing(location)[0]
2036
except errors.NoWorkingTree:
2037
b = Branch.open(location)
2038
last_revision = b.last_revision()
2041
last_revision = wt.last_revision()
2043
self.add_cleanup(b.repository.lock_read().unlock)
2044
graph = b.repository.get_graph()
2045
revisions = [revid for revid, parents in
2046
graph.iter_ancestry([last_revision])]
2047
for revision_id in reversed(revisions):
2048
if _mod_revision.is_null(revision_id):
2050
self.outf.write(revision_id.decode('utf-8') + '\n')
2053
class cmd_init(Command):
2054
__doc__ = """Make a directory into a versioned branch.
2056
Use this to create an empty branch, or before importing an
2059
If there is a repository in a parent directory of the location, then
2060
the history of the branch will be stored in the repository. Otherwise
2061
init creates a standalone branch which carries its own history
2062
in the .bzr directory.
2064
If there is already a branch at the location but it has no working tree,
2065
the tree can be populated with 'brz checkout'.
2067
Recipe for importing a tree of files::
2073
brz commit -m "imported project"
2076
_see_also = ['init-repository', 'branch', 'checkout']
2077
takes_args = ['location?']
2079
Option('create-prefix',
2080
help='Create the path leading up to the branch '
2081
'if it does not already exist.'),
2082
RegistryOption('format',
2083
help='Specify a format for this branch. '
2084
'See "help formats" for a full list.',
2085
lazy_registry=('breezy.controldir', 'format_registry'),
2086
converter=lambda name: controldir.format_registry.make_controldir(
2088
value_switches=True,
2089
title="Branch format",
2091
Option('append-revisions-only',
2092
help='Never change revnos or the existing log.'
2093
' Append revisions to it only.'),
2095
'Create a branch without a working tree.')
2098
def run(self, location=None, format=None, append_revisions_only=False,
2099
create_prefix=False, no_tree=False):
2101
format = controldir.format_registry.make_controldir('default')
2102
if location is None:
2105
to_transport = transport.get_transport(location)
2107
# The path has to exist to initialize a
2108
# branch inside of it.
2109
# Just using os.mkdir, since I don't
2110
# believe that we want to create a bunch of
2111
# locations if the user supplies an extended path
2113
to_transport.ensure_base()
2114
except errors.NoSuchFile:
2115
if not create_prefix:
2116
raise errors.BzrCommandError(gettext("Parent directory of %s"
2118
"\nYou may supply --create-prefix to create all"
2119
" leading parent directories.")
2121
to_transport.create_prefix()
2124
a_controldir = controldir.ControlDir.open_from_transport(
2126
except errors.NotBranchError:
2127
# really a NotBzrDir error...
2128
create_branch = controldir.ControlDir.create_branch_convenience
2130
force_new_tree = False
2132
force_new_tree = None
2133
branch = create_branch(to_transport.base, format=format,
2134
possible_transports=[to_transport],
2135
force_new_tree=force_new_tree)
2136
a_controldir = branch.controldir
2138
from .transport.local import LocalTransport
2139
if a_controldir.has_branch():
2140
if (isinstance(to_transport, LocalTransport)
2141
and not a_controldir.has_workingtree()):
2142
raise errors.BranchExistsWithoutWorkingTree(location)
2143
raise errors.AlreadyBranchError(location)
2144
branch = a_controldir.create_branch()
2145
if not no_tree and not a_controldir.has_workingtree():
2146
a_controldir.create_workingtree()
2147
if append_revisions_only:
2149
branch.set_append_revisions_only(True)
2150
except errors.UpgradeRequired:
2151
raise errors.BzrCommandError(gettext('This branch format cannot be set'
2152
' to append-revisions-only. Try --default.'))
2154
from .info import describe_layout, describe_format
2156
tree = a_controldir.open_workingtree(recommend_upgrade=False)
2157
except (errors.NoWorkingTree, errors.NotLocalUrl):
2159
repository = branch.repository
2160
layout = describe_layout(repository, branch, tree).lower()
2161
format = describe_format(a_controldir, repository, branch, tree)
2162
self.outf.write(gettext("Created a {0} (format: {1})\n").format(
2164
if repository.is_shared():
2165
# XXX: maybe this can be refactored into transport.path_or_url()
2166
url = repository.controldir.root_transport.external_url()
2168
url = urlutils.local_path_from_url(url)
2169
except urlutils.InvalidURL:
2171
self.outf.write(gettext("Using shared repository: %s\n") % url)
2174
class cmd_init_repository(Command):
2175
__doc__ = """Create a shared repository for branches to share storage space.
2177
New branches created under the repository directory will store their
2178
revisions in the repository, not in the branch directory. For branches
2179
with shared history, this reduces the amount of storage needed and
2180
speeds up the creation of new branches.
2182
If the --no-trees option is given then the branches in the repository
2183
will not have working trees by default. They will still exist as
2184
directories on disk, but they will not have separate copies of the
2185
files at a certain revision. This can be useful for repositories that
2186
store branches which are interacted with through checkouts or remote
2187
branches, such as on a server.
2190
Create a shared repository holding just branches::
2192
brz init-repo --no-trees repo
2195
Make a lightweight checkout elsewhere::
2197
brz checkout --lightweight repo/trunk trunk-checkout
2202
_see_also = ['init', 'branch', 'checkout', 'repositories']
2203
takes_args = ["location"]
2204
takes_options = [RegistryOption('format',
2205
help='Specify a format for this repository. See'
2206
' "brz help formats" for details.',
2208
'breezy.controldir', 'format_registry'),
2209
converter=lambda name: controldir.format_registry.make_controldir(
2211
value_switches=True, title='Repository format'),
2213
help='Branches in the repository will default to'
2214
' not having a working tree.'),
2216
aliases = ["init-repo"]
2218
def run(self, location, format=None, no_trees=False):
2220
format = controldir.format_registry.make_controldir('default')
2222
if location is None:
2225
to_transport = transport.get_transport(location)
2227
if format.fixed_components:
2228
repo_format_name = None
2230
repo_format_name = format.repository_format.get_format_string()
2232
(repo, newdir, require_stacking, repository_policy) = (
2233
format.initialize_on_transport_ex(to_transport,
2234
create_prefix=True, make_working_trees=not no_trees,
2235
shared_repo=True, force_new_repo=True,
2236
use_existing_dir=True,
2237
repo_format_name=repo_format_name))
2239
from .info import show_bzrdir_info
2240
show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
2243
class cmd_diff(Command):
2244
__doc__ = """Show differences in the working tree, between revisions or branches.
2246
If no arguments are given, all changes for the current tree are listed.
2247
If files are given, only the changes in those files are listed.
2248
Remote and multiple branches can be compared by using the --old and
2249
--new options. If not provided, the default for both is derived from
2250
the first argument, if any, or the current tree if no arguments are
2253
"brz diff -p1" is equivalent to "brz diff --prefix old/:new/", and
2254
produces patches suitable for "patch -p1".
2256
Note that when using the -r argument with a range of revisions, the
2257
differences are computed between the two specified revisions. That
2258
is, the command does not show the changes introduced by the first
2259
revision in the range. This differs from the interpretation of
2260
revision ranges used by "brz log" which includes the first revision
2265
2 - unrepresentable changes
2270
Shows the difference in the working tree versus the last commit::
2274
Difference between the working tree and revision 1::
2278
Difference between revision 3 and revision 1::
2282
Difference between revision 3 and revision 1 for branch xxx::
2286
The changes introduced by revision 2 (equivalent to -r1..2)::
2290
To see the changes introduced by revision X::
2294
Note that in the case of a merge, the -c option shows the changes
2295
compared to the left hand parent. To see the changes against
2296
another parent, use::
2298
brz diff -r<chosen_parent>..X
2300
The changes between the current revision and the previous revision
2301
(equivalent to -c-1 and -r-2..-1)
2305
Show just the differences for file NEWS::
2309
Show the differences in working tree xxx for file NEWS::
2313
Show the differences from branch xxx to this working tree:
2317
Show the differences between two branches for file NEWS::
2319
brz diff --old xxx --new yyy NEWS
2321
Same as 'brz diff' but prefix paths with old/ and new/::
2323
brz diff --prefix old/:new/
2325
Show the differences using a custom diff program with options::
2327
brz diff --using /usr/bin/diff --diff-options -wu
2329
_see_also = ['status']
2330
takes_args = ['file*']
2332
Option('diff-options', type=text_type,
2333
help='Pass these options to the external diff program.'),
2334
Option('prefix', type=text_type,
2336
help='Set prefixes added to old and new filenames, as '
2337
'two values separated by a colon. (eg "old/:new/").'),
2339
help='Branch/tree to compare from.',
2343
help='Branch/tree to compare to.',
2349
help='Use this command to compare files.',
2352
RegistryOption('format',
2354
help='Diff format to use.',
2355
lazy_registry=('breezy.diff', 'format_registry'),
2356
title='Diff format'),
2358
help='How many lines of context to show.',
2362
aliases = ['di', 'dif']
2363
encoding_type = 'exact'
2366
def run(self, revision=None, file_list=None, diff_options=None,
2367
prefix=None, old=None, new=None, using=None, format=None,
2369
from .diff import (get_trees_and_branches_to_diff_locked,
2376
elif prefix == u'1' or prefix is None:
2379
elif u':' in prefix:
2380
old_label, new_label = prefix.split(u":")
2382
raise errors.BzrCommandError(gettext(
2383
'--prefix expects two values separated by a colon'
2384
' (eg "old/:new/")'))
2386
if revision and len(revision) > 2:
2387
raise errors.BzrCommandError(gettext('brz diff --revision takes exactly'
2388
' one or two revision specifiers'))
2390
if using is not None and format is not None:
2391
raise errors.BzrCommandError(gettext(
2392
'{0} and {1} are mutually exclusive').format(
2393
'--using', '--format'))
2395
(old_tree, new_tree,
2396
old_branch, new_branch,
2397
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2398
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2399
# GNU diff on Windows uses ANSI encoding for filenames
2400
path_encoding = osutils.get_diff_header_encoding()
2401
return show_diff_trees(old_tree, new_tree, self.outf,
2402
specific_files=specific_files,
2403
external_diff_options=diff_options,
2404
old_label=old_label, new_label=new_label,
2405
extra_trees=extra_trees,
2406
path_encoding=path_encoding,
2407
using=using, context=context,
2411
class cmd_deleted(Command):
2412
__doc__ = """List files deleted in the working tree.
2414
# TODO: Show files deleted since a previous revision, or
2415
# between two revisions.
2416
# TODO: Much more efficient way to do this: read in new
2417
# directories with readdir, rather than stating each one. Same
2418
# level of effort but possibly much less IO. (Or possibly not,
2419
# if the directories are very large...)
2420
_see_also = ['status', 'ls']
2421
takes_options = ['directory', 'show-ids']
2424
def run(self, show_ids=False, directory=u'.'):
2425
tree = WorkingTree.open_containing(directory)[0]
2426
self.add_cleanup(tree.lock_read().unlock)
2427
old = tree.basis_tree()
2428
self.add_cleanup(old.lock_read().unlock)
2429
for path, ie in old.iter_entries_by_dir():
2430
if not tree.has_id(ie.file_id):
2431
self.outf.write(path)
2433
self.outf.write(' ')
2434
self.outf.write(ie.file_id)
2435
self.outf.write('\n')
2438
class cmd_modified(Command):
2439
__doc__ = """List files modified in working tree.
2443
_see_also = ['status', 'ls']
2444
takes_options = ['directory', 'null']
2447
def run(self, null=False, directory=u'.'):
2448
tree = WorkingTree.open_containing(directory)[0]
2449
self.add_cleanup(tree.lock_read().unlock)
2450
td = tree.changes_from(tree.basis_tree())
2452
for path, id, kind, text_modified, meta_modified in td.modified:
2454
self.outf.write(path + '\0')
2456
self.outf.write(osutils.quotefn(path) + '\n')
2459
class cmd_added(Command):
2460
__doc__ = """List files added in working tree.
2464
_see_also = ['status', 'ls']
2465
takes_options = ['directory', 'null']
2468
def run(self, null=False, directory=u'.'):
2469
wt = WorkingTree.open_containing(directory)[0]
2470
self.add_cleanup(wt.lock_read().unlock)
2471
basis = wt.basis_tree()
2472
self.add_cleanup(basis.lock_read().unlock)
2473
for path in wt.all_versioned_paths():
2474
if basis.has_filename(path):
2478
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2481
self.outf.write(path + '\0')
2483
self.outf.write(osutils.quotefn(path) + '\n')
2486
class cmd_root(Command):
2487
__doc__ = """Show the tree root directory.
2489
The root is the nearest enclosing directory with a .bzr control
2492
takes_args = ['filename?']
2495
def run(self, filename=None):
2496
"""Print the branch root."""
2497
tree = WorkingTree.open_containing(filename)[0]
2498
self.outf.write(tree.basedir + '\n')
2501
def _parse_limit(limitstring):
2503
return int(limitstring)
2505
msg = gettext("The limit argument must be an integer.")
2506
raise errors.BzrCommandError(msg)
2509
def _parse_levels(s):
2513
msg = gettext("The levels argument must be an integer.")
2514
raise errors.BzrCommandError(msg)
2517
class cmd_log(Command):
2518
__doc__ = """Show historical log for a branch or subset of a branch.
2520
log is brz's default tool for exploring the history of a branch.
2521
The branch to use is taken from the first parameter. If no parameters
2522
are given, the branch containing the working directory is logged.
2523
Here are some simple examples::
2525
brz log log the current branch
2526
brz log foo.py log a file in its branch
2527
brz log http://server/branch log a branch on a server
2529
The filtering, ordering and information shown for each revision can
2530
be controlled as explained below. By default, all revisions are
2531
shown sorted (topologically) so that newer revisions appear before
2532
older ones and descendants always appear before ancestors. If displayed,
2533
merged revisions are shown indented under the revision in which they
2538
The log format controls how information about each revision is
2539
displayed. The standard log formats are called ``long``, ``short``
2540
and ``line``. The default is long. See ``brz help log-formats``
2541
for more details on log formats.
2543
The following options can be used to control what information is
2546
-l N display a maximum of N revisions
2547
-n N display N levels of revisions (0 for all, 1 for collapsed)
2548
-v display a status summary (delta) for each revision
2549
-p display a diff (patch) for each revision
2550
--show-ids display revision-ids (and file-ids), not just revnos
2552
Note that the default number of levels to display is a function of the
2553
log format. If the -n option is not used, the standard log formats show
2554
just the top level (mainline).
2556
Status summaries are shown using status flags like A, M, etc. To see
2557
the changes explained using words like ``added`` and ``modified``
2558
instead, use the -vv option.
2562
To display revisions from oldest to newest, use the --forward option.
2563
In most cases, using this option will have little impact on the total
2564
time taken to produce a log, though --forward does not incrementally
2565
display revisions like --reverse does when it can.
2567
:Revision filtering:
2569
The -r option can be used to specify what revision or range of revisions
2570
to filter against. The various forms are shown below::
2572
-rX display revision X
2573
-rX.. display revision X and later
2574
-r..Y display up to and including revision Y
2575
-rX..Y display from X to Y inclusive
2577
See ``brz help revisionspec`` for details on how to specify X and Y.
2578
Some common examples are given below::
2580
-r-1 show just the tip
2581
-r-10.. show the last 10 mainline revisions
2582
-rsubmit:.. show what's new on this branch
2583
-rancestor:path.. show changes since the common ancestor of this
2584
branch and the one at location path
2585
-rdate:yesterday.. show changes since yesterday
2587
When logging a range of revisions using -rX..Y, log starts at
2588
revision Y and searches back in history through the primary
2589
("left-hand") parents until it finds X. When logging just the
2590
top level (using -n1), an error is reported if X is not found
2591
along the way. If multi-level logging is used (-n0), X may be
2592
a nested merge revision and the log will be truncated accordingly.
2596
If parameters are given and the first one is not a branch, the log
2597
will be filtered to show only those revisions that changed the
2598
nominated files or directories.
2600
Filenames are interpreted within their historical context. To log a
2601
deleted file, specify a revision range so that the file existed at
2602
the end or start of the range.
2604
Historical context is also important when interpreting pathnames of
2605
renamed files/directories. Consider the following example:
2607
* revision 1: add tutorial.txt
2608
* revision 2: modify tutorial.txt
2609
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2613
* ``brz log guide.txt`` will log the file added in revision 1
2615
* ``brz log tutorial.txt`` will log the new file added in revision 3
2617
* ``brz log -r2 -p tutorial.txt`` will show the changes made to
2618
the original file in revision 2.
2620
* ``brz log -r2 -p guide.txt`` will display an error message as there
2621
was no file called guide.txt in revision 2.
2623
Renames are always followed by log. By design, there is no need to
2624
explicitly ask for this (and no way to stop logging a file back
2625
until it was last renamed).
2629
The --match option can be used for finding revisions that match a
2630
regular expression in a commit message, committer, author or bug.
2631
Specifying the option several times will match any of the supplied
2632
expressions. --match-author, --match-bugs, --match-committer and
2633
--match-message can be used to only match a specific field.
2637
GUI tools and IDEs are often better at exploring history than command
2638
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2639
bzr-explorer shell, or the Loggerhead web interface. See the Bazaar
2640
Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2641
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2643
You may find it useful to add the aliases below to ``breezy.conf``::
2647
top = log -l10 --line
2650
``brz tip`` will then show the latest revision while ``brz top``
2651
will show the last 10 mainline revisions. To see the details of a
2652
particular revision X, ``brz show -rX``.
2654
If you are interested in looking deeper into a particular merge X,
2655
use ``brz log -n0 -rX``.
2657
``brz log -v`` on a branch with lots of history is currently
2658
very slow. A fix for this issue is currently under development.
2659
With or without that fix, it is recommended that a revision range
2660
be given when using the -v option.
2662
brz has a generic full-text matching plugin, brz-search, that can be
2663
used to find revisions matching user names, commit messages, etc.
2664
Among other features, this plugin can find all revisions containing
2665
a list of words but not others.
2667
When exploring non-mainline history on large projects with deep
2668
history, the performance of log can be greatly improved by installing
2669
the historycache plugin. This plugin buffers historical information
2670
trading disk space for faster speed.
2672
takes_args = ['file*']
2673
_see_also = ['log-formats', 'revisionspec']
2676
help='Show from oldest to newest.'),
2678
custom_help('verbose',
2679
help='Show files changed in each revision.'),
2683
type=breezy.option._parse_revision_str,
2685
help='Show just the specified revision.'
2686
' See also "help revisionspec".'),
2688
RegistryOption('authors',
2689
'What names to list as authors - first, all or committer.',
2692
'breezy.log', 'author_list_registry'),
2696
help='Number of levels to display - 0 for all, 1 for flat.',
2698
type=_parse_levels),
2700
help='Show revisions whose message matches this '
2701
'regular expression.',
2706
help='Limit the output to the first N revisions.',
2711
help='Show changes made in each revision as a patch.'),
2712
Option('include-merged',
2713
help='Show merged revisions like --levels 0 does.'),
2714
Option('include-merges', hidden=True,
2715
help='Historical alias for --include-merged.'),
2716
Option('omit-merges',
2717
help='Do not report commits with more than one parent.'),
2718
Option('exclude-common-ancestry',
2719
help='Display only the revisions that are not part'
2720
' of both ancestries (require -rX..Y).'
2722
Option('signatures',
2723
help='Show digital signature validity.'),
2726
help='Show revisions whose properties match this '
2729
ListOption('match-message',
2730
help='Show revisions whose message matches this '
2733
ListOption('match-committer',
2734
help='Show revisions whose committer matches this '
2737
ListOption('match-author',
2738
help='Show revisions whose authors match this '
2741
ListOption('match-bugs',
2742
help='Show revisions whose bugs match this '
2746
encoding_type = 'replace'
2749
def run(self, file_list=None, timezone='original',
2760
include_merged=None,
2762
exclude_common_ancestry=False,
2766
match_committer=None,
2773
make_log_request_dict,
2774
_get_info_for_log_files,
2776
direction = (forward and 'forward') or 'reverse'
2777
if include_merged is None:
2778
include_merged = False
2779
if (exclude_common_ancestry
2780
and (revision is None or len(revision) != 2)):
2781
raise errors.BzrCommandError(gettext(
2782
'--exclude-common-ancestry requires -r with two revisions'))
2787
raise errors.BzrCommandError(gettext(
2788
'{0} and {1} are mutually exclusive').format(
2789
'--levels', '--include-merged'))
2791
if change is not None:
2793
raise errors.RangeInChangeOption()
2794
if revision is not None:
2795
raise errors.BzrCommandError(gettext(
2796
'{0} and {1} are mutually exclusive').format(
2797
'--revision', '--change'))
2802
filter_by_dir = False
2804
# find the file ids to log and check for directory filtering
2805
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2806
revision, file_list, self.add_cleanup)
2807
for relpath, file_id, kind in file_info_list:
2809
raise errors.BzrCommandError(gettext(
2810
"Path unknown at end or start of revision range: %s") %
2812
# If the relpath is the top of the tree, we log everything
2817
file_ids.append(file_id)
2818
filter_by_dir = filter_by_dir or (
2819
kind in ['directory', 'tree-reference'])
2822
# FIXME ? log the current subdir only RBC 20060203
2823
if revision is not None \
2824
and len(revision) > 0 and revision[0].get_branch():
2825
location = revision[0].get_branch()
2828
dir, relpath = controldir.ControlDir.open_containing(location)
2829
b = dir.open_branch()
2830
self.add_cleanup(b.lock_read().unlock)
2831
rev1, rev2 = _get_revision_range(revision, b, self.name())
2833
if b.get_config_stack().get('validate_signatures_in_log'):
2837
if not gpg.GPGStrategy.verify_signatures_available():
2838
raise errors.GpgmeNotInstalled(None)
2840
# Decide on the type of delta & diff filtering to use
2841
# TODO: add an --all-files option to make this configurable & consistent
2849
diff_type = 'partial'
2853
# Build the log formatter
2854
if log_format is None:
2855
log_format = log.log_formatter_registry.get_default(b)
2856
# Make a non-encoding output to include the diffs - bug 328007
2857
unencoded_output = ui.ui_factory.make_output_stream(
2858
encoding_type='exact')
2859
lf = log_format(show_ids=show_ids, to_file=self.outf,
2860
to_exact_file=unencoded_output,
2861
show_timezone=timezone,
2862
delta_format=get_verbosity_level(),
2864
show_advice=levels is None,
2865
author_list_handler=authors)
2867
# Choose the algorithm for doing the logging. It's annoying
2868
# having multiple code paths like this but necessary until
2869
# the underlying repository format is faster at generating
2870
# deltas or can provide everything we need from the indices.
2871
# The default algorithm - match-using-deltas - works for
2872
# multiple files and directories and is faster for small
2873
# amounts of history (200 revisions say). However, it's too
2874
# slow for logging a single file in a repository with deep
2875
# history, i.e. > 10K revisions. In the spirit of "do no
2876
# evil when adding features", we continue to use the
2877
# original algorithm - per-file-graph - for the "single
2878
# file that isn't a directory without showing a delta" case.
2879
partial_history = revision and b.repository._format.supports_chks
2880
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2881
or delta_type or partial_history)
2885
match_dict[''] = match
2887
match_dict['message'] = match_message
2889
match_dict['committer'] = match_committer
2891
match_dict['author'] = match_author
2893
match_dict['bugs'] = match_bugs
2895
# Build the LogRequest and execute it
2896
if len(file_ids) == 0:
2898
rqst = make_log_request_dict(
2899
direction=direction, specific_fileids=file_ids,
2900
start_revision=rev1, end_revision=rev2, limit=limit,
2901
message_search=message, delta_type=delta_type,
2902
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2903
exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2904
signature=signatures, omit_merges=omit_merges,
2906
Logger(b, rqst).show(lf)
2909
def _get_revision_range(revisionspec_list, branch, command_name):
2910
"""Take the input of a revision option and turn it into a revision range.
2912
It returns RevisionInfo objects which can be used to obtain the rev_id's
2913
of the desired revisions. It does some user input validations.
2915
if revisionspec_list is None:
2918
elif len(revisionspec_list) == 1:
2919
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2920
elif len(revisionspec_list) == 2:
2921
start_spec = revisionspec_list[0]
2922
end_spec = revisionspec_list[1]
2923
if end_spec.get_branch() != start_spec.get_branch():
2924
# b is taken from revision[0].get_branch(), and
2925
# show_log will use its revision_history. Having
2926
# different branches will lead to weird behaviors.
2927
raise errors.BzrCommandError(gettext(
2928
"brz %s doesn't accept two revisions in different"
2929
" branches.") % command_name)
2930
if start_spec.spec is None:
2931
# Avoid loading all the history.
2932
rev1 = RevisionInfo(branch, None, None)
2934
rev1 = start_spec.in_history(branch)
2935
# Avoid loading all of history when we know a missing
2936
# end of range means the last revision ...
2937
if end_spec.spec is None:
2938
last_revno, last_revision_id = branch.last_revision_info()
2939
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2941
rev2 = end_spec.in_history(branch)
2943
raise errors.BzrCommandError(gettext(
2944
'brz %s --revision takes one or two values.') % command_name)
2948
def _revision_range_to_revid_range(revision_range):
2951
if revision_range[0] is not None:
2952
rev_id1 = revision_range[0].rev_id
2953
if revision_range[1] is not None:
2954
rev_id2 = revision_range[1].rev_id
2955
return rev_id1, rev_id2
2958
def get_log_format(long=False, short=False, line=False, default='long'):
2959
log_format = default
2963
log_format = 'short'
2969
class cmd_touching_revisions(Command):
2970
__doc__ = """Return revision-ids which affected a particular file.
2972
A more user-friendly interface is "brz log FILE".
2976
takes_args = ["filename"]
2979
def run(self, filename):
2980
tree, relpath = WorkingTree.open_containing(filename)
2981
with tree.lock_read():
2982
touching_revs = log.find_touching_revisions(
2983
tree.branch.repository, tree.branch.last_revision(), tree, relpath)
2984
for revno, revision_id, what in reversed(list(touching_revs)):
2985
self.outf.write("%6d %s\n" % (revno, what))
2988
class cmd_ls(Command):
2989
__doc__ = """List files in a tree.
2992
_see_also = ['status', 'cat']
2993
takes_args = ['path?']
2997
Option('recursive', short_name='R',
2998
help='Recurse into subdirectories.'),
3000
help='Print paths relative to the root of the branch.'),
3001
Option('unknown', short_name='u',
3002
help='Print unknown files.'),
3003
Option('versioned', help='Print versioned files.',
3005
Option('ignored', short_name='i',
3006
help='Print ignored files.'),
3007
Option('kind', short_name='k',
3008
help=('List entries of a particular kind: file, '
3009
'directory, symlink, tree-reference.'),
3017
def run(self, revision=None, verbose=False,
3018
recursive=False, from_root=False,
3019
unknown=False, versioned=False, ignored=False,
3020
null=False, kind=None, show_ids=False, path=None, directory=None):
3022
if kind and kind not in ('file', 'directory', 'symlink', 'tree-reference'):
3023
raise errors.BzrCommandError(gettext('invalid kind specified'))
3025
if verbose and null:
3026
raise errors.BzrCommandError(
3027
gettext('Cannot set both --verbose and --null'))
3028
all = not (unknown or versioned or ignored)
3030
selection = {'I': ignored, '?': unknown, 'V': versioned}
3036
raise errors.BzrCommandError(gettext('cannot specify both --from-root'
3039
tree, branch, relpath = \
3040
_open_directory_or_containing_tree_or_branch(fs_path, directory)
3042
# Calculate the prefix to use
3046
prefix = relpath + '/'
3047
elif fs_path != '.' and not fs_path.endswith('/'):
3048
prefix = fs_path + '/'
3050
if revision is not None or tree is None:
3051
tree = _get_one_revision_tree('ls', revision, branch=branch)
3054
if isinstance(tree, WorkingTree) and tree.supports_views():
3055
view_files = tree.views.lookup_view()
3058
view_str = views.view_display_str(view_files)
3059
note(gettext("Ignoring files outside view. View is %s") % view_str)
3061
self.add_cleanup(tree.lock_read().unlock)
3062
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
3063
from_dir=relpath, recursive=recursive):
3064
# Apply additional masking
3065
if not all and not selection[fc]:
3067
if kind is not None and fkind != kind:
3072
fullpath = osutils.pathjoin(relpath, fp)
3075
views.check_path_in_view(tree, fullpath)
3076
except views.FileOutsideView:
3081
fp = osutils.pathjoin(prefix, fp)
3082
kindch = entry.kind_character()
3083
outstring = fp + kindch
3084
ui.ui_factory.clear_term()
3086
outstring = '%-8s %s' % (fc, outstring)
3087
if show_ids and fid is not None:
3088
outstring = "%-50s %s" % (outstring, fid.decode('utf-8'))
3089
self.outf.write(outstring + '\n')
3091
self.outf.write(fp + '\0')
3094
self.outf.write(fid.decode('utf-8'))
3095
self.outf.write('\0')
3100
my_id = fid.decode('utf-8')
3103
self.outf.write('%-50s %s\n' % (outstring, my_id))
3105
self.outf.write(outstring + '\n')
3108
class cmd_unknowns(Command):
3109
__doc__ = """List unknown files.
3114
takes_options = ['directory']
3117
def run(self, directory=u'.'):
3118
for f in WorkingTree.open_containing(directory)[0].unknowns():
3119
self.outf.write(osutils.quotefn(f) + '\n')
3122
class cmd_ignore(Command):
3123
__doc__ = """Ignore specified files or patterns.
3125
See ``brz help patterns`` for details on the syntax of patterns.
3127
If a .bzrignore file does not exist, the ignore command
3128
will create one and add the specified files or patterns to the newly
3129
created file. The ignore command will also automatically add the
3130
.bzrignore file to be versioned. Creating a .bzrignore file without
3131
the use of the ignore command will require an explicit add command.
3133
To remove patterns from the ignore list, edit the .bzrignore file.
3134
After adding, editing or deleting that file either indirectly by
3135
using this command or directly by using an editor, be sure to commit
3138
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
3139
the global ignore file can be found in the application data directory as
3140
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
3141
Global ignores are not touched by this command. The global ignore file
3142
can be edited directly using an editor.
3144
Patterns prefixed with '!' are exceptions to ignore patterns and take
3145
precedence over regular ignores. Such exceptions are used to specify
3146
files that should be versioned which would otherwise be ignored.
3148
Patterns prefixed with '!!' act as regular ignore patterns, but have
3149
precedence over the '!' exception patterns.
3153
* Ignore patterns containing shell wildcards must be quoted from
3156
* Ignore patterns starting with "#" act as comments in the ignore file.
3157
To ignore patterns that begin with that character, use the "RE:" prefix.
3160
Ignore the top level Makefile::
3162
brz ignore ./Makefile
3164
Ignore .class files in all directories...::
3166
brz ignore "*.class"
3168
...but do not ignore "special.class"::
3170
brz ignore "!special.class"
3172
Ignore files whose name begins with the "#" character::
3176
Ignore .o files under the lib directory::
3178
brz ignore "lib/**/*.o"
3180
Ignore .o files under the lib directory::
3182
brz ignore "RE:lib/.*\\.o"
3184
Ignore everything but the "debian" toplevel directory::
3186
brz ignore "RE:(?!debian/).*"
3188
Ignore everything except the "local" toplevel directory,
3189
but always ignore autosave files ending in ~, even under local/::
3192
brz ignore "!./local"
3196
_see_also = ['status', 'ignored', 'patterns']
3197
takes_args = ['name_pattern*']
3198
takes_options = ['directory',
3199
Option('default-rules',
3200
help='Display the default ignore rules that brz uses.')
3203
def run(self, name_pattern_list=None, default_rules=None,
3205
from breezy import ignores
3206
if default_rules is not None:
3207
# dump the default rules and exit
3208
for pattern in ignores.USER_DEFAULTS:
3209
self.outf.write("%s\n" % pattern)
3211
if not name_pattern_list:
3212
raise errors.BzrCommandError(gettext("ignore requires at least one "
3213
"NAME_PATTERN or --default-rules."))
3214
name_pattern_list = [globbing.normalize_pattern(p)
3215
for p in name_pattern_list]
3217
bad_patterns_count = 0
3218
for p in name_pattern_list:
3219
if not globbing.Globster.is_pattern_valid(p):
3220
bad_patterns_count += 1
3221
bad_patterns += ('\n %s' % p)
3223
msg = (ngettext('Invalid ignore pattern found. %s',
3224
'Invalid ignore patterns found. %s',
3225
bad_patterns_count) % bad_patterns)
3226
ui.ui_factory.show_error(msg)
3227
raise lazy_regex.InvalidPattern('')
3228
for name_pattern in name_pattern_list:
3229
if (name_pattern[0] == '/' or
3230
(len(name_pattern) > 1 and name_pattern[1] == ':')):
3231
raise errors.BzrCommandError(gettext(
3232
"NAME_PATTERN should not be an absolute path"))
3233
tree, relpath = WorkingTree.open_containing(directory)
3234
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
3235
ignored = globbing.Globster(name_pattern_list)
3237
self.add_cleanup(tree.lock_read().unlock)
3238
for entry in tree.list_files():
3242
if ignored.match(filename):
3243
matches.append(filename)
3244
if len(matches) > 0:
3245
self.outf.write(gettext("Warning: the following files are version "
3246
"controlled and match your ignore pattern:\n%s"
3247
"\nThese files will continue to be version controlled"
3248
" unless you 'brz remove' them.\n") % ("\n".join(matches),))
3251
class cmd_ignored(Command):
3252
__doc__ = """List ignored files and the patterns that matched them.
3254
List all the ignored files and the ignore pattern that caused the file to
3257
Alternatively, to list just the files::
3262
encoding_type = 'replace'
3263
_see_also = ['ignore', 'ls']
3264
takes_options = ['directory']
3267
def run(self, directory=u'.'):
3268
tree = WorkingTree.open_containing(directory)[0]
3269
self.add_cleanup(tree.lock_read().unlock)
3270
for path, file_class, kind, file_id, entry in tree.list_files():
3271
if file_class != 'I':
3273
# XXX: Slightly inefficient since this was already calculated
3274
pat = tree.is_ignored(path)
3275
self.outf.write('%-50s %s\n' % (path, pat))
3278
class cmd_lookup_revision(Command):
3279
__doc__ = """Lookup the revision-id from a revision-number
3282
brz lookup-revision 33
3285
takes_args = ['revno']
3286
takes_options = ['directory']
3289
def run(self, revno, directory=u'.'):
3293
raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3295
revid = WorkingTree.open_containing(
3296
directory)[0].branch.get_rev_id(revno)
3297
self.outf.write("%s\n" % revid.decode('utf-8'))
3300
class cmd_export(Command):
3301
__doc__ = """Export current or past revision to a destination directory or archive.
3303
If no revision is specified this exports the last committed revision.
3305
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
3306
given, try to find the format with the extension. If no extension
3307
is found exports to a directory (equivalent to --format=dir).
3309
If root is supplied, it will be used as the root directory inside
3310
container formats (tar, zip, etc). If it is not supplied it will default
3311
to the exported filename. The root option has no effect for 'dir' format.
3313
If branch is omitted then the branch containing the current working
3314
directory will be used.
3316
Note: Export of tree with non-ASCII filenames to zip is not supported.
3318
================= =========================
3319
Supported formats Autodetected by extension
3320
================= =========================
3323
tbz2 .tar.bz2, .tbz2
3326
================= =========================
3329
encoding_type = 'exact'
3330
takes_args = ['dest', 'branch_or_subdir?']
3331
takes_options = ['directory',
3333
help="Type of file to export to.",
3336
Option('filters', help='Apply content filters to export the '
3337
'convenient form.'),
3340
help="Name of the root directory inside the exported file."),
3341
Option('per-file-timestamps',
3342
help='Set modification time of files to that of the last '
3343
'revision in which it was changed.'),
3344
Option('uncommitted',
3345
help='Export the working tree contents rather than that of the '
3349
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3350
root=None, filters=False, per_file_timestamps=False, uncommitted=False,
3352
from .export import export, guess_format, get_root_name
3354
if branch_or_subdir is None:
3355
branch_or_subdir = directory
3357
(tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
3359
if tree is not None:
3360
self.add_cleanup(tree.lock_read().unlock)
3364
raise errors.BzrCommandError(
3365
gettext("--uncommitted requires a working tree"))
3368
export_tree = _get_one_revision_tree(
3369
'export', revision, branch=b,
3373
format = guess_format(dest)
3376
root = get_root_name(dest)
3378
if not per_file_timestamps:
3379
force_mtime = time.time()
3384
from breezy.filter_tree import ContentFilterTree
3385
export_tree = ContentFilterTree(
3386
export_tree, export_tree._content_filter_stack)
3389
export(export_tree, dest, format, root, subdir,
3390
per_file_timestamps=per_file_timestamps)
3391
except errors.NoSuchExportFormat as e:
3392
raise errors.BzrCommandError(
3393
gettext('Unsupported export format: %s') % e.format)
3396
class cmd_cat(Command):
3397
__doc__ = """Write the contents of a file as of a given revision to standard output.
3399
If no revision is nominated, the last revision is used.
3401
Note: Take care to redirect standard output when using this command on a
3406
takes_options = ['directory',
3407
Option('name-from-revision',
3408
help='The path name in the old tree.'),
3409
Option('filters', help='Apply content filters to display the '
3410
'convenience form.'),
3413
takes_args = ['filename']
3414
encoding_type = 'exact'
3417
def run(self, filename, revision=None, name_from_revision=False,
3418
filters=False, directory=None):
3419
if revision is not None and len(revision) != 1:
3420
raise errors.BzrCommandError(gettext("brz cat --revision takes exactly"
3421
" one revision specifier"))
3422
tree, branch, relpath = \
3423
_open_directory_or_containing_tree_or_branch(filename, directory)
3424
self.add_cleanup(branch.lock_read().unlock)
3425
return self._run(tree, branch, relpath, filename, revision,
3426
name_from_revision, filters)
3428
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3432
tree = b.basis_tree()
3433
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3434
self.add_cleanup(rev_tree.lock_read().unlock)
3436
if name_from_revision:
3437
# Try in revision if requested
3438
if not rev_tree.is_versioned(relpath):
3439
raise errors.BzrCommandError(gettext(
3440
"{0!r} is not present in revision {1}").format(
3441
filename, rev_tree.get_revision_id()))
3442
rev_tree_path = relpath
3445
rev_tree_path = _mod_tree.find_previous_path(
3446
tree, rev_tree, relpath)
3447
except errors.NoSuchFile:
3448
rev_tree_path = None
3450
if rev_tree_path is None:
3451
# Path didn't exist in working tree
3452
if not rev_tree.is_versioned(relpath):
3453
raise errors.BzrCommandError(gettext(
3454
"{0!r} is not present in revision {1}").format(
3455
filename, rev_tree.get_revision_id()))
3457
# Fall back to the same path in the basis tree, if present.
3458
rev_tree_path = relpath
3461
from .filter_tree import ContentFilterTree
3462
filter_tree = ContentFilterTree(
3463
rev_tree, rev_tree._content_filter_stack)
3464
fileobj = filter_tree.get_file(rev_tree_path)
3466
fileobj = rev_tree.get_file(rev_tree_path)
3467
shutil.copyfileobj(fileobj, self.outf)
3471
class cmd_local_time_offset(Command):
3472
__doc__ = """Show the offset in seconds from GMT to local time."""
3477
self.outf.write("%s\n" % osutils.local_time_offset())
3480
class cmd_commit(Command):
3481
__doc__ = """Commit changes into a new revision.
3483
An explanatory message needs to be given for each commit. This is
3484
often done by using the --message option (getting the message from the
3485
command line) or by using the --file option (getting the message from
3486
a file). If neither of these options is given, an editor is opened for
3487
the user to enter the message. To see the changed files in the
3488
boilerplate text loaded into the editor, use the --show-diff option.
3490
By default, the entire tree is committed and the person doing the
3491
commit is assumed to be the author. These defaults can be overridden
3496
If selected files are specified, only changes to those files are
3497
committed. If a directory is specified then the directory and
3498
everything within it is committed.
3500
When excludes are given, they take precedence over selected files.
3501
For example, to commit only changes within foo, but not changes
3504
brz commit foo -x foo/bar
3506
A selective commit after a merge is not yet supported.
3510
If the author of the change is not the same person as the committer,
3511
you can specify the author's name using the --author option. The
3512
name should be in the same format as a committer-id, e.g.
3513
"John Doe <jdoe@example.com>". If there is more than one author of
3514
the change you can specify the option multiple times, once for each
3519
A common mistake is to forget to add a new file or directory before
3520
running the commit command. The --strict option checks for unknown
3521
files and aborts the commit if any are found. More advanced pre-commit
3522
checks can be implemented by defining hooks. See ``brz help hooks``
3527
If you accidentially commit the wrong changes or make a spelling
3528
mistake in the commit message say, you can use the uncommit command
3529
to undo it. See ``brz help uncommit`` for details.
3531
Hooks can also be configured to run after a commit. This allows you
3532
to trigger updates to external systems like bug trackers. The --fixes
3533
option can be used to record the association between a revision and
3534
one or more bugs. See ``brz help bugs`` for details.
3537
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3538
takes_args = ['selected*']
3541
'exclude', type=text_type, short_name='x',
3542
help="Do not consider changes made to a given path."),
3543
Option('message', type=text_type,
3545
help="Description of the new revision."),
3548
help='Commit even if nothing has changed.'),
3549
Option('file', type=text_type,
3552
help='Take commit message from this file.'),
3554
help="Refuse to commit if there are unknown "
3555
"files in the working tree."),
3556
Option('commit-time', type=text_type,
3557
help="Manually set a commit time using commit date "
3558
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3560
'bugs', type=text_type,
3561
help="Link to a related bug. (see \"brz help bugs\")."),
3563
'fixes', type=text_type,
3564
help="Mark a bug as being fixed by this revision "
3565
"(see \"brz help bugs\")."),
3567
'author', type=text_type,
3568
help="Set the author's name, if it's different "
3569
"from the committer."),
3571
help="Perform a local commit in a bound "
3572
"branch. Local commits are not pushed to "
3573
"the master branch until a normal commit "
3576
Option('show-diff', short_name='p',
3577
help='When no message is supplied, show the diff along'
3578
' with the status summary in the message editor.'),
3580
help='When committing to a foreign version control '
3581
'system do not push data that can not be natively '
3583
aliases = ['ci', 'checkin']
3585
def _iter_bug_urls(self, bugs, branch, status):
3586
default_bugtracker = None
3587
# Configure the properties for bug fixing attributes.
3589
tokens = bug.split(':')
3590
if len(tokens) == 1:
3591
if default_bugtracker is None:
3592
branch_config = branch.get_config_stack()
3593
default_bugtracker = branch_config.get(
3595
if default_bugtracker is None:
3596
raise errors.BzrCommandError(gettext(
3597
"No tracker specified for bug %s. Use the form "
3598
"'tracker:id' or specify a default bug tracker "
3599
"using the `bugtracker` option.\nSee "
3600
"\"brz help bugs\" for more information on this "
3601
"feature. Commit refused.") % bug)
3602
tag = default_bugtracker
3604
elif len(tokens) != 2:
3605
raise errors.BzrCommandError(gettext(
3606
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3607
"See \"brz help bugs\" for more information on this "
3608
"feature.\nCommit refused.") % bug)
3610
tag, bug_id = tokens
3612
yield bugtracker.get_bug_url(tag, branch, bug_id), status
3613
except bugtracker.UnknownBugTrackerAbbreviation:
3614
raise errors.BzrCommandError(gettext(
3615
'Unrecognized bug %s. Commit refused.') % bug)
3616
except bugtracker.MalformedBugIdentifier as e:
3617
raise errors.BzrCommandError(gettext(
3618
u"%s\nCommit refused.") % (e,))
3620
def run(self, message=None, file=None, verbose=False, selected_list=None,
3621
unchanged=False, strict=False, local=False, fixes=None, bugs=None,
3622
author=None, show_diff=False, exclude=None, commit_time=None,
3625
from .commit import (
3628
from .errors import (
3632
from .msgeditor import (
3633
edit_commit_message_encoded,
3634
generate_commit_message_template,
3635
make_commit_message_template_encoded,
3639
commit_stamp = offset = None
3640
if commit_time is not None:
3642
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3643
except ValueError as e:
3644
raise errors.BzrCommandError(gettext(
3645
"Could not parse --commit-time: " + str(e)))
3649
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3650
if selected_list == ['']:
3651
# workaround - commit of root of tree should be exactly the same
3652
# as just default commit in that tree, and succeed even though
3653
# selected-file merge commit is not done yet
3660
bug_property = bugtracker.encode_fixes_bug_urls(
3662
self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
3663
self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
3665
properties[u'bugs'] = bug_property
3667
if local and not tree.branch.get_bound_location():
3668
raise errors.LocalRequiresBoundBranch()
3670
if message is not None:
3672
file_exists = osutils.lexists(message)
3673
except UnicodeError:
3674
# The commit message contains unicode characters that can't be
3675
# represented in the filesystem encoding, so that can't be a
3680
'The commit message is a file name: "%(f)s".\n'
3681
'(use --file "%(f)s" to take commit message from that file)'
3683
ui.ui_factory.show_warning(warning_msg)
3685
message = message.replace('\r\n', '\n')
3686
message = message.replace('\r', '\n')
3688
raise errors.BzrCommandError(gettext(
3689
"please specify either --message or --file"))
3691
def get_message(commit_obj):
3692
"""Callback to get commit message"""
3694
with open(file, 'rb') as f:
3695
my_message = f.read().decode(osutils.get_user_encoding())
3696
elif message is not None:
3697
my_message = message
3699
# No message supplied: make one up.
3700
# text is the status of the tree
3701
text = make_commit_message_template_encoded(tree,
3702
selected_list, diff=show_diff,
3703
output_encoding=osutils.get_user_encoding())
3704
# start_message is the template generated from hooks
3705
# XXX: Warning - looks like hooks return unicode,
3706
# make_commit_message_template_encoded returns user encoding.
3707
# We probably want to be using edit_commit_message instead to
3709
my_message = set_commit_message(commit_obj)
3710
if my_message is None:
3711
start_message = generate_commit_message_template(
3713
if start_message is not None:
3714
start_message = start_message.encode(
3715
osutils.get_user_encoding())
3716
my_message = edit_commit_message_encoded(text,
3717
start_message=start_message)
3718
if my_message is None:
3719
raise errors.BzrCommandError(gettext("please specify a commit"
3720
" message with either --message or --file"))
3721
if my_message == "":
3722
raise errors.BzrCommandError(gettext("Empty commit message specified."
3723
" Please specify a commit message with either"
3724
" --message or --file or leave a blank message"
3725
" with --message \"\"."))
3728
# The API permits a commit with a filter of [] to mean 'select nothing'
3729
# but the command line should not do that.
3730
if not selected_list:
3731
selected_list = None
3733
tree.commit(message_callback=get_message,
3734
specific_files=selected_list,
3735
allow_pointless=unchanged, strict=strict, local=local,
3736
reporter=None, verbose=verbose, revprops=properties,
3737
authors=author, timestamp=commit_stamp,
3739
exclude=tree.safe_relpath_files(exclude),
3741
except PointlessCommit:
3742
raise errors.BzrCommandError(gettext("No changes to commit."
3743
" Please 'brz add' the files you want to commit, or use"
3744
" --unchanged to force an empty commit."))
3745
except ConflictsInTree:
3746
raise errors.BzrCommandError(gettext('Conflicts detected in working '
3747
'tree. Use "brz conflicts" to list, "brz resolve FILE" to'
3749
except StrictCommitFailed:
3750
raise errors.BzrCommandError(gettext("Commit refused because there are"
3751
" unknown files in the working tree."))
3752
except errors.BoundBranchOutOfDate as e:
3753
e.extra_help = (gettext("\n"
3754
'To commit to master branch, run update and then commit.\n'
3755
'You can also pass --local to commit to continue working '
3760
class cmd_check(Command):
3761
__doc__ = """Validate working tree structure, branch consistency and repository history.
3763
This command checks various invariants about branch and repository storage
3764
to detect data corruption or brz bugs.
3766
The working tree and branch checks will only give output if a problem is
3767
detected. The output fields of the repository check are:
3770
This is just the number of revisions checked. It doesn't
3774
This is just the number of versionedfiles checked. It
3775
doesn't indicate a problem.
3777
unreferenced ancestors
3778
Texts that are ancestors of other texts, but
3779
are not properly referenced by the revision ancestry. This is a
3780
subtle problem that Bazaar can work around.
3783
This is the total number of unique file contents
3784
seen in the checked revisions. It does not indicate a problem.
3787
This is the total number of repeated texts seen
3788
in the checked revisions. Texts can be repeated when their file
3789
entries are modified, but the file contents are not. It does not
3792
If no restrictions are specified, all Bazaar data that is found at the given
3793
location will be checked.
3797
Check the tree and branch at 'foo'::
3799
brz check --tree --branch foo
3801
Check only the repository at 'bar'::
3803
brz check --repo bar
3805
Check everything at 'baz'::
3810
_see_also = ['reconcile']
3811
takes_args = ['path?']
3812
takes_options = ['verbose',
3813
Option('branch', help="Check the branch related to the"
3814
" current directory."),
3815
Option('repo', help="Check the repository related to the"
3816
" current directory."),
3817
Option('tree', help="Check the working tree related to"
3818
" the current directory.")]
3820
def run(self, path=None, verbose=False, branch=False, repo=False,
3822
from .check import check_dwim
3825
if not branch and not repo and not tree:
3826
branch = repo = tree = True
3827
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3830
class cmd_upgrade(Command):
3831
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3833
When the default format has changed after a major new release of
3834
Bazaar, you may be informed during certain operations that you
3835
should upgrade. Upgrading to a newer format may improve performance
3836
or make new features available. It may however limit interoperability
3837
with older repositories or with older versions of Bazaar.
3839
If you wish to upgrade to a particular format rather than the
3840
current default, that can be specified using the --format option.
3841
As a consequence, you can use the upgrade command this way to
3842
"downgrade" to an earlier format, though some conversions are
3843
a one way process (e.g. changing from the 1.x default to the
3844
2.x default) so downgrading is not always possible.
3846
A backup.bzr.~#~ directory is created at the start of the conversion
3847
process (where # is a number). By default, this is left there on
3848
completion. If the conversion fails, delete the new .bzr directory
3849
and rename this one back in its place. Use the --clean option to ask
3850
for the backup.bzr directory to be removed on successful conversion.
3851
Alternatively, you can delete it by hand if everything looks good
3854
If the location given is a shared repository, dependent branches
3855
are also converted provided the repository converts successfully.
3856
If the conversion of a branch fails, remaining branches are still
3859
For more information on upgrades, see the Bazaar Upgrade Guide,
3860
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3863
_see_also = ['check', 'reconcile', 'formats']
3864
takes_args = ['url?']
3866
RegistryOption('format',
3867
help='Upgrade to a specific format. See "brz help'
3868
' formats" for details.',
3869
lazy_registry=('breezy.controldir', 'format_registry'),
3870
converter=lambda name: controldir.format_registry.make_controldir(
3872
value_switches=True, title='Branch format'),
3874
help='Remove the backup.bzr directory if successful.'),
3876
help="Show what would be done, but don't actually do anything."),
3879
def run(self, url='.', format=None, clean=False, dry_run=False):
3880
from .upgrade import upgrade
3881
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3883
if len(exceptions) == 1:
3884
# Compatibility with historical behavior
3890
class cmd_whoami(Command):
3891
__doc__ = """Show or set brz user id.
3894
Show the email of the current user::
3898
Set the current user::
3900
brz whoami "Frank Chu <fchu@example.com>"
3902
takes_options = ['directory',
3904
help='Display email address only.'),
3906
help='Set identity for the current branch instead of '
3909
takes_args = ['name?']
3910
encoding_type = 'replace'
3913
def run(self, email=False, branch=False, name=None, directory=None):
3915
if directory is None:
3916
# use branch if we're inside one; otherwise global config
3918
c = Branch.open_containing(u'.')[0].get_config_stack()
3919
except errors.NotBranchError:
3920
c = _mod_config.GlobalStack()
3922
c = Branch.open(directory).get_config_stack()
3923
identity = c.get('email')
3925
self.outf.write(_mod_config.extract_email_address(identity)
3928
self.outf.write(identity + '\n')
3932
raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3935
# display a warning if an email address isn't included in the given name.
3937
_mod_config.extract_email_address(name)
3938
except _mod_config.NoEmailInUsername:
3939
warning('"%s" does not seem to contain an email address. '
3940
'This is allowed, but not recommended.', name)
3942
# use global config unless --branch given
3944
if directory is None:
3945
c = Branch.open_containing(u'.')[0].get_config_stack()
3947
b = Branch.open(directory)
3948
self.add_cleanup(b.lock_write().unlock)
3949
c = b.get_config_stack()
3951
c = _mod_config.GlobalStack()
3952
c.set('email', name)
3955
class cmd_nick(Command):
3956
__doc__ = """Print or set the branch nickname.
3958
If unset, the colocated branch name is used for colocated branches, and
3959
the branch directory name is used for other branches. To print the
3960
current nickname, execute with no argument.
3962
Bound branches use the nickname of its master branch unless it is set
3966
_see_also = ['info']
3967
takes_args = ['nickname?']
3968
takes_options = ['directory']
3970
def run(self, nickname=None, directory=u'.'):
3971
branch = Branch.open_containing(directory)[0]
3972
if nickname is None:
3973
self.printme(branch)
3975
branch.nick = nickname
3978
def printme(self, branch):
3979
self.outf.write('%s\n' % branch.nick)
3982
class cmd_alias(Command):
3983
__doc__ = """Set/unset and display aliases.
3986
Show the current aliases::
3990
Show the alias specified for 'll'::
3994
Set an alias for 'll'::
3996
brz alias ll="log --line -r-10..-1"
3998
To remove an alias for 'll'::
4000
brz alias --remove ll
4003
takes_args = ['name?']
4005
Option('remove', help='Remove the alias.'),
4008
def run(self, name=None, remove=False):
4010
self.remove_alias(name)
4012
self.print_aliases()
4014
equal_pos = name.find('=')
4016
self.print_alias(name)
4018
self.set_alias(name[:equal_pos], name[equal_pos + 1:])
4020
def remove_alias(self, alias_name):
4021
if alias_name is None:
4022
raise errors.BzrCommandError(gettext(
4023
'brz alias --remove expects an alias to remove.'))
4024
# If alias is not found, print something like:
4025
# unalias: foo: not found
4026
c = _mod_config.GlobalConfig()
4027
c.unset_alias(alias_name)
4030
def print_aliases(self):
4031
"""Print out the defined aliases in a similar format to bash."""
4032
aliases = _mod_config.GlobalConfig().get_aliases()
4033
for key, value in sorted(viewitems(aliases)):
4034
self.outf.write('brz alias %s="%s"\n' % (key, value))
4037
def print_alias(self, alias_name):
4038
from .commands import get_alias
4039
alias = get_alias(alias_name)
4041
self.outf.write("brz alias: %s: not found\n" % alias_name)
4044
'brz alias %s="%s"\n' % (alias_name, ' '.join(alias)))
4046
def set_alias(self, alias_name, alias_command):
4047
"""Save the alias in the global config."""
4048
c = _mod_config.GlobalConfig()
4049
c.set_alias(alias_name, alias_command)
4052
class cmd_selftest(Command):
4053
__doc__ = """Run internal test suite.
4055
If arguments are given, they are regular expressions that say which tests
4056
should run. Tests matching any expression are run, and other tests are
4059
Alternatively if --first is given, matching tests are run first and then
4060
all other tests are run. This is useful if you have been working in a
4061
particular area, but want to make sure nothing else was broken.
4063
If --exclude is given, tests that match that regular expression are
4064
excluded, regardless of whether they match --first or not.
4066
To help catch accidential dependencies between tests, the --randomize
4067
option is useful. In most cases, the argument used is the word 'now'.
4068
Note that the seed used for the random number generator is displayed
4069
when this option is used. The seed can be explicitly passed as the
4070
argument to this option if required. This enables reproduction of the
4071
actual ordering used if and when an order sensitive problem is encountered.
4073
If --list-only is given, the tests that would be run are listed. This is
4074
useful when combined with --first, --exclude and/or --randomize to
4075
understand their impact. The test harness reports "Listed nn tests in ..."
4076
instead of "Ran nn tests in ..." when list mode is enabled.
4078
If the global option '--no-plugins' is given, plugins are not loaded
4079
before running the selftests. This has two effects: features provided or
4080
modified by plugins will not be tested, and tests provided by plugins will
4083
Tests that need working space on disk use a common temporary directory,
4084
typically inside $TMPDIR or /tmp.
4086
If you set BRZ_TEST_PDB=1 when running selftest, failing tests will drop
4087
into a pdb postmortem session.
4089
The --coverage=DIRNAME global option produces a report with covered code
4093
Run only tests relating to 'ignore'::
4097
Disable plugins and list tests as they're run::
4099
brz --no-plugins selftest -v
4101
# NB: this is used from the class without creating an instance, which is
4102
# why it does not have a self parameter.
4104
def get_transport_type(typestring):
4105
"""Parse and return a transport specifier."""
4106
if typestring == "sftp":
4107
from .tests import stub_sftp
4108
return stub_sftp.SFTPAbsoluteServer
4109
elif typestring == "memory":
4110
from .tests import test_server
4111
return memory.MemoryServer
4112
elif typestring == "fakenfs":
4113
from .tests import test_server
4114
return test_server.FakeNFSServer
4115
msg = "No known transport type %s. Supported types are: sftp\n" %\
4117
raise errors.BzrCommandError(msg)
4120
takes_args = ['testspecs*']
4121
takes_options = ['verbose',
4123
help='Stop when one test fails.',
4127
help='Use a different transport by default '
4128
'throughout the test suite.',
4129
type=get_transport_type),
4131
help='Run the benchmarks rather than selftests.',
4133
Option('lsprof-timed',
4134
help='Generate lsprof output for benchmarked'
4135
' sections of code.'),
4136
Option('lsprof-tests',
4137
help='Generate lsprof output for each test.'),
4139
help='Run all tests, but run specified tests first.',
4143
help='List the tests instead of running them.'),
4144
RegistryOption('parallel',
4145
help="Run the test suite in parallel.",
4147
'breezy.tests', 'parallel_registry'),
4148
value_switches=False,
4150
Option('randomize', type=text_type, argname="SEED",
4151
help='Randomize the order of tests using the given'
4152
' seed or "now" for the current time.'),
4153
ListOption('exclude', type=text_type, argname="PATTERN",
4155
help='Exclude tests that match this regular'
4158
help='Output test progress via subunit v1.'),
4160
help='Output test progress via subunit v2.'),
4161
Option('strict', help='Fail on missing dependencies or '
4163
Option('load-list', type=text_type, argname='TESTLISTFILE',
4164
help='Load a test id list from a text file.'),
4165
ListOption('debugflag', type=text_type, short_name='E',
4166
help='Turn on a selftest debug flag.'),
4167
ListOption('starting-with', type=text_type, argname='TESTID',
4168
param_name='starting_with', short_name='s',
4169
help='Load only the tests starting with TESTID.'),
4171
help="By default we disable fsync and fdatasync"
4172
" while running the test suite.")
4174
encoding_type = 'replace'
4177
Command.__init__(self)
4178
self.additional_selftest_args = {}
4180
def run(self, testspecs_list=None, verbose=False, one=False,
4181
transport=None, benchmark=None,
4183
first=False, list_only=False,
4184
randomize=None, exclude=None, strict=False,
4185
load_list=None, debugflag=None, starting_with=None, subunit1=False,
4186
subunit2=False, parallel=None, lsprof_tests=False, sync=False):
4188
# During selftest, disallow proxying, as it can cause severe
4189
# performance penalties and is only needed for thread
4190
# safety. The selftest command is assumed to not use threads
4191
# too heavily. The call should be as early as possible, as
4192
# error reporting for past duplicate imports won't have useful
4194
if sys.version_info[0] < 3:
4195
# TODO(pad.lv/1696545): Allow proxying on Python 3, since
4196
# disallowing it currently leads to failures in many places.
4197
lazy_import.disallow_proxying()
4202
raise errors.BzrCommandError("tests not available. Install the "
4203
"breezy tests to run the breezy testsuite.")
4205
if testspecs_list is not None:
4206
pattern = '|'.join(testspecs_list)
4211
from .tests import SubUnitBzrRunnerv1
4213
raise errors.BzrCommandError(gettext(
4214
"subunit not available. subunit needs to be installed "
4215
"to use --subunit."))
4216
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv1
4217
# On Windows, disable automatic conversion of '\n' to '\r\n' in
4218
# stdout, which would corrupt the subunit stream.
4219
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
4220
# following code can be deleted when it's sufficiently deployed
4221
# -- vila/mgz 20100514
4222
if (sys.platform == "win32"
4223
and getattr(sys.stdout, 'fileno', None) is not None):
4225
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
4228
from .tests import SubUnitBzrRunnerv2
4230
raise errors.BzrCommandError(gettext(
4231
"subunit not available. subunit "
4232
"needs to be installed to use --subunit2."))
4233
self.additional_selftest_args['runner_class'] = SubUnitBzrRunnerv2
4236
self.additional_selftest_args.setdefault(
4237
'suite_decorators', []).append(parallel)
4239
raise errors.BzrCommandError(gettext(
4240
"--benchmark is no longer supported from brz 2.2; "
4241
"use bzr-usertest instead"))
4242
test_suite_factory = None
4244
exclude_pattern = None
4246
exclude_pattern = '(' + '|'.join(exclude) + ')'
4248
self._disable_fsync()
4249
selftest_kwargs = {"verbose": verbose,
4251
"stop_on_failure": one,
4252
"transport": transport,
4253
"test_suite_factory": test_suite_factory,
4254
"lsprof_timed": lsprof_timed,
4255
"lsprof_tests": lsprof_tests,
4256
"matching_tests_first": first,
4257
"list_only": list_only,
4258
"random_seed": randomize,
4259
"exclude_pattern": exclude_pattern,
4261
"load_list": load_list,
4262
"debug_flags": debugflag,
4263
"starting_with": starting_with
4265
selftest_kwargs.update(self.additional_selftest_args)
4267
# Make deprecation warnings visible, unless -Werror is set
4268
cleanup = symbol_versioning.activate_deprecation_warnings(
4271
result = tests.selftest(**selftest_kwargs)
4274
return int(not result)
4276
def _disable_fsync(self):
4277
"""Change the 'os' functionality to not synchronize."""
4278
self._orig_fsync = getattr(os, 'fsync', None)
4279
if self._orig_fsync is not None:
4280
os.fsync = lambda filedes: None
4281
self._orig_fdatasync = getattr(os, 'fdatasync', None)
4282
if self._orig_fdatasync is not None:
4283
os.fdatasync = lambda filedes: None
4286
class cmd_version(Command):
4287
__doc__ = """Show version of brz."""
4289
encoding_type = 'replace'
4291
Option("short", help="Print just the version number."),
4295
def run(self, short=False):
4296
from .version import show_version
4298
self.outf.write(breezy.version_string + '\n')
4300
show_version(to_file=self.outf)
4303
class cmd_rocks(Command):
4304
__doc__ = """Statement of optimism."""
4310
self.outf.write(gettext("It sure does!\n"))
4313
class cmd_find_merge_base(Command):
4314
__doc__ = """Find and print a base revision for merging two branches."""
4315
# TODO: Options to specify revisions on either side, as if
4316
# merging only part of the history.
4317
takes_args = ['branch', 'other']
4321
def run(self, branch, other):
4322
from .revision import ensure_null
4324
branch1 = Branch.open_containing(branch)[0]
4325
branch2 = Branch.open_containing(other)[0]
4326
self.add_cleanup(branch1.lock_read().unlock)
4327
self.add_cleanup(branch2.lock_read().unlock)
4328
last1 = ensure_null(branch1.last_revision())
4329
last2 = ensure_null(branch2.last_revision())
4331
graph = branch1.repository.get_graph(branch2.repository)
4332
base_rev_id = graph.find_unique_lca(last1, last2)
4334
self.outf.write(gettext('merge base is revision %s\n') %
4335
base_rev_id.decode('utf-8'))
4338
class cmd_merge(Command):
4339
__doc__ = """Perform a three-way merge.
4341
The source of the merge can be specified either in the form of a branch,
4342
or in the form of a path to a file containing a merge directive generated
4343
with brz send. If neither is specified, the default is the upstream branch
4344
or the branch most recently merged using --remember. The source of the
4345
merge may also be specified in the form of a path to a file in another
4346
branch: in this case, only the modifications to that file are merged into
4347
the current working tree.
4349
When merging from a branch, by default brz will try to merge in all new
4350
work from the other branch, automatically determining an appropriate base
4351
revision. If this fails, you may need to give an explicit base.
4353
To pick a different ending revision, pass "--revision OTHER". brz will
4354
try to merge in all new work up to and including revision OTHER.
4356
If you specify two values, "--revision BASE..OTHER", only revisions BASE
4357
through OTHER, excluding BASE but including OTHER, will be merged. If this
4358
causes some revisions to be skipped, i.e. if the destination branch does
4359
not already contain revision BASE, such a merge is commonly referred to as
4360
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4361
cherrypicks. The changes look like a normal commit, and the history of the
4362
changes from the other branch is not stored in the commit.
4364
Revision numbers are always relative to the source branch.
4366
Merge will do its best to combine the changes in two branches, but there
4367
are some kinds of problems only a human can fix. When it encounters those,
4368
it will mark a conflict. A conflict means that you need to fix something,
4369
before you can commit.
4371
Use brz resolve when you have fixed a problem. See also brz conflicts.
4373
If there is no default branch set, the first merge will set it (use
4374
--no-remember to avoid setting it). After that, you can omit the branch
4375
to use the default. To change the default, use --remember. The value will
4376
only be saved if the remote location can be accessed.
4378
The results of the merge are placed into the destination working
4379
directory, where they can be reviewed (with brz diff), tested, and then
4380
committed to record the result of the merge.
4382
merge refuses to run if there are any uncommitted changes, unless
4383
--force is given. If --force is given, then the changes from the source
4384
will be merged with the current working tree, including any uncommitted
4385
changes in the tree. The --force option can also be used to create a
4386
merge revision which has more than two parents.
4388
If one would like to merge changes from the working tree of the other
4389
branch without merging any committed revisions, the --uncommitted option
4392
To select only some changes to merge, use "merge -i", which will prompt
4393
you to apply each diff hunk and file change, similar to "shelve".
4396
To merge all new revisions from brz.dev::
4398
brz merge ../brz.dev
4400
To merge changes up to and including revision 82 from brz.dev::
4402
brz merge -r 82 ../brz.dev
4404
To merge the changes introduced by 82, without previous changes::
4406
brz merge -r 81..82 ../brz.dev
4408
To apply a merge directive contained in /tmp/merge::
4410
brz merge /tmp/merge
4412
To create a merge revision with three parents from two branches
4413
feature1a and feature1b:
4415
brz merge ../feature1a
4416
brz merge ../feature1b --force
4417
brz commit -m 'revision with three parents'
4420
encoding_type = 'exact'
4421
_see_also = ['update', 'remerge', 'status-flags', 'send']
4422
takes_args = ['location?']
4427
help='Merge even if the destination tree has uncommitted changes.'),
4431
Option('show-base', help="Show base revision text in "
4433
Option('uncommitted', help='Apply uncommitted changes'
4434
' from a working copy, instead of branch changes.'),
4435
Option('pull', help='If the destination is already'
4436
' completely merged into the source, pull from the'
4437
' source rather than merging. When this happens,'
4438
' you do not need to commit the result.'),
4439
custom_help('directory',
4440
help='Branch to merge into, '
4441
'rather than the one containing the working directory.'),
4442
Option('preview', help='Instead of merging, show a diff of the'
4444
Option('interactive', help='Select changes interactively.',
4448
def run(self, location=None, revision=None, force=False,
4449
merge_type=None, show_base=False, reprocess=None, remember=None,
4450
uncommitted=False, pull=False,
4455
if merge_type is None:
4456
merge_type = _mod_merge.Merge3Merger
4458
if directory is None:
4460
possible_transports = []
4462
allow_pending = True
4463
verified = 'inapplicable'
4465
tree = WorkingTree.open_containing(directory)[0]
4466
if tree.branch.last_revision() == _mod_revision.NULL_REVISION:
4467
raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4468
'https://bugs.launchpad.net/bzr/+bug/308562'))
4470
# die as quickly as possible if there are uncommitted changes
4472
if tree.has_changes():
4473
raise errors.UncommittedChanges(tree)
4475
view_info = _get_view_info_for_change_reporter(tree)
4476
change_reporter = delta._ChangeReporter(
4477
unversioned_filter=tree.is_ignored, view_info=view_info)
4478
pb = ui.ui_factory.nested_progress_bar()
4479
self.add_cleanup(pb.finished)
4480
self.add_cleanup(tree.lock_write().unlock)
4481
if location is not None:
4483
mergeable = bundle.read_mergeable_from_url(location,
4484
possible_transports=possible_transports)
4485
except errors.NotABundle:
4489
raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4490
' with bundles or merge directives.'))
4492
if revision is not None:
4493
raise errors.BzrCommandError(gettext(
4494
'Cannot use -r with merge directives or bundles'))
4495
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4498
if merger is None and uncommitted:
4499
if revision is not None and len(revision) > 0:
4500
raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4501
' --revision at the same time.'))
4502
merger = self.get_merger_from_uncommitted(tree, location, None)
4503
allow_pending = False
4506
merger, allow_pending = self._get_merger_from_branch(tree,
4507
location, revision, remember, possible_transports, None)
4509
merger.merge_type = merge_type
4510
merger.reprocess = reprocess
4511
merger.show_base = show_base
4512
self.sanity_check_merger(merger)
4513
if (merger.base_rev_id == merger.other_rev_id and
4514
merger.other_rev_id is not None):
4515
# check if location is a nonexistent file (and not a branch) to
4516
# disambiguate the 'Nothing to do'
4517
if merger.interesting_files:
4518
if not merger.other_tree.has_filename(
4519
merger.interesting_files[0]):
4520
note(gettext("merger: ") + str(merger))
4521
raise errors.PathsDoNotExist([location])
4522
note(gettext('Nothing to do.'))
4524
if pull and not preview:
4525
if merger.interesting_files is not None:
4526
raise errors.BzrCommandError(
4527
gettext('Cannot pull individual files'))
4528
if (merger.base_rev_id == tree.last_revision()):
4529
result = tree.pull(merger.other_branch, False,
4530
merger.other_rev_id)
4531
result.report(self.outf)
4533
if merger.this_basis is None:
4534
raise errors.BzrCommandError(gettext(
4535
"This branch has no commits."
4536
" (perhaps you would prefer 'brz pull')"))
4538
return self._do_preview(merger)
4540
return self._do_interactive(merger)
4542
return self._do_merge(merger, change_reporter, allow_pending,
4545
def _get_preview(self, merger):
4546
tree_merger = merger.make_merger()
4547
tt = tree_merger.make_preview_transform()
4548
self.add_cleanup(tt.finalize)
4549
result_tree = tt.get_preview_tree()
4552
def _do_preview(self, merger):
4553
from .diff import show_diff_trees
4554
result_tree = self._get_preview(merger)
4555
path_encoding = osutils.get_diff_header_encoding()
4556
show_diff_trees(merger.this_tree, result_tree, self.outf,
4557
old_label='', new_label='',
4558
path_encoding=path_encoding)
4560
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4561
merger.change_reporter = change_reporter
4562
conflict_count = merger.do_merge()
4564
merger.set_pending()
4565
if verified == 'failed':
4566
warning('Preview patch does not match changes')
4567
if conflict_count != 0:
4572
def _do_interactive(self, merger):
4573
"""Perform an interactive merge.
4575
This works by generating a preview tree of the merge, then using
4576
Shelver to selectively remove the differences between the working tree
4577
and the preview tree.
4579
from . import shelf_ui
4580
result_tree = self._get_preview(merger)
4581
writer = breezy.option.diff_writer_registry.get()
4582
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4583
reporter=shelf_ui.ApplyReporter(),
4584
diff_writer=writer(self.outf))
4590
def sanity_check_merger(self, merger):
4591
if (merger.show_base and
4592
merger.merge_type is not _mod_merge.Merge3Merger):
4593
raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4594
" merge type. %s") % merger.merge_type)
4595
if merger.reprocess is None:
4596
if merger.show_base:
4597
merger.reprocess = False
4599
# Use reprocess if the merger supports it
4600
merger.reprocess = merger.merge_type.supports_reprocess
4601
if merger.reprocess and not merger.merge_type.supports_reprocess:
4602
raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4603
" for merge type %s.") %
4605
if merger.reprocess and merger.show_base:
4606
raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4609
if (merger.merge_type.requires_file_merge_plan and
4610
(not getattr(merger.this_tree, 'plan_file_merge', None) or
4611
not getattr(merger.other_tree, 'plan_file_merge', None) or
4612
(merger.base_tree is not None and
4613
not getattr(merger.base_tree, 'plan_file_merge', None)))):
4614
raise errors.BzrCommandError(
4615
gettext('Plan file merge unsupported: '
4616
'Merge type incompatible with tree formats.'))
4618
def _get_merger_from_branch(self, tree, location, revision, remember,
4619
possible_transports, pb):
4620
"""Produce a merger from a location, assuming it refers to a branch."""
4621
# find the branch locations
4622
other_loc, user_location = self._select_branch_location(tree, location,
4624
if revision is not None and len(revision) == 2:
4625
base_loc, _unused = self._select_branch_location(tree,
4626
location, revision, 0)
4628
base_loc = other_loc
4630
other_branch, other_path = Branch.open_containing(other_loc,
4631
possible_transports)
4632
if base_loc == other_loc:
4633
base_branch = other_branch
4635
base_branch, base_path = Branch.open_containing(base_loc,
4636
possible_transports)
4637
# Find the revision ids
4638
other_revision_id = None
4639
base_revision_id = None
4640
if revision is not None:
4641
if len(revision) >= 1:
4642
other_revision_id = revision[-1].as_revision_id(other_branch)
4643
if len(revision) == 2:
4644
base_revision_id = revision[0].as_revision_id(base_branch)
4645
if other_revision_id is None:
4646
other_revision_id = _mod_revision.ensure_null(
4647
other_branch.last_revision())
4648
# Remember where we merge from. We need to remember if:
4649
# - user specify a location (and we don't merge from the parent
4651
# - user ask to remember or there is no previous location set to merge
4652
# from and user didn't ask to *not* remember
4653
if (user_location is not None
4655
(remember is None and
4656
tree.branch.get_submit_branch() is None)))):
4657
tree.branch.set_submit_branch(other_branch.base)
4658
# Merge tags (but don't set them in the master branch yet, the user
4659
# might revert this merge). Commit will propagate them.
4660
other_branch.tags.merge_to(tree.branch.tags, ignore_master=True)
4661
merger = _mod_merge.Merger.from_revision_ids(tree,
4662
other_revision_id, base_revision_id, other_branch, base_branch)
4663
if other_path != '':
4664
allow_pending = False
4665
merger.interesting_files = [other_path]
4667
allow_pending = True
4668
return merger, allow_pending
4670
def get_merger_from_uncommitted(self, tree, location, pb):
4671
"""Get a merger for uncommitted changes.
4673
:param tree: The tree the merger should apply to.
4674
:param location: The location containing uncommitted changes.
4675
:param pb: The progress bar to use for showing progress.
4677
location = self._select_branch_location(tree, location)[0]
4678
other_tree, other_path = WorkingTree.open_containing(location)
4679
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4680
if other_path != '':
4681
merger.interesting_files = [other_path]
4684
def _select_branch_location(self, tree, user_location, revision=None,
4686
"""Select a branch location, according to possible inputs.
4688
If provided, branches from ``revision`` are preferred. (Both
4689
``revision`` and ``index`` must be supplied.)
4691
Otherwise, the ``location`` parameter is used. If it is None, then the
4692
``submit`` or ``parent`` location is used, and a note is printed.
4694
:param tree: The working tree to select a branch for merging into
4695
:param location: The location entered by the user
4696
:param revision: The revision parameter to the command
4697
:param index: The index to use for the revision parameter. Negative
4698
indices are permitted.
4699
:return: (selected_location, user_location). The default location
4700
will be the user-entered location.
4702
if (revision is not None and index is not None
4703
and revision[index] is not None):
4704
branch = revision[index].get_branch()
4705
if branch is not None:
4706
return branch, branch
4707
if user_location is None:
4708
location = self._get_remembered(tree, 'Merging from')
4710
location = user_location
4711
return location, user_location
4713
def _get_remembered(self, tree, verb_string):
4714
"""Use tree.branch's parent if none was supplied.
4716
Report if the remembered location was used.
4718
stored_location = tree.branch.get_submit_branch()
4719
stored_location_type = "submit"
4720
if stored_location is None:
4721
stored_location = tree.branch.get_parent()
4722
stored_location_type = "parent"
4723
mutter("%s", stored_location)
4724
if stored_location is None:
4725
raise errors.BzrCommandError(
4726
gettext("No location specified or remembered"))
4727
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4728
note(gettext("{0} remembered {1} location {2}").format(verb_string,
4729
stored_location_type, display_url))
4730
return stored_location
4733
class cmd_remerge(Command):
4734
__doc__ = """Redo a merge.
4736
Use this if you want to try a different merge technique while resolving
4737
conflicts. Some merge techniques are better than others, and remerge
4738
lets you try different ones on different files.
4740
The options for remerge have the same meaning and defaults as the ones for
4741
merge. The difference is that remerge can (only) be run when there is a
4742
pending merge, and it lets you specify particular files.
4745
Re-do the merge of all conflicted files, and show the base text in
4746
conflict regions, in addition to the usual THIS and OTHER texts::
4748
brz remerge --show-base
4750
Re-do the merge of "foobar", using the weave merge algorithm, with
4751
additional processing to reduce the size of conflict regions::
4753
brz remerge --merge-type weave --reprocess foobar
4755
takes_args = ['file*']
4760
help="Show base revision text in conflicts."),
4763
def run(self, file_list=None, merge_type=None, show_base=False,
4765
from .conflicts import restore
4766
if merge_type is None:
4767
merge_type = _mod_merge.Merge3Merger
4768
tree, file_list = WorkingTree.open_containing_paths(file_list)
4769
self.add_cleanup(tree.lock_write().unlock)
4770
parents = tree.get_parent_ids()
4771
if len(parents) != 2:
4772
raise errors.BzrCommandError(
4773
gettext("Sorry, remerge only works after normal"
4774
" merges. Not cherrypicking or multi-merges."))
4775
interesting_files = None
4777
conflicts = tree.conflicts()
4778
if file_list is not None:
4779
interesting_files = set()
4780
for filename in file_list:
4781
if not tree.is_versioned(filename):
4782
raise errors.NotVersionedError(filename)
4783
interesting_files.add(filename)
4784
if tree.kind(filename) != "directory":
4787
for path, ie in tree.iter_entries_by_dir(
4788
specific_files=[filename]):
4789
interesting_files.add(path)
4790
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4792
# Remerge only supports resolving contents conflicts
4793
allowed_conflicts = ('text conflict', 'contents conflict')
4794
restore_files = [c.path for c in conflicts
4795
if c.typestring in allowed_conflicts]
4796
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_files)
4797
tree.set_conflicts(ConflictList(new_conflicts))
4798
if file_list is not None:
4799
restore_files = file_list
4800
for filename in restore_files:
4802
restore(tree.abspath(filename))
4803
except errors.NotConflicted:
4805
# Disable pending merges, because the file texts we are remerging
4806
# have not had those merges performed. If we use the wrong parents
4807
# list, we imply that the working tree text has seen and rejected
4808
# all the changes from the other tree, when in fact those changes
4809
# have not yet been seen.
4810
tree.set_parent_ids(parents[:1])
4812
merger = _mod_merge.Merger.from_revision_ids(tree, parents[1])
4813
merger.interesting_files = interesting_files
4814
merger.merge_type = merge_type
4815
merger.show_base = show_base
4816
merger.reprocess = reprocess
4817
conflicts = merger.do_merge()
4819
tree.set_parent_ids(parents)
4826
class cmd_revert(Command):
4828
Set files in the working tree back to the contents of a previous revision.
4830
Giving a list of files will revert only those files. Otherwise, all files
4831
will be reverted. If the revision is not specified with '--revision', the
4832
working tree basis revision is used. A revert operation affects only the
4833
working tree, not any revision history like the branch and repository or
4834
the working tree basis revision.
4836
To remove only some changes, without reverting to a prior version, use
4837
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4838
will remove the changes introduced by the second last commit (-2), without
4839
affecting the changes introduced by the last commit (-1). To remove
4840
certain changes on a hunk-by-hunk basis, see the shelve command.
4841
To update the branch to a specific revision or the latest revision and
4842
update the working tree accordingly while preserving local changes, see the
4845
Uncommitted changes to files that are reverted will be discarded.
4846
Howver, by default, any files that have been manually changed will be
4847
backed up first. (Files changed only by merge are not backed up.) Backup
4848
files have '.~#~' appended to their name, where # is a number.
4850
When you provide files, you can use their current pathname or the pathname
4851
from the target revision. So you can use revert to "undelete" a file by
4852
name. If you name a directory, all the contents of that directory will be
4855
If you have newly added files since the target revision, they will be
4856
removed. If the files to be removed have been changed, backups will be
4857
created as above. Directories containing unknown files will not be
4860
The working tree contains a list of revisions that have been merged but
4861
not yet committed. These revisions will be included as additional parents
4862
of the next commit. Normally, using revert clears that list as well as
4863
reverting the files. If any files are specified, revert leaves the list
4864
of uncommitted merges alone and reverts only the files. Use ``brz revert
4865
.`` in the tree root to revert all files but keep the recorded merges,
4866
and ``brz revert --forget-merges`` to clear the pending merge list without
4867
reverting any files.
4869
Using "brz revert --forget-merges", it is possible to apply all of the
4870
changes from a branch in a single revision. To do this, perform the merge
4871
as desired. Then doing revert with the "--forget-merges" option will keep
4872
the content of the tree as it was, but it will clear the list of pending
4873
merges. The next commit will then contain all of the changes that are
4874
present in the other branch, but without any other parent revisions.
4875
Because this technique forgets where these changes originated, it may
4876
cause additional conflicts on later merges involving the same source and
4880
_see_also = ['cat', 'export', 'merge', 'shelve']
4883
Option('no-backup', "Do not save backups of reverted files."),
4884
Option('forget-merges',
4885
'Remove pending merge marker, without changing any files.'),
4887
takes_args = ['file*']
4889
def run(self, revision=None, no_backup=False, file_list=None,
4890
forget_merges=None):
4891
tree, file_list = WorkingTree.open_containing_paths(file_list)
4892
self.add_cleanup(tree.lock_tree_write().unlock)
4894
tree.set_parent_ids(tree.get_parent_ids()[:1])
4896
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4899
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4900
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4901
tree.revert(file_list, rev_tree, not no_backup, None,
4902
report_changes=True)
4905
class cmd_assert_fail(Command):
4906
__doc__ = """Test reporting of assertion failures"""
4907
# intended just for use in testing
4912
raise AssertionError("always fails")
4915
class cmd_help(Command):
4916
__doc__ = """Show help on a command or other topic.
4919
_see_also = ['topics']
4921
Option('long', 'Show help on all commands.'),
4923
takes_args = ['topic?']
4924
aliases = ['?', '--help', '-?', '-h']
4927
def run(self, topic=None, long=False):
4929
if topic is None and long:
4931
breezy.help.help(topic)
4934
class cmd_shell_complete(Command):
4935
__doc__ = """Show appropriate completions for context.
4937
For a list of all available commands, say 'brz shell-complete'.
4939
takes_args = ['context?']
4944
def run(self, context=None):
4945
from . import shellcomplete
4946
shellcomplete.shellcomplete(context)
4949
class cmd_missing(Command):
4950
__doc__ = """Show unmerged/unpulled revisions between two branches.
4952
OTHER_BRANCH may be local or remote.
4954
To filter on a range of revisions, you can use the command -r begin..end
4955
-r revision requests a specific revision, -r ..end or -r begin.. are
4959
1 - some missing revisions
4960
0 - no missing revisions
4964
Determine the missing revisions between this and the branch at the
4965
remembered pull location::
4969
Determine the missing revisions between this and another branch::
4971
brz missing http://server/branch
4973
Determine the missing revisions up to a specific revision on the other
4976
brz missing -r ..-10
4978
Determine the missing revisions up to a specific revision on this
4981
brz missing --my-revision ..-10
4984
_see_also = ['merge', 'pull']
4985
takes_args = ['other_branch?']
4988
Option('reverse', 'Reverse the order of revisions.'),
4990
'Display changes in the local branch only.'),
4991
Option('this', 'Same as --mine-only.'),
4992
Option('theirs-only',
4993
'Display changes in the remote branch only.'),
4994
Option('other', 'Same as --theirs-only.'),
4998
custom_help('revision',
4999
help='Filter on other branch revisions (inclusive). '
5000
'See "help revisionspec" for details.'),
5001
Option('my-revision',
5002
type=_parse_revision_str,
5003
help='Filter on local branch revisions (inclusive). '
5004
'See "help revisionspec" for details.'),
5005
Option('include-merged',
5006
'Show all revisions in addition to the mainline ones.'),
5007
Option('include-merges', hidden=True,
5008
help='Historical alias for --include-merged.'),
5010
encoding_type = 'replace'
5013
def run(self, other_branch=None, reverse=False, mine_only=False,
5015
log_format=None, long=False, short=False, line=False,
5016
show_ids=False, verbose=False, this=False, other=False,
5017
include_merged=None, revision=None, my_revision=None,
5019
from breezy.missing import find_unmerged, iter_log_revisions
5025
if include_merged is None:
5026
include_merged = False
5031
# TODO: We should probably check that we don't have mine-only and
5032
# theirs-only set, but it gets complicated because we also have
5033
# this and other which could be used.
5040
local_branch = Branch.open_containing(directory)[0]
5041
self.add_cleanup(local_branch.lock_read().unlock)
5043
parent = local_branch.get_parent()
5044
if other_branch is None:
5045
other_branch = parent
5046
if other_branch is None:
5047
raise errors.BzrCommandError(gettext("No peer location known"
5049
display_url = urlutils.unescape_for_display(parent,
5051
message(gettext("Using saved parent location: {0}\n").format(
5054
remote_branch = Branch.open(other_branch)
5055
if remote_branch.base == local_branch.base:
5056
remote_branch = local_branch
5058
self.add_cleanup(remote_branch.lock_read().unlock)
5060
local_revid_range = _revision_range_to_revid_range(
5061
_get_revision_range(my_revision, local_branch,
5064
remote_revid_range = _revision_range_to_revid_range(
5065
_get_revision_range(revision,
5066
remote_branch, self.name()))
5068
local_extra, remote_extra = find_unmerged(
5069
local_branch, remote_branch, restrict,
5070
backward=not reverse,
5071
include_merged=include_merged,
5072
local_revid_range=local_revid_range,
5073
remote_revid_range=remote_revid_range)
5075
if log_format is None:
5076
registry = log.log_formatter_registry
5077
log_format = registry.get_default(local_branch)
5078
lf = log_format(to_file=self.outf,
5080
show_timezone='original')
5083
if local_extra and not theirs_only:
5084
message(ngettext("You have %d extra revision:\n",
5085
"You have %d extra revisions:\n",
5089
if local_branch.supports_tags():
5090
rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
5091
for revision in iter_log_revisions(local_extra,
5092
local_branch.repository,
5095
lf.log_revision(revision)
5096
printed_local = True
5099
printed_local = False
5101
if remote_extra and not mine_only:
5102
if printed_local is True:
5104
message(ngettext("You are missing %d revision:\n",
5105
"You are missing %d revisions:\n",
5106
len(remote_extra)) %
5108
if remote_branch.supports_tags():
5109
rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
5110
for revision in iter_log_revisions(remote_extra,
5111
remote_branch.repository,
5114
lf.log_revision(revision)
5117
if mine_only and not local_extra:
5118
# We checked local, and found nothing extra
5119
message(gettext('This branch has no new revisions.\n'))
5120
elif theirs_only and not remote_extra:
5121
# We checked remote, and found nothing extra
5122
message(gettext('Other branch has no new revisions.\n'))
5123
elif not (mine_only or theirs_only or local_extra or
5125
# We checked both branches, and neither one had extra
5127
message(gettext("Branches are up to date.\n"))
5129
if not status_code and parent is None and other_branch is not None:
5130
self.add_cleanup(local_branch.lock_write().unlock)
5131
# handle race conditions - a parent might be set while we run.
5132
if local_branch.get_parent() is None:
5133
local_branch.set_parent(remote_branch.base)
5137
class cmd_pack(Command):
5138
__doc__ = """Compress the data within a repository.
5140
This operation compresses the data within a bazaar repository. As
5141
bazaar supports automatic packing of repository, this operation is
5142
normally not required to be done manually.
5144
During the pack operation, bazaar takes a backup of existing repository
5145
data, i.e. pack files. This backup is eventually removed by bazaar
5146
automatically when it is safe to do so. To save disk space by removing
5147
the backed up pack files, the --clean-obsolete-packs option may be
5150
Warning: If you use --clean-obsolete-packs and your machine crashes
5151
during or immediately after repacking, you may be left with a state
5152
where the deletion has been written to disk but the new packs have not
5153
been. In this case the repository may be unusable.
5156
_see_also = ['repositories']
5157
takes_args = ['branch_or_repo?']
5159
Option('clean-obsolete-packs',
5160
'Delete obsolete packs to save disk space.'),
5163
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
5164
dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
5166
branch = dir.open_branch()
5167
repository = branch.repository
5168
except errors.NotBranchError:
5169
repository = dir.open_repository()
5170
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
5173
class cmd_plugins(Command):
5174
__doc__ = """List the installed plugins.
5176
This command displays the list of installed plugins including
5177
version of plugin and a short description of each.
5179
--verbose shows the path where each plugin is located.
5181
A plugin is an external component for Bazaar that extends the
5182
revision control system, by adding or replacing code in Bazaar.
5183
Plugins can do a variety of things, including overriding commands,
5184
adding new commands, providing additional network transports and
5185
customizing log output.
5187
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
5188
for further information on plugins including where to find them and how to
5189
install them. Instructions are also provided there on how to write new
5190
plugins using the Python programming language.
5192
takes_options = ['verbose']
5195
def run(self, verbose=False):
5196
from . import plugin
5197
# Don't give writelines a generator as some codecs don't like that
5198
self.outf.writelines(
5199
list(plugin.describe_plugins(show_paths=verbose)))
5202
class cmd_testament(Command):
5203
__doc__ = """Show testament (signing-form) of a revision."""
5206
Option('long', help='Produce long-format testament.'),
5208
help='Produce a strict-format testament.')]
5209
takes_args = ['branch?']
5210
encoding_type = 'exact'
5213
def run(self, branch=u'.', revision=None, long=False, strict=False):
5214
from .testament import Testament, StrictTestament
5216
testament_class = StrictTestament
5218
testament_class = Testament
5220
b = Branch.open_containing(branch)[0]
5222
b = Branch.open(branch)
5223
self.add_cleanup(b.lock_read().unlock)
5224
if revision is None:
5225
rev_id = b.last_revision()
5227
rev_id = revision[0].as_revision_id(b)
5228
t = testament_class.from_revision(b.repository, rev_id)
5230
self.outf.writelines(t.as_text_lines())
5232
self.outf.write(t.as_short_text())
5235
class cmd_annotate(Command):
5236
__doc__ = """Show the origin of each line in a file.
5238
This prints out the given file with an annotation on the left side
5239
indicating which revision, author and date introduced the change.
5241
If the origin is the same for a run of consecutive lines, it is
5242
shown only at the top, unless the --all option is given.
5244
# TODO: annotate directories; showing when each file was last changed
5245
# TODO: if the working copy is modified, show annotations on that
5246
# with new uncommitted lines marked
5247
aliases = ['ann', 'blame', 'praise']
5248
takes_args = ['filename']
5249
takes_options = [Option('all', help='Show annotations on all lines.'),
5250
Option('long', help='Show commit date in annotations.'),
5255
encoding_type = 'exact'
5258
def run(self, filename, all=False, long=False, revision=None,
5259
show_ids=False, directory=None):
5260
from .annotate import (
5263
wt, branch, relpath = \
5264
_open_directory_or_containing_tree_or_branch(filename, directory)
5266
self.add_cleanup(wt.lock_read().unlock)
5268
self.add_cleanup(branch.lock_read().unlock)
5269
tree = _get_one_revision_tree('annotate', revision, branch=branch)
5270
self.add_cleanup(tree.lock_read().unlock)
5271
if wt is not None and revision is None:
5272
file_id = wt.path2id(relpath)
5274
file_id = tree.path2id(relpath)
5276
raise errors.NotVersionedError(filename)
5277
if wt is not None and revision is None:
5278
# If there is a tree and we're not annotating historical
5279
# versions, annotate the working tree's content.
5280
annotate_file_tree(wt, relpath, self.outf, long, all,
5283
annotate_file_tree(tree, relpath, self.outf, long, all,
5284
show_ids=show_ids, branch=branch)
5287
class cmd_re_sign(Command):
5288
__doc__ = """Create a digital signature for an existing revision."""
5289
# TODO be able to replace existing ones.
5291
hidden = True # is this right ?
5292
takes_args = ['revision_id*']
5293
takes_options = ['directory', 'revision']
5295
def run(self, revision_id_list=None, revision=None, directory=u'.'):
5296
if revision_id_list is not None and revision is not None:
5297
raise errors.BzrCommandError(
5298
gettext('You can only supply one of revision_id or --revision'))
5299
if revision_id_list is None and revision is None:
5300
raise errors.BzrCommandError(
5301
gettext('You must supply either --revision or a revision_id'))
5302
b = WorkingTree.open_containing(directory)[0].branch
5303
self.add_cleanup(b.lock_write().unlock)
5304
return self._run(b, revision_id_list, revision)
5306
def _run(self, b, revision_id_list, revision):
5307
gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
5308
if revision_id_list is not None:
5309
b.repository.start_write_group()
5311
for revision_id in revision_id_list:
5312
revision_id = cache_utf8.encode(revision_id)
5313
b.repository.sign_revision(revision_id, gpg_strategy)
5314
except BaseException:
5315
b.repository.abort_write_group()
5318
b.repository.commit_write_group()
5319
elif revision is not None:
5320
if len(revision) == 1:
5321
revno, rev_id = revision[0].in_history(b)
5322
b.repository.start_write_group()
5324
b.repository.sign_revision(rev_id, gpg_strategy)
5325
except BaseException:
5326
b.repository.abort_write_group()
5329
b.repository.commit_write_group()
5330
elif len(revision) == 2:
5331
# are they both on rh- if so we can walk between them
5332
# might be nice to have a range helper for arbitrary
5333
# revision paths. hmm.
5334
from_revno, from_revid = revision[0].in_history(b)
5335
to_revno, to_revid = revision[1].in_history(b)
5336
if to_revid is None:
5337
to_revno = b.revno()
5338
if from_revno is None or to_revno is None:
5339
raise errors.BzrCommandError(
5340
gettext('Cannot sign a range of non-revision-history revisions'))
5341
b.repository.start_write_group()
5343
for revno in range(from_revno, to_revno + 1):
5344
b.repository.sign_revision(b.get_rev_id(revno),
5346
except BaseException:
5347
b.repository.abort_write_group()
5350
b.repository.commit_write_group()
5352
raise errors.BzrCommandError(
5353
gettext('Please supply either one revision, or a range.'))
5356
class cmd_bind(Command):
5357
__doc__ = """Convert the current branch into a checkout of the supplied branch.
5358
If no branch is supplied, rebind to the last bound location.
5360
Once converted into a checkout, commits must succeed on the master branch
5361
before they will be applied to the local branch.
5363
Bound branches use the nickname of its master branch unless it is set
5364
locally, in which case binding will update the local nickname to be
5368
_see_also = ['checkouts', 'unbind']
5369
takes_args = ['location?']
5370
takes_options = ['directory']
5372
def run(self, location=None, directory=u'.'):
5373
b, relpath = Branch.open_containing(directory)
5374
if location is None:
5376
location = b.get_old_bound_location()
5377
except errors.UpgradeRequired:
5378
raise errors.BzrCommandError(
5379
gettext('No location supplied. '
5380
'This format does not remember old locations.'))
5382
if location is None:
5383
if b.get_bound_location() is not None:
5384
raise errors.BzrCommandError(
5385
gettext('Branch is already bound'))
5387
raise errors.BzrCommandError(
5388
gettext('No location supplied'
5389
' and no previous location known'))
5390
b_other = Branch.open(location)
5393
except errors.DivergedBranches:
5394
raise errors.BzrCommandError(
5395
gettext('These branches have diverged.'
5396
' Try merging, and then bind again.'))
5397
if b.get_config().has_explicit_nickname():
5398
b.nick = b_other.nick
5401
class cmd_unbind(Command):
5402
__doc__ = """Convert the current checkout into a regular branch.
5404
After unbinding, the local branch is considered independent and subsequent
5405
commits will be local only.
5408
_see_also = ['checkouts', 'bind']
5410
takes_options = ['directory']
5412
def run(self, directory=u'.'):
5413
b, relpath = Branch.open_containing(directory)
5415
raise errors.BzrCommandError(gettext('Local branch is not bound'))
5418
class cmd_uncommit(Command):
5419
__doc__ = """Remove the last committed revision.
5421
--verbose will print out what is being removed.
5422
--dry-run will go through all the motions, but not actually
5425
If --revision is specified, uncommit revisions to leave the branch at the
5426
specified revision. For example, "brz uncommit -r 15" will leave the
5427
branch at revision 15.
5429
Uncommit leaves the working tree ready for a new commit. The only change
5430
it may make is to restore any pending merges that were present before
5434
# TODO: jam 20060108 Add an option to allow uncommit to remove
5435
# unreferenced information in 'branch-as-repository' branches.
5436
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
5437
# information in shared branches as well.
5438
_see_also = ['commit']
5439
takes_options = ['verbose', 'revision',
5440
Option('dry-run', help='Don\'t actually make changes.'),
5441
Option('force', help='Say yes to all questions.'),
5443
help='Keep tags that point to removed revisions.'),
5445
help="Only remove the commits from the local "
5446
"branch when in a checkout."
5449
takes_args = ['location?']
5451
encoding_type = 'replace'
5453
def run(self, location=None, dry_run=False, verbose=False,
5454
revision=None, force=False, local=False, keep_tags=False):
5455
if location is None:
5457
control, relpath = controldir.ControlDir.open_containing(location)
5459
tree = control.open_workingtree()
5461
except (errors.NoWorkingTree, errors.NotLocalUrl):
5463
b = control.open_branch()
5465
if tree is not None:
5466
self.add_cleanup(tree.lock_write().unlock)
5468
self.add_cleanup(b.lock_write().unlock)
5469
return self._run(b, tree, dry_run, verbose, revision, force,
5472
def _run(self, b, tree, dry_run, verbose, revision, force, local,
5474
from .log import log_formatter, show_log
5475
from .uncommit import uncommit
5477
last_revno, last_rev_id = b.last_revision_info()
5480
if revision is None:
5482
rev_id = last_rev_id
5484
# 'brz uncommit -r 10' actually means uncommit
5485
# so that the final tree is at revno 10.
5486
# but breezy.uncommit.uncommit() actually uncommits
5487
# the revisions that are supplied.
5488
# So we need to offset it by one
5489
revno = revision[0].in_history(b).revno + 1
5490
if revno <= last_revno:
5491
rev_id = b.get_rev_id(revno)
5493
if rev_id is None or _mod_revision.is_null(rev_id):
5494
self.outf.write(gettext('No revisions to uncommit.\n'))
5497
lf = log_formatter('short',
5499
show_timezone='original')
5504
direction='forward',
5505
start_revision=revno,
5506
end_revision=last_revno)
5509
self.outf.write(gettext('Dry-run, pretending to remove'
5510
' the above revisions.\n'))
5513
gettext('The above revision(s) will be removed.\n'))
5516
if not ui.ui_factory.confirm_action(
5517
gettext(u'Uncommit these revisions'),
5518
'breezy.builtins.uncommit',
5520
self.outf.write(gettext('Canceled\n'))
5523
mutter('Uncommitting from {%s} to {%s}',
5524
last_rev_id, rev_id)
5525
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5526
revno=revno, local=local, keep_tags=keep_tags)
5528
gettext('You can restore the old tip by running:\n'
5529
' brz pull . -r revid:%s\n')
5530
% last_rev_id.decode('utf-8'))
5533
class cmd_break_lock(Command):
5534
__doc__ = """Break a dead lock.
5536
This command breaks a lock on a repository, branch, working directory or
5539
CAUTION: Locks should only be broken when you are sure that the process
5540
holding the lock has been stopped.
5542
You can get information on what locks are open via the 'brz info
5543
[location]' command.
5547
brz break-lock brz+ssh://example.com/brz/foo
5548
brz break-lock --conf ~/.bazaar
5551
takes_args = ['location?']
5554
help='LOCATION is the directory where the config lock is.'),
5556
help='Do not ask for confirmation before breaking the lock.'),
5559
def run(self, location=None, config=False, force=False):
5560
if location is None:
5563
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5565
{'breezy.lockdir.break': True})
5567
conf = _mod_config.LockableConfig(file_name=location)
5570
control, relpath = controldir.ControlDir.open_containing(location)
5572
control.break_lock()
5573
except NotImplementedError:
5577
class cmd_wait_until_signalled(Command):
5578
__doc__ = """Test helper for test_start_and_stop_brz_subprocess_send_signal.
5580
This just prints a line to signal when it is ready, then blocks on stdin.
5586
self.outf.write("running\n")
5588
sys.stdin.readline()
5591
class cmd_serve(Command):
5592
__doc__ = """Run the brz server."""
5594
aliases = ['server']
5598
help='Serve on stdin/out for use from inetd or sshd.'),
5599
RegistryOption('protocol',
5600
help="Protocol to serve.",
5601
lazy_registry=('breezy.transport',
5602
'transport_server_registry'),
5603
value_switches=True),
5605
help='Listen for connections on nominated address.',
5608
help='Listen for connections on nominated port. Passing 0 as '
5609
'the port number will result in a dynamically allocated '
5610
'port. The default port depends on the protocol.',
5612
custom_help('directory',
5613
help='Serve contents of this directory.'),
5614
Option('allow-writes',
5615
help='By default the server is a readonly server. Supplying '
5616
'--allow-writes enables write access to the contents of '
5617
'the served directory and below. Note that ``brz serve`` '
5618
'does not perform authentication, so unless some form of '
5619
'external authentication is arranged supplying this '
5620
'option leads to global uncontrolled write access to your '
5623
Option('client-timeout', type=float,
5624
help='Override the default idle client timeout (5min).'),
5627
def run(self, listen=None, port=None, inet=False, directory=None,
5628
allow_writes=False, protocol=None, client_timeout=None):
5629
from . import transport
5630
if directory is None:
5631
directory = osutils.getcwd()
5632
if protocol is None:
5633
protocol = transport.transport_server_registry.get()
5634
url = transport.location_to_url(directory)
5635
if not allow_writes:
5636
url = 'readonly+' + url
5637
t = transport.get_transport_from_url(url)
5638
protocol(t, listen, port, inet, client_timeout)
5641
class cmd_join(Command):
5642
__doc__ = """Combine a tree into its containing tree.
5644
This command requires the target tree to be in a rich-root format.
5646
The TREE argument should be an independent tree, inside another tree, but
5647
not part of it. (Such trees can be produced by "brz split", but also by
5648
running "brz branch" with the target inside a tree.)
5650
The result is a combined tree, with the subtree no longer an independent
5651
part. This is marked as a merge of the subtree into the containing tree,
5652
and all history is preserved.
5655
_see_also = ['split']
5656
takes_args = ['tree']
5658
Option('reference', help='Join by reference.', hidden=True),
5661
def run(self, tree, reference=False):
5662
from breezy.mutabletree import BadReferenceTarget
5663
sub_tree = WorkingTree.open(tree)
5664
parent_dir = osutils.dirname(sub_tree.basedir)
5665
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5666
repo = containing_tree.branch.repository
5667
if not repo.supports_rich_root():
5668
raise errors.BzrCommandError(gettext(
5669
"Can't join trees because %s doesn't support rich root data.\n"
5670
"You can use brz upgrade on the repository.")
5674
containing_tree.add_reference(sub_tree)
5675
except BadReferenceTarget as e:
5676
# XXX: Would be better to just raise a nicely printable
5677
# exception from the real origin. Also below. mbp 20070306
5678
raise errors.BzrCommandError(
5679
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5682
containing_tree.subsume(sub_tree)
5683
except errors.BadSubsumeSource as e:
5684
raise errors.BzrCommandError(
5685
gettext("Cannot join {0}. {1}").format(tree, e.reason))
5688
class cmd_split(Command):
5689
__doc__ = """Split a subdirectory of a tree into a separate tree.
5691
This command will produce a target tree in a format that supports
5692
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5693
converted into earlier formats like 'dirstate-tags'.
5695
The TREE argument should be a subdirectory of a working tree. That
5696
subdirectory will be converted into an independent tree, with its own
5697
branch. Commits in the top-level tree will not apply to the new subtree.
5700
_see_also = ['join']
5701
takes_args = ['tree']
5703
def run(self, tree):
5704
containing_tree, subdir = WorkingTree.open_containing(tree)
5705
if not containing_tree.is_versioned(subdir):
5706
raise errors.NotVersionedError(subdir)
5708
containing_tree.extract(subdir)
5709
except errors.RootNotRich:
5710
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5713
class cmd_merge_directive(Command):
5714
__doc__ = """Generate a merge directive for auto-merge tools.
5716
A directive requests a merge to be performed, and also provides all the
5717
information necessary to do so. This means it must either include a
5718
revision bundle, or the location of a branch containing the desired
5721
A submit branch (the location to merge into) must be supplied the first
5722
time the command is issued. After it has been supplied once, it will
5723
be remembered as the default.
5725
A public branch is optional if a revision bundle is supplied, but required
5726
if --diff or --plain is specified. It will be remembered as the default
5727
after the first use.
5730
takes_args = ['submit_branch?', 'public_branch?']
5734
_see_also = ['send']
5738
RegistryOption.from_kwargs(
5740
'The type of patch to include in the directive.',
5742
value_switches=True,
5744
bundle='Bazaar revision bundle (default).',
5745
diff='Normal unified diff.',
5746
plain='No patch, just directive.'),
5747
Option('sign', help='GPG-sign the directive.'), 'revision',
5748
Option('mail-to', type=text_type,
5749
help='Instead of printing the directive, email to this '
5751
Option('message', type=text_type, short_name='m',
5752
help='Message to use when committing this merge.')
5755
encoding_type = 'exact'
5757
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5758
sign=False, revision=None, mail_to=None, message=None,
5760
from .revision import ensure_null, NULL_REVISION
5761
include_patch, include_bundle = {
5762
'plain': (False, False),
5763
'diff': (True, False),
5764
'bundle': (True, True),
5766
branch = Branch.open(directory)
5767
stored_submit_branch = branch.get_submit_branch()
5768
if submit_branch is None:
5769
submit_branch = stored_submit_branch
5771
if stored_submit_branch is None:
5772
branch.set_submit_branch(submit_branch)
5773
if submit_branch is None:
5774
submit_branch = branch.get_parent()
5775
if submit_branch is None:
5776
raise errors.BzrCommandError(
5777
gettext('No submit branch specified or known'))
5779
stored_public_branch = branch.get_public_branch()
5780
if public_branch is None:
5781
public_branch = stored_public_branch
5782
elif stored_public_branch is None:
5783
# FIXME: Should be done only if we succeed ? -- vila 2012-01-03
5784
branch.set_public_branch(public_branch)
5785
if not include_bundle and public_branch is None:
5786
raise errors.BzrCommandError(
5787
gettext('No public branch specified or known'))
5788
base_revision_id = None
5789
if revision is not None:
5790
if len(revision) > 2:
5791
raise errors.BzrCommandError(
5792
gettext('brz merge-directive takes '
5793
'at most two one revision identifiers'))
5794
revision_id = revision[-1].as_revision_id(branch)
5795
if len(revision) == 2:
5796
base_revision_id = revision[0].as_revision_id(branch)
5798
revision_id = branch.last_revision()
5799
revision_id = ensure_null(revision_id)
5800
if revision_id == NULL_REVISION:
5801
raise errors.BzrCommandError(gettext('No revisions to bundle.'))
5802
directive = merge_directive.MergeDirective2.from_objects(
5803
branch.repository, revision_id, time.time(),
5804
osutils.local_time_offset(), submit_branch,
5805
public_branch=public_branch, include_patch=include_patch,
5806
include_bundle=include_bundle, message=message,
5807
base_revision_id=base_revision_id)
5810
self.outf.write(directive.to_signed(branch))
5812
self.outf.writelines(directive.to_lines())
5814
message = directive.to_email(mail_to, branch, sign)
5815
s = SMTPConnection(branch.get_config_stack())
5816
s.send_email(message)
5819
class cmd_send(Command):
5820
__doc__ = """Mail or create a merge-directive for submitting changes.
5822
A merge directive provides many things needed for requesting merges:
5824
* A machine-readable description of the merge to perform
5826
* An optional patch that is a preview of the changes requested
5828
* An optional bundle of revision data, so that the changes can be applied
5829
directly from the merge directive, without retrieving data from a
5832
`brz send` creates a compact data set that, when applied using brz
5833
merge, has the same effect as merging from the source branch.
5835
By default the merge directive is self-contained and can be applied to any
5836
branch containing submit_branch in its ancestory without needing access to
5839
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5840
revisions, but only a structured request to merge from the
5841
public_location. In that case the public_branch is needed and it must be
5842
up-to-date and accessible to the recipient. The public_branch is always
5843
included if known, so that people can check it later.
5845
The submit branch defaults to the parent of the source branch, but can be
5846
overridden. Both submit branch and public branch will be remembered in
5847
branch.conf the first time they are used for a particular branch. The
5848
source branch defaults to that containing the working directory, but can
5849
be changed using --from.
5851
Both the submit branch and the public branch follow the usual behavior with
5852
respect to --remember: If there is no default location set, the first send
5853
will set it (use --no-remember to avoid setting it). After that, you can
5854
omit the location to use the default. To change the default, use
5855
--remember. The value will only be saved if the location can be accessed.
5857
In order to calculate those changes, brz must analyse the submit branch.
5858
Therefore it is most efficient for the submit branch to be a local mirror.
5859
If a public location is known for the submit_branch, that location is used
5860
in the merge directive.
5862
The default behaviour is to send the merge directive by mail, unless -o is
5863
given, in which case it is sent to a file.
5865
Mail is sent using your preferred mail program. This should be transparent
5866
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5867
If the preferred client can't be found (or used), your editor will be used.
5869
To use a specific mail program, set the mail_client configuration option.
5870
Supported values for specific clients are "claws", "evolution", "kmail",
5871
"mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options
5872
are "default", "editor", "emacsclient", "mapi", and "xdg-email". Plugins
5873
may also add supported clients.
5875
If mail is being sent, a to address is required. This can be supplied
5876
either on the commandline, by setting the submit_to configuration
5877
option in the branch itself or the child_submit_to configuration option
5878
in the submit branch.
5880
The merge directives created by brz send may be applied using brz merge or
5881
brz pull by specifying a file containing a merge directive as the location.
5883
brz send makes extensive use of public locations to map local locations into
5884
URLs that can be used by other people. See `brz help configuration` to
5885
set them, and use `brz info` to display them.
5888
encoding_type = 'exact'
5890
_see_also = ['merge', 'pull']
5892
takes_args = ['submit_branch?', 'public_branch?']
5896
help='Do not include a bundle in the merge directive.'),
5897
Option('no-patch', help='Do not include a preview patch in the merge'
5900
help='Remember submit and public branch.'),
5902
help='Branch to generate the submission from, '
5903
'rather than the one containing the working directory.',
5906
Option('output', short_name='o',
5907
help='Write merge directive to this file or directory; '
5908
'use - for stdout.',
5911
help='Refuse to send if there are uncommitted changes in'
5912
' the working tree, --no-strict disables the check.'),
5913
Option('mail-to', help='Mail the request to this address.',
5917
Option('body', help='Body for the email.', type=text_type),
5918
RegistryOption('format',
5919
help='Use the specified output format.',
5920
lazy_registry=('breezy.send', 'format_registry')),
5923
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5924
no_patch=False, revision=None, remember=None, output=None,
5925
format=None, mail_to=None, message=None, body=None,
5926
strict=None, **kwargs):
5927
from .send import send
5928
return send(submit_branch, revision, public_branch, remember,
5929
format, no_bundle, no_patch, output,
5930
kwargs.get('from', '.'), mail_to, message, body,
5935
class cmd_bundle_revisions(cmd_send):
5936
__doc__ = """Create a merge-directive for submitting changes.
5938
A merge directive provides many things needed for requesting merges:
5940
* A machine-readable description of the merge to perform
5942
* An optional patch that is a preview of the changes requested
5944
* An optional bundle of revision data, so that the changes can be applied
5945
directly from the merge directive, without retrieving data from a
5948
If --no-bundle is specified, then public_branch is needed (and must be
5949
up-to-date), so that the receiver can perform the merge using the
5950
public_branch. The public_branch is always included if known, so that
5951
people can check it later.
5953
The submit branch defaults to the parent, but can be overridden. Both
5954
submit branch and public branch will be remembered if supplied.
5956
If a public_branch is known for the submit_branch, that public submit
5957
branch is used in the merge instructions. This means that a local mirror
5958
can be used as your actual submit branch, once you have set public_branch
5964
help='Do not include a bundle in the merge directive.'),
5965
Option('no-patch', help='Do not include a preview patch in the merge'
5968
help='Remember submit and public branch.'),
5970
help='Branch to generate the submission from, '
5971
'rather than the one containing the working directory.',
5974
Option('output', short_name='o', help='Write directive to this file.',
5977
help='Refuse to bundle revisions if there are uncommitted'
5978
' changes in the working tree, --no-strict disables the check.'),
5980
RegistryOption('format',
5981
help='Use the specified output format.',
5982
lazy_registry=('breezy.send', 'format_registry')),
5984
aliases = ['bundle']
5986
_see_also = ['send', 'merge']
5990
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5991
no_patch=False, revision=None, remember=False, output=None,
5992
format=None, strict=None, **kwargs):
5995
from .send import send
5996
return send(submit_branch, revision, public_branch, remember,
5997
format, no_bundle, no_patch, output,
5998
kwargs.get('from', '.'), None, None, None,
5999
self.outf, strict=strict)
6002
class cmd_tag(Command):
6003
__doc__ = """Create, remove or modify a tag naming a revision.
6005
Tags give human-meaningful names to revisions. Commands that take a -r
6006
(--revision) option can be given -rtag:X, where X is any previously
6009
Tags are stored in the branch. Tags are copied from one branch to another
6010
along when you branch, push, pull or merge.
6012
It is an error to give a tag name that already exists unless you pass
6013
--force, in which case the tag is moved to point to the new revision.
6015
To rename a tag (change the name but keep it on the same revsion), run ``brz
6016
tag new-name -r tag:old-name`` and then ``brz tag --delete oldname``.
6018
If no tag name is specified it will be determined through the
6019
'automatic_tag_name' hook. This can e.g. be used to automatically tag
6020
upstream releases by reading configure.ac. See ``brz help hooks`` for
6024
_see_also = ['commit', 'tags']
6025
takes_args = ['tag_name?']
6028
help='Delete this tag rather than placing it.',
6030
custom_help('directory',
6031
help='Branch in which to place the tag.'),
6033
help='Replace existing tags.',
6038
def run(self, tag_name=None,
6044
branch, relpath = Branch.open_containing(directory)
6045
self.add_cleanup(branch.lock_write().unlock)
6047
if tag_name is None:
6048
raise errors.BzrCommandError(
6049
gettext("No tag specified to delete."))
6050
branch.tags.delete_tag(tag_name)
6051
note(gettext('Deleted tag %s.') % tag_name)
6054
if len(revision) != 1:
6055
raise errors.BzrCommandError(gettext(
6056
"Tags can only be placed on a single revision, "
6058
revision_id = revision[0].as_revision_id(branch)
6060
revision_id = branch.last_revision()
6061
if tag_name is None:
6062
tag_name = branch.automatic_tag_name(revision_id)
6063
if tag_name is None:
6064
raise errors.BzrCommandError(gettext(
6065
"Please specify a tag name."))
6067
existing_target = branch.tags.lookup_tag(tag_name)
6068
except errors.NoSuchTag:
6069
existing_target = None
6070
if not force and existing_target not in (None, revision_id):
6071
raise errors.TagAlreadyExists(tag_name)
6072
if existing_target == revision_id:
6073
note(gettext('Tag %s already exists for that revision.') % tag_name)
6075
branch.tags.set_tag(tag_name, revision_id)
6076
if existing_target is None:
6077
note(gettext('Created tag %s.') % tag_name)
6079
note(gettext('Updated tag %s.') % tag_name)
6082
class cmd_tags(Command):
6083
__doc__ = """List tags.
6085
This command shows a table of tag names and the revisions they reference.
6090
custom_help('directory',
6091
help='Branch whose tags should be displayed.'),
6092
RegistryOption('sort',
6093
'Sort tags by different criteria.', title='Sorting',
6094
lazy_registry=('breezy.tag', 'tag_sort_methods')
6101
def run(self, directory='.', sort=None, show_ids=False, revision=None):
6102
from .tag import tag_sort_methods
6103
branch, relpath = Branch.open_containing(directory)
6105
tags = list(viewitems(branch.tags.get_tag_dict()))
6109
self.add_cleanup(branch.lock_read().unlock)
6111
# Restrict to the specified range
6112
tags = self._tags_for_range(branch, revision)
6114
sort = tag_sort_methods.get()
6117
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
6118
for index, (tag, revid) in enumerate(tags):
6120
revno = branch.revision_id_to_dotted_revno(revid)
6121
if isinstance(revno, tuple):
6122
revno = '.'.join(map(str, revno))
6123
except (errors.NoSuchRevision,
6124
errors.GhostRevisionsHaveNoRevno,
6125
errors.UnsupportedOperation):
6126
# Bad tag data/merges can lead to tagged revisions
6127
# which are not in this branch. Fail gracefully ...
6129
tags[index] = (tag, revno)
6131
tags = [(tag, revid.decode('utf-8')) for (tag, revid) in tags]
6133
for tag, revspec in tags:
6134
self.outf.write('%-20s %s\n' % (tag, revspec))
6136
def _tags_for_range(self, branch, revision):
6137
rev1, rev2 = _get_revision_range(revision, branch, self.name())
6138
revid1, revid2 = rev1.rev_id, rev2.rev_id
6139
# _get_revision_range will always set revid2 if it's not specified.
6140
# If revid1 is None, it means we want to start from the branch
6141
# origin which is always a valid ancestor. If revid1 == revid2, the
6142
# ancestry check is useless.
6143
if revid1 and revid1 != revid2:
6144
# FIXME: We really want to use the same graph than
6145
# branch.iter_merge_sorted_revisions below, but this is not
6146
# easily available -- vila 2011-09-23
6147
if branch.repository.get_graph().is_ancestor(revid2, revid1):
6148
# We don't want to output anything in this case...
6150
# only show revisions between revid1 and revid2 (inclusive)
6151
tagged_revids = branch.tags.get_reverse_tag_dict()
6153
for r in branch.iter_merge_sorted_revisions(
6154
start_revision_id=revid2, stop_revision_id=revid1,
6155
stop_rule='include'):
6156
revid_tags = tagged_revids.get(r[0], None)
6158
found.extend([(tag, r[0]) for tag in revid_tags])
6162
class cmd_reconfigure(Command):
6163
__doc__ = """Reconfigure the type of a brz directory.
6165
A target configuration must be specified.
6167
For checkouts, the bind-to location will be auto-detected if not specified.
6168
The order of preference is
6169
1. For a lightweight checkout, the current bound location.
6170
2. For branches that used to be checkouts, the previously-bound location.
6171
3. The push location.
6172
4. The parent location.
6173
If none of these is available, --bind-to must be specified.
6176
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
6177
takes_args = ['location?']
6179
RegistryOption.from_kwargs(
6182
help='The relation between branch and tree.',
6183
value_switches=True, enum_switch=False,
6184
branch='Reconfigure to be an unbound branch with no working tree.',
6185
tree='Reconfigure to be an unbound branch with a working tree.',
6186
checkout='Reconfigure to be a bound branch with a working tree.',
6187
lightweight_checkout='Reconfigure to be a lightweight'
6188
' checkout (with no local history).',
6190
RegistryOption.from_kwargs(
6192
title='Repository type',
6193
help='Location fo the repository.',
6194
value_switches=True, enum_switch=False,
6195
standalone='Reconfigure to be a standalone branch '
6196
'(i.e. stop using shared repository).',
6197
use_shared='Reconfigure to use a shared repository.',
6199
RegistryOption.from_kwargs(
6201
title='Trees in Repository',
6202
help='Whether new branches in the repository have trees.',
6203
value_switches=True, enum_switch=False,
6204
with_trees='Reconfigure repository to create '
6205
'working trees on branches by default.',
6206
with_no_trees='Reconfigure repository to not create '
6207
'working trees on branches by default.'
6209
Option('bind-to', help='Branch to bind checkout to.', type=text_type),
6211
help='Perform reconfiguration even if local changes'
6213
Option('stacked-on',
6214
help='Reconfigure a branch to be stacked on another branch.',
6218
help='Reconfigure a branch to be unstacked. This '
6219
'may require copying substantial data into it.',
6223
def run(self, location=None, bind_to=None, force=False,
6224
tree_type=None, repository_type=None, repository_trees=None,
6225
stacked_on=None, unstacked=None):
6226
directory = controldir.ControlDir.open(location)
6227
if stacked_on and unstacked:
6228
raise errors.BzrCommandError(
6229
gettext("Can't use both --stacked-on and --unstacked"))
6230
elif stacked_on is not None:
6231
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
6233
reconfigure.ReconfigureUnstacked().apply(directory)
6234
# At the moment you can use --stacked-on and a different
6235
# reconfiguration shape at the same time; there seems no good reason
6237
if (tree_type is None and
6238
repository_type is None and
6239
repository_trees is None):
6240
if stacked_on or unstacked:
6243
raise errors.BzrCommandError(gettext('No target configuration '
6245
reconfiguration = None
6246
if tree_type == 'branch':
6247
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
6248
elif tree_type == 'tree':
6249
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
6250
elif tree_type == 'checkout':
6251
reconfiguration = reconfigure.Reconfigure.to_checkout(
6253
elif tree_type == 'lightweight-checkout':
6254
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
6257
reconfiguration.apply(force)
6258
reconfiguration = None
6259
if repository_type == 'use-shared':
6260
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
6261
elif repository_type == 'standalone':
6262
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
6264
reconfiguration.apply(force)
6265
reconfiguration = None
6266
if repository_trees == 'with-trees':
6267
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6269
elif repository_trees == 'with-no-trees':
6270
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
6273
reconfiguration.apply(force)
6274
reconfiguration = None
6277
class cmd_switch(Command):
6278
__doc__ = """Set the branch of a checkout and update.
6280
For lightweight checkouts, this changes the branch being referenced.
6281
For heavyweight checkouts, this checks that there are no local commits
6282
versus the current bound branch, then it makes the local branch a mirror
6283
of the new location and binds to it.
6285
In both cases, the working tree is updated and uncommitted changes
6286
are merged. The user can commit or revert these as they desire.
6288
Pending merges need to be committed or reverted before using switch.
6290
The path to the branch to switch to can be specified relative to the parent
6291
directory of the current branch. For example, if you are currently in a
6292
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
6295
Bound branches use the nickname of its master branch unless it is set
6296
locally, in which case switching will update the local nickname to be
6300
takes_args = ['to_location?']
6301
takes_options = ['directory',
6303
help='Switch even if local commits will be lost.'),
6305
Option('create-branch', short_name='b',
6306
help='Create the target branch from this one before'
6307
' switching to it.'),
6309
help='Store and restore uncommitted changes in the'
6313
def run(self, to_location=None, force=False, create_branch=False,
6314
revision=None, directory=u'.', store=False):
6315
from . import switch
6316
tree_location = directory
6317
revision = _get_one_revision('switch', revision)
6318
possible_transports = []
6319
control_dir = controldir.ControlDir.open_containing(tree_location,
6320
possible_transports=possible_transports)[0]
6321
if to_location is None:
6322
if revision is None:
6323
raise errors.BzrCommandError(gettext('You must supply either a'
6324
' revision or a location'))
6325
to_location = tree_location
6327
branch = control_dir.open_branch(
6328
possible_transports=possible_transports)
6329
had_explicit_nick = branch.get_config().has_explicit_nickname()
6330
except errors.NotBranchError:
6332
had_explicit_nick = False
6335
raise errors.BzrCommandError(
6336
gettext('cannot create branch without source branch'))
6337
to_location = lookup_new_sibling_branch(
6338
control_dir, to_location,
6339
possible_transports=possible_transports)
6340
if revision is not None:
6341
revision = revision.as_revision_id(branch)
6342
to_branch = branch.controldir.sprout(
6344
possible_transports=possible_transports,
6345
revision_id=revision,
6346
source_branch=branch).open_branch()
6349
to_branch = Branch.open(to_location,
6350
possible_transports=possible_transports)
6351
except errors.NotBranchError:
6352
to_branch = open_sibling_branch(
6353
control_dir, to_location,
6354
possible_transports=possible_transports)
6355
if revision is not None:
6356
revision = revision.as_revision_id(to_branch)
6358
switch.switch(control_dir, to_branch, force, revision_id=revision,
6359
store_uncommitted=store)
6360
except controldir.BranchReferenceLoop:
6361
raise errors.BzrCommandError(
6362
gettext('switching would create a branch reference loop. '
6363
'Use the "bzr up" command to switch to a '
6364
'different revision.'))
6365
if had_explicit_nick:
6366
branch = control_dir.open_branch() # get the new branch!
6367
branch.nick = to_branch.nick
6368
note(gettext('Switched to branch: %s'),
6369
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6372
class cmd_view(Command):
6373
__doc__ = """Manage filtered views.
6375
Views provide a mask over the tree so that users can focus on
6376
a subset of a tree when doing their work. After creating a view,
6377
commands that support a list of files - status, diff, commit, etc -
6378
effectively have that list of files implicitly given each time.
6379
An explicit list of files can still be given but those files
6380
must be within the current view.
6382
In most cases, a view has a short life-span: it is created to make
6383
a selected change and is deleted once that change is committed.
6384
At other times, you may wish to create one or more named views
6385
and switch between them.
6387
To disable the current view without deleting it, you can switch to
6388
the pseudo view called ``off``. This can be useful when you need
6389
to see the whole tree for an operation or two (e.g. merge) but
6390
want to switch back to your view after that.
6393
To define the current view::
6395
brz view file1 dir1 ...
6397
To list the current view::
6401
To delete the current view::
6405
To disable the current view without deleting it::
6407
brz view --switch off
6409
To define a named view and switch to it::
6411
brz view --name view-name file1 dir1 ...
6413
To list a named view::
6415
brz view --name view-name
6417
To delete a named view::
6419
brz view --name view-name --delete
6421
To switch to a named view::
6423
brz view --switch view-name
6425
To list all views defined::
6429
To delete all views::
6431
brz view --delete --all
6435
takes_args = ['file*']
6438
help='Apply list or delete action to all views.',
6441
help='Delete the view.',
6444
help='Name of the view to define, list or delete.',
6448
help='Name of the view to switch to.',
6453
def run(self, file_list,
6459
tree, file_list = WorkingTree.open_containing_paths(file_list,
6461
current_view, view_dict = tree.views.get_view_info()
6466
raise errors.BzrCommandError(gettext(
6467
"Both --delete and a file list specified"))
6469
raise errors.BzrCommandError(gettext(
6470
"Both --delete and --switch specified"))
6472
tree.views.set_view_info(None, {})
6473
self.outf.write(gettext("Deleted all views.\n"))
6475
raise errors.BzrCommandError(
6476
gettext("No current view to delete"))
6478
tree.views.delete_view(name)
6479
self.outf.write(gettext("Deleted '%s' view.\n") % name)
6482
raise errors.BzrCommandError(gettext(
6483
"Both --switch and a file list specified"))
6485
raise errors.BzrCommandError(gettext(
6486
"Both --switch and --all specified"))
6487
elif switch == 'off':
6488
if current_view is None:
6489
raise errors.BzrCommandError(
6490
gettext("No current view to disable"))
6491
tree.views.set_view_info(None, view_dict)
6492
self.outf.write(gettext("Disabled '%s' view.\n") %
6495
tree.views.set_view_info(switch, view_dict)
6496
view_str = views.view_display_str(tree.views.lookup_view())
6498
gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6501
self.outf.write(gettext('Views defined:\n'))
6502
for view in sorted(view_dict):
6503
if view == current_view:
6507
view_str = views.view_display_str(view_dict[view])
6508
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6510
self.outf.write(gettext('No views defined.\n'))
6513
# No name given and no current view set
6516
raise errors.BzrCommandError(gettext(
6517
"Cannot change the 'off' pseudo view"))
6518
tree.views.set_view(name, sorted(file_list))
6519
view_str = views.view_display_str(tree.views.lookup_view())
6521
gettext("Using '{0}' view: {1}\n").format(name, view_str))
6525
# No name given and no current view set
6526
self.outf.write(gettext('No current view.\n'))
6528
view_str = views.view_display_str(tree.views.lookup_view(name))
6530
gettext("'{0}' view is: {1}\n").format(name, view_str))
6533
class cmd_hooks(Command):
6534
__doc__ = """Show hooks."""
6539
for hook_key in sorted(hooks.known_hooks.keys()):
6540
some_hooks = hooks.known_hooks_key_to_object(hook_key)
6541
self.outf.write("%s:\n" % type(some_hooks).__name__)
6542
for hook_name, hook_point in sorted(some_hooks.items()):
6543
self.outf.write(" %s:\n" % (hook_name,))
6544
found_hooks = list(hook_point)
6546
for hook in found_hooks:
6547
self.outf.write(" %s\n" %
6548
(some_hooks.get_hook_name(hook),))
6550
self.outf.write(gettext(" <no hooks installed>\n"))
6553
class cmd_remove_branch(Command):
6554
__doc__ = """Remove a branch.
6556
This will remove the branch from the specified location but
6557
will keep any working tree or repository in place.
6561
Remove the branch at repo/trunk::
6563
brz remove-branch repo/trunk
6567
takes_args = ["location?"]
6569
takes_options = ['directory',
6570
Option('force', help='Remove branch even if it is the active branch.')]
6572
aliases = ["rmbranch"]
6574
def run(self, directory=None, location=None, force=False):
6575
br = open_nearby_branch(near=directory, location=location)
6576
if not force and br.controldir.has_workingtree():
6578
active_branch = br.controldir.open_branch(name="")
6579
except errors.NotBranchError:
6580
active_branch = None
6581
if (active_branch is not None and
6582
br.control_url == active_branch.control_url):
6583
raise errors.BzrCommandError(
6584
gettext("Branch is active. Use --force to remove it."))
6585
br.controldir.destroy_branch(br.name)
6588
class cmd_shelve(Command):
6589
__doc__ = """Temporarily set aside some changes from the current tree.
6591
Shelve allows you to temporarily put changes you've made "on the shelf",
6592
ie. out of the way, until a later time when you can bring them back from
6593
the shelf with the 'unshelve' command. The changes are stored alongside
6594
your working tree, and so they aren't propagated along with your branch nor
6595
will they survive its deletion.
6597
If shelve --list is specified, previously-shelved changes are listed.
6599
Shelve is intended to help separate several sets of changes that have
6600
been inappropriately mingled. If you just want to get rid of all changes
6601
and you don't need to restore them later, use revert. If you want to
6602
shelve all text changes at once, use shelve --all.
6604
If filenames are specified, only the changes to those files will be
6605
shelved. Other files will be left untouched.
6607
If a revision is specified, changes since that revision will be shelved.
6609
You can put multiple items on the shelf, and by default, 'unshelve' will
6610
restore the most recently shelved changes.
6612
For complicated changes, it is possible to edit the changes in a separate
6613
editor program to decide what the file remaining in the working copy
6614
should look like. To do this, add the configuration option
6616
change_editor = PROGRAM @new_path @old_path
6618
where @new_path is replaced with the path of the new version of the
6619
file and @old_path is replaced with the path of the old version of
6620
the file. The PROGRAM should save the new file with the desired
6621
contents of the file in the working tree.
6625
takes_args = ['file*']
6630
Option('all', help='Shelve all changes.'),
6632
RegistryOption('writer', 'Method to use for writing diffs.',
6633
breezy.option.diff_writer_registry,
6634
value_switches=True, enum_switch=False),
6636
Option('list', help='List shelved changes.'),
6638
help='Destroy removed changes instead of shelving them.'),
6640
_see_also = ['unshelve', 'configuration']
6642
def run(self, revision=None, all=False, file_list=None, message=None,
6643
writer=None, list=False, destroy=False, directory=None):
6645
return self.run_for_list(directory=directory)
6646
from .shelf_ui import Shelver
6648
writer = breezy.option.diff_writer_registry.get()
6650
shelver = Shelver.from_args(writer(self.outf), revision, all,
6651
file_list, message, destroy=destroy, directory=directory)
6656
except errors.UserAbort:
6659
def run_for_list(self, directory=None):
6660
if directory is None:
6662
tree = WorkingTree.open_containing(directory)[0]
6663
self.add_cleanup(tree.lock_read().unlock)
6664
manager = tree.get_shelf_manager()
6665
shelves = manager.active_shelves()
6666
if len(shelves) == 0:
6667
note(gettext('No shelved changes.'))
6669
for shelf_id in reversed(shelves):
6670
message = manager.get_metadata(shelf_id).get(b'message')
6672
message = '<no message>'
6673
self.outf.write('%3d: %s\n' % (shelf_id, message))
6677
class cmd_unshelve(Command):
6678
__doc__ = """Restore shelved changes.
6680
By default, the most recently shelved changes are restored. However if you
6681
specify a shelf by id those changes will be restored instead. This works
6682
best when the changes don't depend on each other.
6685
takes_args = ['shelf_id?']
6688
RegistryOption.from_kwargs(
6689
'action', help="The action to perform.",
6690
enum_switch=False, value_switches=True,
6691
apply="Apply changes and remove from the shelf.",
6692
dry_run="Show changes, but do not apply or remove them.",
6693
preview="Instead of unshelving the changes, show the diff that "
6694
"would result from unshelving.",
6695
delete_only="Delete changes without applying them.",
6696
keep="Apply changes but don't delete them.",
6699
_see_also = ['shelve']
6701
def run(self, shelf_id=None, action='apply', directory=u'.'):
6702
from .shelf_ui import Unshelver
6703
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6707
unshelver.tree.unlock()
6710
class cmd_clean_tree(Command):
6711
__doc__ = """Remove unwanted files from working tree.
6713
By default, only unknown files, not ignored files, are deleted. Versioned
6714
files are never deleted.
6716
Another class is 'detritus', which includes files emitted by brz during
6717
normal operations and selftests. (The value of these files decreases with
6720
If no options are specified, unknown files are deleted. Otherwise, option
6721
flags are respected, and may be combined.
6723
To check what clean-tree will do, use --dry-run.
6725
takes_options = ['directory',
6726
Option('ignored', help='Delete all ignored files.'),
6727
Option('detritus', help='Delete conflict files, merge and revert'
6728
' backups, and failed selftest dirs.'),
6730
help='Delete files unknown to brz (default).'),
6731
Option('dry-run', help='Show files to delete instead of'
6733
Option('force', help='Do not prompt before deleting.')]
6735
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6736
force=False, directory=u'.'):
6737
from .clean_tree import clean_tree
6738
if not (unknown or ignored or detritus):
6742
clean_tree(directory, unknown=unknown, ignored=ignored,
6743
detritus=detritus, dry_run=dry_run, no_prompt=force)
6746
class cmd_reference(Command):
6747
__doc__ = """list, view and set branch locations for nested trees.
6749
If no arguments are provided, lists the branch locations for nested trees.
6750
If one argument is provided, display the branch location for that tree.
6751
If two arguments are provided, set the branch location for that tree.
6756
takes_args = ['path?', 'location?']
6758
Option('force-unversioned',
6759
help='Set reference even if path is not versioned.'),
6762
def run(self, path=None, location=None, force_unversioned=False):
6764
if path is not None:
6766
tree, branch, relpath = (
6767
controldir.ControlDir.open_containing_tree_or_branch(branchdir))
6768
if path is not None:
6771
tree = branch.basis_tree()
6773
info = viewitems(branch._get_all_reference_info())
6774
self._display_reference_info(tree, branch, info)
6776
if not tree.is_versioned(path) and not force_unversioned:
6777
raise errors.NotVersionedError(path)
6778
if location is None:
6779
info = [(path, branch.get_reference_info(path))]
6780
self._display_reference_info(tree, branch, info)
6782
branch.set_reference_info(
6783
path, location, file_id=tree.path2id(path))
6785
def _display_reference_info(self, tree, branch, info):
6787
for path, (location, file_id) in info:
6788
ref_list.append((path, location))
6789
for path, location in sorted(ref_list):
6790
self.outf.write('%s %s\n' % (path, location))
6793
class cmd_export_pot(Command):
6794
__doc__ = """Export command helps and error messages in po format."""
6797
takes_options = [Option('plugin',
6798
help='Export help text from named command '
6799
'(defaults to all built in commands).',
6801
Option('include-duplicates',
6802
help='Output multiple copies of the same msgid '
6803
'string if it appears more than once.'),
6806
def run(self, plugin=None, include_duplicates=False):
6807
from .export_pot import export_pot
6808
export_pot(self.outf, plugin, include_duplicates)
6811
class cmd_import(Command):
6812
__doc__ = """Import sources from a directory, tarball or zip file
6814
This command will import a directory, tarball or zip file into a bzr
6815
tree, replacing any versioned files already present. If a directory is
6816
specified, it is used as the target. If the directory does not exist, or
6817
is not versioned, it is created.
6819
Tarballs may be gzip or bzip2 compressed. This is autodetected.
6821
If the tarball or zip has a single root directory, that directory is
6822
stripped when extracting the tarball. This is not done for directories.
6825
takes_args = ['source', 'tree?']
6827
def run(self, source, tree=None):
6828
from .upstream_import import do_import
6829
do_import(source, tree)
6832
class cmd_link_tree(Command):
6833
__doc__ = """Hardlink matching files to another tree.
6835
Only files with identical content and execute bit will be linked.
6838
takes_args = ['location']
6840
def run(self, location):
6841
from .transform import link_tree
6842
target_tree = WorkingTree.open_containing(".")[0]
6843
source_tree = WorkingTree.open(location)
6844
with target_tree.lock_write(), source_tree.lock_read():
6845
link_tree(target_tree, source_tree)
6848
class cmd_fetch_ghosts(Command):
6849
__doc__ = """Attempt to retrieve ghosts from another branch.
6851
If the other branch is not supplied, the last-pulled branch is used.
6855
aliases = ['fetch-missing']
6856
takes_args = ['branch?']
6857
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
6859
def run(self, branch=None, no_fix=False):
6860
from .fetch_ghosts import GhostFetcher
6861
installed, failed = GhostFetcher.from_cmdline(branch).run()
6862
if len(installed) > 0:
6863
self.outf.write("Installed:\n")
6864
for rev in installed:
6865
self.outf.write(rev.decode('utf-8') + "\n")
6867
self.outf.write("Still missing:\n")
6869
self.outf.write(rev.decode('utf-8') + "\n")
6870
if not no_fix and len(installed) > 0:
6871
cmd_reconcile().run(".")
6874
def _register_lazy_builtins():
6875
# register lazy builtins from other modules; called at startup and should
6876
# be only called once.
6877
for (name, aliases, module_name) in [
6878
('cmd_bisect', [], 'breezy.bisect'),
6879
('cmd_bundle_info', [], 'breezy.bundle.commands'),
6880
('cmd_config', [], 'breezy.config'),
6881
('cmd_dump_btree', [], 'breezy.bzr.debug_commands'),
6882
('cmd_version_info', [], 'breezy.cmd_version_info'),
6883
('cmd_resolve', ['resolved'], 'breezy.conflicts'),
6884
('cmd_conflicts', [], 'breezy.conflicts'),
6885
('cmd_ping', [], 'breezy.bzr.smart.ping'),
6886
('cmd_sign_my_commits', [], 'breezy.commit_signature_commands'),
6887
('cmd_verify_signatures', [], 'breezy.commit_signature_commands'),
6888
('cmd_test_script', [], 'breezy.cmd_test_script'),
6890
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
breezy/builtins.py
